Interface CfnBucket.ReplicationRuleProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBucket.ReplicationRuleProperty.Jsii$Proxy
- Enclosing class:
CfnBucket
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.s3.*; ReplicationRuleProperty replicationRuleProperty = ReplicationRuleProperty.builder() .destination(ReplicationDestinationProperty.builder() .bucket("bucket") // the properties below are optional .accessControlTranslation(AccessControlTranslationProperty.builder() .owner("owner") .build()) .account("account") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .replicaKmsKeyId("replicaKmsKeyId") .build()) .metrics(MetricsProperty.builder() .status("status") // the properties below are optional .eventThreshold(ReplicationTimeValueProperty.builder() .minutes(123) .build()) .build()) .replicationTime(ReplicationTimeProperty.builder() .status("status") .time(ReplicationTimeValueProperty.builder() .minutes(123) .build()) .build()) .storageClass("storageClass") .build()) .status("status") // the properties below are optional .deleteMarkerReplication(DeleteMarkerReplicationProperty.builder() .status("status") .build()) .filter(ReplicationRuleFilterProperty.builder() .and(ReplicationRuleAndOperatorProperty.builder() .prefix("prefix") .tagFilters(List.of(TagFilterProperty.builder() .key("key") .value("value") .build())) .build()) .prefix("prefix") .tagFilter(TagFilterProperty.builder() .key("key") .value("value") .build()) .build()) .id("id") .prefix("prefix") .priority(123) .sourceSelectionCriteria(SourceSelectionCriteriaProperty.builder() .replicaModifications(ReplicaModificationsProperty.builder() .status("status") .build()) .sseKmsEncryptedObjects(SseKmsEncryptedObjectsProperty.builder() .status("status") .build()) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBucket.ReplicationRuleProperty
static final class
An implementation forCfnBucket.ReplicationRuleProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Specifies whether Amazon S3 replicates delete markers.A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).default Object
A filter that identifies the subset of objects to which the replication rule applies.default String
getId()
A unique identifier for the rule.default String
An object key name prefix that identifies the object or objects to which the rule applies.default Number
The priority indicates which rule has precedence whenever two or more replication rules conflict.default Object
A container that describes additional filters for identifying the source objects that you want to replicate.Specifies whether the rule is enabled.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDestination
A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).- See Also:
-
getStatus
Specifies whether the rule is enabled.- See Also:
-
getDeleteMarkerReplication
Specifies whether Amazon S3 replicates delete markers.If you specify a
Filter
in your replication configuration, you must also include aDeleteMarkerReplication
element. If yourFilter
includes aTag
element, theDeleteMarkerReplication
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 .
- See Also:
-
getFilter
A filter that identifies the subset of objects to which the replication rule applies.A
Filter
must specify exactly onePrefix
,TagFilter
, or anAnd
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 theRule
element.- See Also:
-
getId
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".
- See Also:
-
getPrefix
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 theRule
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 .
- See Also:
-
getPriority
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 .
- See Also:
-
getSourceSelectionCriteria
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.
- See Also:
-
builder
-