You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDB::Types::ReplicaDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains the details of the replica.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#global_secondary_indexes ⇒ Array<Types::ReplicaGlobalSecondaryIndexDescription>

Replica-specific global secondary index settings.

Returns:

#kms_master_key_id ⇒ String

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.

Returns:

  • (String) —

    The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.

#provisioned_throughput_override ⇒ Types::ProvisionedThroughputOverride

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

Returns:

#region_name ⇒ String

The name of the Region.

Returns:

  • (String) —

    The name of the Region.

#replica_inaccessible_date_time ⇒ Time

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

Returns:

  • (Time) —

    The time at which the replica was first detected as inaccessible.

#replica_status ⇒ String

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 AWS Region has been disabled.

    If the AWS 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 AWS KMS key used to encrypt the table is inaccessible.

    If the AWS 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.

    Possible values:

    • CREATING
    • CREATION_FAILED
    • UPDATING
    • DELETING
    • ACTIVE
    • REGION_DISABLED
    • INACCESSIBLE_ENCRYPTION_CREDENTIALS

Returns:

  • (String) —

    The current state of the replica:.

#replica_status_description ⇒ String

Detailed information about the replica status.

Returns:

  • (String) —

    Detailed information about the replica status.

#replica_status_percent_progress ⇒ String

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

Returns:

  • (String) —

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