--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_application_autoscaling_policy{% #aws_application_autoscaling_policy %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `alarms`{% #alarms %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Alarms`**Description**: The CloudWatch alarms associated with the scaling policy. - `alarm_arn`**Type**: `STRING`**Provider name**: `AlarmARN`**Description**: The Amazon Resource Name (ARN) of the alarm. - `alarm_name`**Type**: `STRING`**Provider name**: `AlarmName`**Description**: The name of the alarm. ## `creation_time`{% #creation_time %} **Type**: `TIMESTAMP`**Provider name**: `CreationTime`**Description**: The Unix timestamp for when the scaling policy was created. ## `policy_arn`{% #policy_arn %} **Type**: `STRING`**Provider name**: `PolicyARN`**Description**: The Amazon Resource Name (ARN) of the scaling policy. ## `policy_name`{% #policy_name %} **Type**: `STRING`**Provider name**: `PolicyName`**Description**: The name of the scaling policy. ## `policy_type`{% #policy_type %} **Type**: `STRING`**Provider name**: `PolicyType`**Description**: The scaling policy type. The following policy types are supported: `TargetTrackingScaling`—Not supported for Amazon EMR `StepScaling`—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. ## `resource_id`{% #resource_id %} **Type**: `STRING`**Provider name**: `ResourceId`**Description**: The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. - ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/my-cluster/my-service`. - Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`. - EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`. - AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet`. - DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table`. - DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index`. - Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster`. - SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`. - Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://github.com/aws/aws-auto-scaling-custom-resource). - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`. - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`. - Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`. Example: `function:my-function:prod` or `function:my-function:1`. - Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable`. - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`. - Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster`. - Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`. - SageMaker serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`. - SageMaker inference component - The resource type is `inference-component` and the unique identifier is the resource ID. Example: `inference-component/my-inference-component`. - Pool of WorkSpaces - The resource type is `workspacespool` and the unique identifier is the pool ID. Example: `workspacespool/wspool-123456`. ## `scalable_dimension`{% #scalable_dimension %} **Type**: `STRING`**Provider name**: `ScalableDimension`**Description**: The scalable dimension. This string consists of the service namespace, resource type, and scaling property. - `ecs:service:DesiredCount` - The task count of an ECS service. - `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group. - `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet. - `appstream:fleet:DesiredCapacity` - The capacity of an AppStream 2.0 fleet. - `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table. - `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table. - `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index. - `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index. - `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. - `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant. - `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service. - `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint. - `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. - `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function. - `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table. - `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table. - `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. - `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group. - `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group. - `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster. - `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker serverless endpoint. - `sagemaker:inference-component:DesiredCopyCount` - The number of copies across an endpoint for a SageMaker inference component. - `workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool. ## `service_namespace`{% #service_namespace %} **Type**: `STRING`**Provider name**: `ServiceNamespace`**Description**: The namespace of the Amazon Web Services service that provides the resource, or a `custom-resource`. ## `step_scaling_policy_configuration`{% #step_scaling_policy_configuration %} **Type**: `STRUCT`**Provider name**: `StepScalingPolicyConfiguration`**Description**: A step scaling policy. - `adjustment_type`**Type**: `STRING`**Provider name**: `AdjustmentType`**Description**: Specifies how the `ScalingAdjustment` value in a [StepAdjustment](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) is interpreted (for example, an absolute number or a percentage). The valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`. `AdjustmentType` is required if you are adding a new step scaling policy configuration. - `cooldown`**Type**: `INT32`**Provider name**: `Cooldown`**Description**: The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the Application Auto Scaling User Guide. - `metric_aggregation_type`**Type**: `STRING`**Provider name**: `MetricAggregationType`**Description**: The aggregation type for the CloudWatch metrics. Valid values are `Minimum`, `Maximum`, and `Average`. If the aggregation type is null, the value is treated as `Average`. - `min_adjustment_magnitude`**Type**: `INT32`**Provider name**: `MinAdjustmentMagnitude`**Description**: The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a `MinAdjustmentMagnitude` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a `MinAdjustmentMagnitude` of 2, Application Auto Scaling scales out the service by 2 tasks. - `step_adjustments`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `StepAdjustments`**Description**: A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration. - `metric_interval_lower_bound`**Type**: `DOUBLE`**Provider name**: `MetricIntervalLowerBound`**Description**: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. - `metric_interval_upper_bound`**Type**: `DOUBLE`**Provider name**: `MetricIntervalUpperBound`**Description**: The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound. - `scaling_adjustment`**Type**: `INT32`**Provider name**: `ScalingAdjustment`**Description**: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `target_tracking_scaling_policy_configuration`{% #target_tracking_scaling_policy_configuration %} **Type**: `STRUCT`**Provider name**: `TargetTrackingScalingPolicyConfiguration`**Description**: A target tracking scaling policy. - `customized_metric_specification`**Type**: `STRUCT`**Provider name**: `CustomizedMetricSpecification`**Description**: A customized metric. You can specify either a predefined metric or a customized metric. - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). - `metrics`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Metrics`**Description**: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. - `expression`**Type**: `STRING`**Provider name**: `Expression`**Description**: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. Conditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `id`**Type**: `STRING`**Provider name**: `Id`**Description**: A short name that identifies the object's results in the response. This name must be unique among all `MetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. - `label`**Type**: `STRING`**Provider name**: `Label`**Description**: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. - `metric_stat`**Type**: `STRUCT`**Provider name**: `MetricStat`**Description**: Information about the metric data to return. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `metric`**Type**: `STRUCT`**Provider name**: `Metric`**Description**: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. - `stat`**Type**: `STRING`**Provider name**: `Stat`**Description**: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is `Average`. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `return_data`**Type**: `BOOLEAN`**Provider name**: `ReturnData`**Description**: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData`. This sets it to its default (`true`). - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. - `statistic`**Type**: `STRING`**Provider name**: `Statistic`**Description**: The statistic of the metric. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `disable_scale_in`**Type**: `BOOLEAN`**Provider name**: `DisableScaleIn`**Description**: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is `true`, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is `false`. - `predefined_metric_specification`**Type**: `STRUCT`**Provider name**: `PredefinedMetricSpecification`**Description**: A predefined metric. You can specify either a predefined metric or a customized metric. - `predefined_metric_type`**Type**: `STRING`**Provider name**: `PredefinedMetricType`**Description**: The metric type. The `ALBRequestCountPerTarget` metric type applies only to Spot Fleets and ECS services. - `resource_label`**Type**: `STRING`**Provider name**: `ResourceLabel`**Description**: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is `ALBRequestCountPerTarget` and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`. Where: - app// is the final portion of the load balancer ARN - targetgroup// is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. - `scale_in_cooldown`**Type**: `INT32`**Provider name**: `ScaleInCooldown`**Description**: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the Application Auto Scaling User Guide. - `scale_out_cooldown`**Type**: `INT32`**Provider name**: `ScaleOutCooldown`**Description**: The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the Application Auto Scaling User Guide. - `target_value`**Type**: `DOUBLE`**Provider name**: `TargetValue`**Description**: The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.If the scaling policy specifies the `ALBRequestCountPerTarget` predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.