@Generated(value="software.amazon.awssdk:codegen") public final class CreateTableRequest extends DynamoDbRequest implements ToCopyableBuilder<CreateTableRequest.Builder,CreateTableRequest>
Represents the input of a CreateTable
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateTableRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<AttributeDefinition> |
attributeDefinitions()
An array of attributes that describe the key schema for the table and indexes.
|
BillingMode |
billingMode()
Controls how you are charged for read and write throughput and how you manage capacity.
|
String |
billingModeAsString()
Controls how you are charged for read and write throughput and how you manage capacity.
|
static CreateTableRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
List<GlobalSecondaryIndex> |
globalSecondaryIndexes()
One or more global secondary indexes (the maximum is 20) to be created on the table.
|
int |
hashCode() |
List<KeySchemaElement> |
keySchema()
Specifies the attributes that make up the primary key for a table or an index.
|
List<LocalSecondaryIndex> |
localSecondaryIndexes()
One or more local secondary indexes (the maximum is 5) to be created on the table.
|
ProvisionedThroughput |
provisionedThroughput()
Represents the provisioned throughput settings for a specified table or index.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateTableRequest.Builder> |
serializableBuilderClass() |
SSESpecification |
sseSpecification()
Represents the settings used to enable server-side encryption.
|
StreamSpecification |
streamSpecification()
The settings for DynamoDB Streams on the table.
|
String |
tableName()
The name of the table to create.
|
List<Tag> |
tags()
A list of key-value pairs to label the table.
|
CreateTableRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public List<AttributeDefinition> attributeDefinitions()
An array of attributes that describe the key schema for the table and indexes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String tableName()
The name of the table to create.
public List<KeySchemaElement> keySchema()
Specifies the attributes that make up the primary key for a table or an index. The attributes in
KeySchema
must also be defined in the AttributeDefinitions
array. For more information,
see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.
KeyType
- The role that the key attribute will assume:
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 the DynamoDB 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.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of
HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:
The first element must have a KeyType
of HASH
, and the second element must have a
KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
KeySchema
must also be defined in the AttributeDefinitions
array. For more
information, see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.
KeyType
- The role that the key attribute will assume:
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 the DynamoDB 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.
For a simple primary key (partition key), you must provide exactly one element with a
KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
public List<LocalSecondaryIndex> localSecondaryIndexes()
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must
begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
public List<GlobalSecondaryIndex> globalSecondaryIndexes()
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
public BillingMode billingMode()
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED
- Sets the billing mode to PROVISIONED
. We recommend using
PROVISIONED
for predictable workloads.
PAY_PER_REQUEST
- Sets the billing mode to PAY_PER_REQUEST
. We recommend using
PAY_PER_REQUEST
for unpredictable workloads.
If the service returns an enum value that is not available in the current SDK version, billingMode
will
return BillingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
billingModeAsString()
.
PROVISIONED
- Sets the billing mode to PROVISIONED
. We recommend using
PROVISIONED
for predictable workloads.
PAY_PER_REQUEST
- Sets the billing mode to PAY_PER_REQUEST
. We recommend using
PAY_PER_REQUEST
for unpredictable workloads.
BillingMode
public String billingModeAsString()
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED
- Sets the billing mode to PROVISIONED
. We recommend using
PROVISIONED
for predictable workloads.
PAY_PER_REQUEST
- Sets the billing mode to PAY_PER_REQUEST
. We recommend using
PAY_PER_REQUEST
for unpredictable workloads.
If the service returns an enum value that is not available in the current SDK version, billingMode
will
return BillingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
billingModeAsString()
.
PROVISIONED
- Sets the billing mode to PROVISIONED
. We recommend using
PROVISIONED
for predictable workloads.
PAY_PER_REQUEST
- Sets the billing mode to PAY_PER_REQUEST
. We recommend using
PAY_PER_REQUEST
for unpredictable workloads.
BillingMode
public ProvisionedThroughput provisionedThroughput()
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using
the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode as
PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set
BillingMode as PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
public StreamSpecification streamSpecification()
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what
information is written to the table's stream. Valid values for StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled
(false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what information is written to the table's stream. Valid values for
StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the
stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the
stream.
public SSESpecification sseSpecification()
Represents the settings used to enable server-side encryption.
public List<Tag> tags()
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreateTableRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateTableRequest.Builder,CreateTableRequest>
toBuilder
in class DynamoDbRequest
public static CreateTableRequest.Builder builder()
public static Class<? extends CreateTableRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2019. All rights reserved.