Package software.amazon.awscdk.services.dynamodb

Class CfnTable.LocalSecondaryIndexProperty.Builder

java.lang.Object
software.amazon.awscdk.services.dynamodb.CfnTable.LocalSecondaryIndexProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTable.LocalSecondaryIndexProperty>
Enclosing interface:
CfnTable.LocalSecondaryIndexProperty
@Stability(Stable) public static final class CfnTable.LocalSecondaryIndexProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnTable.LocalSecondaryIndexProperty>
A builder for CfnTable.LocalSecondaryIndexProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • indexName

      @Stability(Stable) public CfnTable.LocalSecondaryIndexProperty.Builder indexName(String indexName)
      Sets the value of CfnTable.LocalSecondaryIndexProperty.getIndexName()
      Parameters:
      indexName - The name of the local secondary index. This parameter is required. The name must be unique among all other indexes on this table.
      Returns:
      this

    • keySchema

      @Stability(Stable) public CfnTable.LocalSecondaryIndexProperty.Builder keySchema(IResolvable keySchema)
      Sets the value of CfnTable.LocalSecondaryIndexProperty.getKeySchema()
      Parameters:
      keySchema - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute . This parameter is required. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

      Returns:
      this

    • keySchema

      @Stability(Stable) public CfnTable.LocalSecondaryIndexProperty.Builder keySchema(List<? extends Object> keySchema)
      Sets the value of CfnTable.LocalSecondaryIndexProperty.getKeySchema()
      Parameters:
      keySchema - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute . This parameter is required. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

      Returns:
      this

    • projection

      @Stability(Stable) public CfnTable.LocalSecondaryIndexProperty.Builder projection(IResolvable projection)
      Sets the value of CfnTable.LocalSecondaryIndexProperty.getProjection()
      Parameters:
      projection - Represents attributes that are copied (projected) from the table into the local secondary index. This parameter is required. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
      Returns:
      this

    • projection

      @Stability(Stable) public CfnTable.LocalSecondaryIndexProperty.Builder projection(CfnTable.ProjectionProperty projection)
      Sets the value of CfnTable.LocalSecondaryIndexProperty.getProjection()
      Parameters:
      projection - Represents attributes that are copied (projected) from the table into the local secondary index. This parameter is required. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTable.LocalSecondaryIndexProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTable.LocalSecondaryIndexProperty>
      Returns:
      a new instance of CfnTable.LocalSecondaryIndexProperty
      Throws:
      NullPointerException - if any required attribute was not provided