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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#global_secondary_indexes ⇒ Array<Types::ReplicaGlobalSecondaryIndexDescription>

Replica-specific global secondary index settings.

Returns:



6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#kms_master_key_id ⇒ String

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

Returns:

  • (String) 


6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput_override ⇒ Types::ProvisionedThroughputOverride

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

Returns:



6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#region_name ⇒ String

The name of the Region.

Returns:

  • (String) 


6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services Region has been disabled.

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

    </note>

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

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

    </note>

Returns:

  • (String) 


6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status_description ⇒ String

Detailed information about the replica status.

Returns:

  • (String) 


6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status_percent_progress ⇒ String

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

Returns:

  • (String) 


6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_table_class_summary ⇒ Types::TableClassSummary

Contains details of the table class.

Returns:



6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 6833

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,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end