software.amazon.awscdk.services.s3

Class CfnBucket.RuleProperty.Builder

java.lang.Object

software.amazon.awscdk.services.s3.CfnBucket.RuleProperty.Builder

Enclosing interface:

CfnBucket.RuleProperty

public static final class CfnBucket.RuleProperty.Builder
extends java.lang.Object

A builder for CfnBucket.RuleProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnBucket.RuleProperty.Builder	abortIncompleteMultipartUpload(CfnBucket.AbortIncompleteMultipartUploadProperty abortIncompleteMultipartUpload) Sets the value of CfnBucket.RuleProperty.getAbortIncompleteMultipartUpload()
CfnBucket.RuleProperty.Builder	abortIncompleteMultipartUpload(IResolvable abortIncompleteMultipartUpload) Sets the value of CfnBucket.RuleProperty.getAbortIncompleteMultipartUpload()
CfnBucket.RuleProperty	build() Builds the configured instance.
CfnBucket.RuleProperty.Builder	expirationDate(java.time.Instant expirationDate) Sets the value of CfnBucket.RuleProperty.getExpirationDate()
CfnBucket.RuleProperty.Builder	expirationDate(IResolvable expirationDate) Sets the value of CfnBucket.RuleProperty.getExpirationDate()
CfnBucket.RuleProperty.Builder	expirationInDays(java.lang.Number expirationInDays) Sets the value of CfnBucket.RuleProperty.getExpirationInDays()
CfnBucket.RuleProperty.Builder	expiredObjectDeleteMarker(java.lang.Boolean expiredObjectDeleteMarker) Sets the value of CfnBucket.RuleProperty.getExpiredObjectDeleteMarker()
CfnBucket.RuleProperty.Builder	expiredObjectDeleteMarker(IResolvable expiredObjectDeleteMarker) Sets the value of CfnBucket.RuleProperty.getExpiredObjectDeleteMarker()
CfnBucket.RuleProperty.Builder	id(java.lang.String id) Sets the value of CfnBucket.RuleProperty.getId()
CfnBucket.RuleProperty.Builder	noncurrentVersionExpiration(CfnBucket.NoncurrentVersionExpirationProperty noncurrentVersionExpiration) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionExpiration()
CfnBucket.RuleProperty.Builder	noncurrentVersionExpiration(IResolvable noncurrentVersionExpiration) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionExpiration()
CfnBucket.RuleProperty.Builder	noncurrentVersionExpirationInDays(java.lang.Number noncurrentVersionExpirationInDays) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionExpirationInDays()
CfnBucket.RuleProperty.Builder	noncurrentVersionTransition(CfnBucket.NoncurrentVersionTransitionProperty noncurrentVersionTransition) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransition()
CfnBucket.RuleProperty.Builder	noncurrentVersionTransition(IResolvable noncurrentVersionTransition) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransition()
CfnBucket.RuleProperty.Builder	noncurrentVersionTransitions(IResolvable noncurrentVersionTransitions) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransitions()
CfnBucket.RuleProperty.Builder	noncurrentVersionTransitions(java.util.List<? extends java.lang.Object> noncurrentVersionTransitions) Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransitions()
CfnBucket.RuleProperty.Builder	objectSizeGreaterThan(java.lang.Number objectSizeGreaterThan) Sets the value of CfnBucket.RuleProperty.getObjectSizeGreaterThan()
CfnBucket.RuleProperty.Builder	objectSizeLessThan(java.lang.Number objectSizeLessThan) Sets the value of CfnBucket.RuleProperty.getObjectSizeLessThan()
CfnBucket.RuleProperty.Builder	prefix(java.lang.String prefix) Sets the value of CfnBucket.RuleProperty.getPrefix()
CfnBucket.RuleProperty.Builder	status(java.lang.String status) Sets the value of CfnBucket.RuleProperty.getStatus()
CfnBucket.RuleProperty.Builder	tagFilters(IResolvable tagFilters) Sets the value of CfnBucket.RuleProperty.getTagFilters()
CfnBucket.RuleProperty.Builder	tagFilters(java.util.List<? extends java.lang.Object> tagFilters) Sets the value of CfnBucket.RuleProperty.getTagFilters()
CfnBucket.RuleProperty.Builder	transition(CfnBucket.TransitionProperty transition) Sets the value of CfnBucket.RuleProperty.getTransition()
CfnBucket.RuleProperty.Builder	transition(IResolvable transition) Sets the value of CfnBucket.RuleProperty.getTransition()
CfnBucket.RuleProperty.Builder	transitions(IResolvable transitions) Sets the value of CfnBucket.RuleProperty.getTransitions()
CfnBucket.RuleProperty.Builder	transitions(java.util.List<? extends java.lang.Object> transitions) Sets the value of CfnBucket.RuleProperty.getTransitions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

status

public CfnBucket.RuleProperty.Builder status(java.lang.String status)

Sets the value of CfnBucket.RuleProperty.getStatus()

Parameters:

status - If `Enabled` , the rule is currently being applied. This parameter is required. If Disabled , the rule is not currently being applied.

Returns:

this

abortIncompleteMultipartUpload

public CfnBucket.RuleProperty.Builder abortIncompleteMultipartUpload(IResolvable abortIncompleteMultipartUpload)

Sets the value of CfnBucket.RuleProperty.getAbortIncompleteMultipartUpload()

Parameters:

abortIncompleteMultipartUpload - Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket.

Returns:

this

abortIncompleteMultipartUpload

public CfnBucket.RuleProperty.Builder abortIncompleteMultipartUpload(CfnBucket.AbortIncompleteMultipartUploadProperty abortIncompleteMultipartUpload)

