Interface GlobalSecondaryIndexProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,SchemaOptions
,SecondaryIndexProps
- All Known Implementing Classes:
GlobalSecondaryIndexProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:01.128Z")
@Stability(Stable)
public interface GlobalSecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable, SecondaryIndexProps, SchemaOptions
Properties for a global secondary index.
Example:
Table table = Table.Builder.create(this, "Table") .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build()) .contributorInsightsEnabled(true) .build(); table.addGlobalSecondaryIndex(GlobalSecondaryIndexProps.builder() .contributorInsightsEnabled(true) // for a specific global secondary index .indexName("gsi") .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build()) .build());
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forGlobalSecondaryIndexProps
static final class
An implementation forGlobalSecondaryIndexProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Boolean
Whether CloudWatch contributor insights is enabled for the specified global secondary index.default Number
The maximum read request units for the global secondary index.default Number
The maximum write request units for the global secondary index.default Number
The read capacity for the global secondary index.default WarmThroughput
The warm throughput configuration for the global secondary index.default Number
The write capacity for the global secondary index.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.dynamodb.SchemaOptions
getPartitionKey, getSortKey
Methods inherited from interface software.amazon.awscdk.services.dynamodb.SecondaryIndexProps
getIndexName, getNonKeyAttributes, getProjectionType
-
Method Details
-
getContributorInsightsEnabled
Whether CloudWatch contributor insights is enabled for the specified global secondary index.Default: false
-
getMaxReadRequestUnits
The maximum read request units for the global secondary index.Can only be provided if table billingMode is PAY_PER_REQUEST.
Default: - on-demand throughput is disabled
-
getMaxWriteRequestUnits
The maximum write request units for the global secondary index.Can only be provided if table billingMode is PAY_PER_REQUEST.
Default: - on-demand throughput is disabled
-
getReadCapacity
The read capacity for the global secondary index.Can only be provided if table billingMode is Provisioned or undefined.
Default: 5
-
getWarmThroughput
The warm throughput configuration for the global secondary index.Default: - no warm throughput is configured
-
getWriteCapacity
The write capacity for the global secondary index.Can only be provided if table billingMode is Provisioned or undefined.
Default: 5
-
builder
- Returns:
- a
GlobalSecondaryIndexProps.Builder
ofGlobalSecondaryIndexProps
-