aws-cdk-lib.aws_dynamodb.CfnGlobalTable.ReplicaSpecificationProperty

interface ReplicaSpecificationProperty

LanguageType name
.NETAmazon.CDK.AWS.DynamoDB.CfnGlobalTable.ReplicaSpecificationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnGlobalTable_ReplicaSpecificationProperty
Javasoftware.amazon.awscdk.services.dynamodb.CfnGlobalTable.ReplicaSpecificationProperty
Pythonaws_cdk.aws_dynamodb.CfnGlobalTable.ReplicaSpecificationProperty
TypeScript aws-cdk-lib » 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 { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
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

NameTypeDescription
regionstringThe region in which this replica exists.
contributorInsightsSpecification?IResolvable | ContributorInsightsSpecificationPropertyThe settings used to enable or disable CloudWatch Contributor Insights for the specified replica.
deletionProtectionEnabled?boolean | IResolvableDetermines if a replica is protected from deletion.
globalSecondaryIndexes?IResolvable | IResolvable | ReplicaGlobalSecondaryIndexSpecificationProperty[]Defines additional settings for the global secondary indexes of this replica.
kinesisStreamSpecification?IResolvable | KinesisStreamSpecificationPropertyDefines the Kinesis Data Streams configuration for the specified replica.
pointInTimeRecoverySpecification?IResolvable | PointInTimeRecoverySpecificationPropertyThe settings used to enable point in time recovery.
readProvisionedThroughputSettings?IResolvable | ReadProvisionedThroughputSettingsPropertyDefines read capacity settings for the replica table.
sseSpecification?IResolvable | ReplicaSSESpecificationPropertyAllows you to specify a customer-managed key for the replica.
tableClass?stringThe 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 .


globalSecondaryIndexes?

Type: IResolvable | IResolvable | ReplicaGlobalSecondaryIndexSpecificationProperty[] (optional)

Defines additional settings for the global secondary indexes of this replica.


kinesisStreamSpecification?

Type: IResolvable | KinesisStreamSpecificationProperty (optional)

Defines the Kinesis Data Streams configuration for the specified replica.


pointInTimeRecoverySpecification?

Type: IResolvable | PointInTimeRecoverySpecificationProperty (optional)

The settings used to enable point in time recovery.

When not specified, defaults to point in time recovery disabled for the replica.


readProvisionedThroughputSettings?

Type: IResolvable | ReadProvisionedThroughputSettingsProperty (optional)

Defines read capacity settings for the replica table.


sseSpecification?

Type: IResolvable | ReplicaSSESpecificationProperty (optional)

Allows you to specify a customer-managed key for the replica.

When using customer-managed keys for server-side encryption, this property must have a value in all replicas.


tableClass?

Type: string (optional)

The table class of the specified table.

Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .


tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this replica.

For more information, see Tag .