software.amazon.awscdk.services.s3

Interface LifecycleRule

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LifecycleRule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:46.742Z")
 @Stability(value=Experimental)
public interface LifecycleRule
extends software.amazon.jsii.JsiiSerializable

(experimental) Declaration of a Life cycle rule.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LifecycleRule.Builder A builder for LifecycleRule
static class	LifecycleRule.Jsii$Proxy An implementation for LifecycleRule

Method Summary

Modifier and Type	Method and Description
static LifecycleRule.Builder	builder()
default Duration	getAbortIncompleteMultipartUploadAfter() (experimental) Specifies a lifecycle rule that aborts incomplete multipart uploads to an Amazon S3 bucket.
default Boolean	getEnabled() (experimental) Whether this rule is enabled.
default Duration	getExpiration() (experimental) Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon Glacier.
default Instant	getExpirationDate() (experimental) Indicates when objects are deleted from Amazon S3 and Amazon Glacier.
default String	getId() (experimental) A unique identifier for this rule.
default Duration	getNoncurrentVersionExpiration() (experimental) Time between when a new version of the object is uploaded to the bucket and when old versions of the object expire.
default List<NoncurrentVersionTransition>	getNoncurrentVersionTransitions() (experimental) One or more transition rules that specify when non-current objects transition to a specified storage class.
default String	getPrefix() (experimental) Object key prefix that identifies one or more objects to which this rule applies.
default Map<String,Object>	getTagFilters() (experimental) The TagFilter property type specifies tags to use to identify a subset of objects for an Amazon S3 bucket.
default List<Transition>	getTransitions() (experimental) One or more transition rules that specify when an object transitions to a specified storage class.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAbortIncompleteMultipartUploadAfter

@Stability(value=Experimental)
 @Nullable
default Duration getAbortIncompleteMultipartUploadAfter()

(experimental) Specifies a lifecycle rule that aborts incomplete multipart uploads to an Amazon S3 bucket.

The AbortIncompleteMultipartUpload property type creates a lifecycle rule that aborts incomplete multipart uploads to an Amazon S3 bucket. When Amazon S3 aborts a multipart upload, it deletes all parts associated with the multipart upload.

Default: Incomplete uploads are never aborted

getEnabled

@Stability(value=Experimental)
 @Nullable
default Boolean getEnabled()

(experimental) Whether this rule is enabled.

Default: true

getExpiration

@Stability(value=Experimental)
 @Nullable
default Duration getExpiration()

(experimental) Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon 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.

Default: No expiration timeout

getExpirationDate

@Stability(value=Experimental)
 @Nullable
default Instant getExpirationDate()

(experimental) Indicates when objects are deleted from Amazon S3 and Amazon 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.

Default: No expiration date

getId

@Stability(value=Experimental)
 @Nullable
default String getId()

(experimental) A unique identifier for this rule.

The value cannot be more than 255 characters.

getNoncurrentVersionExpiration

@Stability(value=Experimental)
 @Nullable
default Duration getNoncurrentVersionExpiration()

(experimental) Time between when a new version of the object is uploaded to the bucket and when old versions of the object expire.

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.

Default: No noncurrent version expiration

getNoncurrentVersionTransitions

@Stability(value=Experimental)
 @Nullable
default List<NoncurrentVersionTransition> getNoncurrentVersionTransitions()

(experimental) One or more transition rules that specify when non-current objects transition to a specified storage class.

Only for for buckets with versioning enabled (or suspended).

If you specify a transition and expiration time, the expiration time must be later than the transition time.

getPrefix

@Stability(value=Experimental)
 @Nullable
default String getPrefix()

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

Default: Rule applies to all objects

getTagFilters

@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getTagFilters()

(experimental) The TagFilter property type specifies tags to use to identify a subset of objects for an Amazon S3 bucket.

Default: Rule applies to all objects

getTransitions

@Stability(value=Experimental)
 @Nullable
default List<Transition> getTransitions()

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

Default: No transition rules

builder

@Stability(value=Experimental)
static LifecycleRule.Builder builder()

Returns:

a LifecycleRule.Builder of LifecycleRule