Update Global Table Settings
dynamodb_update_global_table_settings | R Documentation |
Updates settings for a global table¶
Description¶
Updates settings for a global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Usage¶
dynamodb_update_global_table_settings(GlobalTableName,
GlobalTableBillingMode, GlobalTableProvisionedWriteCapacityUnits,
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate,
GlobalTableGlobalSecondaryIndexSettingsUpdate, ReplicaSettingsUpdate)
Arguments¶
GlobalTableName
[required] The name of the global table
GlobalTableBillingMode
The billing mode of the global table. If
GlobalTableBillingMode
is not specified, the global table defaults toPROVISIONED
capacity billing mode.PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode.PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
GlobalTableProvisionedWriteCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException.
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate
Auto scaling settings for managing provisioned write capacity for the global table.
GlobalTableGlobalSecondaryIndexSettingsUpdate
Represents the settings of a global secondary index for a global table that will be modified.
ReplicaSettingsUpdate
Represents the settings for a global table in a Region that will be modified.
Value¶
A list with the following syntax:
list(
GlobalTableName = "string",
ReplicaSettings = list(
list(
RegionName = "string",
ReplicaStatus = "CREATING"|"CREATION_FAILED"|"UPDATING"|"DELETING"|"ACTIVE"|"REGION_DISABLED"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
ReplicaBillingModeSummary = list(
BillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
LastUpdateToPayPerRequestDateTime = as.POSIXct(
"2015-01-01"
)
),
ReplicaProvisionedReadCapacityUnits = 123,
ReplicaProvisionedReadCapacityAutoScalingSettings = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicies = list(
list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
)
),
ReplicaProvisionedWriteCapacityUnits = 123,
ReplicaProvisionedWriteCapacityAutoScalingSettings = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicies = list(
list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
)
),
ReplicaGlobalSecondaryIndexSettings = list(
list(
IndexName = "string",
IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE",
ProvisionedReadCapacityUnits = 123,
ProvisionedReadCapacityAutoScalingSettings = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicies = list(
list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
)
),
ProvisionedWriteCapacityUnits = 123,
ProvisionedWriteCapacityAutoScalingSettings = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicies = list(
list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
)
)
)
),
ReplicaTableClassSummary = list(
TableClass = "STANDARD"|"STANDARD_INFREQUENT_ACCESS",
LastUpdateDateTime = as.POSIXct(
"2015-01-01"
)
)
)
)
)
Request syntax¶
svc$update_global_table_settings(
GlobalTableName = "string",
GlobalTableBillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
GlobalTableProvisionedWriteCapacityUnits = 123,
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicyUpdate = list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
),
GlobalTableGlobalSecondaryIndexSettingsUpdate = list(
list(
IndexName = "string",
ProvisionedWriteCapacityUnits = 123,
ProvisionedWriteCapacityAutoScalingSettingsUpdate = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicyUpdate = list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
)
)
),
ReplicaSettingsUpdate = list(
list(
RegionName = "string",
ReplicaProvisionedReadCapacityUnits = 123,
ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicyUpdate = list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
),
ReplicaGlobalSecondaryIndexSettingsUpdate = list(
list(
IndexName = "string",
ProvisionedReadCapacityUnits = 123,
ProvisionedReadCapacityAutoScalingSettingsUpdate = list(
MinimumUnits = 123,
MaximumUnits = 123,
AutoScalingDisabled = TRUE|FALSE,
AutoScalingRoleArn = "string",
ScalingPolicyUpdate = list(
PolicyName = "string",
TargetTrackingScalingPolicyConfiguration = list(
DisableScaleIn = TRUE|FALSE,
ScaleInCooldown = 123,
ScaleOutCooldown = 123,
TargetValue = 123.0
)
)
)
)
),
ReplicaTableClass = "STANDARD"|"STANDARD_INFREQUENT_ACCESS"
)
)
)