describe-table-replica-auto-scaling¶
Description¶
Describes auto scaling settings across replicas of the global table at once.
Note
This operation only applies to Version 2019.11.21 of global tables.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-table-replica-auto-scaling
--table-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--table-name (string)
The name of the table.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To view auto scaling settings across replicas of a global table
The following describe-table-replica-auto-scaling example displays auto scaling settings across replicas of the MusicCollection global table.
aws dynamodb describe-table-replica-auto-scaling \
--table-name MusicCollection
Output:
{
"TableAutoScalingDescription": {
"TableName": "MusicCollection",
"TableStatus": "ACTIVE",
"Replicas": [
{
"RegionName": "us-east-1",
"GlobalSecondaryIndexes": [],
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"MinimumUnits": 5,
"MaximumUnits": 40000,
"AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable",
"ScalingPolicies": [
{
"PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection",
"TargetTrackingScalingPolicyConfiguration": {
"TargetValue": 70.0
}
}
]
},
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"MinimumUnits": 5,
"MaximumUnits": 40000,
"AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable",
"ScalingPolicies": [
{
"PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection",
"TargetTrackingScalingPolicyConfiguration": {
"TargetValue": 70.0
}
}
]
},
"ReplicaStatus": "ACTIVE"
},
{
"RegionName": "us-east-2",
"GlobalSecondaryIndexes": [],
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"MinimumUnits": 5,
"MaximumUnits": 40000,
"AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable",
"ScalingPolicies": [
{
"PolicyName": "DynamoDBReadCapacityUtilization:table/MusicCollection",
"TargetTrackingScalingPolicyConfiguration": {
"TargetValue": 70.0
}
}
]
},
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"MinimumUnits": 5,
"MaximumUnits": 40000,
"AutoScalingRoleArn": "arn:aws:iam::123456789012:role/aws-service-role/dynamodb.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_DynamoDBTable",
"ScalingPolicies": [
{
"PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection",
"TargetTrackingScalingPolicyConfiguration": {
"TargetValue": 70.0
}
}
]
},
"ReplicaStatus": "ACTIVE"
}
]
}
}
For more information, see DynamoDB Global Tables in the Amazon DynamoDB Developer Guide.
Output¶
TableAutoScalingDescription -> (structure)
Represents the auto scaling properties of the table.
TableName -> (string)
The name of the table.
TableStatus -> (string)
The current state of the table:
CREATING- The table is being created.
UPDATING- The table is being updated.
DELETING- The table is being deleted.
ACTIVE- The table is ready for use.Replicas -> (list)
Represents replicas of the global table.
(structure)
Represents the auto scaling settings of the replica.
RegionName -> (string)
The Region where the replica exists.
GlobalSecondaryIndexes -> (list)
Replica-specific global secondary index auto scaling settings.
(structure)
Represents the auto scaling configuration for a replica global secondary index.
IndexName -> (string)
The name of the global secondary index.
IndexStatus -> (string)
The current state of the replica global secondary index:
CREATING- The index is being created.
UPDATING- The index is being updated.
DELETING- The index is being deleted.
ACTIVE- The index is ready for use.ProvisionedReadCapacityAutoScalingSettings -> (structure)
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits -> (long)
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits -> (long)
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled -> (boolean)
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn -> (string)
Role ARN used for configuring the auto scaling policy.
ScalingPolicies -> (list)
Information about the scaling policies.
(structure)
Represents the properties of the scaling policy.
PolicyName -> (string)
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration -> (structure)
Represents a target tracking scaling policy configuration.
DisableScaleIn -> (boolean)
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown -> (integer)
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown -> (integer)
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue -> (double)
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ProvisionedWriteCapacityAutoScalingSettings -> (structure)
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits -> (long)
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits -> (long)
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled -> (boolean)
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn -> (string)
Role ARN used for configuring the auto scaling policy.
ScalingPolicies -> (list)
Information about the scaling policies.
(structure)
Represents the properties of the scaling policy.
PolicyName -> (string)
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration -> (structure)
Represents a target tracking scaling policy configuration.
DisableScaleIn -> (boolean)
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown -> (integer)
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown -> (integer)
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue -> (double)
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedReadCapacityAutoScalingSettings -> (structure)
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits -> (long)
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits -> (long)
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled -> (boolean)
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn -> (string)
Role ARN used for configuring the auto scaling policy.
ScalingPolicies -> (list)
Information about the scaling policies.
(structure)
Represents the properties of the scaling policy.
PolicyName -> (string)
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration -> (structure)
Represents a target tracking scaling policy configuration.
DisableScaleIn -> (boolean)
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown -> (integer)
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown -> (integer)
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue -> (double)
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedWriteCapacityAutoScalingSettings -> (structure)
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits -> (long)
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits -> (long)
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled -> (boolean)
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn -> (string)
Role ARN used for configuring the auto scaling policy.
ScalingPolicies -> (list)
Information about the scaling policies.
(structure)
Represents the properties of the scaling policy.
PolicyName -> (string)
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration -> (structure)
Represents a target tracking scaling policy configuration.
DisableScaleIn -> (boolean)
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown -> (integer)
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown -> (integer)
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue -> (double)
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaStatus -> (string)
The current state of the replica:
CREATING- The replica is being created.
UPDATING- The replica is being updated.
DELETING- The replica is being deleted.
ACTIVE- The replica is ready for use.