scaling_policy
Gets an individual scaling_policy
resource
Overview
Name | scaling_policy |
Type | Resource |
Description | scaling_policy |
Id | awscc.applicationautoscaling.scaling_policy |
Fields
Name | Datatype | Description |
---|---|---|
policy_name | string | The name of the scaling policy.<br/><br/>Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name. |
policy_type | string | The scaling policy type.<br/><br/>The following policy types are supported:<br/><br/>TargetTrackingScaling Not supported for Amazon EMR<br/><br/>StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. |
resource_id | string | The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. |
scalable_dimension | string | The scalable dimension. This string consists of the service namespace, resource type, and scaling property. |
scaling_target_id | string | The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource. |
service_namespace | string | The namespace of the AWS service that provides the resource, or a custom-resource. |
step_scaling_policy_configuration | object | A step scaling policy. |
target_tracking_scaling_policy_configuration | object | A target tracking scaling policy. |
arn | string | ARN is a read only property for the resource. |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
policy_name,
policy_type,
resource_id,
scalable_dimension,
scaling_target_id,
service_namespace,
step_scaling_policy_configuration,
target_tracking_scaling_policy_configuration,
arn
FROM awscc.applicationautoscaling.scaling_policy
WHERE data__Identifier = '<Arn>|<ScalableDimension>';
Permissions
To operate on the scaling_policy
resource, the following permissions are required:
Read
application-autoscaling:DescribeScalingPolicies
Update
application-autoscaling:DescribeScalingPolicies,
application-autoscaling:PutScalingPolicy
Delete
application-autoscaling:DescribeScalingPolicies,
application-autoscaling:DeleteScalingPolicy