Class: Aws::DynamoDB::Types::ReplicaSettingsDescription

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::ReplicaSettingsDescription

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

Represents the properties of a replica.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #region_name ⇒ String

  The Region name of the replica.

• #replica_billing_mode_summary ⇒ Types::BillingModeSummary

  The read/write capacity mode of the replica.

• #replica_global_secondary_index_settings ⇒ Array<Types::ReplicaGlobalSecondaryIndexSettingsDescription>

  Replica global secondary index settings for the global table.

• #replica_provisioned_read_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

  Auto scaling settings for a global table replica’s read capacity units.

• #replica_provisioned_read_capacity_units ⇒ Integer

  The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ‘ThrottlingException`.

• #replica_provisioned_write_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

  Auto scaling settings for a global table replica’s write capacity units.

• #replica_provisioned_write_capacity_units ⇒ Integer

  The maximum number of writes consumed per second before DynamoDB returns a ‘ThrottlingException`.

• #replica_status ⇒ String

  The current state of the Region:.

• #replica_table_class_summary ⇒ Types::TableClassSummary

  Contains details of the table class.

Instance Attribute Details

#region_name ⇒ String

The Region name of the replica.

Returns:

• (String)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_billing_mode_summary ⇒ Types::BillingModeSummary

The read/write capacity mode of the replica.

Returns:

• (Types::BillingModeSummary)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_global_secondary_index_settings ⇒ Array<Types::ReplicaGlobalSecondaryIndexSettingsDescription>

Replica global secondary index settings for the global table.

Returns:

• (Array<Types::ReplicaGlobalSecondaryIndexSettingsDescription>)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_provisioned_read_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

Auto scaling settings for a global table replica’s read capacity units.

Returns:

• (Types::AutoScalingSettingsDescription)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_provisioned_read_capacity_units ⇒ Integer

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ‘ThrottlingException`. For more information, see [Specifying Read and Write Requirements] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput

Returns:

• (Integer)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_provisioned_write_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

Auto scaling settings for a global table replica’s write capacity units.

Returns:

• (Types::AutoScalingSettingsDescription)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_provisioned_write_capacity_units ⇒ Integer

The maximum number of writes consumed per second before DynamoDB returns a ‘ThrottlingException`. For more information, see

Specifying Read and Write Requirements][1

in the *Amazon DynamoDB

Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput

Returns:

• (Integer)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_status ⇒ String

The current state of the Region:

• ‘CREATING` - The Region is being created.

• ‘UPDATING` - The Region is being updated.

• ‘DELETING` - The Region is being deleted.

• ‘ACTIVE` - The Region is ready for use.

Returns:

• (String)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end

#replica_table_class_summary ⇒ Types::TableClassSummary

Contains details of the table class.

Returns:

• (Types::TableClassSummary)

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

class ReplicaSettingsDescription < Struct.new(
  :region_name,
  :replica_status,
  :replica_billing_mode_summary,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings,
  :replica_provisioned_write_capacity_units,
  :replica_provisioned_write_capacity_auto_scaling_settings,
  :replica_global_secondary_index_settings,
  :replica_table_class_summary)
  SENSITIVE = []
  include Aws::Structure
end