aws-cdk-lib.aws_dynamodb.CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty

interface ReplicaGlobalSecondaryIndexSpecificationProperty

LanguageType name
.NETAmazon.CDK.AWS.DynamoDB.CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnGlobalTable_ReplicaGlobalSecondaryIndexSpecificationProperty
Javasoftware.amazon.awscdk.services.dynamodb.CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty
Pythonaws_cdk.aws_dynamodb.CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty
TypeScript aws-cdk-lib » aws_dynamodb » CfnGlobalTable » ReplicaGlobalSecondaryIndexSpecificationProperty

Represents the properties of a global secondary index that can be set on a per-replica basis.

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 replicaGlobalSecondaryIndexSpecificationProperty: dynamodb.CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty = {
  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,
  },
};

Properties

NameTypeDescription
indexNamestringThe name of the global secondary index.
contributorInsightsSpecification?IResolvable | ContributorInsightsSpecificationPropertyUpdates the status for contributor insights for a specific table or index.
readProvisionedThroughputSettings?IResolvable | ReadProvisionedThroughputSettingsPropertyAllows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

indexName

Type: string

The name of the global secondary index.

The name must be unique among all other indexes on this table.


contributorInsightsSpecification?

Type: IResolvable | ContributorInsightsSpecificationProperty (optional)

Updates the status for contributor insights for a specific table or index.

CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.


readProvisionedThroughputSettings?

Type: IResolvable | ReadProvisionedThroughputSettingsProperty (optional)

Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .