interface CustomizedMetricSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ApplicationAutoScaling.CfnScalingPolicy.CustomizedMetricSpecificationProperty`
Java	`software.amazon.awscdk.services.applicationautoscaling.CfnScalingPolicy.CustomizedMetricSpecificationProperty`
Python	`aws_cdk.aws_applicationautoscaling.CfnScalingPolicy.CustomizedMetricSpecificationProperty`
TypeScript	`@aws-cdk/aws-applicationautoscaling` » `CfnScalingPolicy` » `CustomizedMetricSpecificationProperty`

Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling.

For information about the available metrics for a service, see AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .

To create your customized metric specification:

Add values for each required parameter 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 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, and increase when capacity decreases.

For an example of how creating new metrics can be useful, see Scaling based on Amazon SQS in the Amazon EC2 Auto Scaling User Guide . This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts .

CustomizedMetricSpecification is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration property type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appscaling from '@aws-cdk/aws-applicationautoscaling';
const customizedMetricSpecificationProperty: appscaling.CfnScalingPolicy.CustomizedMetricSpecificationProperty = {
  metricName: 'metricName',
  namespace: 'namespace',
  statistic: 'statistic',

  // the properties below are optional
  dimensions: [{
    name: 'name',
    value: 'value',
  }],
  unit: 'unit',
};

Properties

Name	Type	Description
metricName	`string`	The name of the metric.
namespace	`string`	The namespace of the metric.
statistic	`string`	The statistic of the metric.
dimensions?	`IResolvable` `\|` `IResolvable` `\|` `MetricDimensionProperty[]`	The dimensions of the metric.
unit?	`string`	The unit of the metric.

metricName

Type: string

The name of the metric.

To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics .

namespace

Type: string

The namespace of the metric.

statistic

Type: string

The statistic of the metric.

dimensions?

Type: IResolvable | IResolvable | MetricDimensionProperty[] (optional)

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

unit?

Type: string (optional)

The unit of the metric.

For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .