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
}

YAML


  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 this rule when you apply ObjectLockConfiguration to a bucket. If Object Lock is turned on, bucket settings require both Mode and a period of either Days or Years. You cannot specify Days and Years at the same time. For more information, see ObjectLockRule and DefaultRetention.

Required: Conditional

Type: ObjectLockRule