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

Class CfnBucketPropsMixin.ReplicationRuleProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnBucketPropsMixin.ReplicationRuleProperty

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

A builder for CfnBucketPropsMixin.ReplicationRuleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnBucketPropsMixin.ReplicationRuleProperty	build()	Builds the configured instance.
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	deleteMarkerReplication(CfnBucketPropsMixin.DeleteMarkerReplicationProperty deleteMarkerReplication)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDeleteMarkerReplication()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	deleteMarkerReplication(IResolvable deleteMarkerReplication)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDeleteMarkerReplication()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	destination(CfnBucketPropsMixin.ReplicationDestinationProperty destination)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDestination()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	destination(IResolvable destination)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDestination()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	filter(CfnBucketPropsMixin.ReplicationRuleFilterProperty filter)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getFilter()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	filter(IResolvable filter)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getFilter()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	id(String id)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getId()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	prefix(String prefix)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getPrefix()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	priority(Number priority)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getPriority()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	sourceSelectionCriteria(CfnBucketPropsMixin.SourceSelectionCriteriaProperty sourceSelectionCriteria)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getSourceSelectionCriteria()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	sourceSelectionCriteria(IResolvable sourceSelectionCriteria)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getSourceSelectionCriteria()
CfnBucketPropsMixin.ReplicationRuleProperty.Builder	status(String status)	Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getStatus()

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

deleteMarkerReplication

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder deleteMarkerReplication(IResolvable deleteMarkerReplication)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDeleteMarkerReplication()

Parameters:

deleteMarkerReplication - Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration .

For more information about delete marker replication, see Basic Rule Configuration .

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility .

Returns:

this

deleteMarkerReplication

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder deleteMarkerReplication(CfnBucketPropsMixin.DeleteMarkerReplicationProperty deleteMarkerReplication)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDeleteMarkerReplication()

Parameters:

deleteMarkerReplication - Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration .

For more information about delete marker replication, see Basic Rule Configuration .

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility .

Returns:

this

destination

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder destination(IResolvable destination)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDestination()

Parameters:

destination - A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

Returns:

this

destination

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder destination(CfnBucketPropsMixin.ReplicationDestinationProperty destination)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getDestination()

Parameters:

destination - A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

Returns:

this

filter

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder filter(IResolvable filter)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getFilter()

Parameters:

filter - A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix , TagFilter , or an And child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.

V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the Prefix directly as a child element of the Rule element.

Returns:

this

filter

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder filter(CfnBucketPropsMixin.ReplicationRuleFilterProperty filter)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getFilter()

Parameters:

filter - A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix , TagFilter , or an And child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.

V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the Prefix directly as a child element of the Rule element.

Returns:

this

id

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

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getId()

Parameters:

id - A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as "ID".

Returns:

this

prefix

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

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getPrefix()

Parameters:

prefix - An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the Prefix directly as a child element of the Rule element.

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

priority

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder priority(Number priority)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getPriority()

Parameters:

priority - The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon S3 User Guide .

Returns:

this

sourceSelectionCriteria

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder sourceSelectionCriteria(IResolvable sourceSelectionCriteria)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getSourceSelectionCriteria()

Parameters:

sourceSelectionCriteria - A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.

Returns:

this

sourceSelectionCriteria

@Stability(Stable)
public CfnBucketPropsMixin.ReplicationRuleProperty.Builder sourceSelectionCriteria(CfnBucketPropsMixin.SourceSelectionCriteriaProperty sourceSelectionCriteria)

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getSourceSelectionCriteria()

Parameters:

sourceSelectionCriteria - A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.

Returns:

this

status

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

Sets the value of CfnBucketPropsMixin.ReplicationRuleProperty.getStatus()

Parameters:

status - Specifies whether the rule is enabled.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnBucketPropsMixin.ReplicationRuleProperty

Throws:

NullPointerException - if any required attribute was not provided