Sets the value of CfnBucket.RuleProperty.getAbortIncompleteMultipartUpload()

Parameters:

abortIncompleteMultipartUpload - Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket.

Returns:

this

expirationDate

public CfnBucket.RuleProperty.Builder expirationDate(java.time.Instant expirationDate)

Sets the value of CfnBucket.RuleProperty.getExpirationDate()

Parameters:

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.

Returns:

this

expirationDate

public CfnBucket.RuleProperty.Builder expirationDate(IResolvable expirationDate)

Sets the value of CfnBucket.RuleProperty.getExpirationDate()

Parameters:

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.

Returns:

this

expirationInDays

public CfnBucket.RuleProperty.Builder expirationInDays(java.lang.Number expirationInDays)

Sets the value of CfnBucket.RuleProperty.getExpirationInDays()

Parameters:

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.

Returns:

this

expiredObjectDeleteMarker

public CfnBucket.RuleProperty.Builder expiredObjectDeleteMarker(java.lang.Boolean expiredObjectDeleteMarker)

Sets the value of CfnBucket.RuleProperty.getExpiredObjectDeleteMarker()

Parameters:

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 .

Returns:

this

expiredObjectDeleteMarker

public CfnBucket.RuleProperty.Builder expiredObjectDeleteMarker(IResolvable expiredObjectDeleteMarker)

Sets the value of CfnBucket.RuleProperty.getExpiredObjectDeleteMarker()

Parameters:

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 .

Returns:

this

id

public CfnBucket.RuleProperty.Builder id(java.lang.String id)

Sets the value of CfnBucket.RuleProperty.getId()

Parameters:

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

Returns:

this

noncurrentVersionExpiration

public CfnBucket.RuleProperty.Builder noncurrentVersionExpiration(IResolvable noncurrentVersionExpiration)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionExpiration()

Parameters:

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.

Returns:

this

noncurrentVersionExpiration

public CfnBucket.RuleProperty.Builder noncurrentVersionExpiration(CfnBucket.NoncurrentVersionExpirationProperty noncurrentVersionExpiration)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionExpiration()

Parameters:

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.

Returns:

this

noncurrentVersionExpirationInDays

public CfnBucket.RuleProperty.Builder noncurrentVersionExpirationInDays(java.lang.Number noncurrentVersionExpirationInDays)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionExpirationInDays()

Parameters:

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.

Returns:

this

noncurrentVersionTransition

public CfnBucket.RuleProperty.Builder noncurrentVersionTransition(IResolvable noncurrentVersionTransition)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransition()

Parameters:

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.

Returns:

this

noncurrentVersionTransition

public CfnBucket.RuleProperty.Builder noncurrentVersionTransition(CfnBucket.NoncurrentVersionTransitionProperty noncurrentVersionTransition)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransition()

Parameters:

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.

Returns:

this

noncurrentVersionTransitions

public CfnBucket.RuleProperty.Builder noncurrentVersionTransitions(IResolvable noncurrentVersionTransitions)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransitions()

Parameters:

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.

Returns:

this

noncurrentVersionTransitions

public CfnBucket.RuleProperty.Builder noncurrentVersionTransitions(java.util.List<? extends java.lang.Object> noncurrentVersionTransitions)

Sets the value of CfnBucket.RuleProperty.getNoncurrentVersionTransitions()

Parameters:

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.

Returns:

this

objectSizeGreaterThan

public CfnBucket.RuleProperty.Builder objectSizeGreaterThan(java.lang.Number objectSizeGreaterThan)

Sets the value of CfnBucket.RuleProperty.getObjectSizeGreaterThan()

Parameters:

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

Returns:

this

objectSizeLessThan

public CfnBucket.RuleProperty.Builder objectSizeLessThan(java.lang.Number objectSizeLessThan)

Sets the value of CfnBucket.RuleProperty.getObjectSizeLessThan()

Parameters:

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

Returns:

this

prefix

public CfnBucket.RuleProperty.Builder prefix(java.lang.String prefix)

Sets the value of CfnBucket.RuleProperty.getPrefix()

Parameters:

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 .

Returns:

this

tagFilters

public CfnBucket.RuleProperty.Builder tagFilters(IResolvable tagFilters)

Sets the value of CfnBucket.RuleProperty.getTagFilters()

Parameters:

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

Returns:

this

tagFilters

public CfnBucket.RuleProperty.Builder tagFilters(java.util.List<? extends java.lang.Object> tagFilters)

Sets the value of CfnBucket.RuleProperty.getTagFilters()

Parameters:

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

Returns:

this

transition

public CfnBucket.RuleProperty.Builder transition(IResolvable transition)

Sets the value of CfnBucket.RuleProperty.getTransition()

Parameters:

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.

Returns:

this

transition

public CfnBucket.RuleProperty.Builder transition(CfnBucket.TransitionProperty transition)

Sets the value of CfnBucket.RuleProperty.getTransition()

Parameters:

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.

Returns:

this

transitions

public CfnBucket.RuleProperty.Builder transitions(IResolvable transitions)

Sets the value of CfnBucket.RuleProperty.getTransitions()

Parameters:

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.

Returns:

this

transitions

public CfnBucket.RuleProperty.Builder transitions(java.util.List<? extends java.lang.Object> transitions)

Sets the value of CfnBucket.RuleProperty.getTransitions()

Parameters:

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.

Returns:

this

build

public CfnBucket.RuleProperty build()

Builds the configured instance.

Returns:

a new instance of CfnBucket.RuleProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided