This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::S3::Bucket Rule Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.amazonaws.cn/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*. You must specify at least one of the following properties: `AbortIncompleteMultipartUpload`, `ExpirationDate`, `ExpirationInDays`, `NoncurrentVersionExpirationInDays`, `NoncurrentVersionTransition`, `NoncurrentVersionTransitions`, `Transition`, or `Transitions`. ## Syntax To declare this entity in your Amazon CloudFormation template, use the following syntax: ### JSON ``` { "[AbortIncompleteMultipartUpload](#cfn-s3-bucket-rule-abortincompletemultipartupload)" : {{AbortIncompleteMultipartUpload}}, "[ExpirationDate](#cfn-s3-bucket-rule-expirationdate)" : {{String}}, "[ExpirationInDays](#cfn-s3-bucket-rule-expirationindays)" : {{Integer}}, "[ExpiredObjectDeleteMarker](#cfn-s3-bucket-rule-expiredobjectdeletemarker)" : {{Boolean}}, "[Id](#cfn-s3-bucket-rule-id)" : {{String}}, "[NoncurrentVersionExpiration](#cfn-s3-bucket-rule-noncurrentversionexpiration)" : {{NoncurrentVersionExpiration}}, "[NoncurrentVersionExpirationInDays](#cfn-s3-bucket-rule-noncurrentversionexpirationindays)" : {{Integer}}, "[NoncurrentVersionTransition](#cfn-s3-bucket-rule-noncurrentversiontransition)" : {{NoncurrentVersionTransition}}, "[NoncurrentVersionTransitions](#cfn-s3-bucket-rule-noncurrentversiontransitions)" : {{[ NoncurrentVersionTransition, ... ]}}, "[ObjectSizeGreaterThan](#cfn-s3-bucket-rule-objectsizegreaterthan)" : {{String}}, "[ObjectSizeLessThan](#cfn-s3-bucket-rule-objectsizelessthan)" : {{String}}, "[Prefix](#cfn-s3-bucket-rule-prefix)" : {{String}}, "[Status](#cfn-s3-bucket-rule-status)" : {{String}}, "[TagFilters](#cfn-s3-bucket-rule-tagfilters)" : {{[ TagFilter, ... ]}}, "[Transition](#cfn-s3-bucket-rule-transition)" : {{Transition}}, "[Transitions](#cfn-s3-bucket-rule-transitions)" : {{[ Transition, ... ]}} } ``` ### YAML ``` [AbortIncompleteMultipartUpload](#cfn-s3-bucket-rule-abortincompletemultipartupload): {{ AbortIncompleteMultipartUpload}} [ExpirationDate](#cfn-s3-bucket-rule-expirationdate): {{String}} [ExpirationInDays](#cfn-s3-bucket-rule-expirationindays): {{Integer}} [ExpiredObjectDeleteMarker](#cfn-s3-bucket-rule-expiredobjectdeletemarker): {{Boolean}} [Id](#cfn-s3-bucket-rule-id): {{String}} [NoncurrentVersionExpiration](#cfn-s3-bucket-rule-noncurrentversionexpiration): {{ NoncurrentVersionExpiration}} [NoncurrentVersionExpirationInDays](#cfn-s3-bucket-rule-noncurrentversionexpirationindays): {{Integer}} [NoncurrentVersionTransition](#cfn-s3-bucket-rule-noncurrentversiontransition): {{ NoncurrentVersionTransition}} [NoncurrentVersionTransitions](#cfn-s3-bucket-rule-noncurrentversiontransitions): {{ - NoncurrentVersionTransition}} [ObjectSizeGreaterThan](#cfn-s3-bucket-rule-objectsizegreaterthan): {{String}} [ObjectSizeLessThan](#cfn-s3-bucket-rule-objectsizelessthan): {{String}} [Prefix](#cfn-s3-bucket-rule-prefix): {{String}} [Status](#cfn-s3-bucket-rule-status): {{String}} [TagFilters](#cfn-s3-bucket-rule-tagfilters): {{ - TagFilter}} [Transition](#cfn-s3-bucket-rule-transition): {{ Transition}} [Transitions](#cfn-s3-bucket-rule-transitions): {{ - Transition}} ``` ## Properties `AbortIncompleteMultipartUpload` Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. *Required*: Conditional *Type*: [AbortIncompleteMultipartUpload](aws-properties-s3-bucket-abortincompletemultipartupload.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExpirationDate` Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. *Required*: Conditional *Type*: String *Pattern*: `^(\d{4})-(0[0-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-4]):([0-5]\d):([0-6]\d)((\.\d{3})?)Z$` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExpirationInDays` Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. *Required*: Conditional *Type*: Integer *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExpiredObjectDeleteMarker` Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with `ExpirationInDays`, `ExpirationDate`, or `TagFilters`. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` Unique identifier for the rule. The value can't be longer than 255 characters. *Required*: No *Type*: String *Maximum*: `255` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NoncurrentVersionExpiration` Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime. *Required*: No *Type*: [NoncurrentVersionExpiration](aws-properties-s3-bucket-noncurrentversionexpiration.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NoncurrentVersionExpirationInDays` (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time. *Required*: Conditional *Type*: Integer *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NoncurrentVersionTransition` (Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransitions` property. *Required*: Conditional *Type*: [NoncurrentVersionTransition](aws-properties-s3-bucket-noncurrentversiontransition.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NoncurrentVersionTransitions` For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransition` property. *Required*: Conditional *Type*: Array of [NoncurrentVersionTransition](aws-properties-s3-bucket-noncurrentversiontransition.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectSizeGreaterThan` Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.amazonaws.cn/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*. *Required*: No *Type*: String *Pattern*: `[0-9]+` *Maximum*: `20` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectSizeLessThan` Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.amazonaws.cn/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*. *Required*: No *Type*: String *Pattern*: `[0-9]+` *Maximum*: `20` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Prefix` Object key prefix that identifies one or more objects to which this rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.amazonaws.cn/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Status` If `Enabled`, the rule is currently being applied. If `Disabled`, the rule is not currently being applied. *Required*: Yes *Type*: String *Allowed values*: `Enabled | Disabled` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagFilters` Tags to use to identify a subset of objects to which the lifecycle rule applies. *Required*: No *Type*: Array of [TagFilter](aws-properties-s3-bucket-tagfilter.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Transition` (Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transitions` property. *Required*: Conditional *Type*: [Transition](aws-properties-s3-bucket-transition.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Transitions` One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transition` property. *Required*: Conditional *Type*: Array of [Transition](aws-properties-s3-bucket-transition.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Examples ### Manage the lifecycle for S3 objects The following example template shows an S3 bucket with a lifecycle configuration rule. The rule applies to all objects with the `glacier` key prefix. The objects are transitioned to Glacier after one day, and deleted after one year. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "S3Bucket": { "Type": "AWS::S3::Bucket", "Properties": { "AccessControl": "Private", "LifecycleConfiguration": { "Rules": [ { "Id": "GlacierRule", "Prefix": "glacier", "Status": "Enabled", "ExpirationInDays": 365, "Transitions": [ { "TransitionInDays": 1, "StorageClass": "GLACIER" } ] } ] } } } }, "Outputs": { "BucketName": { "Value": { "Ref": "S3Bucket" }, "Description": "Name of the sample Amazon S3 bucket with a lifecycle configuration." } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Resources: S3Bucket: Type: 'AWS::S3::Bucket' Properties: AccessControl: Private LifecycleConfiguration: Rules: - Id: GlacierRule Prefix: glacier Status: Enabled ExpirationInDays: 365 Transitions: - TransitionInDays: 1 StorageClass: GLACIER Outputs: BucketName: Value: !Ref S3Bucket Description: Name of the sample Amazon S3 bucket with a lifecycle configuration. ``` ## See also + AWS::S3::Bucket [Examples](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#aws-properties-s3-bucket--examples)