AWS CloudFormation
User Guide (Version )

AWS::S3::Bucket DefaultRetention

The default retention period that you want to apply to new objects placed in the specified bucket.

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.

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

On this page: