Class: Aws::DynamoDB::Types::UpdateGlobalTableSettingsInput

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 UpdateGlobalTableSettingsInput data as a hash:

{
  global_table_name: "TableName", # required
  global_table_billing_mode: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
  global_table_provisioned_write_capacity_units: 1,
  global_table_provisioned_write_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
      },
    },
  },
  global_table_global_secondary_index_settings_update: [
    {
      index_name: "IndexName", # required
      provisioned_write_capacity_units: 1,
      provisioned_write_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_settings_update: [
    {
      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
              },
            },
          },
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#global_table_billing_modeString

The billing mode of the global table. If `GlobalTableBillingMode` is not specified, the global table defaults to `PROVISIONED` capacity billing mode.

  • `PROVISIONED` - We recommend using `PROVISIONED` for predictable workloads. `PROVISIONED` sets the billing mode to [Provisioned Mode].

  • `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for unpredictable workloads. `PAY_PER_REQUEST` sets the billing mode to [On-Demand Mode].

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand

Returns:

  • (String)

10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
# File 'lib/aws-sdk-dynamodb/types.rb', line 10077

class UpdateGlobalTableSettingsInput < Struct.new(
  :global_table_name,
  :global_table_billing_mode,
  :global_table_provisioned_write_capacity_units,
  :global_table_provisioned_write_capacity_auto_scaling_settings_update,
  :global_table_global_secondary_index_settings_update,
  :replica_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#global_table_global_secondary_index_settings_updateArray<Types::GlobalTableGlobalSecondaryIndexSettingsUpdate>

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


10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
# File 'lib/aws-sdk-dynamodb/types.rb', line 10077

class UpdateGlobalTableSettingsInput < Struct.new(
  :global_table_name,
  :global_table_billing_mode,
  :global_table_provisioned_write_capacity_units,
  :global_table_provisioned_write_capacity_auto_scaling_settings_update,
  :global_table_global_secondary_index_settings_update,
  :replica_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#global_table_nameString

The name of the global table

Returns:

  • (String)

10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
# File 'lib/aws-sdk-dynamodb/types.rb', line 10077

class UpdateGlobalTableSettingsInput < Struct.new(
  :global_table_name,
  :global_table_billing_mode,
  :global_table_provisioned_write_capacity_units,
  :global_table_provisioned_write_capacity_auto_scaling_settings_update,
  :global_table_global_secondary_index_settings_update,
  :replica_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#global_table_provisioned_write_capacity_auto_scaling_settings_updateTypes::AutoScalingSettingsUpdate

Auto scaling settings for managing provisioned write capacity for the global table.


10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
# File 'lib/aws-sdk-dynamodb/types.rb', line 10077

class UpdateGlobalTableSettingsInput < Struct.new(
  :global_table_name,
  :global_table_billing_mode,
  :global_table_provisioned_write_capacity_units,
  :global_table_provisioned_write_capacity_auto_scaling_settings_update,
  :global_table_global_secondary_index_settings_update,
  :replica_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#global_table_provisioned_write_capacity_unitsInteger

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

Returns:

  • (Integer)

10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
# File 'lib/aws-sdk-dynamodb/types.rb', line 10077

class UpdateGlobalTableSettingsInput < Struct.new(
  :global_table_name,
  :global_table_billing_mode,
  :global_table_provisioned_write_capacity_units,
  :global_table_provisioned_write_capacity_auto_scaling_settings_update,
  :global_table_global_secondary_index_settings_update,
  :replica_settings_update)
  SENSITIVE = []
  include Aws::Structure
end

#replica_settings_updateArray<Types::ReplicaSettingsUpdate>

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

Returns:


10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
# File 'lib/aws-sdk-dynamodb/types.rb', line 10077

class UpdateGlobalTableSettingsInput < Struct.new(
  :global_table_name,
  :global_table_billing_mode,
  :global_table_provisioned_write_capacity_units,
  :global_table_provisioned_write_capacity_auto_scaling_settings_update,
  :global_table_global_secondary_index_settings_update,
  :replica_settings_update)
  SENSITIVE = []
  include Aws::Structure
end