interface ReplicaSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DynamoDB.CfnGlobalTable.ReplicaSpecificationProperty`
Java	`software.amazon.awscdk.services.dynamodb.CfnGlobalTable.ReplicaSpecificationProperty`
Python	`aws_cdk.aws_dynamodb.CfnGlobalTable.ReplicaSpecificationProperty`
TypeScript	`@aws-cdk/aws-dynamodb` » `CfnGlobalTable` » `ReplicaSpecificationProperty`

Defines settings specific to a single replica of a global table.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as dynamodb from '@aws-cdk/aws-dynamodb';
const replicaSpecificationProperty: dynamodb.CfnGlobalTable.ReplicaSpecificationProperty = {
  region: 'region',

  // the properties below are optional
  contributorInsightsSpecification: {
    enabled: false,
  },
  deletionProtectionEnabled: false,
  globalSecondaryIndexes: [{
    indexName: 'indexName',

    // the properties below are optional
    contributorInsightsSpecification: {
      enabled: false,
    },
    readProvisionedThroughputSettings: {
      readCapacityAutoScalingSettings: {
        maxCapacity: 123,
        minCapacity: 123,
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 123,

          // the properties below are optional
          disableScaleIn: false,
          scaleInCooldown: 123,
          scaleOutCooldown: 123,
        },

        // the properties below are optional
        seedCapacity: 123,
      },
      readCapacityUnits: 123,
    },
  }],
  kinesisStreamSpecification: {
    streamArn: 'streamArn',
  },
  pointInTimeRecoverySpecification: {
    pointInTimeRecoveryEnabled: false,
  },
  readProvisionedThroughputSettings: {
    readCapacityAutoScalingSettings: {
      maxCapacity: 123,
      minCapacity: 123,
      targetTrackingScalingPolicyConfiguration: {
        targetValue: 123,

        // the properties below are optional
        disableScaleIn: false,
        scaleInCooldown: 123,
        scaleOutCooldown: 123,
      },

      // the properties below are optional
      seedCapacity: 123,
    },
    readCapacityUnits: 123,
  },
  sseSpecification: {
    kmsMasterKeyId: 'kmsMasterKeyId',
  },
  tableClass: 'tableClass',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
region	`string`	The region in which this replica exists.
contributorInsightsSpecification?	`IResolvable` `\|` `ContributorInsightsSpecificationProperty`	The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.
deletionProtectionEnabled?	`boolean \|` `IResolvable`	Determines if a replica is protected from deletion.
globalSecondaryIndexes?	`IResolvable` `\|` `IResolvable` `\|` `ReplicaGlobalSecondaryIndexSpecificationProperty[]`	Defines additional settings for the global secondary indexes of this replica.
kinesisStreamSpecification?	`IResolvable` `\|` `KinesisStreamSpecificationProperty`	Defines the Kinesis Data Streams configuration for the specified replica.
pointInTimeRecoverySpecification?	`IResolvable` `\|` `PointInTimeRecoverySpecificationProperty`	The settings used to enable point in time recovery.
readProvisionedThroughputSettings?	`IResolvable` `\|` `ReadProvisionedThroughputSettingsProperty`	Defines read capacity settings for the replica table.
sseSpecification?	`IResolvable` `\|` `ReplicaSSESpecificationProperty`	Allows you to specify a customer-managed key for the replica.
tableClass?	`string`	The table class of the specified table.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this replica.

region

Type: string

The region in which this replica exists.

contributorInsightsSpecification?

Type: IResolvable | ContributorInsightsSpecificationProperty (optional)

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.

When not specified, defaults to contributor insights disabled for the replica.

deletionProtectionEnabled?

Type: boolean | IResolvable (optional)

Determines if a replica is protected from deletion.

When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Amazon DynamoDB Developer Guide .