AWS::DynamoDB::GlobalTable CapacityAutoScalingSettings
Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "MaxCapacity" :
Integer
, "MinCapacity" :Integer
, "SeedCapacity" :Integer
, "TargetTrackingScalingPolicyConfiguration" :TargetTrackingScalingPolicyConfiguration
}
YAML
MaxCapacity:
Integer
MinCapacity:Integer
SeedCapacity:Integer
TargetTrackingScalingPolicyConfiguration:TargetTrackingScalingPolicyConfiguration
Properties
MaxCapacity
-
The maximum provisioned capacity units for the global table.
Required: Yes
Type: Integer
Minimum:
1
Update requires: No interruption
MinCapacity
-
The minimum provisioned capacity units for the global table.
Required: Yes
Type: Integer
Minimum:
1
Update requires: No interruption
SeedCapacity
-
When switching billing mode from
PAY_PER_REQUEST
toPROVISIONED
, DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.If you want to switch a table's billing mode from
PAY_PER_REQUEST
toPROVISIONED
, you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either theSeedCapacity
orReadCapacityUnits
properties. For example, if your global secondary indexmyGSI
has aSeedCapacity
of 10 in us-east-1 and a fixedReadCapacityUnits
of 20 in eu-west-1, CloudFormation will initially set the read capacity formyGSI
to 20. Note that if you disableScaleIn
formyGSI
in us-east-1, its read capacity units might not be set back to 10.You must also specify a value for
SeedCapacity
when you plan to switch a table's billing mode fromPROVISIONED
toPAY_PER_REQUEST
, because CloudFormation might need to roll back the operation (reverting the billing mode toPROVISIONED
) and this cannot succeed without specifying a value forSeedCapacity
.Required: No
Type: Integer
Minimum:
1
Update requires: No interruption
TargetTrackingScalingPolicyConfiguration
-
Defines a target tracking scaling policy.
Required: Yes
Type: TargetTrackingScalingPolicyConfiguration
Update requires: No interruption