Class CfnScalingPolicy.TargetTrackingMetricStatProperty

This structure defines the CloudWatch metric to return, along with the statistic and unit.

Inheritance

object

CfnScalingPolicy.TargetTrackingMetricStatProperty

Implements

CfnScalingPolicy.ITargetTrackingMetricStatProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnScalingPolicy.TargetTrackingMetricStatProperty : CfnScalingPolicy.ITargetTrackingMetricStatProperty

Syntax (vb)

Public Class CfnScalingPolicy.TargetTrackingMetricStatProperty Implements CfnScalingPolicy.ITargetTrackingMetricStatProperty

Remarks

TargetTrackingMetricStat is a property of the TargetTrackingMetricDataQuery object.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AutoScaling;

             var targetTrackingMetricStatProperty = new TargetTrackingMetricStatProperty {
                 Metric = new MetricProperty {
                     MetricName = "metricName",
                     Namespace = "namespace",

                     // the properties below are optional
                     Dimensions = new [] { new MetricDimensionProperty {
                         Name = "name",
                         Value = "value"
                     } }
                 },
                 Stat = "stat",

                 // the properties below are optional
                 Period = 123,
                 Unit = "unit"
             };

Synopsis

Constructors

TargetTrackingMetricStatProperty()

This structure defines the CloudWatch metric to return, along with the statistic and unit.

Properties

Metric	The metric to use.
Period	The period of the metric in seconds.
Stat	The statistic to return.
Unit	The unit to use for the returned data points.

Constructors

TargetTrackingMetricStatProperty()

This structure defines the CloudWatch metric to return, along with the statistic and unit.

public TargetTrackingMetricStatProperty()

Remarks

TargetTrackingMetricStat is a property of the TargetTrackingMetricDataQuery object.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AutoScaling;

             var targetTrackingMetricStatProperty = new TargetTrackingMetricStatProperty {
                 Metric = new MetricProperty {
                     MetricName = "metricName",
                     Namespace = "namespace",

                     // the properties below are optional
                     Dimensions = new [] { new MetricDimensionProperty {
                         Name = "name",
                         Value = "value"
                     } }
                 },
                 Stat = "stat",

                 // the properties below are optional
                 Period = 123,
                 Unit = "unit"
             };

Properties

Metric

The metric to use.

public object Metric { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingmetricstat.html#cfn-autoscaling-scalingpolicy-targettrackingmetricstat-metric

Type union: either IResolvable or CfnScalingPolicy.IMetricProperty

Period

The period of the metric in seconds.

public double? Period { get; set; }

Property Value

double?

Remarks

The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see Create a target tracking policy using high-resolution metrics for faster response .

Stat

The statistic to return.

public string Stat { get; set; }

Property Value

string

Remarks

It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .

The most commonly used metric for scaling is Average .

Unit

The unit to use for the returned data points.

public string? Unit { get; set; }

Property Value

string

Remarks

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

Implements

CfnScalingPolicy.ITargetTrackingMetricStatProperty