aws-cdk-lib.aws_s3express.CfnDirectoryBucket.RuleProperty

RuleProperty Struct

Specifies lifecycle rules for an Amazon S3 bucket.

For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference . For examples, see Put Bucket Lifecycle Configuration Examples .

You must specify at least one of the following properties: AbortIncompleteMultipartUpload , or ExpirationInDays .

Source

Generated code

Type last changed

v2.172.0 · 7 Dec 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3express as s3express } from 'aws-cdk-lib';
const ruleProperty: s3express.CfnDirectoryBucket.RuleProperty = {
  status: 'status',

  // the properties below are optional
  abortIncompleteMultipartUpload: {
    daysAfterInitiation: 123,
  },
  expirationInDays: 123,
  id: 'id',
  objectSizeGreaterThan: 'objectSizeGreaterThan',
  objectSizeLessThan: 'objectSizeLessThan',
  prefix: 'prefix',
};

Properties

abortIncompleteMultipartUpload?optionalIResolvable | CfnDirectoryBucket.AbortIncompleteMultipartUploadPropertyabort_incomplete_multipart_upload?optionaltyping.Union[IResolvable, AbortIncompleteMultipartUploadProperty]abortIncompleteMultipartUpload?optionalIResolvableAbortIncompleteMultipartUpload?optionalIResolvableAbortIncompleteMultipartUpload?optionalinterface{}#

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.

expirationInDays?optionalnumberexpiration_in_days?optionalint | floatexpirationInDays?optionalNumberExpirationInDays?optionaldoubleExpirationInDays?optional*float64#

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.

id?optionalstringid?optionalstrid?optionalStringId?optionalstringId?optional*string#

Unique identifier for the rule.

The value can't be longer than 255 characters.

objectSizeGreaterThan?optionalstringobject_size_greater_than?optionalstrobjectSizeGreaterThan?optionalStringObjectSizeGreaterThan?optionalstringObjectSizeGreaterThan?optional*string#

Specifies the minimum object size in bytes for this rule to apply to.

notes

Objects must be larger than this value in bytes. For more information about size based rules, see Lifecycle configuration using size-based rules in the Amazon S3 User Guide .

objectSizeLessThan?optionalstringobject_size_less_than?optionalstrobjectSizeLessThan?optionalStringObjectSizeLessThan?optionalstringObjectSizeLessThan?optional*string#

Specifies the maximum object size in bytes for this rule to apply to.

notes

Objects must be smaller than this value in bytes. For more information about sized based rules, see Lifecycle configuration using size-based rules in the Amazon S3 User Guide .

prefix?optionalstringprefix?optionalstrprefix?optionalStringPrefix?optionalstringPrefix?optional*string#

Object key prefix that identifies one or more objects to which this rule applies.

notes

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 .

statusstringstatusstrstatusStringStatusstringStatus*stringrequired#

If `Enabled` , the rule is currently being applied.

If Disabled , the rule is not currently being applied.