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

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::ReplicaDescription

Defined in:

gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Contains the details of the replica.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #global_secondary_indexes ⇒ Array<Types::ReplicaGlobalSecondaryIndexDescription>

  Replica-specific global secondary index settings.

• #global_table_settings_replication_mode ⇒ String

  Indicates one of the settings synchronization modes for the global table replica:.

• #kms_master_key_id ⇒ String

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

• #on_demand_throughput_override ⇒ Types::OnDemandThroughputOverride

  Overrides the maximum on-demand throughput settings for the specified replica table.

• #provisioned_throughput_override ⇒ Types::ProvisionedThroughputOverride

  Replica-specific provisioned throughput.

• #region_name ⇒ String

  The name of the Region.

• #replica_arn ⇒ String

  The Amazon Resource Name (ARN) of the global table replica.

• #replica_inaccessible_date_time ⇒ Time

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

• #replica_status ⇒ String

  The current state of the replica:.

• #replica_status_description ⇒ 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.

• #replica_table_class_summary ⇒ Types::TableClassSummary

  Contains details of the table class.

• #warm_throughput ⇒ Types::TableWarmThroughputDescription

  Represents the warm throughput value for this replica.

Instance Attribute Details

#global_secondary_indexes ⇒ Array<Types::ReplicaGlobalSecondaryIndexDescription>

Replica-specific global secondary index settings.

Returns:

• (Array<Types::ReplicaGlobalSecondaryIndexDescription>)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#global_table_settings_replication_mode ⇒ String

Indicates one of the settings synchronization modes for the global table replica:

• ENABLED: Indicates that the settings synchronization mode for the global table replica is enabled.

• DISABLED: Indicates that the settings synchronization mode for the global table replica is disabled.

• ENABLED_WITH_OVERRIDES: This mode is set by default for a same account global table. Indicates that certain global table settings can be overridden.

Returns:

• (String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_arn,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :on_demand_throughput_override,
  :warm_throughput,
  :global_secondary_indexes,
  :replica_inaccessible_date_time,
  :replica_table_class_summary,
  :global_table_settings_replication_mode)
  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)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#on_demand_throughput_override ⇒ Types::OnDemandThroughputOverride

Overrides the maximum on-demand throughput settings for the specified replica table.

Returns:

• (Types::OnDemandThroughputOverride)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_arn,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :on_demand_throughput_override,
  :warm_throughput,
  :global_secondary_indexes,
  :replica_inaccessible_date_time,
  :replica_table_class_summary,
  :global_table_settings_replication_mode)
  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:

• (Types::ProvisionedThroughputOverride)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#region_name ⇒ String

The name of the Region.

Returns:

• (String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#replica_arn ⇒ String

The Amazon Resource Name (ARN) of the global table replica.

Returns:

• (String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_arn,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :on_demand_throughput_override,
  :warm_throughput,
  :global_secondary_indexes,
  :replica_inaccessible_date_time,
  :replica_table_class_summary,
  :global_table_settings_replication_mode)
  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)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_arn,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :on_demand_throughput_override,
  :warm_throughput,
  :global_secondary_indexes,
  :replica_inaccessible_date_time,
  :replica_table_class_summary,
  :global_table_settings_replication_mode)
  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.

  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:

• (String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#replica_status_description ⇒ String

Detailed information about the replica status.

Returns:

• (String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

class ReplicaDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_arn,
  :replica_status_description,
  :replica_status_percent_progress,
  :kms_master_key_id,
  :provisioned_throughput_override,
  :on_demand_throughput_override,
  :warm_throughput,
  :global_secondary_indexes,
  :replica_inaccessible_date_time,
  :replica_table_class_summary,
  :global_table_settings_replication_mode)
  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)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#replica_table_class_summary ⇒ Types::TableClassSummary

Contains details of the table class.

Returns:

• (Types::TableClassSummary)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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

#warm_throughput ⇒ Types::TableWarmThroughputDescription

Represents the warm throughput value for this replica.

Returns:

• (Types::TableWarmThroughputDescription)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7621

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