Policy class
Provides an Application AutoScaling Policy resource.
{{% examples %}}
Example Usage
DynamoDB Table Autoscaling
resource "aws_appautoscaling_target" "dynamodb_table_read_target" {
max_capacity = 100
min_capacity = 5
resource_id = "table/tableName"
scalable_dimension = "dynamodb:table:ReadCapacityUnits"
service_namespace = "dynamodb"
}
resource "aws_appautoscaling_policy" "dynamodb_table_read_policy" {
name = "DynamoDBReadCapacityUtilization:${aws_appautoscaling_target.dynamodb_table_read_target.resource_id}"
policy_type = "TargetTrackingScaling"
resource_id = aws_appautoscaling_target.dynamodb_table_read_target.resource_id
scalable_dimension = aws_appautoscaling_target.dynamodb_table_read_target.scalable_dimension
service_namespace = aws_appautoscaling_target.dynamodb_table_read_target.service_namespace
target_tracking_scaling_policy_configuration {
predefined_metric_specification {
predefined_metric_type = "DynamoDBReadCapacityUtilization"
}
target_value = 70
}
}
ECS Service Autoscaling
resource "aws_appautoscaling_target" "ecs_target" {
max_capacity = 4
min_capacity = 1
resource_id = "service/clusterName/serviceName"
scalable_dimension = "ecs:service:DesiredCount"
service_namespace = "ecs"
}
resource "aws_appautoscaling_policy" "ecs_policy" {
name = "scale-down"
policy_type = "StepScaling"
resource_id = aws_appautoscaling_target.ecs_target.resource_id
scalable_dimension = aws_appautoscaling_target.ecs_target.scalable_dimension
service_namespace = aws_appautoscaling_target.ecs_target.service_namespace
step_scaling_policy_configuration {
adjustment_type = "ChangeInCapacity"
cooldown = 60
metric_aggregation_type = "Maximum"
step_adjustment {
metric_interval_upper_bound = 0
scaling_adjustment = -1
}
}
}
Preserve desired count when updating an autoscaled ECS Service
> To preserve the desiredCount of an autoscaled ECS Service during updates, use the ignoreChanges resource option. This prevents Pulumi from resetting the count that autoscaling has set:
>
> typescript > const ecsService = new aws.ecs.Service("ecsService", { > name: "serviceName", > cluster: "clusterName", > taskDefinition: "taskDefinitionFamily:1", > desiredCount: 2, > }, { > ignoreChanges: ["desiredCount"], > }); >
Aurora Read Replica Autoscaling
resource "aws_appautoscaling_target" "replicas" {
service_namespace = "rds"
scalable_dimension = "rds:cluster:ReadReplicaCount"
resource_id = "cluster:${aws_rds_cluster.example.id}"
min_capacity = 1
max_capacity = 15
}
resource "aws_appautoscaling_policy" "replicas" {
name = "cpu-auto-scaling"
service_namespace = aws_appautoscaling_target.replicas.service_namespace
scalable_dimension = aws_appautoscaling_target.replicas.scalable_dimension
resource_id = aws_appautoscaling_target.replicas.resource_id
policy_type = "TargetTrackingScaling"
target_tracking_scaling_policy_configuration {
predefined_metric_specification {
predefined_metric_type = "RDSReaderAverageCPUUtilization"
}
target_value = 75
scale_in_cooldown = 300
scale_out_cooldown = 300
}
}
Create target tracking scaling policy using metric math
resource "aws_appautoscaling_target" "ecs_target" {
max_capacity = 4
min_capacity = 1
resource_id = "service/clusterName/serviceName"
scalable_dimension = "ecs:service:DesiredCount"
service_namespace = "ecs"
}
resource "aws_appautoscaling_policy" "example" {
name = "foo"
policy_type = "TargetTrackingScaling"
resource_id = aws_appautoscaling_target.ecs_target.resource_id
scalable_dimension = aws_appautoscaling_target.ecs_target.scalable_dimension
service_namespace = aws_appautoscaling_target.ecs_target.service_namespace
target_tracking_scaling_policy_configuration {
target_value = 100
customized_metric_specification {
metrics {
label = "Get the queue size (the number of messages waiting to be processed)"
id = "m1"
metric_stat {
metric {
metric_name = "ApproximateNumberOfMessagesVisible"
namespace = "AWS/SQS"
dimensions {
name = "QueueName"
value = "my-queue"
}
}
stat = "Sum"
}
return_data = false
}
metrics {
label = "Get the ECS running task count (the number of currently running tasks)"
id = "m2"
metric_stat {
metric {
metric_name = "RunningTaskCount"
namespace = "ECS/ContainerInsights"
dimensions {
name = "ClusterName"
value = "default"
}
dimensions {
name = "ServiceName"
value = "web-app"
}
}
stat = "Average"
}
return_data = false
}
metrics {
label = "Calculate the backlog per instance"
id = "e1"
expression = "m1 / m2"
return_data = true
}
}
}
}
Predictive Scaling
resource "aws_appautoscaling_policy" "example" {
name = "example-policy"
resource_id = aws_appautoscaling_target.example.resource_id
scalable_dimension = aws_appautoscaling_target.example.scalable_dimension
service_namespace = aws_appautoscaling_target.example.service_namespace
policy_type = "PredictiveScaling"
predictive_scaling_policy_configuration {
metric_specification {
target_value = 40
predefined_metric_pair_specification {
predefined_metric_type = "ECSServiceMemoryUtilization"
}
}
}
}
MSK / Kafka Autoscaling
resource "aws_appautoscaling_target" "msk_target" {
service_namespace = "kafka"
scalable_dimension = "kafka:broker-storage:VolumeSize"
resource_id = "${aws_msk_cluster.example.arn}"
min_capacity = 1
max_capacity = 8
}
resource "aws_appautoscaling_policy" "targets" {
name = "storage-size-auto-scaling"
service_namespace = aws_appautoscaling_target.msk_target.service_namespace
scalable_dimension = aws_appautoscaling_target.msk_target.scalable_dimension
resource_id = aws_appautoscaling_target.msk_target.resource_id
policy_type = "TargetTrackingScaling"
target_tracking_scaling_policy_configuration {
predefined_metric_specification {
predefined_metric_type = "KafkaBrokerStorageUtilization"
}
target_value = 55
}
}
Import
Identity Schema
Required
name- (String) Name of the scaling policy.resourceId- (String) Resource type and unique identifier string for the resource associated with the scaling policy.scalableDimension- (String) Scalable dimension of the scalable target.serviceNamespace- (String) AWS service namespace of the scalable target.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Application AutoScaling Policy using the service-namespace , resource-id, scalable-dimension and policy-name separated by /. For example:
$ pulumi import aws:appautoscaling/policy:Policy test-policy service-namespace/resource-id/scalable-dimension/policy-name
{{% /examples %}}
Constructors
- Policy(String name, {PolicyArgs? args, CustomResourceOptions? options})
-
Creates a new Policy.
nameThe Pulumi resource name.argsArguments used to configure this Policy. The set of arguments for Policy.optionsResource options controlling this resource's behavior. - Policy.reference(String urn)
- Creates a typed reference to an existing Policy resource.
Properties
-
alarmArns
↔ Output<
List< String> > -
List of CloudWatch alarm ARNs associated with the scaling policy.
latefinal
-
arn
↔ Output<
String> -
ARN assigned by AWS to the scaling policy.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the policy. Must be between 1 and 255 characters in length.
latefinal
-
policyType
↔ Output<
String?> -
Policy type. Valid values are
StepScaling,TargetTrackingScaling, andPredictiveScaling. Defaults toStepScaling. Certain services only support only one policy type. For more information see the Target Tracking Scaling Policies, Step Scaling Policies, and Predictive Scaling documentation.latefinal -
predictiveScalingPolicyConfiguration
↔ Output<
PolicyPredictiveScalingPolicyConfiguration?> -
Predictive scaling policy configuration, requires
policyType = "PredictiveScaling". See supported fields below.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceId
↔ Output<
String> -
Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the
ResourceIdparameter at: AWS Application Auto Scaling API Referencelatefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scalableDimension
↔ Output<
String> -
Scalable dimension of the scalable target. Documentation can be found in the
ScalableDimensionparameter at: AWS Application Auto Scaling API Referencelatefinal -
serviceNamespace
↔ Output<
String> -
AWS service namespace of the scalable target. Documentation can be found in the
ServiceNamespaceparameter at: AWS Application Auto Scaling API Referencelatefinal -
stepScalingPolicyConfiguration
↔ Output<
PolicyStepScalingPolicyConfiguration?> -
Step scaling policy configuration, requires
policyType = "StepScaling"(default). See supported fields below.latefinal -
targetTrackingScalingPolicyConfiguration
↔ Output<
PolicyTargetTrackingScalingPolicyConfiguration?> -
Target tracking policy configuration, requires
policyType = "TargetTrackingScaling". See supported fields below.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited