AWSAutoScalingCustomizedMetricSpecification

Objective-C

@interface AWSAutoScalingCustomizedMetricSpecification

Swift

class AWSAutoScalingCustomizedMetricSpecification

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized 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 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 more information about the CloudWatch terminology below, see Amazon CloudWatch concepts.

Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

  • The dimensions of the metric.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSAutoScalingMetricDimension *> *_Nullable dimensions;

    Swift

    var dimensions: [AWSAutoScalingMetricDimension]? { get set }

  • The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable metricName;

    Swift

    var metricName: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSAutoScalingTargetTrackingMetricDataQuery *> *_Nullable metrics;

    Swift

    var metrics: [AWSAutoScalingTargetTrackingMetricDataQuery]? { get set }

  • The namespace of the metric.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable namespace;

    Swift

    var namespace: String? { get set }

  • The statistic of the metric.

    Declaration

    Objective-C

    @property (nonatomic) AWSAutoScalingMetricStatistic statistic;

    Swift

    var statistic: AWSAutoScalingMetricStatistic { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable unit;

    Swift

    var unit: String? { get set }