Put Scaling Policy
| applicationautoscaling_put_scaling_policy | R Documentation |
Creates or updates a scaling policy for an Application Auto Scaling scalable target¶
Description¶
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
Usage¶
applicationautoscaling_put_scaling_policy(PolicyName, ServiceNamespace,
ResourceId, ScalableDimension, PolicyType,
StepScalingPolicyConfiguration,
TargetTrackingScalingPolicyConfiguration,
PredictiveScalingPolicyConfiguration)
Arguments¶
PolicyName |
[required] The name of the scaling policy. You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name. |
ServiceNamespace |
[required] The namespace of the Amazon Web Services service that
provides the resource. For a resource provided by your own application
or service, use |
ResourceId |
[required] The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
|
ScalableDimension |
[required] The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
|
PolicyType |
The scaling policy type. This parameter is required if you are creating a scaling policy. The following policy types are supported:
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. |
StepScalingPolicyConfiguration |
A step scaling policy. This parameter is required if you are creating a policy and the
policy type is |
TargetTrackingScalingPolicyConfiguration |
A target tracking scaling policy. Includes support for predefined or customized metrics. This parameter is required if you are creating a policy and the
policy type is |
PredictiveScalingPolicyConfiguration |
The configuration of the predictive scaling policy. |
Value¶
A list with the following syntax:
list(
PolicyARN = "string",
Alarms = list(
list(
AlarmName = "string",
AlarmARN = "string"
)
)
)
Request syntax¶
svc$put_scaling_policy(
PolicyName = "string",
ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra"|"kafka"|"elasticache"|"neptune"|"workspaces",
ResourceId = "string",
ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|"appstream:fleet:DesiredCapacity"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|"rds:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredInstanceCount"|"custom-resource:ResourceType:Property"|"comprehend:document-classifier-endpoint:DesiredInferenceUnits"|"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"|"lambda:function:ProvisionedConcurrency"|"cassandra:table:ReadCapacityUnits"|"cassandra:table:WriteCapacityUnits"|"kafka:broker-storage:VolumeSize"|"elasticache:replication-group:NodeGroups"|"elasticache:replication-group:Replicas"|"neptune:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredProvisionedConcurrency"|"sagemaker:inference-component:DesiredCopyCount"|"workspaces:workspacespool:DesiredUserSessions",
PolicyType = "StepScaling"|"TargetTrackingScaling"|"PredictiveScaling",
StepScalingPolicyConfiguration = list(
AdjustmentType = "ChangeInCapacity"|"PercentChangeInCapacity"|"ExactCapacity",
StepAdjustments = list(
list(
MetricIntervalLowerBound = 123.0,
MetricIntervalUpperBound = 123.0,
ScalingAdjustment = 123
)
),
MinAdjustmentMagnitude = 123,
Cooldown = 123,
MetricAggregationType = "Average"|"Minimum"|"Maximum"
),
TargetTrackingScalingPolicyConfiguration = list(
TargetValue = 123.0,
PredefinedMetricSpecification = list(
PredefinedMetricType = "DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|"SageMakerVariantInvocationsPerInstance"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"AppStreamAverageCapacityUtilization"|"ComprehendInferenceUtilization"|"LambdaProvisionedConcurrencyUtilization"|"CassandraReadCapacityUtilization"|"CassandraWriteCapacityUtilization"|"KafkaBrokerStorageUtilization"|"ElastiCachePrimaryEngineCPUUtilization"|"ElastiCacheReplicaEngineCPUUtilization"|"ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"|"NeptuneReaderAverageCPUUtilization"|"SageMakerVariantProvisionedConcurrencyUtilization"|"ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage"|"SageMakerInferenceComponentInvocationsPerCopy"|"WorkSpacesAverageUserSessionsCapacityUtilization"|"SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution"|"SageMakerVariantConcurrentRequestsPerModelHighResolution",
ResourceLabel = "string"
),
CustomizedMetricSpecification = list(
MetricName = "string",
Namespace = "string",
Dimensions = list(
list(
Name = "string",
Value = "string"
)
),
Statistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum",
Unit = "string",
Metrics = list(
list(
Expression = "string",
Id = "string",
Label = "string",
MetricStat = list(
Metric = list(
Dimensions = list(
list(
Name = "string",
Value = "string"
)
),
MetricName = "string",
Namespace = "string"
),
Stat = "string",
Unit = "string"
),
ReturnData = TRUE|FALSE
)
)
),
ScaleOutCooldown = 123,
ScaleInCooldown = 123,
DisableScaleIn = TRUE|FALSE
),
PredictiveScalingPolicyConfiguration = list(
MetricSpecifications = list(
list(
TargetValue = 123.0,
PredefinedMetricPairSpecification = list(
PredefinedMetricType = "string",
ResourceLabel = "string"
),
PredefinedScalingMetricSpecification = list(
PredefinedMetricType = "string",
ResourceLabel = "string"
),
PredefinedLoadMetricSpecification = list(
PredefinedMetricType = "string",
ResourceLabel = "string"
),
CustomizedScalingMetricSpecification = list(
MetricDataQueries = list(
list(
Id = "string",
Expression = "string",
MetricStat = list(
Metric = list(
Dimensions = list(
list(
Name = "string",
Value = "string"
)
),
MetricName = "string",
Namespace = "string"
),
Stat = "string",
Unit = "string"
),
Label = "string",
ReturnData = TRUE|FALSE
)
)
),
CustomizedLoadMetricSpecification = list(
MetricDataQueries = list(
list(
Id = "string",
Expression = "string",
MetricStat = list(
Metric = list(
Dimensions = list(
list(
Name = "string",
Value = "string"
)
),
MetricName = "string",
Namespace = "string"
),
Stat = "string",
Unit = "string"
),
Label = "string",
ReturnData = TRUE|FALSE
)
)
),
CustomizedCapacityMetricSpecification = list(
MetricDataQueries = list(
list(
Id = "string",
Expression = "string",
MetricStat = list(
Metric = list(
Dimensions = list(
list(
Name = "string",
Value = "string"
)
),
MetricName = "string",
Namespace = "string"
),
Stat = "string",
Unit = "string"
),
Label = "string",
ReturnData = TRUE|FALSE
)
)
)
)
),
Mode = "ForecastOnly"|"ForecastAndScale",
SchedulingBufferTime = 123,
MaxCapacityBreachBehavior = "HonorMaxCapacity"|"IncreaseMaxCapacity",
MaxCapacityBuffer = 123
)
)
Examples¶
## Not run:
# The following example applies a target tracking scaling policy with a
# predefined metric specification to an Amazon ECS service called web-app
# in the default cluster. The policy keeps the average CPU utilization of
# the service at 75 percent, with scale-out and scale-in cooldown periods
# of 60 seconds.
svc$put_scaling_policy(
PolicyName = "cpu75-target-tracking-scaling-policy",
PolicyType = "TargetTrackingScaling",
ResourceId = "service/default/web-app",
ScalableDimension = "ecs:service:DesiredCount",
ServiceNamespace = "ecs",
TargetTrackingScalingPolicyConfiguration = list(
PredefinedMetricSpecification = list(
PredefinedMetricType = "ECSServiceAverageCPUUtilization"
),
ScaleInCooldown = 60L,
ScaleOutCooldown = 60L,
TargetValue = 75L
)
)
## End(Not run)