You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DynamoDB::Types::UpdateGlobalTableSettingsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::UpdateGlobalTableSettingsInput
- Defined in:
- (unknown)
Overview
When passing UpdateGlobalTableSettingsInput as input to an Aws::Client method, you can use a vanilla 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
},
},
},
},
],
},
],
}
Instance Attribute Summary collapse
-
#global_table_billing_mode ⇒ String
The billing mode of the global table.
-
#global_table_global_secondary_index_settings_update ⇒ Array<Types::GlobalTableGlobalSecondaryIndexSettingsUpdate>
Represents the settings of a global secondary index for a global table that will be modified.
-
#global_table_name ⇒ String
The name of the global table.
-
#global_table_provisioned_write_capacity_auto_scaling_settings_update ⇒ Types::AutoScalingSettingsUpdate
Auto scaling settings for managing provisioned write capacity for the global table.
-
#global_table_provisioned_write_capacity_units ⇒ Integer
The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException.
. -
#replica_settings_update ⇒ Array<Types::ReplicaSettingsUpdate>
Represents the settings for a global table in a Region that will be modified.
Instance Attribute Details
#global_table_billing_mode ⇒ String
The billing mode of the global table. If GlobalTableBillingMode
is not
specified, the global table defaults to PROVISIONED
capacity billing
mode.
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode.PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
#global_table_global_secondary_index_settings_update ⇒ Array<Types::GlobalTableGlobalSecondaryIndexSettingsUpdate>
Represents the settings of a global secondary index for a global table that will be modified.
#global_table_name ⇒ String
The name of the global table
#global_table_provisioned_write_capacity_auto_scaling_settings_update ⇒ Types::AutoScalingSettingsUpdate
Auto scaling settings for managing provisioned write capacity for the global table.
#global_table_provisioned_write_capacity_units ⇒ Integer
The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException.
#replica_settings_update ⇒ Array<Types::ReplicaSettingsUpdate>
Represents the settings for a global table in a Region that will be modified.