Package software.amazon.awssdk.services.dynamodb.model

Interface ReplicaGlobalSecondaryIndexSettingsDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>, SdkBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>, SdkPojo

Enclosing class:

ReplicaGlobalSecondaryIndexSettingsDescription

@Mutable
@NotThreadSafe
public static interface ReplicaGlobalSecondaryIndexSettingsDescription.Builder
extends SdkPojo, CopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>

Method Summary

Modifier and Type	Method	Description
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	indexName(String indexName)	The name of the global secondary index.
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	indexStatus(String indexStatus)	The current status of the global secondary index:
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	indexStatus(IndexStatus indexStatus)	The current status of the global secondary index:
default ReplicaGlobalSecondaryIndexSettingsDescription.Builder	provisionedReadCapacityAutoScalingSettings(Consumer<AutoScalingSettingsDescription.Builder> provisionedReadCapacityAutoScalingSettings)	Auto scaling settings for a global secondary index replica's read capacity units.
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	provisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)	Auto scaling settings for a global secondary index replica's read capacity units.
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	provisionedReadCapacityUnits(Long provisionedReadCapacityUnits)	The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
default ReplicaGlobalSecondaryIndexSettingsDescription.Builder	provisionedWriteCapacityAutoScalingSettings(Consumer<AutoScalingSettingsDescription.Builder> provisionedWriteCapacityAutoScalingSettings)	Auto scaling settings for a global secondary index replica's write capacity units.
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	provisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)	Auto scaling settings for a global secondary index replica's write capacity units.
ReplicaGlobalSecondaryIndexSettingsDescription.Builder	provisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits)	The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

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

ReplicaGlobalSecondaryIndexSettingsDescription.Builder indexName(String 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

ReplicaGlobalSecondaryIndexSettingsDescription.Builder indexStatus(String 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
• IndexStatus

indexStatus

ReplicaGlobalSecondaryIndexSettingsDescription.Builder indexStatus(IndexStatus 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
• IndexStatus

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 a ThrottlingException.

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 the AutoScalingSettingsDescription.Builder avoiding the need to create one manually via AutoScalingSettingsDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription).

Parameters:

provisionedReadCapacityAutoScalingSettings - a consumer that will call methods on AutoScalingSettingsDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• provisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription)

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 a ThrottlingException.

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 the AutoScalingSettingsDescription.Builder avoiding the need to create one manually via AutoScalingSettingsDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription).

Parameters:

provisionedWriteCapacityAutoScalingSettings - a consumer that will call methods on AutoScalingSettingsDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• provisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription)