RuleArgs

data class RuleArgs(val abortIncompleteMultipartUpload: Output<AbortIncompleteMultipartUploadArgs>? = null, val expirationDate: Output<String>? = null, val expirationInDays: Output<Int>? = null, val expiredObjectDeleteMarker: Output<Boolean>? = null, val id: Output<String>? = null, val noncurrentVersionExpiration: Output<NoncurrentVersionExpirationArgs>? = null, val noncurrentVersionExpirationInDays: Output<Int>? = null, val noncurrentVersionTransition: Output<NoncurrentVersionTransitionArgs>? = null, val noncurrentVersionTransitions: Output<List<NoncurrentVersionTransitionArgs>>? = null, val objectSizeGreaterThan: Output<String>? = null, val objectSizeLessThan: Output<String>? = null, val prefix: Output<String>? = null, val status: Output<Either<String, RuleStatus>>? = null, val tagFilters: Output<List<TagFilterArgs>>? = null, val transition: Output<TransitionArgs>? = null, val transitions: Output<List<TransitionArgs>>? = null) : ConvertibleToJava<RuleArgs>

Definition of Rule

Constructors

Link copied to clipboard
constructor(abortIncompleteMultipartUpload: Output<AbortIncompleteMultipartUploadArgs>? = null, expirationDate: Output<String>? = null, expirationInDays: Output<Int>? = null, expiredObjectDeleteMarker: Output<Boolean>? = null, id: Output<String>? = null, noncurrentVersionExpiration: Output<NoncurrentVersionExpirationArgs>? = null, noncurrentVersionExpirationInDays: Output<Int>? = null, noncurrentVersionTransition: Output<NoncurrentVersionTransitionArgs>? = null, noncurrentVersionTransitions: Output<List<NoncurrentVersionTransitionArgs>>? = null, objectSizeGreaterThan: Output<String>? = null, objectSizeLessThan: Output<String>? = null, prefix: Output<String>? = null, status: Output<Either<String, RuleStatus>>? = null, tagFilters: Output<List<TagFilterArgs>>? = null, transition: Output<TransitionArgs>? = null, transitions: Output<List<TransitionArgs>>? = null)

Properties

Link copied to clipboard

Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

Link copied to clipboard
val expirationDate: Output<String>? = null

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. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)

Link copied to clipboard
val expirationInDays: Output<Int>? = null

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.

Link copied to clipboard
val expiredObjectDeleteMarker: Output<Boolean>? = null

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`.

Link copied to clipboard
val id: Output<String>? = null

Unique identifier for the rule. The value can't be longer than 255 characters.

Link copied to clipboard

Specifies when noncurrent object versions expire. Upon expiration, 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 S3 delete noncurrent object versions at a specific period in the object's lifetime. Specifies when noncurrent object versions expire. Upon expiration, 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 S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see AWS::S3::Bucket Rule.

Link copied to clipboard

(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.

Link copied to clipboard

(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. Container for the transition rule that describes when noncurrent objects transition to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the `NoncurrentVersionTransitions` property.

Link copied to clipboard

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.

Link copied to clipboard
val objectSizeGreaterThan: Output<String>? = null

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 in the Amazon S3 User Guide.

Link copied to clipboard
val objectSizeLessThan: Output<String>? = null

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 in the Amazon S3 User Guide.

Link copied to clipboard
val prefix: Output<String>? = null

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.

Link copied to clipboard
val status: Output<Either<String, RuleStatus>>? = null

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

Link copied to clipboard
val tagFilters: Output<List<TagFilterArgs>>? = null

Tags to use to identify a subset of objects to which the lifecycle rule applies.

Link copied to clipboard
val transition: Output<TransitionArgs>? = null

(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. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

Link copied to clipboard
val transitions: Output<List<TransitionArgs>>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): RuleArgs