package awscloudwatch

import (
	"github.com/aws/aws-cdk-go/awscdk/v2"
)

// Properties for a concrete metric.
//
// NOTE: `unit` is no longer on this object since it is only used for `Alarms`, and doesn't mean what one
// would expect it to mean there anyway. It is most likely to be misused.
//
// Example:
//   // The code below shows an example of how to instantiate this type.
//   // The values are placeholders you should change.
//   import cdk "github.com/aws/aws-cdk-go/awscdk"
//   import "github.com/aws/aws-cdk-go/awscdk"
//
//   var value interface{}
//
//   metricStatConfig := &MetricStatConfig{
//   	MetricName: jsii.String("metricName"),
//   	Namespace: jsii.String("namespace"),
//   	Period: cdk.Duration_Minutes(jsii.Number(30)),
//   	Statistic: jsii.String("statistic"),
//
//   	// the properties below are optional
//   	Account: jsii.String("account"),
//   	Dimensions: []dimension{
//   		&dimension{
//   			Name: jsii.String("name"),
//   			Value: value,
//   		},
//   	},
//   	Region: jsii.String("region"),
//   	UnitFilter: awscdk.Aws_cloudwatch.Unit_SECONDS,
//   }
//
type MetricStatConfig struct {
	// Name of the metric.
	MetricName *string `field:"required" json:"metricName" yaml:"metricName"`
	// Namespace of the metric.
	Namespace *string `field:"required" json:"namespace" yaml:"namespace"`
	// How many seconds to aggregate over.
	Period awscdk.Duration `field:"required" json:"period" yaml:"period"`
	// Aggregation function to use (can be either simple or a percentile).
	Statistic *string `field:"required" json:"statistic" yaml:"statistic"`
	// Account which this metric comes from.
	Account *string `field:"optional" json:"account" yaml:"account"`
	// The dimensions to apply to the alarm.
	Dimensions *[]*Dimension `field:"optional" json:"dimensions" yaml:"dimensions"`
	// Region which this metric comes from.
	Region *string `field:"optional" json:"region" yaml:"region"`
	// Unit used to filter the metric stream.
	//
	// Only refer to datums emitted to the metric stream with the given unit and
	// ignore all others. Only useful when datums are being emitted to the same
	// metric stream under different units.
	//
	// This field has been renamed from plain `unit` to clearly communicate
	// its purpose.
	UnitFilter Unit `field:"optional" json:"unitFilter" yaml:"unitFilter"`
}