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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Contains the details of the replica.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#global_secondary_indexesArray<Types::ReplicaGlobalSecondaryIndexDescription>

Replica-specific global secondary index settings.


7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_master_key_idString

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

Returns:

  • (String)

7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput_overrideTypes::ProvisionedThroughputOverride

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


7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#region_nameString

The name of the Region.

Returns:

  • (String)

7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#replica_inaccessible_date_timeTime

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

Returns:

  • (Time)

7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#replica_statusString

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.

    <note markdown=“1”> 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.

    </note>
    
  • `INACCESSIBLE_ENCRYPTION_CREDENTIALS ` - The AWS KMS key used to encrypt the table is inaccessible.

    <note markdown=“1”> 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.

    </note>
    

Returns:

  • (String)

7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status_descriptionString

Detailed information about the replica status.

Returns:

  • (String)

7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status_percent_progressString

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

Returns:

  • (String)

7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
# File 'lib/aws-sdk-dynamodb/types.rb', line 7052

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :global_secondary_indexes,
  :replica_inaccessible_date_time)
  SENSITIVE = []
  include Aws::Structure
end