interface ReplicaGlobalSecondaryIndexSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.DynamoDB.Mixins.CfnGlobalTablePropsMixin.ReplicaGlobalSecondaryIndexSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdynamodb/mixins#CfnGlobalTablePropsMixin_ReplicaGlobalSecondaryIndexSpecificationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.dynamodb.mixins.CfnGlobalTablePropsMixin.ReplicaGlobalSecondaryIndexSpecificationProperty`
Python	`aws_cdk.mixins_preview.aws_dynamodb.mixins.CfnGlobalTablePropsMixin.ReplicaGlobalSecondaryIndexSpecificationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_dynamodb` » `mixins` » `CfnGlobalTablePropsMixin` » `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 { mixins as dynamodb_mixins } from '@aws-cdk/mixins-preview/aws-dynamodb';
const replicaGlobalSecondaryIndexSpecificationProperty: dynamodb_mixins.CfnGlobalTablePropsMixin.ReplicaGlobalSecondaryIndexSpecificationProperty = {
  contributorInsightsSpecification: {
    enabled: false,
    mode: 'mode',
  },
  indexName: 'indexName',
  readOnDemandThroughputSettings: {
    maxReadRequestUnits: 123,
  },
  readProvisionedThroughputSettings: {
    readCapacityAutoScalingSettings: {
      maxCapacity: 123,
      minCapacity: 123,
      seedCapacity: 123,
      targetTrackingScalingPolicyConfiguration: {
        disableScaleIn: false,
        scaleInCooldown: 123,
        scaleOutCooldown: 123,
        targetValue: 123,
      },
    },
    readCapacityUnits: 123,
  },
};

Properties

Name	Type	Description
contributorInsightsSpecification?	`IResolvable` `\|` `ContributorInsightsSpecificationProperty`	Updates the status for contributor insights for a specific table or index.
indexName?	`string`	The name of the global secondary index.
readOnDemandThroughputSettings?	`IResolvable` `\|` `ReadOnDemandThroughputSettingsProperty`	Sets the read request settings for a replica global secondary index.
readProvisionedThroughputSettings?	`IResolvable` `\|` `ReadProvisionedThroughputSettingsProperty`	Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED` .

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.

indexName?

Type: string (optional)

The name of the global secondary index.

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

readOnDemandThroughputSettings?

Type: IResolvable | ReadOnDemandThroughputSettingsProperty (optional)

Sets the read request settings for a replica global secondary index.

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

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 .

AWS CDK

2.233.0