public static interface CfnBucket.ReplicationRuleProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnBucket.ReplicationRuleProperty.Builder
A builder for
CfnBucket.ReplicationRuleProperty |
static class |
CfnBucket.ReplicationRuleProperty.Jsii$Proxy
An implementation for
CfnBucket.ReplicationRuleProperty |
Modifier and Type | Method and Description |
---|---|
static CfnBucket.ReplicationRuleProperty.Builder |
builder() |
default java.lang.Object |
getDeleteMarkerReplication()
Specifies whether Amazon S3 replicates delete markers.
|
java.lang.Object |
getDestination()
A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
|
default java.lang.Object |
getFilter()
A filter that identifies the subset of objects to which the replication rule applies.
|
default java.lang.String |
getId()
A unique identifier for the rule.
|
default java.lang.String |
getPrefix()
An object key name prefix that identifies the object or objects to which the rule applies.
|
default java.lang.Number |
getPriority()
The priority indicates which rule has precedence whenever two or more replication rules conflict.
|
default java.lang.Object |
getSourceSelectionCriteria()
A container that describes additional filters for identifying the source objects that you want to replicate.
|
java.lang.String |
getStatus()
Specifies whether the rule is enabled.
|
java.lang.Object getDestination()
java.lang.String getStatus()
default java.lang.Object getDeleteMarkerReplication()
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 .
default java.lang.Object getFilter()
A Filter
must specify exactly one Prefix
, TagFilter
, or an And
child element. The use of the filter field indicates this is a V2 replication configuration. V1 does not have this field.
default java.lang.String getId()
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".
default java.lang.String getPrefix()
The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.
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 .
default java.lang.Number getPriority()
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 .
default java.lang.Object getSourceSelectionCriteria()
You can choose to enable or disable the replication of these objects.
static CfnBucket.ReplicationRuleProperty.Builder builder()