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

Interface ReplicaDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ReplicaDescription.Builder,ReplicaDescription>, SdkBuilder<ReplicaDescription.Builder,ReplicaDescription>, SdkPojo
Enclosing class:
ReplicaDescription
public static interface ReplicaDescription.Builder extends SdkPojo, CopyableBuilder<ReplicaDescription.Builder,ReplicaDescription>

  • Method Details

    • regionName

      ReplicaDescription.Builder regionName(String regionName)

      The name of the Region.

      Parameters:
      regionName - The name of the Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaStatus

      ReplicaDescription.Builder replicaStatus(String replicaStatus)

      The current state of the replica:

      • CREATING - The replica is being created.

      • UPDATING - The replica is being updated.

      • DELETING - The replica is being deleted.

      • ACTIVE - The replica is ready for use.

      • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

        If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

        If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      Parameters:
      replicaStatus - The current state of the replica:

      • CREATING - The replica is being created.

      • UPDATING - The replica is being updated.

      • DELETING - The replica is being deleted.

      • ACTIVE - The replica is ready for use.

      • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

        If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

        If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

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

    • replicaStatus

      ReplicaDescription.Builder replicaStatus(ReplicaStatus replicaStatus)

      The current state of the replica:

      • CREATING - The replica is being created.

      • UPDATING - The replica is being updated.

      • DELETING - The replica is being deleted.

      • ACTIVE - The replica is ready for use.

      • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

        If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

        If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      Parameters:
      replicaStatus - The current state of the replica:

      • CREATING - The replica is being created.

      • UPDATING - The replica is being updated.

      • DELETING - The replica is being deleted.

      • ACTIVE - The replica is ready for use.

      • REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.

        If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

      • INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.

        If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

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

    • replicaStatusDescription

      ReplicaDescription.Builder replicaStatusDescription(String replicaStatusDescription)

      Detailed information about the replica status.

      Parameters:
      replicaStatusDescription - Detailed information about the replica status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaStatusPercentProgress

      ReplicaDescription.Builder replicaStatusPercentProgress(String replicaStatusPercentProgress)

      Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

      Parameters:
      replicaStatusPercentProgress - Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsMasterKeyId

      ReplicaDescription.Builder kmsMasterKeyId(String kmsMasterKeyId)

      The KMS key of the replica that will be used for KMS encryption.

      Parameters:
      kmsMasterKeyId - The KMS key of the replica that will be used for KMS encryption.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • provisionedThroughputOverride

      ReplicaDescription.Builder provisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride)

      Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

      Parameters:
      provisionedThroughputOverride - Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • provisionedThroughputOverride

      default ReplicaDescription.Builder provisionedThroughputOverride(Consumer<ProvisionedThroughputOverride.Builder> provisionedThroughputOverride)

      Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.

      This is a convenience method that creates an instance of the ProvisionedThroughputOverride.Builder avoiding the need to create one manually via ProvisionedThroughputOverride.builder().

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

      Parameters:
      provisionedThroughputOverride - a consumer that will call methods on ProvisionedThroughputOverride.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • globalSecondaryIndexes

      ReplicaDescription.Builder globalSecondaryIndexes(Collection<ReplicaGlobalSecondaryIndexDescription> globalSecondaryIndexes)

      Replica-specific global secondary index settings.

      Parameters:
      globalSecondaryIndexes - Replica-specific global secondary index settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalSecondaryIndexes

      ReplicaDescription.Builder globalSecondaryIndexes(ReplicaGlobalSecondaryIndexDescription... globalSecondaryIndexes)

      Replica-specific global secondary index settings.

      Parameters:
      globalSecondaryIndexes - Replica-specific global secondary index settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalSecondaryIndexes

      ReplicaDescription.Builder globalSecondaryIndexes(Consumer<ReplicaGlobalSecondaryIndexDescription.Builder>... globalSecondaryIndexes)

      Replica-specific global secondary index settings.

      This is a convenience method that creates an instance of the ReplicaGlobalSecondaryIndexDescription.Builder avoiding the need to create one manually via ReplicaGlobalSecondaryIndexDescription.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to globalSecondaryIndexes(List<ReplicaGlobalSecondaryIndexDescription>).

      Parameters:
      globalSecondaryIndexes - a consumer that will call methods on ReplicaGlobalSecondaryIndexDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicaInaccessibleDateTime

      ReplicaDescription.Builder replicaInaccessibleDateTime(Instant replicaInaccessibleDateTime)

      The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

      Parameters:
      replicaInaccessibleDateTime - The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaTableClassSummary

      ReplicaDescription.Builder replicaTableClassSummary(TableClassSummary replicaTableClassSummary)
      Sets the value of the ReplicaTableClassSummary property for this object.
      Parameters:
      replicaTableClassSummary - The new value for the ReplicaTableClassSummary property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaTableClassSummary

      default ReplicaDescription.Builder replicaTableClassSummary(Consumer<TableClassSummary.Builder> replicaTableClassSummary)
      Sets the value of the ReplicaTableClassSummary property for this object. This is a convenience method that creates an instance of the TableClassSummary.Builder avoiding the need to create one manually via TableClassSummary.builder().

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

      Parameters:
      replicaTableClassSummary - a consumer that will call methods on TableClassSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: