Interface TableDescription.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<TableDescription.Builder,TableDescription>
,SdkBuilder<TableDescription.Builder,TableDescription>
,SdkPojo
- Enclosing class:
- TableDescription
public static interface TableDescription.Builder extends SdkPojo, CopyableBuilder<TableDescription.Builder,TableDescription>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default TableDescription.Builder
archivalSummary(Consumer<ArchivalSummary.Builder> archivalSummary)
Contains information about the table archive.TableDescription.Builder
archivalSummary(ArchivalSummary archivalSummary)
Contains information about the table archive.TableDescription.Builder
attributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array ofAttributeDefinition
objects.TableDescription.Builder
attributeDefinitions(Consumer<AttributeDefinition.Builder>... attributeDefinitions)
An array ofAttributeDefinition
objects.TableDescription.Builder
attributeDefinitions(AttributeDefinition... attributeDefinitions)
An array ofAttributeDefinition
objects.default TableDescription.Builder
billingModeSummary(Consumer<BillingModeSummary.Builder> billingModeSummary)
Contains the details for the read/write capacity mode.TableDescription.Builder
billingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.TableDescription.Builder
creationDateTime(Instant creationDateTime)
The date and time when the table was created, in UNIX epoch time format.TableDescription.Builder
deletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.TableDescription.Builder
globalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table.TableDescription.Builder
globalSecondaryIndexes(Consumer<GlobalSecondaryIndexDescription.Builder>... globalSecondaryIndexes)
The global secondary indexes, if any, on the table.TableDescription.Builder
globalSecondaryIndexes(GlobalSecondaryIndexDescription... globalSecondaryIndexes)
The global secondary indexes, if any, on the table.TableDescription.Builder
globalTableVersion(String globalTableVersion)
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.TableDescription.Builder
itemCount(Long itemCount)
The number of items in the specified table.TableDescription.Builder
keySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table.TableDescription.Builder
keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
The primary key structure for the table.TableDescription.Builder
keySchema(KeySchemaElement... keySchema)
The primary key structure for the table.TableDescription.Builder
latestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.TableDescription.Builder
latestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.TableDescription.Builder
localSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table.TableDescription.Builder
localSecondaryIndexes(Consumer<LocalSecondaryIndexDescription.Builder>... localSecondaryIndexes)
Represents one or more local secondary indexes on the table.TableDescription.Builder
localSecondaryIndexes(LocalSecondaryIndexDescription... localSecondaryIndexes)
Represents one or more local secondary indexes on the table.default TableDescription.Builder
provisionedThroughput(Consumer<ProvisionedThroughputDescription.Builder> provisionedThroughput)
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.TableDescription.Builder
provisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.TableDescription.Builder
replicas(Collection<ReplicaDescription> replicas)
Represents replicas of the table.TableDescription.Builder
replicas(Consumer<ReplicaDescription.Builder>... replicas)
Represents replicas of the table.TableDescription.Builder
replicas(ReplicaDescription... replicas)
Represents replicas of the table.default TableDescription.Builder
restoreSummary(Consumer<RestoreSummary.Builder> restoreSummary)
Contains details for the restore.TableDescription.Builder
restoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.default TableDescription.Builder
sseDescription(Consumer<SSEDescription.Builder> sseDescription)
The description of the server-side encryption status on the specified table.TableDescription.Builder
sseDescription(SSEDescription sseDescription)
The description of the server-side encryption status on the specified table.default TableDescription.Builder
streamSpecification(Consumer<StreamSpecification.Builder> streamSpecification)
The current DynamoDB Streams configuration for the table.TableDescription.Builder
streamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.TableDescription.Builder
tableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.default TableDescription.Builder
tableClassSummary(Consumer<TableClassSummary.Builder> tableClassSummary)
Contains details of the table class.TableDescription.Builder
tableClassSummary(TableClassSummary tableClassSummary)
Contains details of the table class.TableDescription.Builder
tableId(String tableId)
Unique identifier for the table for which the backup was created.TableDescription.Builder
tableName(String tableName)
The name of the table.TableDescription.Builder
tableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes.TableDescription.Builder
tableStatus(String tableStatus)
The current state of the table:TableDescription.Builder
tableStatus(TableStatus tableStatus)
The current state of the table:-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
attributeDefinitions
TableDescription.Builder attributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of
AttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.Each
AttributeDefinition
object in this array is composed of:-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
- Parameters:
attributeDefinitions
- An array ofAttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.Each
AttributeDefinition
object in this array is composed of:-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
attributeDefinitions
TableDescription.Builder attributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of
AttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.Each
AttributeDefinition
object in this array is composed of:-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
- Parameters:
attributeDefinitions
- An array ofAttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.Each
AttributeDefinition
object in this array is composed of:-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
attributeDefinitions
TableDescription.Builder attributeDefinitions(Consumer<AttributeDefinition.Builder>... attributeDefinitions)
An array of
AttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.Each
AttributeDefinition
object in this array is composed of:-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
AttributeDefinition.Builder
avoiding the need to create one manually viaAttributeDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#attributeDefinitions(List
.) - Parameters:
attributeDefinitions
- a consumer that will call methods onAttributeDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#attributeDefinitions(java.util.Collection
)
-
-
tableName
TableDescription.Builder tableName(String tableName)
The name of the table.
- Parameters:
tableName
- The name of the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keySchema
TableDescription.Builder keySchema(Collection<KeySchemaElement> keySchema)
The primary key structure for the table. Each
KeySchemaElement
consists of:-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
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.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
- Parameters:
keySchema
- The primary key structure for the table. EachKeySchemaElement
consists of:-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
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.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
keySchema
TableDescription.Builder keySchema(KeySchemaElement... keySchema)
The primary key structure for the table. Each
KeySchemaElement
consists of:-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
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.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
- Parameters:
keySchema
- The primary key structure for the table. EachKeySchemaElement
consists of:-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
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.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
keySchema
TableDescription.Builder keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
The primary key structure for the table. Each
KeySchemaElement
consists of:-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
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.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
This is a convenience method that creates an instance of theKeySchemaElement.Builder
avoiding the need to create one manually viaKeySchemaElement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#keySchema(List
.) - Parameters:
keySchema
- a consumer that will call methods onKeySchemaElement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#keySchema(java.util.Collection
)
-
-
tableStatus
TableDescription.Builder tableStatus(String tableStatus)
The current state of the table:
-
CREATING
- The table is being created. -
UPDATING
- The table/index configuration is being updated. The table/index remains available for data operations whenUPDATING
. -
DELETING
- The table is being deleted. -
ACTIVE
- The table is ready for use. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. -
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete. -
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
- Parameters:
tableStatus
- The current state of the table:-
CREATING
- The table is being created. -
UPDATING
- The table/index configuration is being updated. The table/index remains available for data operations whenUPDATING
. -
DELETING
- The table is being deleted. -
ACTIVE
- The table is ready for use. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. -
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete. -
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TableStatus
,TableStatus
-
-
tableStatus
TableDescription.Builder tableStatus(TableStatus tableStatus)
The current state of the table:
-
CREATING
- The table is being created. -
UPDATING
- The table/index configuration is being updated. The table/index remains available for data operations whenUPDATING
. -
DELETING
- The table is being deleted. -
ACTIVE
- The table is ready for use. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. -
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete. -
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
- Parameters:
tableStatus
- The current state of the table:-
CREATING
- The table is being created. -
UPDATING
- The table/index configuration is being updated. The table/index remains available for data operations whenUPDATING
. -
DELETING
- The table is being deleted. -
ACTIVE
- The table is ready for use. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. -
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete. -
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TableStatus
,TableStatus
-
-
creationDateTime
TableDescription.Builder creationDateTime(Instant creationDateTime)
The date and time when the table was created, in UNIX epoch time format.
- Parameters:
creationDateTime
- The date and time when the table was created, in UNIX epoch time format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedThroughput
TableDescription.Builder provisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
- Parameters:
provisionedThroughput
- The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedThroughput
default TableDescription.Builder provisionedThroughput(Consumer<ProvisionedThroughputDescription.Builder> provisionedThroughput)
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
This is a convenience method that creates an instance of theProvisionedThroughputDescription.Builder
avoiding the need to create one manually viaProvisionedThroughputDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedThroughput(ProvisionedThroughputDescription)
.- Parameters:
provisionedThroughput
- a consumer that will call methods onProvisionedThroughputDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
provisionedThroughput(ProvisionedThroughputDescription)
-
tableSizeBytes
TableDescription.Builder tableSizeBytes(Long tableSizeBytes)
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
- Parameters:
tableSizeBytes
- The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
itemCount
TableDescription.Builder itemCount(Long itemCount)
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
- Parameters:
itemCount
- The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tableArn
TableDescription.Builder tableArn(String tableArn)
The Amazon Resource Name (ARN) that uniquely identifies the table.
- Parameters:
tableArn
- The Amazon Resource Name (ARN) that uniquely identifies the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tableId
TableDescription.Builder tableId(String tableId)
Unique identifier for the table for which the backup was created.
- Parameters:
tableId
- Unique identifier for the table for which the backup was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
billingModeSummary
TableDescription.Builder billingModeSummary(BillingModeSummary billingModeSummary)
Contains the details for the read/write capacity mode.
- Parameters:
billingModeSummary
- Contains the details for the read/write capacity mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
billingModeSummary
default TableDescription.Builder billingModeSummary(Consumer<BillingModeSummary.Builder> billingModeSummary)
Contains the details for the read/write capacity mode.
This is a convenience method that creates an instance of theBillingModeSummary.Builder
avoiding the need to create one manually viaBillingModeSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobillingModeSummary(BillingModeSummary)
.- Parameters:
billingModeSummary
- a consumer that will call methods onBillingModeSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
billingModeSummary(BillingModeSummary)
-
localSecondaryIndexes
TableDescription.Builder localSecondaryIndexes(Collection<LocalSecondaryIndexDescription> localSecondaryIndexes)
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.- Parameters:
localSecondaryIndexes
- Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
localSecondaryIndexes
TableDescription.Builder localSecondaryIndexes(LocalSecondaryIndexDescription... localSecondaryIndexes)
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.- Parameters:
localSecondaryIndexes
- Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
localSecondaryIndexes
TableDescription.Builder localSecondaryIndexes(Consumer<LocalSecondaryIndexDescription.Builder>... localSecondaryIndexes)
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
This is a convenience method that creates an instance of theDELETING
state, no information about indexes will be returned.LocalSecondaryIndexDescription.Builder
avoiding the need to create one manually viaLocalSecondaryIndexDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#localSecondaryIndexes(List
.) - Parameters:
localSecondaryIndexes
- a consumer that will call methods onLocalSecondaryIndexDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#localSecondaryIndexes(java.util.Collection
)
-
-
globalSecondaryIndexes
TableDescription.Builder globalSecondaryIndexes(Collection<GlobalSecondaryIndexDescription> globalSecondaryIndexes)
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
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 inNonKeyAttributes
, 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, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.- Parameters:
globalSecondaryIndexes
- The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
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 inNonKeyAttributes
, 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, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
globalSecondaryIndexes
TableDescription.Builder globalSecondaryIndexes(GlobalSecondaryIndexDescription... globalSecondaryIndexes)
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
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 inNonKeyAttributes
, 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, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.- Parameters:
globalSecondaryIndexes
- The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
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 inNonKeyAttributes
, 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, along with data about increases and decreases.
If the table is in the
DELETING
state, no information about indexes will be returned.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
globalSecondaryIndexes
TableDescription.Builder globalSecondaryIndexes(Consumer<GlobalSecondaryIndexDescription.Builder>... globalSecondaryIndexes)
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
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 inNonKeyAttributes
, 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, along with data about increases and decreases.
If the table is in the
This is a convenience method that creates an instance of theDELETING
state, no information about indexes will be returned.GlobalSecondaryIndexDescription.Builder
avoiding the need to create one manually viaGlobalSecondaryIndexDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#globalSecondaryIndexes(List
.) - Parameters:
globalSecondaryIndexes
- a consumer that will call methods onGlobalSecondaryIndexDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#globalSecondaryIndexes(java.util.Collection
)
-
-
streamSpecification
TableDescription.Builder streamSpecification(StreamSpecification streamSpecification)
The current DynamoDB Streams configuration for the table.
- Parameters:
streamSpecification
- The current DynamoDB Streams configuration for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamSpecification
default TableDescription.Builder streamSpecification(Consumer<StreamSpecification.Builder> streamSpecification)
The current DynamoDB Streams configuration for the table.
This is a convenience method that creates an instance of theStreamSpecification.Builder
avoiding the need to create one manually viaStreamSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostreamSpecification(StreamSpecification)
.- Parameters:
streamSpecification
- a consumer that will call methods onStreamSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
streamSpecification(StreamSpecification)
-
latestStreamLabel
TableDescription.Builder latestStreamLabel(String latestStreamLabel)
A timestamp, in ISO 8601 format, for this stream.
Note that
LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:-
Amazon Web Services customer ID
-
Table name
-
StreamLabel
- Parameters:
latestStreamLabel
- A timestamp, in ISO 8601 format, for this stream.Note that
LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:-
Amazon Web Services customer ID
-
Table name
-
StreamLabel
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
latestStreamArn
TableDescription.Builder latestStreamArn(String latestStreamArn)
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
- Parameters:
latestStreamArn
- The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
globalTableVersion
TableDescription.Builder globalTableVersion(String globalTableVersion)
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
- Parameters:
globalTableVersion
- Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicas
TableDescription.Builder replicas(Collection<ReplicaDescription> replicas)
Represents replicas of the table.
- Parameters:
replicas
- Represents replicas of the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicas
TableDescription.Builder replicas(ReplicaDescription... replicas)
Represents replicas of the table.
- Parameters:
replicas
- Represents replicas of the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicas
TableDescription.Builder replicas(Consumer<ReplicaDescription.Builder>... replicas)
Represents replicas of the table.
This is a convenience method that creates an instance of theReplicaDescription.Builder
avoiding the need to create one manually viaReplicaDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#replicas(List
.) - Parameters:
replicas
- a consumer that will call methods onReplicaDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#replicas(java.util.Collection
)
-
restoreSummary
TableDescription.Builder restoreSummary(RestoreSummary restoreSummary)
Contains details for the restore.
- Parameters:
restoreSummary
- Contains details for the restore.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreSummary
default TableDescription.Builder restoreSummary(Consumer<RestoreSummary.Builder> restoreSummary)
Contains details for the restore.
This is a convenience method that creates an instance of theRestoreSummary.Builder
avoiding the need to create one manually viaRestoreSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestoreSummary(RestoreSummary)
.- Parameters:
restoreSummary
- a consumer that will call methods onRestoreSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
restoreSummary(RestoreSummary)
-
sseDescription
TableDescription.Builder sseDescription(SSEDescription sseDescription)
The description of the server-side encryption status on the specified table.
- Parameters:
sseDescription
- The description of the server-side encryption status on the specified table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseDescription
default TableDescription.Builder sseDescription(Consumer<SSEDescription.Builder> sseDescription)
The description of the server-side encryption status on the specified table.
This is a convenience method that creates an instance of theSSEDescription.Builder
avoiding the need to create one manually viaSSEDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosseDescription(SSEDescription)
.- Parameters:
sseDescription
- a consumer that will call methods onSSEDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sseDescription(SSEDescription)
-
archivalSummary
TableDescription.Builder archivalSummary(ArchivalSummary archivalSummary)
Contains information about the table archive.
- Parameters:
archivalSummary
- Contains information about the table archive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
archivalSummary
default TableDescription.Builder archivalSummary(Consumer<ArchivalSummary.Builder> archivalSummary)
Contains information about the table archive.
This is a convenience method that creates an instance of theArchivalSummary.Builder
avoiding the need to create one manually viaArchivalSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toarchivalSummary(ArchivalSummary)
.- Parameters:
archivalSummary
- a consumer that will call methods onArchivalSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
archivalSummary(ArchivalSummary)
-
tableClassSummary
TableDescription.Builder tableClassSummary(TableClassSummary tableClassSummary)
Contains details of the table class.
- Parameters:
tableClassSummary
- Contains details of the table class.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tableClassSummary
default TableDescription.Builder tableClassSummary(Consumer<TableClassSummary.Builder> tableClassSummary)
Contains details of the table class.
This is a convenience method that creates an instance of theTableClassSummary.Builder
avoiding the need to create one manually viaTableClassSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totableClassSummary(TableClassSummary)
.- Parameters:
tableClassSummary
- a consumer that will call methods onTableClassSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
tableClassSummary(TableClassSummary)
-
deletionProtectionEnabled
TableDescription.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
- Parameters:
deletionProtectionEnabled
- Indicates whether deletion protection is enabled (true) or disabled (false) on the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-