Interface AwsDynamoDbTableDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsDynamoDbTableDetails.Builder,
,AwsDynamoDbTableDetails> SdkBuilder<AwsDynamoDbTableDetails.Builder,
,AwsDynamoDbTableDetails> SdkPojo
- Enclosing class:
AwsDynamoDbTableDetails
-
Method Summary
Modifier and TypeMethodDescriptionattributeDefinitions
(Collection<AwsDynamoDbTableAttributeDefinition> attributeDefinitions) A list of attribute definitions for the table.attributeDefinitions
(Consumer<AwsDynamoDbTableAttributeDefinition.Builder>... attributeDefinitions) A list of attribute definitions for the table.attributeDefinitions
(AwsDynamoDbTableAttributeDefinition... attributeDefinitions) A list of attribute definitions for the table.default AwsDynamoDbTableDetails.Builder
billingModeSummary
(Consumer<AwsDynamoDbTableBillingModeSummary.Builder> billingModeSummary) Information about the billing for read/write capacity on the table.billingModeSummary
(AwsDynamoDbTableBillingModeSummary billingModeSummary) Information about the billing for read/write capacity on the table.creationDateTime
(String creationDateTime) Indicates when the table was created.deletionProtectionEnabled
(Boolean deletionProtectionEnabled) Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.globalSecondaryIndexes
(Collection<AwsDynamoDbTableGlobalSecondaryIndex> globalSecondaryIndexes) List of global secondary indexes for the table.globalSecondaryIndexes
(Consumer<AwsDynamoDbTableGlobalSecondaryIndex.Builder>... globalSecondaryIndexes) List of global secondary indexes for the table.globalSecondaryIndexes
(AwsDynamoDbTableGlobalSecondaryIndex... globalSecondaryIndexes) List of global secondary indexes for the table.globalTableVersion
(String globalTableVersion) The version of global tables being used.The number of items in the table.keySchema
(Collection<AwsDynamoDbTableKeySchema> keySchema) The primary key structure for the table.keySchema
(Consumer<AwsDynamoDbTableKeySchema.Builder>... keySchema) The primary key structure for the table.keySchema
(AwsDynamoDbTableKeySchema... keySchema) The primary key structure for the table.latestStreamArn
(String latestStreamArn) The ARN of the latest stream for the table.latestStreamLabel
(String latestStreamLabel) The label of the latest stream.localSecondaryIndexes
(Collection<AwsDynamoDbTableLocalSecondaryIndex> localSecondaryIndexes) The list of local secondary indexes for the table.localSecondaryIndexes
(Consumer<AwsDynamoDbTableLocalSecondaryIndex.Builder>... localSecondaryIndexes) The list of local secondary indexes for the table.localSecondaryIndexes
(AwsDynamoDbTableLocalSecondaryIndex... localSecondaryIndexes) The list of local secondary indexes for the table.default AwsDynamoDbTableDetails.Builder
provisionedThroughput
(Consumer<AwsDynamoDbTableProvisionedThroughput.Builder> provisionedThroughput) Information about the provisioned throughput for the table.provisionedThroughput
(AwsDynamoDbTableProvisionedThroughput provisionedThroughput) Information about the provisioned throughput for the table.replicas
(Collection<AwsDynamoDbTableReplica> replicas) The list of replicas of this table.replicas
(Consumer<AwsDynamoDbTableReplica.Builder>... replicas) The list of replicas of this table.replicas
(AwsDynamoDbTableReplica... replicas) The list of replicas of this table.default AwsDynamoDbTableDetails.Builder
restoreSummary
(Consumer<AwsDynamoDbTableRestoreSummary.Builder> restoreSummary) Information about the restore for the table.restoreSummary
(AwsDynamoDbTableRestoreSummary restoreSummary) Information about the restore for the table.default AwsDynamoDbTableDetails.Builder
sseDescription
(Consumer<AwsDynamoDbTableSseDescription.Builder> sseDescription) Information about the server-side encryption for the table.sseDescription
(AwsDynamoDbTableSseDescription sseDescription) Information about the server-side encryption for the table.default AwsDynamoDbTableDetails.Builder
streamSpecification
(Consumer<AwsDynamoDbTableStreamSpecification.Builder> streamSpecification) The current DynamoDB Streams configuration for the table.streamSpecification
(AwsDynamoDbTableStreamSpecification streamSpecification) The current DynamoDB Streams configuration for the table.The identifier of the table.The name of the table.tableSizeBytes
(Long tableSizeBytes) The total size of the table in bytes.tableStatus
(String tableStatus) The current status 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, sdkFieldNameToField, sdkFields
-
Method Details
-
attributeDefinitions
AwsDynamoDbTableDetails.Builder attributeDefinitions(Collection<AwsDynamoDbTableAttributeDefinition> attributeDefinitions) A list of attribute definitions for the table.
- Parameters:
attributeDefinitions
- A list of attribute definitions for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeDefinitions
AwsDynamoDbTableDetails.Builder attributeDefinitions(AwsDynamoDbTableAttributeDefinition... attributeDefinitions) A list of attribute definitions for the table.
- Parameters:
attributeDefinitions
- A list of attribute definitions for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeDefinitions
AwsDynamoDbTableDetails.Builder attributeDefinitions(Consumer<AwsDynamoDbTableAttributeDefinition.Builder>... attributeDefinitions) A list of attribute definitions for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableAttributeDefinition.Builder
avoiding the need to create one manually viaAwsDynamoDbTableAttributeDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattributeDefinitions(List<AwsDynamoDbTableAttributeDefinition>)
.- Parameters:
attributeDefinitions
- a consumer that will call methods onAwsDynamoDbTableAttributeDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
billingModeSummary
AwsDynamoDbTableDetails.Builder billingModeSummary(AwsDynamoDbTableBillingModeSummary billingModeSummary) Information about the billing for read/write capacity on the table.
- Parameters:
billingModeSummary
- Information about the billing for read/write capacity on the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
billingModeSummary
default AwsDynamoDbTableDetails.Builder billingModeSummary(Consumer<AwsDynamoDbTableBillingModeSummary.Builder> billingModeSummary) Information about the billing for read/write capacity on the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableBillingModeSummary.Builder
avoiding the need to create one manually viaAwsDynamoDbTableBillingModeSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobillingModeSummary(AwsDynamoDbTableBillingModeSummary)
.- Parameters:
billingModeSummary
- a consumer that will call methods onAwsDynamoDbTableBillingModeSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creationDateTime
Indicates when the table was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
- Parameters:
creationDateTime
- Indicates when the table was created.For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
globalSecondaryIndexes
AwsDynamoDbTableDetails.Builder globalSecondaryIndexes(Collection<AwsDynamoDbTableGlobalSecondaryIndex> globalSecondaryIndexes) List of global secondary indexes for the table.
- Parameters:
globalSecondaryIndexes
- List of global secondary indexes for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
globalSecondaryIndexes
AwsDynamoDbTableDetails.Builder globalSecondaryIndexes(AwsDynamoDbTableGlobalSecondaryIndex... globalSecondaryIndexes) List of global secondary indexes for the table.
- Parameters:
globalSecondaryIndexes
- List of global secondary indexes for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
globalSecondaryIndexes
AwsDynamoDbTableDetails.Builder globalSecondaryIndexes(Consumer<AwsDynamoDbTableGlobalSecondaryIndex.Builder>... globalSecondaryIndexes) List of global secondary indexes for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableGlobalSecondaryIndex.Builder
avoiding the need to create one manually viaAwsDynamoDbTableGlobalSecondaryIndex.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toglobalSecondaryIndexes(List<AwsDynamoDbTableGlobalSecondaryIndex>)
.- Parameters:
globalSecondaryIndexes
- a consumer that will call methods onAwsDynamoDbTableGlobalSecondaryIndex.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
globalTableVersion
The version of global tables being used.
- Parameters:
globalTableVersion
- The version of global tables being used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
itemCount
The number of items in the table.
- Parameters:
itemCount
- The number of items in the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keySchema
The primary key structure for the table.
- Parameters:
keySchema
- The primary key structure for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keySchema
The primary key structure for the table.
- Parameters:
keySchema
- The primary key structure for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keySchema
The primary key structure for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableKeySchema.Builder
avoiding the need to create one manually viaAwsDynamoDbTableKeySchema.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokeySchema(List<AwsDynamoDbTableKeySchema>)
.- Parameters:
keySchema
- a consumer that will call methods onAwsDynamoDbTableKeySchema.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
latestStreamArn
The ARN of the latest stream for the table.
- Parameters:
latestStreamArn
- The ARN of the latest stream for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestStreamLabel
The label of the latest stream. The label is not a unique identifier.
- Parameters:
latestStreamLabel
- The label of the latest stream. The label is not a unique identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localSecondaryIndexes
AwsDynamoDbTableDetails.Builder localSecondaryIndexes(Collection<AwsDynamoDbTableLocalSecondaryIndex> localSecondaryIndexes) The list of local secondary indexes for the table.
- Parameters:
localSecondaryIndexes
- The list of local secondary indexes for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localSecondaryIndexes
AwsDynamoDbTableDetails.Builder localSecondaryIndexes(AwsDynamoDbTableLocalSecondaryIndex... localSecondaryIndexes) The list of local secondary indexes for the table.
- Parameters:
localSecondaryIndexes
- The list of local secondary indexes for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localSecondaryIndexes
AwsDynamoDbTableDetails.Builder localSecondaryIndexes(Consumer<AwsDynamoDbTableLocalSecondaryIndex.Builder>... localSecondaryIndexes) The list of local secondary indexes for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableLocalSecondaryIndex.Builder
avoiding the need to create one manually viaAwsDynamoDbTableLocalSecondaryIndex.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolocalSecondaryIndexes(List<AwsDynamoDbTableLocalSecondaryIndex>)
.- Parameters:
localSecondaryIndexes
- a consumer that will call methods onAwsDynamoDbTableLocalSecondaryIndex.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
provisionedThroughput
AwsDynamoDbTableDetails.Builder provisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput) Information about the provisioned throughput for the table.
- Parameters:
provisionedThroughput
- Information about the provisioned throughput for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedThroughput
default AwsDynamoDbTableDetails.Builder provisionedThroughput(Consumer<AwsDynamoDbTableProvisionedThroughput.Builder> provisionedThroughput) Information about the provisioned throughput for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableProvisionedThroughput.Builder
avoiding the need to create one manually viaAwsDynamoDbTableProvisionedThroughput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedThroughput(AwsDynamoDbTableProvisionedThroughput)
.- Parameters:
provisionedThroughput
- a consumer that will call methods onAwsDynamoDbTableProvisionedThroughput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
replicas
The list of replicas of this table.
- Parameters:
replicas
- The list of replicas of this table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicas
The list of replicas of this table.
- Parameters:
replicas
- The list of replicas of this table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicas
The list of replicas of this table.
This is a convenience method that creates an instance of theAwsDynamoDbTableReplica.Builder
avoiding the need to create one manually viaAwsDynamoDbTableReplica.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreplicas(List<AwsDynamoDbTableReplica>)
.- Parameters:
replicas
- a consumer that will call methods onAwsDynamoDbTableReplica.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
restoreSummary
Information about the restore for the table.
- Parameters:
restoreSummary
- Information about the restore for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreSummary
default AwsDynamoDbTableDetails.Builder restoreSummary(Consumer<AwsDynamoDbTableRestoreSummary.Builder> restoreSummary) Information about the restore for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableRestoreSummary.Builder
avoiding the need to create one manually viaAwsDynamoDbTableRestoreSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestoreSummary(AwsDynamoDbTableRestoreSummary)
.- Parameters:
restoreSummary
- a consumer that will call methods onAwsDynamoDbTableRestoreSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sseDescription
Information about the server-side encryption for the table.
- Parameters:
sseDescription
- Information about the server-side encryption for the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseDescription
default AwsDynamoDbTableDetails.Builder sseDescription(Consumer<AwsDynamoDbTableSseDescription.Builder> sseDescription) Information about the server-side encryption for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableSseDescription.Builder
avoiding the need to create one manually viaAwsDynamoDbTableSseDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosseDescription(AwsDynamoDbTableSseDescription)
.- Parameters:
sseDescription
- a consumer that will call methods onAwsDynamoDbTableSseDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
streamSpecification
AwsDynamoDbTableDetails.Builder streamSpecification(AwsDynamoDbTableStreamSpecification 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 AwsDynamoDbTableDetails.Builder streamSpecification(Consumer<AwsDynamoDbTableStreamSpecification.Builder> streamSpecification) The current DynamoDB Streams configuration for the table.
This is a convenience method that creates an instance of theAwsDynamoDbTableStreamSpecification.Builder
avoiding the need to create one manually viaAwsDynamoDbTableStreamSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostreamSpecification(AwsDynamoDbTableStreamSpecification)
.- Parameters:
streamSpecification
- a consumer that will call methods onAwsDynamoDbTableStreamSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tableId
The identifier of the table.
- Parameters:
tableId
- The identifier of the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
tableSizeBytes
The total size of the table in bytes.
- Parameters:
tableSizeBytes
- The total size of the table in bytes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tableStatus
The current status of the table. Valid values are as follows:
-
ACTIVE
-
ARCHIVED
-
ARCHIVING
-
CREATING
-
DELETING
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS
-
UPDATING
- Parameters:
tableStatus
- The current status of the table. Valid values are as follows:-
ACTIVE
-
ARCHIVED
-
ARCHIVING
-
CREATING
-
DELETING
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS
-
UPDATING
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
deletionProtectionEnabled
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
- Parameters:
deletionProtectionEnabled
- Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-