Query

aws::autoscaling-plan

Creates a Scaling plan.

Example

aws::autoscaling-plan autoscaling-plan-example
    name: "scaling-plan-example"
    scaling-plan-version: 1.0
    status-code: "Active"

    application-source
        tag-filter
            key: "Name"
            values: ["auto-scaling-group-gyro-1-tag"]
        end
    end

    scaling-instructions
        max-capacity: 100
        min-capacity: 0
        service-namespace: "autoscaling"
        resource-id: "autoScalingGroup/auto-scaling-group-gyro-1"
        scalable-dimension: "autoscaling:autoScalingGroup:DesiredCapacity"

        target-tracking-configurations
            target-value: 2.0

            customized-scaling-metric-specification
                dimensions
                    name: "dimension-test"
                    value: "dimension-test-value"
                end

                metric-name: "metric-name-test"
                namespace: "namespace"
                statistic: "Sum"
            end
        end
    end
end

Attributes

Attribute	Description
application-source subresource	The CloudFormation stack or a set of tag filters. (Required) cloud-formation-stack-arn The arn of a CloudFormation stack. Cannot be set if tag-filter is set. tag-filter list subresource The tag filters for the application source. Cannot be set if cloud-formation-stack-arn is set. Maximum allowed items are 50. key The tag key. Must be alphanumeric characters and symbols excluding basic ASCII control characters. Valid values satisfy the regex: [[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*]. (Required) values list The tag values. Maximum allowed items are 20. Must be alphanumeric characters and symbols excluding basic ASCII control characters. Valid values satisfy the regex: [[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*].
scaling-instructions list subresource	A list of scaling instruction configuration. (Required) customized-load-metric-specification subresource The customized load metric for predictive scaling. dimensions list subresource The dimensions of the metric. name The name of the dimension. (Required) value The value of the dimension. (Required) name The name of the metric. (Required) namespace The namespace of the metric. (Required) statistic The statistic of the metric. Currently the only supported value is Sum. (Required) unit The unit of the metric. disable-dynamic-scaling When set to true the dynamic scaling by AWS Auto Scaling is disabled. max-capacity The maximum capacity of the resource. (Required) min-capacity The minimum capacity of the resource. (Required) predefined-load-metric-specification subresource The predefined load metric to use for predictive scaling. predefined-load-metric-type The metric type. Valid values are ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut or ALBTargetGroupRequestCount. (Required) resource-label The resource associated with the metric type. predictive-scaling-max-capacity-behavior The forecast max capacity behavior that should be applied to the resource. Valid values are SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity or SetMaxCapacityAboveForecastCapacity. predictive-scaling-max-capacity-buffer The size of the capacity buffer. Valid values are between 1 to 100. predictive-scaling-mode The predictive scaling mode. Valid values are ForecastAndScale or ForecastOnly. resource-id The ID of the resource that also specifies the resource type and unique identifier. (Required) scalable-dimension The scalable dimension associated with the resource. Valid values are autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits or dynamodb:index:WriteCapacityUnits. scaling-policy-update-behavior The policy update behavior for the resource. Valid values are KeepExternalPolicies or ReplaceExternalPolicies. scheduled-action-buffer-time The amount of time, in seconds, to buffer the run time of scheduled scaling actions. service-namespace The namespace of the service. Valid values are autoscaling, ecs, ec2, rds or dynamodb. target-tracking-configurations list subresource The target tracking configurations. Maximum allowed items are 10. customized-scaling-metric-specification subresource The customized metric. dimensions list subresource The dimensions of the metric. name The name of the dimension. (Required) value The value of the dimension. (Required) name The name of the metric. (Required) namespace The namespace of the metric. (Required) statistic The statistic of the metric. (Required) unit The unit of the metric. disable-scale-in When set to true, the scale in by the target tracking scaling policy is disabled. estimated-instance-warmup The estimated time (in seconds) until a new instance can contribute to the CloudWatch metrics. predefined-scaling-metric-specification subresource The predefined metric specification. predefined-scaling-metric-type The metric type. Valid values are ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn or EC2SpotFleetRequestAverageNetworkOuts. (Required) resource-label The resource associated with the metric type. scale-in-cooldown The amount of time, in seconds, after a scale in activity completes before another can start. scale-out-cooldown The amount of time in seconds, after a scale out activity completes before another can start. target-value The target value for the metric.
name	The name of the scaling plan. (Required)
scaling-plan-version	The version of the scaling plan.

Outputs

Attribute	Description
creation-time	The time and date when the scaling plan was created.
status-code	The status of the scaling plan.
status-message	The current status of the scaling plan.
status-start-time	The time and date when the scaling plan entered the current status.