This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::AutoScalingPlans::ScalingPlan CustomizedScalingMetricSpecification
<a name="aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification"></a>

`CustomizedScalingMetricSpecification` is a subproperty of [TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html) that specifies a customized scaling metric for a target tracking configuration to use with a scaling plan. 

To create your customized scaling metric specification:
+ Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*. 
+ Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases. 

For information about terminology, available metrics, or how to publish new metrics, see [Amazon CloudWatch Concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*. 

## Syntax
<a name="aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification-syntax.json"></a>

```
{
  "[Dimensions](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions)" : {{[ MetricDimension, ... ]}},
  "[MetricName](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname)" : {{String}},
  "[Namespace](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace)" : {{String}},
  "[Statistic](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic)" : {{String}},
  "[Unit](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit)" : {{String}}
}
```

### YAML
<a name="aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification-syntax.yaml"></a>

```
  [Dimensions](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions): {{
    - MetricDimension}}
  [MetricName](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname): {{String}}
  [Namespace](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace): {{String}}
  [Statistic](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic): {{String}}
  [Unit](#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit): {{String}}
```

## Properties
<a name="aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification-properties"></a>

`Dimensions`  <a name="cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions"></a>
The dimensions of the metric.  
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.  
*Required*: No  
*Type*: Array of [MetricDimension](aws-properties-autoscalingplans-scalingplan-metricdimension.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MetricName`  <a name="cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname"></a>
The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metrics](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).  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespace`  <a name="cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace"></a>
The namespace of the metric.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Statistic`  <a name="cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic"></a>
The statistic of the metric.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Average | Minimum | Maximum | SampleCount | Sum`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Unit`  <a name="cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit"></a>
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*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification--seealso"></a>
+  [Scaling Plans User Guide](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-a-scaling-plan.html)