Class CfnGlobalTable.LocalSecondaryIndexProperty.Builder
java.lang.Object
software.amazon.awscdk.services.dynamodb.CfnGlobalTable.LocalSecondaryIndexProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGlobalTable.LocalSecondaryIndexProperty>
- Enclosing interface:
CfnGlobalTable.LocalSecondaryIndexProperty
@Stability(Stable)
public static final class CfnGlobalTable.LocalSecondaryIndexProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGlobalTable.LocalSecondaryIndexProperty>
A builder for
CfnGlobalTable.LocalSecondaryIndexProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofCfnGlobalTable.LocalSecondaryIndexProperty.getIndexName()
Sets the value ofCfnGlobalTable.LocalSecondaryIndexProperty.getKeySchema()
keySchema
(IResolvable keySchema) Sets the value ofCfnGlobalTable.LocalSecondaryIndexProperty.getKeySchema()
projection
(IResolvable projection) Sets the value ofCfnGlobalTable.LocalSecondaryIndexProperty.getProjection()
projection
(CfnGlobalTable.ProjectionProperty projection) Sets the value ofCfnGlobalTable.LocalSecondaryIndexProperty.getProjection()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
indexName
@Stability(Stable) public CfnGlobalTable.LocalSecondaryIndexProperty.Builder indexName(String indexName) Sets the value ofCfnGlobalTable.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 CfnGlobalTable.LocalSecondaryIndexProperty.Builder keySchema(IResolvable keySchema) Sets the value ofCfnGlobalTable.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 CfnGlobalTable.LocalSecondaryIndexProperty.Builder keySchema(List<? extends Object> keySchema) Sets the value ofCfnGlobalTable.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 CfnGlobalTable.LocalSecondaryIndexProperty.Builder projection(IResolvable projection) Sets the value ofCfnGlobalTable.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 CfnGlobalTable.LocalSecondaryIndexProperty.Builder projection(CfnGlobalTable.ProjectionProperty projection) Sets the value ofCfnGlobalTable.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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnGlobalTable.LocalSecondaryIndexProperty>
- Returns:
- a new instance of
CfnGlobalTable.LocalSecondaryIndexProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-