Package software.amazon.awscdk.services.dynamodb

Interface GlobalSecondaryIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SchemaOptions, SecondaryIndexProps

All Known Implementing Classes:

GlobalSecondaryIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:51:55.644Z")
@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())
         .contributorInsightsSpecification(ContributorInsightsSpecification.builder() // for a table
                 .enabled(true)
                 .mode(ContributorInsightsMode.THROTTLED_KEYS).build())
         .build();
 table.addGlobalSecondaryIndex(GlobalSecondaryIndexProps.builder()
         .contributorInsightsSpecification(ContributorInsightsSpecification.builder() // for a specific global secondary index
                 .enabled(true).build())
         .indexName("gsi")
         .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GlobalSecondaryIndexProps.Builder	A builder for GlobalSecondaryIndexProps
static final class	GlobalSecondaryIndexProps.Jsii$Proxy	An implementation for GlobalSecondaryIndexProps

Method Summary

Modifier and Type	Method	Description
static GlobalSecondaryIndexProps.Builder	builder()
default Boolean	getContributorInsightsEnabled()	Deprecated. use contributorInsightsSpecification instead
default ContributorInsightsSpecification	getContributorInsightsSpecification()	Whether CloudWatch contributor insights is enabled and what mode is selected.
default Number	getMaxReadRequestUnits()	The maximum read request units for the global secondary index.
default Number	getMaxWriteRequestUnits()	The maximum write request units for the global secondary index.
default Number	getReadCapacity()	The read capacity for the global secondary index.
default WarmThroughput	getWarmThroughput()	The warm throughput configuration for the global secondary index.
default Number	getWriteCapacity()	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

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getContributorInsightsEnabled()

Deprecated.

use contributorInsightsSpecification instead

(deprecated) Whether CloudWatch contributor insights is enabled for the specified global secondary index.

Default: false

getContributorInsightsSpecification

@Stability(Stable)
@Nullable
default ContributorInsightsSpecification getContributorInsightsSpecification()

Whether CloudWatch contributor insights is enabled and what mode is selected.

Default: - contributor insights is not enabled

getMaxReadRequestUnits

@Stability(Stable)
@Nullable
default Number 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

@Stability(Stable)
@Nullable
default Number 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

@Stability(Stable)
@Nullable
default Number getReadCapacity()

The read capacity for the global secondary index.

Can only be provided if table billingMode is Provisioned or undefined.

Default: 5

getWarmThroughput

@Stability(Stable)
@Nullable
default WarmThroughput getWarmThroughput()

The warm throughput configuration for the global secondary index.

Default: - no warm throughput is configured

getWriteCapacity

@Stability(Stable)
@Nullable
default Number getWriteCapacity()

The write capacity for the global secondary index.

Can only be provided if table billingMode is Provisioned or undefined.

Default: 5

builder

@Stability(Stable)
static GlobalSecondaryIndexProps.Builder builder()

Returns:

a GlobalSecondaryIndexProps.Builder of GlobalSecondaryIndexProps