-
Notifications
You must be signed in to change notification settings - Fork 17
/
CfnScalingPolicy_MetricStatProperty.go
58 lines (55 loc) · 3.18 KB
/
CfnScalingPolicy_MetricStatProperty.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package awsautoscaling
// `MetricStat` is a property of the [AWS::AutoScaling::ScalingPolicy MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdataquery.html) property type.
//
// This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
//
// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide* .
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// metricStatProperty := &MetricStatProperty{
// Metric: &MetricProperty{
// MetricName: jsii.String("metricName"),
// Namespace: jsii.String("namespace"),
//
// // the properties below are optional
// Dimensions: []interface{}{
// &MetricDimensionProperty{
// Name: jsii.String("name"),
// Value: jsii.String("value"),
// },
// },
// },
// Stat: jsii.String("stat"),
//
// // the properties below are optional
// Unit: jsii.String("unit"),
// }
//
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html
//
type CfnScalingPolicy_MetricStatProperty struct {
// 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) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html#cfn-autoscaling-scalingpolicy-metricstat-metric
//
Metric interface{} `field:"required" json:"metric" yaml:"metric"`
// 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 metrics for predictive scaling are `Average` and `Sum` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html#cfn-autoscaling-scalingpolicy-metricstat-stat
//
Stat *string `field:"required" json:"stat" yaml:"stat"`
// 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* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricstat.html#cfn-autoscaling-scalingpolicy-metricstat-unit
//
Unit *string `field:"optional" json:"unit" yaml:"unit"`
}