Interface ReplicaGlobalSecondaryIndexSettingsDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,
,ReplicaGlobalSecondaryIndexSettingsDescription> SdkBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,
,ReplicaGlobalSecondaryIndexSettingsDescription> SdkPojo
- Enclosing class:
ReplicaGlobalSecondaryIndexSettingsDescription
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the global secondary index.indexStatus
(String indexStatus) The current status of the global secondary index:indexStatus
(IndexStatus indexStatus) The current status of the global secondary index:provisionedReadCapacityAutoScalingSettings
(Consumer<AutoScalingSettingsDescription.Builder> provisionedReadCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's read capacity units.provisionedReadCapacityAutoScalingSettings
(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's read capacity units.provisionedReadCapacityUnits
(Long provisionedReadCapacityUnits) The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException
.provisionedWriteCapacityAutoScalingSettings
(Consumer<AutoScalingSettingsDescription.Builder> provisionedWriteCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's write capacity units.provisionedWriteCapacityAutoScalingSettings
(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's write capacity units.provisionedWriteCapacityUnits
(Long provisionedWriteCapacityUnits) The maximum number of writes consumed per second before DynamoDB returns aThrottlingException
.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
-
indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
- Parameters:
indexName
- The name of the global secondary index. The name must be unique among all other indexes on this table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexStatus
The current status of the global secondary index:
-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
- Parameters:
indexStatus
- The current status of the global secondary index:-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
indexStatus
The current status of the global secondary index:
-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
- Parameters:
indexStatus
- The current status of the global secondary index:-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
provisionedReadCapacityUnits
ReplicaGlobalSecondaryIndexSettingsDescription.Builder provisionedReadCapacityUnits(Long provisionedReadCapacityUnits) The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
.- Parameters:
provisionedReadCapacityUnits
- The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedReadCapacityAutoScalingSettings
ReplicaGlobalSecondaryIndexSettingsDescription.Builder provisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's read capacity units.
- Parameters:
provisionedReadCapacityAutoScalingSettings
- Auto scaling settings for a global secondary index replica's read capacity units.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedReadCapacityAutoScalingSettings
default ReplicaGlobalSecondaryIndexSettingsDescription.Builder provisionedReadCapacityAutoScalingSettings(Consumer<AutoScalingSettingsDescription.Builder> provisionedReadCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's read capacity units.
This is a convenience method that creates an instance of theAutoScalingSettingsDescription.Builder
avoiding the need to create one manually viaAutoScalingSettingsDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription)
.- Parameters:
provisionedReadCapacityAutoScalingSettings
- a consumer that will call methods onAutoScalingSettingsDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
provisionedWriteCapacityUnits
ReplicaGlobalSecondaryIndexSettingsDescription.Builder provisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits) The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException
.- Parameters:
provisionedWriteCapacityUnits
- The maximum number of writes consumed per second before DynamoDB returns aThrottlingException
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedWriteCapacityAutoScalingSettings
ReplicaGlobalSecondaryIndexSettingsDescription.Builder provisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's write capacity units.
- Parameters:
provisionedWriteCapacityAutoScalingSettings
- Auto scaling settings for a global secondary index replica's write capacity units.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedWriteCapacityAutoScalingSettings
default ReplicaGlobalSecondaryIndexSettingsDescription.Builder provisionedWriteCapacityAutoScalingSettings(Consumer<AutoScalingSettingsDescription.Builder> provisionedWriteCapacityAutoScalingSettings) Auto scaling settings for a global secondary index replica's write capacity units.
This is a convenience method that creates an instance of theAutoScalingSettingsDescription.Builder
avoiding the need to create one manually viaAutoScalingSettingsDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription)
.- Parameters:
provisionedWriteCapacityAutoScalingSettings
- a consumer that will call methods onAutoScalingSettingsDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-