AWS::S3::Bucket DefaultRetention - AWS CloudFormation

AWS::S3::Bucket DefaultRetention

The default retention period that you want to apply to new objects placed in the specified bucket. Bucket default settings require both a mode and a period.

Syntax

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

JSON

{ "Days" : Integer, "Mode" : String, "Years" : Integer }

YAML

Days: Integer Mode: String Years: Integer

Properties

Days

The number of days that you want to specify for the default retention period.

Required: No

Type: Integer

Update requires: No interruption

Mode

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Bucket default settings require both a mode and a period. The period can be either Days or Years. For more information, see S3 Object Lock overview in the Amazon Simple Storage Service Developer Guide.

Required: No

Type: String

Allowed values: COMPLIANCE | GOVERNANCE

Update requires: No interruption

Years

The number of years that you want to specify for the default retention period.

Required: No

Type: Integer

Update requires: No interruption

See also