AWS::S3::Bucket ObjectLockConfiguration - AWS CloudFormation

AWS::S3::Bucket ObjectLockConfiguration

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "ObjectLockEnabled" : String, "Rule" : ObjectLockRule }

Properties

ObjectLockEnabled

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Required: No

Type: String

Allowed values: Enabled

Update requires: No interruption

Rule

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

Required: No

Type: ObjectLockRule

Update requires: No interruption

See also