Package software.amazon.awscdk.services.s3

Interface CfnBucket.ReplicationDestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.ReplicationDestinationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.ReplicationDestinationProperty
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 ReplicationDestinationProperty replicationDestinationProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.ReplicationDestinationProperty.Builder	A builder for CfnBucket.ReplicationDestinationProperty
static final class	CfnBucket.ReplicationDestinationProperty.Jsii$Proxy	An implementation for CfnBucket.ReplicationDestinationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.ReplicationDestinationProperty.Builder	builder()
default Object	getAccessControlTranslation()	Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket.
default String	getAccount()	Destination bucket owner account ID.
String	getBucket()	The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
default Object	getEncryptionConfiguration()	Specifies encryption-related information.
default Object	getMetrics()	A container specifying replication metrics-related settings enabling replication metrics and events.
default Object	getReplicationTime()	A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated.
default String	getStorageClass()	The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

getAccessControlTranslation

@Stability(Stable)
@Nullable
default Object getAccessControlTranslation()

Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket.

If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.

getAccount

@Stability(Stable)
@Nullable
default String getAccount()

Destination bucket owner account ID.

In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Cross-Region Replication Additional Configuration: Change Replica Owner in the Amazon S3 User Guide .

If you specify the AccessControlTranslation property, the Account property is required.

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

Specifies encryption-related information.

getMetrics

@Stability(Stable)
@Nullable
default Object getMetrics()

A container specifying replication metrics-related settings enabling replication metrics and events.

getReplicationTime

@Stability(Stable)
@Nullable
default Object getReplicationTime()

A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated.

Must be specified together with a Metrics block.

getStorageClass

@Stability(Stable)
@Nullable
default String getStorageClass()

The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.

By default, Amazon S3 uses the storage class of the source object to create the object replica.

For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference .

builder

@Stability(Stable)
static CfnBucket.ReplicationDestinationProperty.Builder builder()

Returns:

a CfnBucket.ReplicationDestinationProperty.Builder of CfnBucket.ReplicationDestinationProperty