Class: Aws::DynamoDB::Types::ReplicaSettingsUpdate

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

Overview

Note:

When making an API call, you may pass ReplicaSettingsUpdate data as a hash:

{
  region_name: "RegionName", # required
  replica_provisioned_read_capacity_units: 1,
  replica_provisioned_read_capacity_auto_scaling_settings_update: {
    minimum_units: 1,
    maximum_units: 1,
    auto_scaling_disabled: false,
    auto_scaling_role_arn: "AutoScalingRoleArn",
    scaling_policy_update: {
      policy_name: "AutoScalingPolicyName",
      target_tracking_scaling_policy_configuration: { # required
        disable_scale_in: false,
        scale_in_cooldown: 1,
        scale_out_cooldown: 1,
        target_value: 1.0, # required
      },
    },
  },
  replica_global_secondary_index_settings_update: [
    {
      index_name: "IndexName", # required
      provisioned_read_capacity_units: 1,
      provisioned_read_capacity_auto_scaling_settings_update: {
        minimum_units: 1,
        maximum_units: 1,
        auto_scaling_disabled: false,
        auto_scaling_role_arn: "AutoScalingRoleArn",
        scaling_policy_update: {
          policy_name: "AutoScalingPolicyName",
          target_tracking_scaling_policy_configuration: { # required
            disable_scale_in: false,
            scale_in_cooldown: 1,
            scale_out_cooldown: 1,
            target_value: 1.0, # required
          },
        },
      },
    },
  ],
}

Represents the settings for a global table in a region that will be modified.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#region_name ⇒ String

The region of the replica to be added.

Returns:

  • (String) 


5638
5639
5640
5641
5642
5643
5644
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5638

class ReplicaSettingsUpdate < Struct.new(
  :region_name,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings_update,
  :replica_global_secondary_index_settings_update)
  include Aws::Structure
end

#replica_global_secondary_index_settings_update ⇒ Array<Types::ReplicaGlobalSecondaryIndexSettingsUpdate>

Represents the settings of a global secondary index for a global table that will be modified.

Returns:



5638
5639
5640
5641
5642
5643
5644
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5638

class ReplicaSettingsUpdate < Struct.new(
  :region_name,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings_update,
  :replica_global_secondary_index_settings_update)
  include Aws::Structure
end

#replica_provisioned_read_capacity_auto_scaling_settings_update ⇒ Types::AutoScalingSettingsUpdate

Autoscaling settings for managing a global table replica’s read capacity units.

Returns:



5638
5639
5640
5641
5642
5643
5644
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5638

class ReplicaSettingsUpdate < Struct.new(
  :region_name,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings_update,
  :replica_global_secondary_index_settings_update)
  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) 


5638
5639
5640
5641
5642
5643
5644
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 5638

class ReplicaSettingsUpdate < Struct.new(
  :region_name,
  :replica_provisioned_read_capacity_units,
  :replica_provisioned_read_capacity_auto_scaling_settings_update,
  :replica_global_secondary_index_settings_update)
  include Aws::Structure
end