Package software.amazon.awscdk.cfnpropertymixins.services.s3

Class CfnBucketPropsMixin.RuleProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.s3.CfnBucketPropsMixin.RuleProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBucketPropsMixin.RuleProperty>

Enclosing interface:

CfnBucketPropsMixin.RuleProperty

@Stability(Stable)
public static final class CfnBucketPropsMixin.RuleProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBucketPropsMixin.RuleProperty>

A builder for CfnBucketPropsMixin.RuleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

abortIncompleteMultipartUpload

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder abortIncompleteMultipartUpload(IResolvable abortIncompleteMultipartUpload)

Sets the value of CfnBucketPropsMixin.RuleProperty.getAbortIncompleteMultipartUpload()

Parameters:

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

Returns:

this

abortIncompleteMultipartUpload

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder abortIncompleteMultipartUpload(CfnBucketPropsMixin.AbortIncompleteMultipartUploadProperty abortIncompleteMultipartUpload)

Sets the value of CfnBucketPropsMixin.RuleProperty.getAbortIncompleteMultipartUpload()

Parameters:

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

Returns:

this

expirationDate

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder expirationDate(Instant expirationDate)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder expirationDate(IResolvable expirationDate)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder expirationInDays(Number expirationInDays)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder expiredObjectDeleteMarker(Boolean expiredObjectDeleteMarker)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder expiredObjectDeleteMarker(IResolvable expiredObjectDeleteMarker)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder id(String id)

Sets the value of CfnBucketPropsMixin.RuleProperty.getId()

Parameters:

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

Returns:

this

noncurrentVersionExpiration

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionExpiration(IResolvable noncurrentVersionExpiration)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionExpiration(CfnBucketPropsMixin.NoncurrentVersionExpirationProperty noncurrentVersionExpiration)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionExpirationInDays(Number noncurrentVersionExpirationInDays)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionTransition(IResolvable noncurrentVersionTransition)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionTransition(CfnBucketPropsMixin.NoncurrentVersionTransitionProperty noncurrentVersionTransition)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionTransitions(IResolvable noncurrentVersionTransitions)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder noncurrentVersionTransitions(List<? extends Object> noncurrentVersionTransitions)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder objectSizeGreaterThan(Number objectSizeGreaterThan)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder objectSizeLessThan(Number objectSizeLessThan)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder prefix(String prefix)

Sets the value of CfnBucketPropsMixin.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

status

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder status(String status)

Sets the value of CfnBucketPropsMixin.RuleProperty.getStatus()

Parameters:

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

Returns:

this

tagFilters

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder tagFilters(IResolvable tagFilters)

Sets the value of CfnBucketPropsMixin.RuleProperty.getTagFilters()

Parameters:

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

Returns:

this

tagFilters

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder tagFilters(List<? extends Object> tagFilters)

Sets the value of CfnBucketPropsMixin.RuleProperty.getTagFilters()

Parameters:

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

Returns:

this

transition

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder transition(IResolvable transition)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder transition(CfnBucketPropsMixin.TransitionProperty transition)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder transitions(IResolvable transitions)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty.Builder transitions(List<? extends Object> transitions)

Sets the value of CfnBucketPropsMixin.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

@Stability(Stable)
public CfnBucketPropsMixin.RuleProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnBucketPropsMixin.RuleProperty>

Returns:

a new instance of CfnBucketPropsMixin.RuleProperty

Throws:

NullPointerException - if any required attribute was not provided