aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

AWS::S3::Bucket - ObjectLockConfiguration-ExistingAttribute causes new buckets to be stuck in CREATE_IN_PROGRESS

Open
#626 1 comment 1 reaction 0 assignees View on GitHub
Coverage
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

## Scope of request
Creating a new S3 Bucket with ObjectLockConfiguration can lead to Cloudformation stuck in CREATE_IN_PROGRESS, and eventually giving up with "Internal Error".

The bucket actually creates successfully, but Cloudformation thinks something went wrong. Per the docs, there are redundant properties (ObjectLockConfiguration.ObjectLockEnabled, and ObjectLockEnabled).

## Expected behavior

Cloudformation should acknowledge that the bucket was created successfully.

## Suggest specific test cases

Example bad request:
```
"S3BucketWithObjectLock": {
"Type": "AWS::S3::Bucket",
"DeletionPolicy": "Retain",
"Properties": {
"ObjectLockConfiguration": {
"ObjectLockEnabled": "Enabled"
}
}
}
```

Example good request:
```
"S3BucketWithObjectLock": {
"Type": "AWS::S3::Bucket",
"DeletionPolicy": "Retain",
"Properties": {
"ObjectLockEnabled": true
}
}
```

Since only the latter actually works, perhaps remove the former?

## Helpful Links to speed up research and evaluation

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockenabled

## Category (required) - Will help with tagging and be easier to find by other users to +1
Storage
S3

Contributor guide

Open the contributing guide

Research direction

Start with the two linked AWS CloudFormation documentation pages and compare the ObjectLockConfiguration and ObjectLockEnabled properties against the supplied failing and working templates. Reproduce the CREATE_IN_PROGRESS behavior if possible; done means the failing configuration is handled correctly or the redundant property is addressed, with coverage for the supplied cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.