Interface CfnBucket.IReplicationDestinationProperty

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

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IReplicationDestinationProperty

Syntax (vb)

Public Interface IReplicationDestinationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;

var replicationDestinationProperty = new ReplicationDestinationProperty {
    Bucket = "bucket",

    // the properties below are optional
    AccessControlTranslation = new AccessControlTranslationProperty {
        Owner = "owner"
    },
    Account = "account",
    EncryptionConfiguration = new EncryptionConfigurationProperty {
        ReplicaKmsKeyId = "replicaKmsKeyId"
    },
    Metrics = new MetricsProperty {
        Status = "status",

        // the properties below are optional
        EventThreshold = new ReplicationTimeValueProperty {
            Minutes = 123
        }
    },
    ReplicationTime = new ReplicationTimeProperty {
        Status = "status",
        Time = new ReplicationTimeValueProperty {
            Minutes = 123
        }
    },
    StorageClass = "storageClass"
};

Synopsis

Properties

AccessControlTranslation	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.
Account	Destination bucket owner account ID.
Bucket	The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
EncryptionConfiguration	Specifies encryption-related information.
Metrics	A container specifying replication metrics-related settings enabling replication metrics and events.
ReplicationTime	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.
StorageClass	The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.

Properties

AccessControlTranslation

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.

virtual object AccessControlTranslation { get; }

Property Value

System.Object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-accesscontroltranslation

Account

Destination bucket owner account ID.

virtual string Account { get; }

Property Value

System.String

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-account

Bucket

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

string Bucket { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-bucket

EncryptionConfiguration

Specifies encryption-related information.

virtual object EncryptionConfiguration { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-encryptionconfiguration

Metrics

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

virtual object Metrics { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-metrics

ReplicationTime

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.

virtual object ReplicationTime { get; }

Property Value

System.Object

Remarks

Must be specified together with a Metrics block.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-replicationtime

StorageClass

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

virtual string StorageClass { get; }

Property Value

System.String

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationdestination.html#cfn-s3-bucket-replicationdestination-storageclass