Interface GlobalSecondaryIndex.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>, SdkBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>, SdkPojo
Enclosing class:
GlobalSecondaryIndex
@Mutable @NotThreadSafe public static interface GlobalSecondaryIndex.Builder extends SdkPojo, CopyableBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>

  • Method Details

    • indexName

      GlobalSecondaryIndex.Builder indexName(String indexName)

      The name of the global secondary index. The name must be unique among all other indexes on this table.

      Parameters:
      indexName - The name of the global secondary index. The name must be unique among all other indexes on this table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keySchema

      GlobalSecondaryIndex.Builder keySchema(Collection<KeySchemaElement> keySchema)

      The complete key schema for a global secondary index, which consists 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. 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.

      Parameters:
      keySchema - The complete key schema for a global secondary index, which consists 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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • keySchema

      GlobalSecondaryIndex.Builder keySchema(KeySchemaElement... keySchema)

      The complete key schema for a global secondary index, which consists 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. 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.

      Parameters:
      keySchema - The complete key schema for a global secondary index, which consists 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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • keySchema

      GlobalSecondaryIndex.Builder keySchema(Consumer<KeySchemaElement.Builder>... keySchema)

      The complete key schema for a global secondary index, which consists 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. 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.

      This is a convenience method that creates an instance of the KeySchemaElement.Builder avoiding the need to create one manually via KeySchemaElement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to keySchema(List<KeySchemaElement>).

      Parameters:
      keySchema - a consumer that will call methods on KeySchemaElement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • projection

      GlobalSecondaryIndex.Builder projection(Projection projection)

      Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

      Parameters:
      projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projection

      default GlobalSecondaryIndex.Builder projection(Consumer<Projection.Builder> projection)

      Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

      This is a convenience method that creates an instance of the Projection.Builder avoiding the need to create one manually via Projection.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to projection(Projection).

      Parameters:
      projection - a consumer that will call methods on Projection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisionedThroughput

      GlobalSecondaryIndex.Builder provisionedThroughput(ProvisionedThroughput provisionedThroughput)

      Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

      Parameters:
      provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • provisionedThroughput

      default GlobalSecondaryIndex.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput)

      Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

      This is a convenience method that creates an instance of the ProvisionedThroughput.Builder avoiding the need to create one manually via ProvisionedThroughput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisionedThroughput(ProvisionedThroughput).

      Parameters:
      provisionedThroughput - a consumer that will call methods on ProvisionedThroughput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onDemandThroughput

      GlobalSecondaryIndex.Builder onDemandThroughput(OnDemandThroughput onDemandThroughput)

      The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

      Parameters:
      onDemandThroughput - The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onDemandThroughput

      default GlobalSecondaryIndex.Builder onDemandThroughput(Consumer<OnDemandThroughput.Builder> onDemandThroughput)

      The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

      This is a convenience method that creates an instance of the OnDemandThroughput.Builder avoiding the need to create one manually via OnDemandThroughput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onDemandThroughput(OnDemandThroughput).

      Parameters:
      onDemandThroughput - a consumer that will call methods on OnDemandThroughput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • warmThroughput

      GlobalSecondaryIndex.Builder warmThroughput(WarmThroughput warmThroughput)

      Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

      Parameters:
      warmThroughput - Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond , WriteUnitsPerSecond, or both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • warmThroughput

      default GlobalSecondaryIndex.Builder warmThroughput(Consumer<WarmThroughput.Builder> warmThroughput)

      Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

      This is a convenience method that creates an instance of the WarmThroughput.Builder avoiding the need to create one manually via WarmThroughput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warmThroughput(WarmThroughput).

      Parameters:
      warmThroughput - a consumer that will call methods on WarmThroughput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: