aws-cdk-lib.aws_s3.CfnBucket.ReplicationConfigurationProperty

interface ReplicationConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.S3.CfnBucket.ReplicationConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnBucket_ReplicationConfigurationProperty
Javasoftware.amazon.awscdk.services.s3.CfnBucket.ReplicationConfigurationProperty
Pythonaws_cdk.aws_s3.CfnBucket.ReplicationConfigurationProperty
TypeScript aws-cdk-lib » aws_s3 » CfnBucket » ReplicationConfigurationProperty

A container for replication rules.

You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
const replicationConfigurationProperty: s3.CfnBucket.ReplicationConfigurationProperty = {
  role: 'role',
  rules: [{
    destination: {
      bucket: 'bucket',

      // the properties below are optional
      accessControlTranslation: {
        owner: 'owner',
      },
      account: 'account',
      encryptionConfiguration: {
        replicaKmsKeyId: 'replicaKmsKeyId',
      },
      metrics: {
        status: 'status',

        // the properties below are optional
        eventThreshold: {
          minutes: 123,
        },
      },
      replicationTime: {
        status: 'status',
        time: {
          minutes: 123,
        },
      },
      storageClass: 'storageClass',
    },
    status: 'status',

    // the properties below are optional
    deleteMarkerReplication: {
      status: 'status',
    },
    filter: {
      and: {
        prefix: 'prefix',
        tagFilters: [{
          key: 'key',
          value: 'value',
        }],
      },
      prefix: 'prefix',
      tagFilter: {
        key: 'key',
        value: 'value',
      },
    },
    id: 'id',
    prefix: 'prefix',
    priority: 123,
    sourceSelectionCriteria: {
      replicaModifications: {
        status: 'status',
      },
      sseKmsEncryptedObjects: {
        status: 'status',
      },
    },
  }],
};

Properties

NameTypeDescription
rolestringThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.
rulesIResolvable | IResolvable | ReplicationRuleProperty[]A container for one or more replication rules.

role

Type: string

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.

For more information, see How to Set Up Replication in the Amazon S3 User Guide .


rules

Type: IResolvable | IResolvable | ReplicationRuleProperty[]

A container for one or more replication rules.

A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.