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());
 
  • Method Details

    • getContributorInsightsEnabled

      @Stability(Stable) @Nullable default Boolean getContributorInsightsEnabled()
      Whether CloudWatch contributor insights is enabled for the specified global secondary index.

      Default: false

    • 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