cloudwatch

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 14, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alarm 

type Alarm struct {
	pulumi.CustomResourceState

	// Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
	ActionsEnabled pulumi.BoolPtrOutput `pulumi:"actionsEnabled"`
	// The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
	AlarmActions pulumi.StringArrayOutput `pulumi:"alarmActions"`
	// The description of the alarm.
	AlarmDescription pulumi.StringPtrOutput `pulumi:"alarmDescription"`
	// The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	AlarmName pulumi.StringPtrOutput `pulumi:"alarmName"`
	// The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
	ComparisonOperator pulumi.StringOutput `pulumi:"comparisonOperator"`
	// The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for “EvaluationPeriods“ is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
	//  If you omit this parameter, CW uses the same value here that you set for “EvaluationPeriods“, and the alarm goes to alarm state if that many consecutive periods are breaching.
	DatapointsToAlarm pulumi.IntPtrOutput `pulumi:"datapointsToAlarm"`
	// The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify “Dimensions“. Instead, you use “Metrics“.
	Dimensions AlarmDimensionArrayOutput `pulumi:"dimensions"`
	// Used only for alarms based on percentiles. If “ignore“, the alarm state does not change during periods with too few data points to be statistically significant. If “evaluate“ or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
	EvaluateLowSampleCountPercentile pulumi.StringPtrOutput `pulumi:"evaluateLowSampleCountPercentile"`
	// The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and “DatapointsToAlarm“ is the M.
	//  For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
	EvaluationPeriods pulumi.IntOutput `pulumi:"evaluationPeriods"`
	// The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
	//  For an alarm based on a metric, you must specify either “Statistic“ or “ExtendedStatistic“ but not both.
	//  For an alarm based on a math expression, you can't specify “ExtendedStatistic“. Instead, you use “Metrics“.
	ExtendedStatistic pulumi.StringPtrOutput `pulumi:"extendedStatistic"`
	// The actions to execute when this alarm transitions to the “INSUFFICIENT_DATA“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	InsufficientDataActions pulumi.StringArrayOutput `pulumi:"insufficientDataActions"`
	// The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use “Metrics“ instead and you can't specify “MetricName“.
	MetricName pulumi.StringPtrOutput `pulumi:"metricName"`
	// An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
	//  If you specify the “Metrics“ parameter, you cannot specify “MetricName“, “Dimensions“, “Period“, “Namespace“, “Statistic“, “ExtendedStatistic“, or “Unit“.
	Metrics AlarmMetricDataQueryArrayOutput `pulumi:"metrics"`
	// The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify “Namespace“ and you use “Metrics“ instead.
	//  For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
	// The actions to execute when this alarm transitions to the “OK“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	OkActions pulumi.StringArrayOutput `pulumi:"okActions"`
	// The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
	//  For an alarm based on a math expression, you can't specify “Period“, and instead you use the “Metrics“ parameter.
	//   *Minimum:* 10
	Period pulumi.IntPtrOutput `pulumi:"period"`
	// The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use “ExtendedStatistic“.
	//  For an alarm based on a metric, you must specify either “Statistic“ or “ExtendedStatistic“ but not both.
	//  For an alarm based on a math expression, you can't specify “Statistic“. Instead, you use “Metrics“.
	Statistic pulumi.StringPtrOutput `pulumi:"statistic"`
	// A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the “cloudwatch:TagResource“ permission.
	//  Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// The value to compare with the specified statistic.
	Threshold pulumi.Float64PtrOutput `pulumi:"threshold"`
	// In an alarm based on an anomaly detection model, this is the ID of the “ANOMALY_DETECTION_BAND“ function used as the threshold for the alarm.
	ThresholdMetricId pulumi.StringPtrOutput `pulumi:"thresholdMetricId"`
	// Sets how this alarm is to handle missing data points. Valid values are “breaching“, “notBreaching“, “ignore“, and “missing“. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
	//  If you omit this parameter, the default behavior of “missing“ is used.
	TreatMissingData pulumi.StringPtrOutput `pulumi:"treatMissingData"`
	// The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a “Metrics“ array.
	//   You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
	Unit pulumi.StringPtrOutput `pulumi:"unit"`
}

The “AWS::CloudWatch::Alarm“ type specifies an alarm and associates it with the specified metric or metric math expression. 

When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

func GetAlarm 

func GetAlarm(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AlarmState, opts ...pulumi.ResourceOption) (*Alarm, error)

GetAlarm gets an existing Alarm resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAlarm 

func NewAlarm(ctx *pulumi.Context,
	name string, args *AlarmArgs, opts ...pulumi.ResourceOption) (*Alarm, error)

NewAlarm registers a new resource with the given unique name, arguments, and options.

func (*Alarm) ElementType 

func (*Alarm) ElementType() reflect.Type

func (*Alarm) ToAlarmOutput 

func (i *Alarm) ToAlarmOutput() AlarmOutput

func (*Alarm) ToAlarmOutputWithContext 

func (i *Alarm) ToAlarmOutputWithContext(ctx context.Context) AlarmOutput

type AlarmArgs 

type AlarmArgs struct {
	// Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
	ActionsEnabled pulumi.BoolPtrInput
	// The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
	AlarmActions pulumi.StringArrayInput
	// The description of the alarm.
	AlarmDescription pulumi.StringPtrInput
	// The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	AlarmName pulumi.StringPtrInput
	// The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
	ComparisonOperator pulumi.StringInput
	// The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for “EvaluationPeriods“ is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
	//  If you omit this parameter, CW uses the same value here that you set for “EvaluationPeriods“, and the alarm goes to alarm state if that many consecutive periods are breaching.
	DatapointsToAlarm pulumi.IntPtrInput
	// The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify “Dimensions“. Instead, you use “Metrics“.
	Dimensions AlarmDimensionArrayInput
	// Used only for alarms based on percentiles. If “ignore“, the alarm state does not change during periods with too few data points to be statistically significant. If “evaluate“ or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
	EvaluateLowSampleCountPercentile pulumi.StringPtrInput
	// The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and “DatapointsToAlarm“ is the M.
	//  For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
	EvaluationPeriods pulumi.IntInput
	// The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
	//  For an alarm based on a metric, you must specify either “Statistic“ or “ExtendedStatistic“ but not both.
	//  For an alarm based on a math expression, you can't specify “ExtendedStatistic“. Instead, you use “Metrics“.
	ExtendedStatistic pulumi.StringPtrInput
	// The actions to execute when this alarm transitions to the “INSUFFICIENT_DATA“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	InsufficientDataActions pulumi.StringArrayInput
	// The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use “Metrics“ instead and you can't specify “MetricName“.
	MetricName pulumi.StringPtrInput
	// An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
	//  If you specify the “Metrics“ parameter, you cannot specify “MetricName“, “Dimensions“, “Period“, “Namespace“, “Statistic“, “ExtendedStatistic“, or “Unit“.
	Metrics AlarmMetricDataQueryArrayInput
	// The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify “Namespace“ and you use “Metrics“ instead.
	//  For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	Namespace pulumi.StringPtrInput
	// The actions to execute when this alarm transitions to the “OK“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	OkActions pulumi.StringArrayInput
	// The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
	//  For an alarm based on a math expression, you can't specify “Period“, and instead you use the “Metrics“ parameter.
	//   *Minimum:* 10
	Period pulumi.IntPtrInput
	// The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use “ExtendedStatistic“.
	//  For an alarm based on a metric, you must specify either “Statistic“ or “ExtendedStatistic“ but not both.
	//  For an alarm based on a math expression, you can't specify “Statistic“. Instead, you use “Metrics“.
	Statistic pulumi.StringPtrInput
	// A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the “cloudwatch:TagResource“ permission.
	//  Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	Tags aws.TagArrayInput
	// The value to compare with the specified statistic.
	Threshold pulumi.Float64PtrInput
	// In an alarm based on an anomaly detection model, this is the ID of the “ANOMALY_DETECTION_BAND“ function used as the threshold for the alarm.
	ThresholdMetricId pulumi.StringPtrInput
	// Sets how this alarm is to handle missing data points. Valid values are “breaching“, “notBreaching“, “ignore“, and “missing“. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
	//  If you omit this parameter, the default behavior of “missing“ is used.
	TreatMissingData pulumi.StringPtrInput
	// The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a “Metrics“ array.
	//   You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
	Unit pulumi.StringPtrInput
}

The set of arguments for constructing a Alarm resource.

func (AlarmArgs) ElementType 

func (AlarmArgs) ElementType() reflect.Type

type AlarmDimension 

type AlarmDimension struct {
	// The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.
	Name string `pulumi:"name"`
	// The value for the dimension, from 1–255 characters in length.
	Value string `pulumi:"value"`
}

Dimension is an embedded property of the “AWS::CloudWatch::Alarm“ type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.

type AlarmDimensionArgs 

type AlarmDimensionArgs struct {
	// The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.
	Name pulumi.StringInput `pulumi:"name"`
	// The value for the dimension, from 1–255 characters in length.
	Value pulumi.StringInput `pulumi:"value"`
}

Dimension is an embedded property of the “AWS::CloudWatch::Alarm“ type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.

func (AlarmDimensionArgs) ElementType 

func (AlarmDimensionArgs) ElementType() reflect.Type

func (AlarmDimensionArgs) ToAlarmDimensionOutput 

func (i AlarmDimensionArgs) ToAlarmDimensionOutput() AlarmDimensionOutput

func (AlarmDimensionArgs) ToAlarmDimensionOutputWithContext 

func (i AlarmDimensionArgs) ToAlarmDimensionOutputWithContext(ctx context.Context) AlarmDimensionOutput

type AlarmDimensionArray 

type AlarmDimensionArray []AlarmDimensionInput

func (AlarmDimensionArray) ElementType 

func (AlarmDimensionArray) ElementType() reflect.Type

func (AlarmDimensionArray) ToAlarmDimensionArrayOutput 

func (i AlarmDimensionArray) ToAlarmDimensionArrayOutput() AlarmDimensionArrayOutput

func (AlarmDimensionArray) ToAlarmDimensionArrayOutputWithContext 

func (i AlarmDimensionArray) ToAlarmDimensionArrayOutputWithContext(ctx context.Context) AlarmDimensionArrayOutput

type AlarmDimensionArrayInput 

type AlarmDimensionArrayInput interface {
	pulumi.Input

	ToAlarmDimensionArrayOutput() AlarmDimensionArrayOutput
	ToAlarmDimensionArrayOutputWithContext(context.Context) AlarmDimensionArrayOutput
}

AlarmDimensionArrayInput is an input type that accepts AlarmDimensionArray and AlarmDimensionArrayOutput values. You can construct a concrete instance of `AlarmDimensionArrayInput` via: 

AlarmDimensionArray{ AlarmDimensionArgs{...} }

type AlarmDimensionArrayOutput 

type AlarmDimensionArrayOutput struct{ *pulumi.OutputState }

func (AlarmDimensionArrayOutput) ElementType 

func (AlarmDimensionArrayOutput) ElementType() reflect.Type

func (AlarmDimensionArrayOutput) Index 

func (o AlarmDimensionArrayOutput) Index(i pulumi.IntInput) AlarmDimensionOutput

func (AlarmDimensionArrayOutput) ToAlarmDimensionArrayOutput 

func (o AlarmDimensionArrayOutput) ToAlarmDimensionArrayOutput() AlarmDimensionArrayOutput

func (AlarmDimensionArrayOutput) ToAlarmDimensionArrayOutputWithContext 

func (o AlarmDimensionArrayOutput) ToAlarmDimensionArrayOutputWithContext(ctx context.Context) AlarmDimensionArrayOutput

type AlarmDimensionInput 

type AlarmDimensionInput interface {
	pulumi.Input

	ToAlarmDimensionOutput() AlarmDimensionOutput
	ToAlarmDimensionOutputWithContext(context.Context) AlarmDimensionOutput
}

AlarmDimensionInput is an input type that accepts AlarmDimensionArgs and AlarmDimensionOutput values. You can construct a concrete instance of `AlarmDimensionInput` via: 

AlarmDimensionArgs{...}

type AlarmDimensionOutput 

type AlarmDimensionOutput struct{ *pulumi.OutputState }

Dimension is an embedded property of the “AWS::CloudWatch::Alarm“ type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.

func (AlarmDimensionOutput) ElementType 

func (AlarmDimensionOutput) ElementType() reflect.Type

func (AlarmDimensionOutput) Name 

func (o AlarmDimensionOutput) Name() pulumi.StringOutput

The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.

func (AlarmDimensionOutput) ToAlarmDimensionOutput 

func (o AlarmDimensionOutput) ToAlarmDimensionOutput() AlarmDimensionOutput

func (AlarmDimensionOutput) ToAlarmDimensionOutputWithContext 

func (o AlarmDimensionOutput) ToAlarmDimensionOutputWithContext(ctx context.Context) AlarmDimensionOutput

func (AlarmDimensionOutput) Value 

func (o AlarmDimensionOutput) Value() pulumi.StringOutput

The value for the dimension, from 1–255 characters in length.

type AlarmInput 

type AlarmInput interface {
	pulumi.Input

	ToAlarmOutput() AlarmOutput
	ToAlarmOutputWithContext(ctx context.Context) AlarmOutput
}

type AlarmMetric 

type AlarmMetric struct {
	// The metric dimensions that you want to be used for the metric that the alarm will watch.
	Dimensions []AlarmDimension `pulumi:"dimensions"`
	// The name of the metric that you want the alarm to watch. This is a required field.
	MetricName *string `pulumi:"metricName"`
	// The namespace of the metric that the alarm will watch.
	Namespace *string `pulumi:"namespace"`
}

The “Metric“ property type represents a specific metric. “Metric“ is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.

type AlarmMetricArgs 

type AlarmMetricArgs struct {
	// The metric dimensions that you want to be used for the metric that the alarm will watch.
	Dimensions AlarmDimensionArrayInput `pulumi:"dimensions"`
	// The name of the metric that you want the alarm to watch. This is a required field.
	MetricName pulumi.StringPtrInput `pulumi:"metricName"`
	// The namespace of the metric that the alarm will watch.
	Namespace pulumi.StringPtrInput `pulumi:"namespace"`
}

The “Metric“ property type represents a specific metric. “Metric“ is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.

func (AlarmMetricArgs) ElementType 

func (AlarmMetricArgs) ElementType() reflect.Type

func (AlarmMetricArgs) ToAlarmMetricOutput 

func (i AlarmMetricArgs) ToAlarmMetricOutput() AlarmMetricOutput

func (AlarmMetricArgs) ToAlarmMetricOutputWithContext 

func (i AlarmMetricArgs) ToAlarmMetricOutputWithContext(ctx context.Context) AlarmMetricOutput

func (AlarmMetricArgs) ToAlarmMetricPtrOutput 

func (i AlarmMetricArgs) ToAlarmMetricPtrOutput() AlarmMetricPtrOutput

func (AlarmMetricArgs) ToAlarmMetricPtrOutputWithContext 

func (i AlarmMetricArgs) ToAlarmMetricPtrOutputWithContext(ctx context.Context) AlarmMetricPtrOutput

type AlarmMetricDataQuery 

type AlarmMetricDataQuery struct {
	// The ID of the account where the metrics are located, if this is a cross-account alarm.
	AccountId *string `pulumi:"accountId"`
	// The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the “Id“ of the other metrics to refer to those metrics, and can also use the “Id“ of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.
	//  Within each MetricDataQuery object, you must specify either “Expression“ or “MetricStat“ but not both.
	Expression *string `pulumi:"expression"`
	// A short name used to tie this object to the results in the response. This name must be unique within a single call to “GetMetricData“. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
	Id string `pulumi:"id"`
	// A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If “Label“ is omitted, CW generates a default.
	Label *string `pulumi:"label"`
	// The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
	//  Within one MetricDataQuery object, you must specify either “Expression“ or “MetricStat“ but not both.
	MetricStat *AlarmMetricStat `pulumi:"metricStat"`
	// The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ operation that includes a “StorageResolution of 1 second“.
	Period *int `pulumi:"period"`
	// This option indicates whether to return the timestamps and raw data values of this metric.
	//  When you create an alarm based on a metric math expression, specify “True“ for this value for only the one math expression that the alarm is based on. You must specify “False“ for “ReturnData“ for all the other metrics and expressions used in the alarm.
	//  This field is required.
	ReturnData *bool `pulumi:"returnData"`
}

The “MetricDataQuery“ property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. 

Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.

type AlarmMetricDataQueryArgs 

type AlarmMetricDataQueryArgs struct {
	// The ID of the account where the metrics are located, if this is a cross-account alarm.
	AccountId pulumi.StringPtrInput `pulumi:"accountId"`
	// The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the “Id“ of the other metrics to refer to those metrics, and can also use the “Id“ of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.
	//  Within each MetricDataQuery object, you must specify either “Expression“ or “MetricStat“ but not both.
	Expression pulumi.StringPtrInput `pulumi:"expression"`
	// A short name used to tie this object to the results in the response. This name must be unique within a single call to “GetMetricData“. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
	Id pulumi.StringInput `pulumi:"id"`
	// A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If “Label“ is omitted, CW generates a default.
	Label pulumi.StringPtrInput `pulumi:"label"`
	// The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
	//  Within one MetricDataQuery object, you must specify either “Expression“ or “MetricStat“ but not both.
	MetricStat AlarmMetricStatPtrInput `pulumi:"metricStat"`
	// The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ operation that includes a “StorageResolution of 1 second“.
	Period pulumi.IntPtrInput `pulumi:"period"`
	// This option indicates whether to return the timestamps and raw data values of this metric.
	//  When you create an alarm based on a metric math expression, specify “True“ for this value for only the one math expression that the alarm is based on. You must specify “False“ for “ReturnData“ for all the other metrics and expressions used in the alarm.
	//  This field is required.
	ReturnData pulumi.BoolPtrInput `pulumi:"returnData"`
}

The “MetricDataQuery“ property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. 

Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.

func (AlarmMetricDataQueryArgs) ElementType 

func (AlarmMetricDataQueryArgs) ElementType() reflect.Type

func (AlarmMetricDataQueryArgs) ToAlarmMetricDataQueryOutput 

func (i AlarmMetricDataQueryArgs) ToAlarmMetricDataQueryOutput() AlarmMetricDataQueryOutput

func (AlarmMetricDataQueryArgs) ToAlarmMetricDataQueryOutputWithContext 

func (i AlarmMetricDataQueryArgs) ToAlarmMetricDataQueryOutputWithContext(ctx context.Context) AlarmMetricDataQueryOutput

type AlarmMetricDataQueryArray 

type AlarmMetricDataQueryArray []AlarmMetricDataQueryInput

func (AlarmMetricDataQueryArray) ElementType 

func (AlarmMetricDataQueryArray) ElementType() reflect.Type

func (AlarmMetricDataQueryArray) ToAlarmMetricDataQueryArrayOutput 

func (i AlarmMetricDataQueryArray) ToAlarmMetricDataQueryArrayOutput() AlarmMetricDataQueryArrayOutput

func (AlarmMetricDataQueryArray) ToAlarmMetricDataQueryArrayOutputWithContext 

func (i AlarmMetricDataQueryArray) ToAlarmMetricDataQueryArrayOutputWithContext(ctx context.Context) AlarmMetricDataQueryArrayOutput

type AlarmMetricDataQueryArrayInput 

type AlarmMetricDataQueryArrayInput interface {
	pulumi.Input

	ToAlarmMetricDataQueryArrayOutput() AlarmMetricDataQueryArrayOutput
	ToAlarmMetricDataQueryArrayOutputWithContext(context.Context) AlarmMetricDataQueryArrayOutput
}

AlarmMetricDataQueryArrayInput is an input type that accepts AlarmMetricDataQueryArray and AlarmMetricDataQueryArrayOutput values. You can construct a concrete instance of `AlarmMetricDataQueryArrayInput` via: 

AlarmMetricDataQueryArray{ AlarmMetricDataQueryArgs{...} }

type AlarmMetricDataQueryArrayOutput 

type AlarmMetricDataQueryArrayOutput struct{ *pulumi.OutputState }

func (AlarmMetricDataQueryArrayOutput) ElementType 

func (AlarmMetricDataQueryArrayOutput) ElementType() reflect.Type

func (AlarmMetricDataQueryArrayOutput) Index 

func (o AlarmMetricDataQueryArrayOutput) Index(i pulumi.IntInput) AlarmMetricDataQueryOutput

func (AlarmMetricDataQueryArrayOutput) ToAlarmMetricDataQueryArrayOutput 

func (o AlarmMetricDataQueryArrayOutput) ToAlarmMetricDataQueryArrayOutput() AlarmMetricDataQueryArrayOutput

func (AlarmMetricDataQueryArrayOutput) ToAlarmMetricDataQueryArrayOutputWithContext 

func (o AlarmMetricDataQueryArrayOutput) ToAlarmMetricDataQueryArrayOutputWithContext(ctx context.Context) AlarmMetricDataQueryArrayOutput

type AlarmMetricDataQueryInput 

type AlarmMetricDataQueryInput interface {
	pulumi.Input

	ToAlarmMetricDataQueryOutput() AlarmMetricDataQueryOutput
	ToAlarmMetricDataQueryOutputWithContext(context.Context) AlarmMetricDataQueryOutput
}

AlarmMetricDataQueryInput is an input type that accepts AlarmMetricDataQueryArgs and AlarmMetricDataQueryOutput values. You can construct a concrete instance of `AlarmMetricDataQueryInput` via: 

AlarmMetricDataQueryArgs{...}

type AlarmMetricDataQueryOutput 

type AlarmMetricDataQueryOutput struct{ *pulumi.OutputState }

The “MetricDataQuery“ property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. 

Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.

func (AlarmMetricDataQueryOutput) AccountId 

func (o AlarmMetricDataQueryOutput) AccountId() pulumi.StringPtrOutput

The ID of the account where the metrics are located, if this is a cross-account alarm.

func (AlarmMetricDataQueryOutput) ElementType 

func (AlarmMetricDataQueryOutput) ElementType() reflect.Type

func (AlarmMetricDataQueryOutput) Expression 

func (o AlarmMetricDataQueryOutput) Expression() pulumi.StringPtrOutput

The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the “Id“ of the other metrics to refer to those metrics, and can also use the “Id“ of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. 

Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.

func (AlarmMetricDataQueryOutput) Id 

func (o AlarmMetricDataQueryOutput) Id() pulumi.StringOutput

A short name used to tie this object to the results in the response. This name must be unique within a single call to “GetMetricData“. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

func (AlarmMetricDataQueryOutput) Label 

func (o AlarmMetricDataQueryOutput) Label() pulumi.StringPtrOutput

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If “Label“ is omitted, CW generates a default.

func (AlarmMetricDataQueryOutput) MetricStat 

func (o AlarmMetricDataQueryOutput) MetricStat() AlarmMetricStatPtrOutput

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. 

Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.

func (AlarmMetricDataQueryOutput) Period 

func (o AlarmMetricDataQueryOutput) Period() pulumi.IntPtrOutput

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ operation that includes a “StorageResolution of 1 second“.

func (AlarmMetricDataQueryOutput) ReturnData 

func (o AlarmMetricDataQueryOutput) ReturnData() pulumi.BoolPtrOutput

This option indicates whether to return the timestamps and raw data values of this metric. 

When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.
This field is required.

func (AlarmMetricDataQueryOutput) ToAlarmMetricDataQueryOutput 

func (o AlarmMetricDataQueryOutput) ToAlarmMetricDataQueryOutput() AlarmMetricDataQueryOutput

func (AlarmMetricDataQueryOutput) ToAlarmMetricDataQueryOutputWithContext 

func (o AlarmMetricDataQueryOutput) ToAlarmMetricDataQueryOutputWithContext(ctx context.Context) AlarmMetricDataQueryOutput

type AlarmMetricInput 

type AlarmMetricInput interface {
	pulumi.Input

	ToAlarmMetricOutput() AlarmMetricOutput
	ToAlarmMetricOutputWithContext(context.Context) AlarmMetricOutput
}

AlarmMetricInput is an input type that accepts AlarmMetricArgs and AlarmMetricOutput values. You can construct a concrete instance of `AlarmMetricInput` via: 

AlarmMetricArgs{...}

type AlarmMetricOutput 

type AlarmMetricOutput struct{ *pulumi.OutputState }

The “Metric“ property type represents a specific metric. “Metric“ is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.

func (AlarmMetricOutput) Dimensions 

func (o AlarmMetricOutput) Dimensions() AlarmDimensionArrayOutput

The metric dimensions that you want to be used for the metric that the alarm will watch.

func (AlarmMetricOutput) ElementType 

func (AlarmMetricOutput) ElementType() reflect.Type

func (AlarmMetricOutput) MetricName 

func (o AlarmMetricOutput) MetricName() pulumi.StringPtrOutput

The name of the metric that you want the alarm to watch. This is a required field.

func (AlarmMetricOutput) Namespace 

func (o AlarmMetricOutput) Namespace() pulumi.StringPtrOutput

The namespace of the metric that the alarm will watch.

func (AlarmMetricOutput) ToAlarmMetricOutput 

func (o AlarmMetricOutput) ToAlarmMetricOutput() AlarmMetricOutput

func (AlarmMetricOutput) ToAlarmMetricOutputWithContext 

func (o AlarmMetricOutput) ToAlarmMetricOutputWithContext(ctx context.Context) AlarmMetricOutput

func (AlarmMetricOutput) ToAlarmMetricPtrOutput 

func (o AlarmMetricOutput) ToAlarmMetricPtrOutput() AlarmMetricPtrOutput

func (AlarmMetricOutput) ToAlarmMetricPtrOutputWithContext 

func (o AlarmMetricOutput) ToAlarmMetricPtrOutputWithContext(ctx context.Context) AlarmMetricPtrOutput

type AlarmMetricPtrInput 

type AlarmMetricPtrInput interface {
	pulumi.Input

	ToAlarmMetricPtrOutput() AlarmMetricPtrOutput
	ToAlarmMetricPtrOutputWithContext(context.Context) AlarmMetricPtrOutput
}

AlarmMetricPtrInput is an input type that accepts AlarmMetricArgs, AlarmMetricPtr and AlarmMetricPtrOutput values. You can construct a concrete instance of `AlarmMetricPtrInput` via: 

        AlarmMetricArgs{...}

or:

        nil

func AlarmMetricPtr 

func AlarmMetricPtr(v *AlarmMetricArgs) AlarmMetricPtrInput

type AlarmMetricPtrOutput 

type AlarmMetricPtrOutput struct{ *pulumi.OutputState }

func (AlarmMetricPtrOutput) Dimensions 

func (o AlarmMetricPtrOutput) Dimensions() AlarmDimensionArrayOutput

The metric dimensions that you want to be used for the metric that the alarm will watch.

func (AlarmMetricPtrOutput) Elem 

func (o AlarmMetricPtrOutput) Elem() AlarmMetricOutput

func (AlarmMetricPtrOutput) ElementType 

func (AlarmMetricPtrOutput) ElementType() reflect.Type

func (AlarmMetricPtrOutput) MetricName 

func (o AlarmMetricPtrOutput) MetricName() pulumi.StringPtrOutput

The name of the metric that you want the alarm to watch. This is a required field.

func (AlarmMetricPtrOutput) Namespace 

func (o AlarmMetricPtrOutput) Namespace() pulumi.StringPtrOutput

The namespace of the metric that the alarm will watch.

func (AlarmMetricPtrOutput) ToAlarmMetricPtrOutput 

func (o AlarmMetricPtrOutput) ToAlarmMetricPtrOutput() AlarmMetricPtrOutput

func (AlarmMetricPtrOutput) ToAlarmMetricPtrOutputWithContext 

func (o AlarmMetricPtrOutput) ToAlarmMetricPtrOutputWithContext(ctx context.Context) AlarmMetricPtrOutput

type AlarmMetricStat 

type AlarmMetricStat struct {
	// The metric to return, including the metric name, namespace, and dimensions.
	Metric AlarmMetric `pulumi:"metric"`
	// The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ call that includes a “StorageResolution“ of 1 second.
	//  If the “StartTime“ parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
	//   +  Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
	//   +  Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
	//   +  Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
	Period int `pulumi:"period"`
	// The statistic to return. It can include any CW 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 *User Guide*.
	Stat string `pulumi:"stat"`
	// The unit to use for the returned data points.
	//  Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
	Unit *string `pulumi:"unit"`
}

This structure defines the metric to be returned, along with the statistics, period, and units. 

``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.

type AlarmMetricStatArgs 

type AlarmMetricStatArgs struct {
	// The metric to return, including the metric name, namespace, and dimensions.
	Metric AlarmMetricInput `pulumi:"metric"`
	// The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ call that includes a “StorageResolution“ of 1 second.
	//  If the “StartTime“ parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
	//   +  Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
	//   +  Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
	//   +  Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
	Period pulumi.IntInput `pulumi:"period"`
	// The statistic to return. It can include any CW 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 *User Guide*.
	Stat pulumi.StringInput `pulumi:"stat"`
	// The unit to use for the returned data points.
	//  Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
	Unit pulumi.StringPtrInput `pulumi:"unit"`
}

This structure defines the metric to be returned, along with the statistics, period, and units. 

``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.

func (AlarmMetricStatArgs) ElementType 

func (AlarmMetricStatArgs) ElementType() reflect.Type

func (AlarmMetricStatArgs) ToAlarmMetricStatOutput 

func (i AlarmMetricStatArgs) ToAlarmMetricStatOutput() AlarmMetricStatOutput

func (AlarmMetricStatArgs) ToAlarmMetricStatOutputWithContext 

func (i AlarmMetricStatArgs) ToAlarmMetricStatOutputWithContext(ctx context.Context) AlarmMetricStatOutput

func (AlarmMetricStatArgs) ToAlarmMetricStatPtrOutput 

func (i AlarmMetricStatArgs) ToAlarmMetricStatPtrOutput() AlarmMetricStatPtrOutput

func (AlarmMetricStatArgs) ToAlarmMetricStatPtrOutputWithContext 

func (i AlarmMetricStatArgs) ToAlarmMetricStatPtrOutputWithContext(ctx context.Context) AlarmMetricStatPtrOutput

type AlarmMetricStatInput 

type AlarmMetricStatInput interface {
	pulumi.Input

	ToAlarmMetricStatOutput() AlarmMetricStatOutput
	ToAlarmMetricStatOutputWithContext(context.Context) AlarmMetricStatOutput
}

AlarmMetricStatInput is an input type that accepts AlarmMetricStatArgs and AlarmMetricStatOutput values. You can construct a concrete instance of `AlarmMetricStatInput` via: 

AlarmMetricStatArgs{...}

type AlarmMetricStatOutput 

type AlarmMetricStatOutput struct{ *pulumi.OutputState }

This structure defines the metric to be returned, along with the statistics, period, and units. 

``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.

func (AlarmMetricStatOutput) ElementType 

func (AlarmMetricStatOutput) ElementType() reflect.Type

func (AlarmMetricStatOutput) Metric 

func (o AlarmMetricStatOutput) Metric() AlarmMetricOutput

The metric to return, including the metric name, namespace, and dimensions.

func (AlarmMetricStatOutput) Period 

func (o AlarmMetricStatOutput) Period() pulumi.IntOutput

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ call that includes a “StorageResolution“ of 1 second. 

If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
 +  Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
 +  Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
 +  Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

func (AlarmMetricStatOutput) Stat 

func (o AlarmMetricStatOutput) Stat() pulumi.StringOutput

The statistic to return. It can include any CW 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 *User Guide*.

func (AlarmMetricStatOutput) ToAlarmMetricStatOutput 

func (o AlarmMetricStatOutput) ToAlarmMetricStatOutput() AlarmMetricStatOutput

func (AlarmMetricStatOutput) ToAlarmMetricStatOutputWithContext 

func (o AlarmMetricStatOutput) ToAlarmMetricStatOutputWithContext(ctx context.Context) AlarmMetricStatOutput

func (AlarmMetricStatOutput) ToAlarmMetricStatPtrOutput 

func (o AlarmMetricStatOutput) ToAlarmMetricStatPtrOutput() AlarmMetricStatPtrOutput

func (AlarmMetricStatOutput) ToAlarmMetricStatPtrOutputWithContext 

func (o AlarmMetricStatOutput) ToAlarmMetricStatPtrOutputWithContext(ctx context.Context) AlarmMetricStatPtrOutput

func (AlarmMetricStatOutput) Unit 

func (o AlarmMetricStatOutput) Unit() pulumi.StringPtrOutput

The unit to use for the returned data points. 

Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

type AlarmMetricStatPtrInput 

type AlarmMetricStatPtrInput interface {
	pulumi.Input

	ToAlarmMetricStatPtrOutput() AlarmMetricStatPtrOutput
	ToAlarmMetricStatPtrOutputWithContext(context.Context) AlarmMetricStatPtrOutput
}

AlarmMetricStatPtrInput is an input type that accepts AlarmMetricStatArgs, AlarmMetricStatPtr and AlarmMetricStatPtrOutput values. You can construct a concrete instance of `AlarmMetricStatPtrInput` via: 

        AlarmMetricStatArgs{...}

or:

        nil

func AlarmMetricStatPtr 

func AlarmMetricStatPtr(v *AlarmMetricStatArgs) AlarmMetricStatPtrInput

type AlarmMetricStatPtrOutput 

type AlarmMetricStatPtrOutput struct{ *pulumi.OutputState }

func (AlarmMetricStatPtrOutput) Elem 

func (o AlarmMetricStatPtrOutput) Elem() AlarmMetricStatOutput

func (AlarmMetricStatPtrOutput) ElementType 

func (AlarmMetricStatPtrOutput) ElementType() reflect.Type

func (AlarmMetricStatPtrOutput) Metric 

func (o AlarmMetricStatPtrOutput) Metric() AlarmMetricPtrOutput

The metric to return, including the metric name, namespace, and dimensions.

func (AlarmMetricStatPtrOutput) Period 

func (o AlarmMetricStatPtrOutput) Period() pulumi.IntPtrOutput

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a “PutMetricData“ call that includes a “StorageResolution“ of 1 second. 

If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
 +  Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
 +  Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
 +  Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

func (AlarmMetricStatPtrOutput) Stat 

func (o AlarmMetricStatPtrOutput) Stat() pulumi.StringPtrOutput

The statistic to return. It can include any CW 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 *User Guide*.

func (AlarmMetricStatPtrOutput) ToAlarmMetricStatPtrOutput 

func (o AlarmMetricStatPtrOutput) ToAlarmMetricStatPtrOutput() AlarmMetricStatPtrOutput

func (AlarmMetricStatPtrOutput) ToAlarmMetricStatPtrOutputWithContext 

func (o AlarmMetricStatPtrOutput) ToAlarmMetricStatPtrOutputWithContext(ctx context.Context) AlarmMetricStatPtrOutput

func (AlarmMetricStatPtrOutput) Unit 

func (o AlarmMetricStatPtrOutput) Unit() pulumi.StringPtrOutput

The unit to use for the returned data points. 

Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

type AlarmOutput 

type AlarmOutput struct{ *pulumi.OutputState }

func (AlarmOutput) ActionsEnabled added in v0.17.0 

func (o AlarmOutput) ActionsEnabled() pulumi.BoolPtrOutput

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

func (AlarmOutput) AlarmActions added in v0.17.0 

func (o AlarmOutput) AlarmActions() pulumi.StringArrayOutput

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.

func (AlarmOutput) AlarmDescription added in v0.17.0 

func (o AlarmOutput) AlarmDescription() pulumi.StringPtrOutput

The description of the alarm.

func (AlarmOutput) AlarmName added in v0.17.0 

func (o AlarmOutput) AlarmName() pulumi.StringPtrOutput

The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. 

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

func (AlarmOutput) Arn added in v0.17.0 

func (o AlarmOutput) Arn() pulumi.StringOutput

The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .

func (AlarmOutput) ComparisonOperator added in v0.17.0 

func (o AlarmOutput) ComparisonOperator() pulumi.StringOutput

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

func (AlarmOutput) DatapointsToAlarm added in v0.17.0 

func (o AlarmOutput) DatapointsToAlarm() pulumi.IntPtrOutput

The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for “EvaluationPeriods“ is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. 

If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.

func (AlarmOutput) Dimensions added in v0.17.0 

func (o AlarmOutput) Dimensions() AlarmDimensionArrayOutput

The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify “Dimensions“. Instead, you use “Metrics“.

func (AlarmOutput) ElementType 

func (AlarmOutput) ElementType() reflect.Type

func (AlarmOutput) EvaluateLowSampleCountPercentile added in v0.17.0 

func (o AlarmOutput) EvaluateLowSampleCountPercentile() pulumi.StringPtrOutput

Used only for alarms based on percentiles. If “ignore“, the alarm state does not change during periods with too few data points to be statistically significant. If “evaluate“ or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

func (AlarmOutput) EvaluationPeriods added in v0.17.0 

func (o AlarmOutput) EvaluationPeriods() pulumi.IntOutput

The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and “DatapointsToAlarm“ is the M. 

For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.

func (AlarmOutput) ExtendedStatistic added in v0.17.0 

func (o AlarmOutput) ExtendedStatistic() pulumi.StringPtrOutput

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. 

For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.

func (AlarmOutput) InsufficientDataActions added in v0.17.0 

func (o AlarmOutput) InsufficientDataActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the “INSUFFICIENT_DATA“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (AlarmOutput) MetricName added in v0.17.0 

func (o AlarmOutput) MetricName() pulumi.StringPtrOutput

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use “Metrics“ instead and you can't specify “MetricName“.

func (AlarmOutput) Metrics added in v0.17.0 

func (o AlarmOutput) Metrics() AlarmMetricDataQueryArrayOutput

An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. 

If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.

func (AlarmOutput) Namespace added in v0.17.0 

func (o AlarmOutput) Namespace() pulumi.StringPtrOutput

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify “Namespace“ and you use “Metrics“ instead. 

For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)

func (AlarmOutput) OkActions added in v0.72.0 

func (o AlarmOutput) OkActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the “OK“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (AlarmOutput) Period added in v0.17.0 

func (o AlarmOutput) Period() pulumi.IntPtrOutput

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. 

For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.
 *Minimum:* 10

func (AlarmOutput) Statistic added in v0.17.0 

func (o AlarmOutput) Statistic() pulumi.StringPtrOutput

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use “ExtendedStatistic“. 

For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.

func (AlarmOutput) Tags added in v0.101.0 

func (o AlarmOutput) Tags() aws.TagArrayOutput

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the “cloudwatch:TagResource“ permission. 

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

func (AlarmOutput) Threshold added in v0.17.0 

func (o AlarmOutput) Threshold() pulumi.Float64PtrOutput

The value to compare with the specified statistic.

func (AlarmOutput) ThresholdMetricId added in v0.17.0 

func (o AlarmOutput) ThresholdMetricId() pulumi.StringPtrOutput

In an alarm based on an anomaly detection model, this is the ID of the “ANOMALY_DETECTION_BAND“ function used as the threshold for the alarm.

func (AlarmOutput) ToAlarmOutput 

func (o AlarmOutput) ToAlarmOutput() AlarmOutput

func (AlarmOutput) ToAlarmOutputWithContext 

func (o AlarmOutput) ToAlarmOutputWithContext(ctx context.Context) AlarmOutput

func (AlarmOutput) TreatMissingData added in v0.17.0 

func (o AlarmOutput) TreatMissingData() pulumi.StringPtrOutput

Sets how this alarm is to handle missing data points. Valid values are “breaching“, “notBreaching“, “ignore“, and “missing“. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. 

If you omit this parameter, the default behavior of ``missing`` is used.

func (AlarmOutput) Unit added in v0.17.0 

func (o AlarmOutput) Unit() pulumi.StringPtrOutput

The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a “Metrics“ array. 

You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

type AlarmState 

type AlarmState struct {
}

func (AlarmState) ElementType 

func (AlarmState) ElementType() reflect.Type

type AlarmTag added in v0.101.0 

type AlarmTag struct {
	// A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
	Key string `pulumi:"key"`
	// The value for the specified tag key.
	Value string `pulumi:"value"`
}

One of the key-value pairs associated with the alarm. Tags can help you organize and categorize your resources.

type CompositeAlarm 

type CompositeAlarm struct {
	pulumi.CustomResourceState

	// Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
	ActionsEnabled pulumi.BoolPtrOutput `pulumi:"actionsEnabled"`
	// Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
	ActionsSuppressor pulumi.StringPtrOutput `pulumi:"actionsSuppressor"`
	// Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
	ActionsSuppressorExtensionPeriod pulumi.IntPtrOutput `pulumi:"actionsSuppressorExtensionPeriod"`
	// Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
	ActionsSuppressorWaitPeriod pulumi.IntPtrOutput `pulumi:"actionsSuppressorWaitPeriod"`
	// The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
	AlarmActions pulumi.StringArrayOutput `pulumi:"alarmActions"`
	// The description of the alarm
	AlarmDescription pulumi.StringPtrOutput `pulumi:"alarmDescription"`
	// The name of the Composite Alarm
	AlarmName pulumi.StringPtrOutput `pulumi:"alarmName"`
	// Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
	AlarmRule pulumi.StringOutput `pulumi:"alarmRule"`
	// Amazon Resource Name (ARN) of the alarm
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	InsufficientDataActions pulumi.StringArrayOutput `pulumi:"insufficientDataActions"`
	// The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	OkActions pulumi.StringArrayOutput `pulumi:"okActions"`
	// A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression

func GetCompositeAlarm 

func GetCompositeAlarm(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CompositeAlarmState, opts ...pulumi.ResourceOption) (*CompositeAlarm, error)

GetCompositeAlarm gets an existing CompositeAlarm resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCompositeAlarm 

func NewCompositeAlarm(ctx *pulumi.Context,
	name string, args *CompositeAlarmArgs, opts ...pulumi.ResourceOption) (*CompositeAlarm, error)

NewCompositeAlarm registers a new resource with the given unique name, arguments, and options.

func (*CompositeAlarm) ElementType 

func (*CompositeAlarm) ElementType() reflect.Type

func (*CompositeAlarm) ToCompositeAlarmOutput 

func (i *CompositeAlarm) ToCompositeAlarmOutput() CompositeAlarmOutput

func (*CompositeAlarm) ToCompositeAlarmOutputWithContext 

func (i *CompositeAlarm) ToCompositeAlarmOutputWithContext(ctx context.Context) CompositeAlarmOutput

type CompositeAlarmArgs 

type CompositeAlarmArgs struct {
	// Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
	ActionsEnabled pulumi.BoolPtrInput
	// Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
	ActionsSuppressor pulumi.StringPtrInput
	// Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
	ActionsSuppressorExtensionPeriod pulumi.IntPtrInput
	// Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
	ActionsSuppressorWaitPeriod pulumi.IntPtrInput
	// The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
	AlarmActions pulumi.StringArrayInput
	// The description of the alarm
	AlarmDescription pulumi.StringPtrInput
	// The name of the Composite Alarm
	AlarmName pulumi.StringPtrInput
	// Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
	AlarmRule pulumi.StringInput
	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	InsufficientDataActions pulumi.StringArrayInput
	// The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	OkActions pulumi.StringArrayInput
	// A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a CompositeAlarm resource.

func (CompositeAlarmArgs) ElementType 

func (CompositeAlarmArgs) ElementType() reflect.Type

type CompositeAlarmInput 

type CompositeAlarmInput interface {
	pulumi.Input

	ToCompositeAlarmOutput() CompositeAlarmOutput
	ToCompositeAlarmOutputWithContext(ctx context.Context) CompositeAlarmOutput
}

type CompositeAlarmOutput 

type CompositeAlarmOutput struct{ *pulumi.OutputState }

func (CompositeAlarmOutput) ActionsEnabled added in v0.17.0 

func (o CompositeAlarmOutput) ActionsEnabled() pulumi.BoolPtrOutput

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

func (CompositeAlarmOutput) ActionsSuppressor added in v0.21.0 

func (o CompositeAlarmOutput) ActionsSuppressor() pulumi.StringPtrOutput

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

func (CompositeAlarmOutput) ActionsSuppressorExtensionPeriod added in v0.21.0 

func (o CompositeAlarmOutput) ActionsSuppressorExtensionPeriod() pulumi.IntPtrOutput

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

func (CompositeAlarmOutput) ActionsSuppressorWaitPeriod added in v0.21.0 

func (o CompositeAlarmOutput) ActionsSuppressorWaitPeriod() pulumi.IntPtrOutput

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

func (CompositeAlarmOutput) AlarmActions added in v0.17.0 

func (o CompositeAlarmOutput) AlarmActions() pulumi.StringArrayOutput

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

func (CompositeAlarmOutput) AlarmDescription added in v0.17.0 

func (o CompositeAlarmOutput) AlarmDescription() pulumi.StringPtrOutput

The description of the alarm

func (CompositeAlarmOutput) AlarmName added in v0.17.0 

func (o CompositeAlarmOutput) AlarmName() pulumi.StringPtrOutput

The name of the Composite Alarm

func (CompositeAlarmOutput) AlarmRule added in v0.17.0 

func (o CompositeAlarmOutput) AlarmRule() pulumi.StringOutput

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

func (CompositeAlarmOutput) Arn added in v0.17.0 

func (o CompositeAlarmOutput) Arn() pulumi.StringOutput

Amazon Resource Name (ARN) of the alarm

func (CompositeAlarmOutput) ElementType 

func (CompositeAlarmOutput) ElementType() reflect.Type

func (CompositeAlarmOutput) InsufficientDataActions added in v0.17.0 

func (o CompositeAlarmOutput) InsufficientDataActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (CompositeAlarmOutput) OkActions added in v0.72.0 

func (o CompositeAlarmOutput) OkActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (CompositeAlarmOutput) Tags added in v0.101.0 

func (o CompositeAlarmOutput) Tags() aws.TagArrayOutput

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

func (CompositeAlarmOutput) ToCompositeAlarmOutput 

func (o CompositeAlarmOutput) ToCompositeAlarmOutput() CompositeAlarmOutput

func (CompositeAlarmOutput) ToCompositeAlarmOutputWithContext 

func (o CompositeAlarmOutput) ToCompositeAlarmOutputWithContext(ctx context.Context) CompositeAlarmOutput

type CompositeAlarmState 

type CompositeAlarmState struct {
}

func (CompositeAlarmState) ElementType 

func (CompositeAlarmState) ElementType() reflect.Type

type CompositeAlarmTag added in v0.101.0 

type CompositeAlarmTag struct {
	// A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.
	Key string `pulumi:"key"`
	// The value for the specified tag key.
	Value string `pulumi:"value"`
}

Metadata that you can assign to a composite alarm, Tags can help you organize and categorize your resources.

type Dashboard 

type Dashboard struct {
	pulumi.CustomResourceState

	// The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
	DashboardBody pulumi.StringOutput `pulumi:"dashboardBody"`
	// The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
	DashboardName pulumi.StringPtrOutput `pulumi:"dashboardName"`
}

Resource Type definition for AWS::CloudWatch::Dashboard

func GetDashboard 

func GetDashboard(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DashboardState, opts ...pulumi.ResourceOption) (*Dashboard, error)

GetDashboard gets an existing Dashboard resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDashboard 

func NewDashboard(ctx *pulumi.Context,
	name string, args *DashboardArgs, opts ...pulumi.ResourceOption) (*Dashboard, error)

NewDashboard registers a new resource with the given unique name, arguments, and options.

func (*Dashboard) ElementType 

func (*Dashboard) ElementType() reflect.Type

func (*Dashboard) ToDashboardOutput 

func (i *Dashboard) ToDashboardOutput() DashboardOutput

func (*Dashboard) ToDashboardOutputWithContext 

func (i *Dashboard) ToDashboardOutputWithContext(ctx context.Context) DashboardOutput

type DashboardArgs 

type DashboardArgs struct {
	// The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
	DashboardBody pulumi.StringInput
	// The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
	DashboardName pulumi.StringPtrInput
}

The set of arguments for constructing a Dashboard resource.

func (DashboardArgs) ElementType 

func (DashboardArgs) ElementType() reflect.Type

type DashboardInput 

type DashboardInput interface {
	pulumi.Input

	ToDashboardOutput() DashboardOutput
	ToDashboardOutputWithContext(ctx context.Context) DashboardOutput
}

type DashboardOutput 

type DashboardOutput struct{ *pulumi.OutputState }

func (DashboardOutput) DashboardBody added in v0.17.0 

func (o DashboardOutput) DashboardBody() pulumi.StringOutput

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard

func (DashboardOutput) DashboardName added in v0.17.0 

func (o DashboardOutput) DashboardName() pulumi.StringPtrOutput

The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.

func (DashboardOutput) ElementType 

func (DashboardOutput) ElementType() reflect.Type

func (DashboardOutput) ToDashboardOutput 

func (o DashboardOutput) ToDashboardOutput() DashboardOutput

func (DashboardOutput) ToDashboardOutputWithContext 

func (o DashboardOutput) ToDashboardOutputWithContext(ctx context.Context) DashboardOutput

type DashboardState 

type DashboardState struct {
}

func (DashboardState) ElementType 

func (DashboardState) ElementType() reflect.Type

type LookupAlarmArgs added in v0.12.0 

type LookupAlarmArgs struct {
	// The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	AlarmName string `pulumi:"alarmName"`
}

type LookupAlarmOutputArgs added in v0.12.0 

type LookupAlarmOutputArgs struct {
	// The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
	//   If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	AlarmName pulumi.StringInput `pulumi:"alarmName"`
}

func (LookupAlarmOutputArgs) ElementType added in v0.12.0 

func (LookupAlarmOutputArgs) ElementType() reflect.Type

type LookupAlarmResult added in v0.12.0 

type LookupAlarmResult struct {
	// Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
	ActionsEnabled *bool `pulumi:"actionsEnabled"`
	// The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
	AlarmActions []string `pulumi:"alarmActions"`
	// The description of the alarm.
	AlarmDescription *string `pulumi:"alarmDescription"`
	// The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
	Arn *string `pulumi:"arn"`
	// The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
	ComparisonOperator *string `pulumi:"comparisonOperator"`
	// The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for “EvaluationPeriods“ is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
	//  If you omit this parameter, CW uses the same value here that you set for “EvaluationPeriods“, and the alarm goes to alarm state if that many consecutive periods are breaching.
	DatapointsToAlarm *int `pulumi:"datapointsToAlarm"`
	// The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify “Dimensions“. Instead, you use “Metrics“.
	Dimensions []AlarmDimension `pulumi:"dimensions"`
	// Used only for alarms based on percentiles. If “ignore“, the alarm state does not change during periods with too few data points to be statistically significant. If “evaluate“ or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
	EvaluateLowSampleCountPercentile *string `pulumi:"evaluateLowSampleCountPercentile"`
	// The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and “DatapointsToAlarm“ is the M.
	//  For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
	EvaluationPeriods *int `pulumi:"evaluationPeriods"`
	// The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
	//  For an alarm based on a metric, you must specify either “Statistic“ or “ExtendedStatistic“ but not both.
	//  For an alarm based on a math expression, you can't specify “ExtendedStatistic“. Instead, you use “Metrics“.
	ExtendedStatistic *string `pulumi:"extendedStatistic"`
	// The actions to execute when this alarm transitions to the “INSUFFICIENT_DATA“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	InsufficientDataActions []string `pulumi:"insufficientDataActions"`
	// The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use “Metrics“ instead and you can't specify “MetricName“.
	MetricName *string `pulumi:"metricName"`
	// An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
	//  If you specify the “Metrics“ parameter, you cannot specify “MetricName“, “Dimensions“, “Period“, “Namespace“, “Statistic“, “ExtendedStatistic“, or “Unit“.
	Metrics []AlarmMetricDataQuery `pulumi:"metrics"`
	// The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify “Namespace“ and you use “Metrics“ instead.
	//  For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
	Namespace *string `pulumi:"namespace"`
	// The actions to execute when this alarm transitions to the “OK“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	OkActions []string `pulumi:"okActions"`
	// The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
	//  For an alarm based on a math expression, you can't specify “Period“, and instead you use the “Metrics“ parameter.
	//   *Minimum:* 10
	Period *int `pulumi:"period"`
	// The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use “ExtendedStatistic“.
	//  For an alarm based on a metric, you must specify either “Statistic“ or “ExtendedStatistic“ but not both.
	//  For an alarm based on a math expression, you can't specify “Statistic“. Instead, you use “Metrics“.
	Statistic *string `pulumi:"statistic"`
	// A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the “cloudwatch:TagResource“ permission.
	//  Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	Tags []aws.Tag `pulumi:"tags"`
	// The value to compare with the specified statistic.
	Threshold *float64 `pulumi:"threshold"`
	// In an alarm based on an anomaly detection model, this is the ID of the “ANOMALY_DETECTION_BAND“ function used as the threshold for the alarm.
	ThresholdMetricId *string `pulumi:"thresholdMetricId"`
	// Sets how this alarm is to handle missing data points. Valid values are “breaching“, “notBreaching“, “ignore“, and “missing“. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
	//  If you omit this parameter, the default behavior of “missing“ is used.
	TreatMissingData *string `pulumi:"treatMissingData"`
	// The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a “Metrics“ array.
	//   You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
	Unit *string `pulumi:"unit"`
}

func LookupAlarm added in v0.12.0 

func LookupAlarm(ctx *pulumi.Context, args *LookupAlarmArgs, opts ...pulumi.InvokeOption) (*LookupAlarmResult, error)

The “AWS::CloudWatch::Alarm“ type specifies an alarm and associates it with the specified metric or metric math expression. 

When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

type LookupAlarmResultOutput added in v0.12.0 

type LookupAlarmResultOutput struct{ *pulumi.OutputState }

func LookupAlarmOutput added in v0.12.0 

func LookupAlarmOutput(ctx *pulumi.Context, args LookupAlarmOutputArgs, opts ...pulumi.InvokeOption) LookupAlarmResultOutput

func (LookupAlarmResultOutput) ActionsEnabled added in v0.12.0 

func (o LookupAlarmResultOutput) ActionsEnabled() pulumi.BoolPtrOutput

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

func (LookupAlarmResultOutput) AlarmActions added in v0.12.0 

func (o LookupAlarmResultOutput) AlarmActions() pulumi.StringArrayOutput

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.

func (LookupAlarmResultOutput) AlarmDescription added in v0.12.0 

func (o LookupAlarmResultOutput) AlarmDescription() pulumi.StringPtrOutput

The description of the alarm.

func (LookupAlarmResultOutput) Arn added in v0.12.0 

func (o LookupAlarmResultOutput) Arn() pulumi.StringPtrOutput

The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .

func (LookupAlarmResultOutput) ComparisonOperator added in v0.12.0 

func (o LookupAlarmResultOutput) ComparisonOperator() pulumi.StringPtrOutput

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

func (LookupAlarmResultOutput) DatapointsToAlarm added in v0.12.0 

func (o LookupAlarmResultOutput) DatapointsToAlarm() pulumi.IntPtrOutput

The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for “EvaluationPeriods“ is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. 

If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.

func (LookupAlarmResultOutput) Dimensions added in v0.12.0 

func (o LookupAlarmResultOutput) Dimensions() AlarmDimensionArrayOutput

The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify “Dimensions“. Instead, you use “Metrics“.

func (LookupAlarmResultOutput) ElementType added in v0.12.0 

func (LookupAlarmResultOutput) ElementType() reflect.Type

func (LookupAlarmResultOutput) EvaluateLowSampleCountPercentile added in v0.12.0 

func (o LookupAlarmResultOutput) EvaluateLowSampleCountPercentile() pulumi.StringPtrOutput

Used only for alarms based on percentiles. If “ignore“, the alarm state does not change during periods with too few data points to be statistically significant. If “evaluate“ or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

func (LookupAlarmResultOutput) EvaluationPeriods added in v0.12.0 

func (o LookupAlarmResultOutput) EvaluationPeriods() pulumi.IntPtrOutput

The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and “DatapointsToAlarm“ is the M. 

For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.

func (LookupAlarmResultOutput) ExtendedStatistic added in v0.12.0 

func (o LookupAlarmResultOutput) ExtendedStatistic() pulumi.StringPtrOutput

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. 

For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.

func (LookupAlarmResultOutput) InsufficientDataActions added in v0.12.0 

func (o LookupAlarmResultOutput) InsufficientDataActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the “INSUFFICIENT_DATA“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (LookupAlarmResultOutput) MetricName added in v0.12.0 

func (o LookupAlarmResultOutput) MetricName() pulumi.StringPtrOutput

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use “Metrics“ instead and you can't specify “MetricName“.

func (LookupAlarmResultOutput) Metrics added in v0.12.0 

func (o LookupAlarmResultOutput) Metrics() AlarmMetricDataQueryArrayOutput

An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. 

If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.

func (LookupAlarmResultOutput) Namespace added in v0.12.0 

func (o LookupAlarmResultOutput) Namespace() pulumi.StringPtrOutput

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify “Namespace“ and you use “Metrics“ instead. 

For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)

func (LookupAlarmResultOutput) OkActions added in v0.72.0 

func (o LookupAlarmResultOutput) OkActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the “OK“ state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (LookupAlarmResultOutput) Period added in v0.12.0 

func (o LookupAlarmResultOutput) Period() pulumi.IntPtrOutput

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. 

For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.
 *Minimum:* 10

func (LookupAlarmResultOutput) Statistic added in v0.12.0 

func (o LookupAlarmResultOutput) Statistic() pulumi.StringPtrOutput

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use “ExtendedStatistic“. 

For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.

func (LookupAlarmResultOutput) Tags added in v0.101.0 

func (o LookupAlarmResultOutput) Tags() aws.TagArrayOutput

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the “cloudwatch:TagResource“ permission. 

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

func (LookupAlarmResultOutput) Threshold added in v0.12.0 

func (o LookupAlarmResultOutput) Threshold() pulumi.Float64PtrOutput

The value to compare with the specified statistic.

func (LookupAlarmResultOutput) ThresholdMetricId added in v0.12.0 

func (o LookupAlarmResultOutput) ThresholdMetricId() pulumi.StringPtrOutput

In an alarm based on an anomaly detection model, this is the ID of the “ANOMALY_DETECTION_BAND“ function used as the threshold for the alarm.

func (LookupAlarmResultOutput) ToLookupAlarmResultOutput added in v0.12.0 

func (o LookupAlarmResultOutput) ToLookupAlarmResultOutput() LookupAlarmResultOutput

func (LookupAlarmResultOutput) ToLookupAlarmResultOutputWithContext added in v0.12.0 

func (o LookupAlarmResultOutput) ToLookupAlarmResultOutputWithContext(ctx context.Context) LookupAlarmResultOutput

func (LookupAlarmResultOutput) TreatMissingData added in v0.12.0 

func (o LookupAlarmResultOutput) TreatMissingData() pulumi.StringPtrOutput

Sets how this alarm is to handle missing data points. Valid values are “breaching“, “notBreaching“, “ignore“, and “missing“. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. 

If you omit this parameter, the default behavior of ``missing`` is used.

func (LookupAlarmResultOutput) Unit added in v0.12.0 

func (o LookupAlarmResultOutput) Unit() pulumi.StringPtrOutput

The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a “Metrics“ array. 

You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

type LookupCompositeAlarmArgs added in v0.12.0 

type LookupCompositeAlarmArgs struct {
	// The name of the Composite Alarm
	AlarmName string `pulumi:"alarmName"`
}

type LookupCompositeAlarmOutputArgs added in v0.12.0 

type LookupCompositeAlarmOutputArgs struct {
	// The name of the Composite Alarm
	AlarmName pulumi.StringInput `pulumi:"alarmName"`
}

func (LookupCompositeAlarmOutputArgs) ElementType added in v0.12.0 

func (LookupCompositeAlarmOutputArgs) ElementType() reflect.Type

type LookupCompositeAlarmResult added in v0.12.0 

type LookupCompositeAlarmResult struct {
	// Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
	ActionsEnabled *bool `pulumi:"actionsEnabled"`
	// Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
	ActionsSuppressor *string `pulumi:"actionsSuppressor"`
	// Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
	ActionsSuppressorExtensionPeriod *int `pulumi:"actionsSuppressorExtensionPeriod"`
	// Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
	ActionsSuppressorWaitPeriod *int `pulumi:"actionsSuppressorWaitPeriod"`
	// The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
	AlarmActions []string `pulumi:"alarmActions"`
	// The description of the alarm
	AlarmDescription *string `pulumi:"alarmDescription"`
	// Expression which aggregates the state of other Alarms (Metric or Composite Alarms)
	AlarmRule *string `pulumi:"alarmRule"`
	// Amazon Resource Name (ARN) of the alarm
	Arn *string `pulumi:"arn"`
	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	InsufficientDataActions []string `pulumi:"insufficientDataActions"`
	// The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
	OkActions []string `pulumi:"okActions"`
	// A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupCompositeAlarm added in v0.12.0 

func LookupCompositeAlarm(ctx *pulumi.Context, args *LookupCompositeAlarmArgs, opts ...pulumi.InvokeOption) (*LookupCompositeAlarmResult, error)

The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression

type LookupCompositeAlarmResultOutput added in v0.12.0 

type LookupCompositeAlarmResultOutput struct{ *pulumi.OutputState }

func LookupCompositeAlarmOutput added in v0.12.0 

func LookupCompositeAlarmOutput(ctx *pulumi.Context, args LookupCompositeAlarmOutputArgs, opts ...pulumi.InvokeOption) LookupCompositeAlarmResultOutput

func (LookupCompositeAlarmResultOutput) ActionsEnabled added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) ActionsEnabled() pulumi.BoolPtrOutput

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

func (LookupCompositeAlarmResultOutput) ActionsSuppressor added in v0.21.0 

func (o LookupCompositeAlarmResultOutput) ActionsSuppressor() pulumi.StringPtrOutput

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

func (LookupCompositeAlarmResultOutput) ActionsSuppressorExtensionPeriod added in v0.21.0 

func (o LookupCompositeAlarmResultOutput) ActionsSuppressorExtensionPeriod() pulumi.IntPtrOutput

Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.

func (LookupCompositeAlarmResultOutput) ActionsSuppressorWaitPeriod added in v0.21.0 

func (o LookupCompositeAlarmResultOutput) ActionsSuppressorWaitPeriod() pulumi.IntPtrOutput

Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.

func (LookupCompositeAlarmResultOutput) AlarmActions added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) AlarmActions() pulumi.StringArrayOutput

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).

func (LookupCompositeAlarmResultOutput) AlarmDescription added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) AlarmDescription() pulumi.StringPtrOutput

The description of the alarm

func (LookupCompositeAlarmResultOutput) AlarmRule added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) AlarmRule() pulumi.StringPtrOutput

Expression which aggregates the state of other Alarms (Metric or Composite Alarms)

func (LookupCompositeAlarmResultOutput) Arn added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) Arn() pulumi.StringPtrOutput

Amazon Resource Name (ARN) of the alarm

func (LookupCompositeAlarmResultOutput) ElementType added in v0.12.0 

func (LookupCompositeAlarmResultOutput) ElementType() reflect.Type

func (LookupCompositeAlarmResultOutput) InsufficientDataActions added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) InsufficientDataActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (LookupCompositeAlarmResultOutput) OkActions added in v0.72.0 

func (o LookupCompositeAlarmResultOutput) OkActions() pulumi.StringArrayOutput

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

func (LookupCompositeAlarmResultOutput) Tags added in v0.101.0 

func (o LookupCompositeAlarmResultOutput) Tags() aws.TagArrayOutput

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

func (LookupCompositeAlarmResultOutput) ToLookupCompositeAlarmResultOutput added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) ToLookupCompositeAlarmResultOutput() LookupCompositeAlarmResultOutput

func (LookupCompositeAlarmResultOutput) ToLookupCompositeAlarmResultOutputWithContext added in v0.12.0 

func (o LookupCompositeAlarmResultOutput) ToLookupCompositeAlarmResultOutputWithContext(ctx context.Context) LookupCompositeAlarmResultOutput

type LookupDashboardArgs added in v0.12.0 

type LookupDashboardArgs struct {
	// The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
	DashboardName string `pulumi:"dashboardName"`
}

type LookupDashboardOutputArgs added in v0.12.0 

type LookupDashboardOutputArgs struct {
	// The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
	DashboardName pulumi.StringInput `pulumi:"dashboardName"`
}

func (LookupDashboardOutputArgs) ElementType added in v0.12.0 

func (LookupDashboardOutputArgs) ElementType() reflect.Type

type LookupDashboardResult added in v0.12.0 

type LookupDashboardResult struct {
	// The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
	DashboardBody *string `pulumi:"dashboardBody"`
}

func LookupDashboard added in v0.12.0 

func LookupDashboard(ctx *pulumi.Context, args *LookupDashboardArgs, opts ...pulumi.InvokeOption) (*LookupDashboardResult, error)

Resource Type definition for AWS::CloudWatch::Dashboard

type LookupDashboardResultOutput added in v0.12.0 

type LookupDashboardResultOutput struct{ *pulumi.OutputState }

func LookupDashboardOutput added in v0.12.0 

func LookupDashboardOutput(ctx *pulumi.Context, args LookupDashboardOutputArgs, opts ...pulumi.InvokeOption) LookupDashboardResultOutput

func (LookupDashboardResultOutput) DashboardBody added in v0.12.0 

func (o LookupDashboardResultOutput) DashboardBody() pulumi.StringPtrOutput

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard

func (LookupDashboardResultOutput) ElementType added in v0.12.0 

func (LookupDashboardResultOutput) ElementType() reflect.Type

func (LookupDashboardResultOutput) ToLookupDashboardResultOutput added in v0.12.0 

func (o LookupDashboardResultOutput) ToLookupDashboardResultOutput() LookupDashboardResultOutput

func (LookupDashboardResultOutput) ToLookupDashboardResultOutputWithContext added in v0.12.0 

func (o LookupDashboardResultOutput) ToLookupDashboardResultOutputWithContext(ctx context.Context) LookupDashboardResultOutput

type LookupMetricStreamArgs added in v0.12.0 

type LookupMetricStreamArgs struct {
	// Name of the metric stream.
	Name string `pulumi:"name"`
}

type LookupMetricStreamOutputArgs added in v0.12.0 

type LookupMetricStreamOutputArgs struct {
	// Name of the metric stream.
	Name pulumi.StringInput `pulumi:"name"`
}

func (LookupMetricStreamOutputArgs) ElementType added in v0.12.0 

func (LookupMetricStreamOutputArgs) ElementType() reflect.Type

type LookupMetricStreamResult added in v0.12.0 

type LookupMetricStreamResult struct {
	// Amazon Resource Name of the metric stream.
	Arn *string `pulumi:"arn"`
	// The date of creation of the metric stream.
	CreationDate *string `pulumi:"creationDate"`
	// Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
	ExcludeFilters []MetricStreamFilter `pulumi:"excludeFilters"`
	// The ARN of the Kinesis Firehose where to stream the data.
	FirehoseArn *string `pulumi:"firehoseArn"`
	// Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
	IncludeFilters []MetricStreamFilter `pulumi:"includeFilters"`
	// If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
	IncludeLinkedAccountsMetrics *bool `pulumi:"includeLinkedAccountsMetrics"`
	// The date of the last update of the metric stream.
	LastUpdateDate *string `pulumi:"lastUpdateDate"`
	// The output format of the data streamed to the Kinesis Firehose.
	OutputFormat *string `pulumi:"outputFormat"`
	// The ARN of the role that provides access to the Kinesis Firehose.
	RoleArn *string `pulumi:"roleArn"`
	// Displays the state of the Metric Stream.
	State *string `pulumi:"state"`
	// By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
	StatisticsConfigurations []MetricStreamStatisticsConfiguration `pulumi:"statisticsConfigurations"`
}

func LookupMetricStream added in v0.12.0 

func LookupMetricStream(ctx *pulumi.Context, args *LookupMetricStreamArgs, opts ...pulumi.InvokeOption) (*LookupMetricStreamResult, error)

Resource Type definition for Metric Stream

type LookupMetricStreamResultOutput added in v0.12.0 

type LookupMetricStreamResultOutput struct{ *pulumi.OutputState }

func LookupMetricStreamOutput added in v0.12.0 

func LookupMetricStreamOutput(ctx *pulumi.Context, args LookupMetricStreamOutputArgs, opts ...pulumi.InvokeOption) LookupMetricStreamResultOutput

func (LookupMetricStreamResultOutput) Arn added in v0.12.0 

func (o LookupMetricStreamResultOutput) Arn() pulumi.StringPtrOutput

Amazon Resource Name of the metric stream.

func (LookupMetricStreamResultOutput) CreationDate added in v0.12.0 

func (o LookupMetricStreamResultOutput) CreationDate() pulumi.StringPtrOutput

The date of creation of the metric stream.

func (LookupMetricStreamResultOutput) ElementType added in v0.12.0 

func (LookupMetricStreamResultOutput) ElementType() reflect.Type

func (LookupMetricStreamResultOutput) ExcludeFilters added in v0.12.0 

func (o LookupMetricStreamResultOutput) ExcludeFilters() MetricStreamFilterArrayOutput

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

func (LookupMetricStreamResultOutput) FirehoseArn added in v0.12.0 

func (o LookupMetricStreamResultOutput) FirehoseArn() pulumi.StringPtrOutput

The ARN of the Kinesis Firehose where to stream the data.

func (LookupMetricStreamResultOutput) IncludeFilters added in v0.12.0 

func (o LookupMetricStreamResultOutput) IncludeFilters() MetricStreamFilterArrayOutput

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

func (LookupMetricStreamResultOutput) IncludeLinkedAccountsMetrics added in v0.48.0 

func (o LookupMetricStreamResultOutput) IncludeLinkedAccountsMetrics() pulumi.BoolPtrOutput

If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.

func (LookupMetricStreamResultOutput) LastUpdateDate added in v0.12.0 

func (o LookupMetricStreamResultOutput) LastUpdateDate() pulumi.StringPtrOutput

The date of the last update of the metric stream.

func (LookupMetricStreamResultOutput) OutputFormat added in v0.12.0 

func (o LookupMetricStreamResultOutput) OutputFormat() pulumi.StringPtrOutput

The output format of the data streamed to the Kinesis Firehose.

func (LookupMetricStreamResultOutput) RoleArn added in v0.12.0 

func (o LookupMetricStreamResultOutput) RoleArn() pulumi.StringPtrOutput

The ARN of the role that provides access to the Kinesis Firehose.

func (LookupMetricStreamResultOutput) State added in v0.12.0 

func (o LookupMetricStreamResultOutput) State() pulumi.StringPtrOutput

Displays the state of the Metric Stream.

func (LookupMetricStreamResultOutput) StatisticsConfigurations added in v0.16.0 

func (o LookupMetricStreamResultOutput) StatisticsConfigurations() MetricStreamStatisticsConfigurationArrayOutput

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

func (LookupMetricStreamResultOutput) ToLookupMetricStreamResultOutput added in v0.12.0 

func (o LookupMetricStreamResultOutput) ToLookupMetricStreamResultOutput() LookupMetricStreamResultOutput

func (LookupMetricStreamResultOutput) ToLookupMetricStreamResultOutputWithContext added in v0.12.0 

func (o LookupMetricStreamResultOutput) ToLookupMetricStreamResultOutputWithContext(ctx context.Context) LookupMetricStreamResultOutput

type MetricStream 

type MetricStream struct {
	pulumi.CustomResourceState

	// Amazon Resource Name of the metric stream.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The date of creation of the metric stream.
	CreationDate pulumi.StringOutput `pulumi:"creationDate"`
	// Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
	ExcludeFilters MetricStreamFilterArrayOutput `pulumi:"excludeFilters"`
	// The ARN of the Kinesis Firehose where to stream the data.
	FirehoseArn pulumi.StringPtrOutput `pulumi:"firehoseArn"`
	// Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
	IncludeFilters MetricStreamFilterArrayOutput `pulumi:"includeFilters"`
	// If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
	IncludeLinkedAccountsMetrics pulumi.BoolPtrOutput `pulumi:"includeLinkedAccountsMetrics"`
	// The date of the last update of the metric stream.
	LastUpdateDate pulumi.StringOutput `pulumi:"lastUpdateDate"`
	// Name of the metric stream.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// The output format of the data streamed to the Kinesis Firehose.
	OutputFormat pulumi.StringPtrOutput `pulumi:"outputFormat"`
	// The ARN of the role that provides access to the Kinesis Firehose.
	RoleArn pulumi.StringPtrOutput `pulumi:"roleArn"`
	// Displays the state of the Metric Stream.
	State pulumi.StringOutput `pulumi:"state"`
	// By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
	StatisticsConfigurations MetricStreamStatisticsConfigurationArrayOutput `pulumi:"statisticsConfigurations"`
	// A set of tags to assign to the delivery stream.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

Resource Type definition for Metric Stream

## Example Usage ### Example

```go package main

import ( 

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewMetricStream(ctx, "myMetricStream", &cloudwatch.MetricStreamArgs{
			OutputFormat: pulumi.String("json"),
			FirehoseArn:  pulumi.String("arn:aws:firehose:us-east-1:123456789012:deliverystream/MyDeliveryStream"),
			RoleArn:      pulumi.String("arn:aws:iam::123456789012:role/service-role/MyRole"),
			IncludeFilters: cloudwatch.MetricStreamFilterArray{
				&cloudwatch.MetricStreamFilterArgs{
					Namespace: pulumi.String("AWS/ELB"),
				},
				&cloudwatch.MetricStreamFilterArgs{
					Namespace: pulumi.String("AWS/EC2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetMetricStream 

func GetMetricStream(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MetricStreamState, opts ...pulumi.ResourceOption) (*MetricStream, error)

GetMetricStream gets an existing MetricStream resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMetricStream 

func NewMetricStream(ctx *pulumi.Context,
	name string, args *MetricStreamArgs, opts ...pulumi.ResourceOption) (*MetricStream, error)

NewMetricStream registers a new resource with the given unique name, arguments, and options.

func (*MetricStream) ElementType 

func (*MetricStream) ElementType() reflect.Type

func (*MetricStream) ToMetricStreamOutput 

func (i *MetricStream) ToMetricStreamOutput() MetricStreamOutput

func (*MetricStream) ToMetricStreamOutputWithContext 

func (i *MetricStream) ToMetricStreamOutputWithContext(ctx context.Context) MetricStreamOutput

type MetricStreamArgs 

type MetricStreamArgs struct {
	// Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
	ExcludeFilters MetricStreamFilterArrayInput
	// The ARN of the Kinesis Firehose where to stream the data.
	FirehoseArn pulumi.StringPtrInput
	// Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
	IncludeFilters MetricStreamFilterArrayInput
	// If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
	IncludeLinkedAccountsMetrics pulumi.BoolPtrInput
	// Name of the metric stream.
	Name pulumi.StringPtrInput
	// The output format of the data streamed to the Kinesis Firehose.
	OutputFormat pulumi.StringPtrInput
	// The ARN of the role that provides access to the Kinesis Firehose.
	RoleArn pulumi.StringPtrInput
	// By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
	StatisticsConfigurations MetricStreamStatisticsConfigurationArrayInput
	// A set of tags to assign to the delivery stream.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a MetricStream resource.

func (MetricStreamArgs) ElementType 

func (MetricStreamArgs) ElementType() reflect.Type

type MetricStreamFilter added in v0.2.0 

type MetricStreamFilter struct {
	// Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
	MetricNames []string `pulumi:"metricNames"`
	// Only metrics with Namespace matching this value will be streamed.
	Namespace string `pulumi:"namespace"`
}

This structure defines the metrics that will be streamed.

type MetricStreamFilterArgs added in v0.2.0 

type MetricStreamFilterArgs struct {
	// Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
	MetricNames pulumi.StringArrayInput `pulumi:"metricNames"`
	// Only metrics with Namespace matching this value will be streamed.
	Namespace pulumi.StringInput `pulumi:"namespace"`
}

This structure defines the metrics that will be streamed.

func (MetricStreamFilterArgs) ElementType added in v0.2.0 

func (MetricStreamFilterArgs) ElementType() reflect.Type

func (MetricStreamFilterArgs) ToMetricStreamFilterOutput added in v0.2.0 

func (i MetricStreamFilterArgs) ToMetricStreamFilterOutput() MetricStreamFilterOutput

func (MetricStreamFilterArgs) ToMetricStreamFilterOutputWithContext added in v0.2.0 

func (i MetricStreamFilterArgs) ToMetricStreamFilterOutputWithContext(ctx context.Context) MetricStreamFilterOutput

type MetricStreamFilterArray added in v0.2.0 

type MetricStreamFilterArray []MetricStreamFilterInput

func (MetricStreamFilterArray) ElementType added in v0.2.0 

func (MetricStreamFilterArray) ElementType() reflect.Type

func (MetricStreamFilterArray) ToMetricStreamFilterArrayOutput added in v0.2.0 

func (i MetricStreamFilterArray) ToMetricStreamFilterArrayOutput() MetricStreamFilterArrayOutput

func (MetricStreamFilterArray) ToMetricStreamFilterArrayOutputWithContext added in v0.2.0 

func (i MetricStreamFilterArray) ToMetricStreamFilterArrayOutputWithContext(ctx context.Context) MetricStreamFilterArrayOutput

type MetricStreamFilterArrayInput added in v0.2.0 

type MetricStreamFilterArrayInput interface {
	pulumi.Input

	ToMetricStreamFilterArrayOutput() MetricStreamFilterArrayOutput
	ToMetricStreamFilterArrayOutputWithContext(context.Context) MetricStreamFilterArrayOutput
}

MetricStreamFilterArrayInput is an input type that accepts MetricStreamFilterArray and MetricStreamFilterArrayOutput values. You can construct a concrete instance of `MetricStreamFilterArrayInput` via: 

MetricStreamFilterArray{ MetricStreamFilterArgs{...} }

type MetricStreamFilterArrayOutput added in v0.2.0 

type MetricStreamFilterArrayOutput struct{ *pulumi.OutputState }

func (MetricStreamFilterArrayOutput) ElementType added in v0.2.0 

func (MetricStreamFilterArrayOutput) ElementType() reflect.Type

func (MetricStreamFilterArrayOutput) Index added in v0.2.0 

func (o MetricStreamFilterArrayOutput) Index(i pulumi.IntInput) MetricStreamFilterOutput

func (MetricStreamFilterArrayOutput) ToMetricStreamFilterArrayOutput added in v0.2.0 

func (o MetricStreamFilterArrayOutput) ToMetricStreamFilterArrayOutput() MetricStreamFilterArrayOutput

func (MetricStreamFilterArrayOutput) ToMetricStreamFilterArrayOutputWithContext added in v0.2.0 

func (o MetricStreamFilterArrayOutput) ToMetricStreamFilterArrayOutputWithContext(ctx context.Context) MetricStreamFilterArrayOutput

type MetricStreamFilterInput added in v0.2.0 

type MetricStreamFilterInput interface {
	pulumi.Input

	ToMetricStreamFilterOutput() MetricStreamFilterOutput
	ToMetricStreamFilterOutputWithContext(context.Context) MetricStreamFilterOutput
}

MetricStreamFilterInput is an input type that accepts MetricStreamFilterArgs and MetricStreamFilterOutput values. You can construct a concrete instance of `MetricStreamFilterInput` via: 

MetricStreamFilterArgs{...}

type MetricStreamFilterOutput added in v0.2.0 

type MetricStreamFilterOutput struct{ *pulumi.OutputState }

This structure defines the metrics that will be streamed.

func (MetricStreamFilterOutput) ElementType added in v0.2.0 

func (MetricStreamFilterOutput) ElementType() reflect.Type

func (MetricStreamFilterOutput) MetricNames added in v0.59.0 

func (o MetricStreamFilterOutput) MetricNames() pulumi.StringArrayOutput

Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.

func (MetricStreamFilterOutput) Namespace added in v0.2.0 

func (o MetricStreamFilterOutput) Namespace() pulumi.StringOutput

Only metrics with Namespace matching this value will be streamed.

func (MetricStreamFilterOutput) ToMetricStreamFilterOutput added in v0.2.0 

func (o MetricStreamFilterOutput) ToMetricStreamFilterOutput() MetricStreamFilterOutput

func (MetricStreamFilterOutput) ToMetricStreamFilterOutputWithContext added in v0.2.0 

func (o MetricStreamFilterOutput) ToMetricStreamFilterOutputWithContext(ctx context.Context) MetricStreamFilterOutput

type MetricStreamInput 

type MetricStreamInput interface {
	pulumi.Input

	ToMetricStreamOutput() MetricStreamOutput
	ToMetricStreamOutputWithContext(ctx context.Context) MetricStreamOutput
}

type MetricStreamOutput 

type MetricStreamOutput struct{ *pulumi.OutputState }

func (MetricStreamOutput) Arn added in v0.17.0 

func (o MetricStreamOutput) Arn() pulumi.StringOutput

Amazon Resource Name of the metric stream.

func (MetricStreamOutput) CreationDate added in v0.17.0 

func (o MetricStreamOutput) CreationDate() pulumi.StringOutput

The date of creation of the metric stream.

func (MetricStreamOutput) ElementType 

func (MetricStreamOutput) ElementType() reflect.Type

func (MetricStreamOutput) ExcludeFilters added in v0.17.0 

func (o MetricStreamOutput) ExcludeFilters() MetricStreamFilterArrayOutput

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

func (MetricStreamOutput) FirehoseArn added in v0.17.0 

func (o MetricStreamOutput) FirehoseArn() pulumi.StringPtrOutput

The ARN of the Kinesis Firehose where to stream the data.

func (MetricStreamOutput) IncludeFilters added in v0.17.0 

func (o MetricStreamOutput) IncludeFilters() MetricStreamFilterArrayOutput

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

func (MetricStreamOutput) IncludeLinkedAccountsMetrics added in v0.48.0 

func (o MetricStreamOutput) IncludeLinkedAccountsMetrics() pulumi.BoolPtrOutput

If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.

func (MetricStreamOutput) LastUpdateDate added in v0.17.0 

func (o MetricStreamOutput) LastUpdateDate() pulumi.StringOutput

The date of the last update of the metric stream.

func (MetricStreamOutput) Name added in v0.17.0 

func (o MetricStreamOutput) Name() pulumi.StringPtrOutput

Name of the metric stream.

func (MetricStreamOutput) OutputFormat added in v0.17.0 

func (o MetricStreamOutput) OutputFormat() pulumi.StringPtrOutput

The output format of the data streamed to the Kinesis Firehose.

func (MetricStreamOutput) RoleArn added in v0.17.0 

func (o MetricStreamOutput) RoleArn() pulumi.StringPtrOutput

The ARN of the role that provides access to the Kinesis Firehose.

func (MetricStreamOutput) State added in v0.17.0 

func (o MetricStreamOutput) State() pulumi.StringOutput

Displays the state of the Metric Stream.

func (MetricStreamOutput) StatisticsConfigurations added in v0.17.0 

func (o MetricStreamOutput) StatisticsConfigurations() MetricStreamStatisticsConfigurationArrayOutput

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

func (MetricStreamOutput) Tags added in v0.17.0 

func (o MetricStreamOutput) Tags() aws.TagArrayOutput

A set of tags to assign to the delivery stream.

func (MetricStreamOutput) ToMetricStreamOutput 

func (o MetricStreamOutput) ToMetricStreamOutput() MetricStreamOutput

func (MetricStreamOutput) ToMetricStreamOutputWithContext 

func (o MetricStreamOutput) ToMetricStreamOutputWithContext(ctx context.Context) MetricStreamOutput

type MetricStreamState 

type MetricStreamState struct {
}

func (MetricStreamState) ElementType 

func (MetricStreamState) ElementType() reflect.Type

type MetricStreamStatisticsConfiguration added in v0.16.0 

type MetricStreamStatisticsConfiguration struct {
	// The additional statistics to stream for the metrics listed in IncludeMetrics.
	AdditionalStatistics []string `pulumi:"additionalStatistics"`
	// An array that defines the metrics that are to have additional statistics streamed.
	IncludeMetrics []MetricStreamStatisticsMetric `pulumi:"includeMetrics"`
}

This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.

type MetricStreamStatisticsConfigurationArgs added in v0.16.0 

type MetricStreamStatisticsConfigurationArgs struct {
	// The additional statistics to stream for the metrics listed in IncludeMetrics.
	AdditionalStatistics pulumi.StringArrayInput `pulumi:"additionalStatistics"`
	// An array that defines the metrics that are to have additional statistics streamed.
	IncludeMetrics MetricStreamStatisticsMetricArrayInput `pulumi:"includeMetrics"`
}

This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.

func (MetricStreamStatisticsConfigurationArgs) ElementType added in v0.16.0 

func (MetricStreamStatisticsConfigurationArgs) ElementType() reflect.Type

func (MetricStreamStatisticsConfigurationArgs) ToMetricStreamStatisticsConfigurationOutput added in v0.16.0 

func (i MetricStreamStatisticsConfigurationArgs) ToMetricStreamStatisticsConfigurationOutput() MetricStreamStatisticsConfigurationOutput

func (MetricStreamStatisticsConfigurationArgs) ToMetricStreamStatisticsConfigurationOutputWithContext added in v0.16.0 

func (i MetricStreamStatisticsConfigurationArgs) ToMetricStreamStatisticsConfigurationOutputWithContext(ctx context.Context) MetricStreamStatisticsConfigurationOutput

type MetricStreamStatisticsConfigurationArray added in v0.16.0 

type MetricStreamStatisticsConfigurationArray []MetricStreamStatisticsConfigurationInput

func (MetricStreamStatisticsConfigurationArray) ElementType added in v0.16.0 

func (MetricStreamStatisticsConfigurationArray) ElementType() reflect.Type

func (MetricStreamStatisticsConfigurationArray) ToMetricStreamStatisticsConfigurationArrayOutput added in v0.16.0 

func (i MetricStreamStatisticsConfigurationArray) ToMetricStreamStatisticsConfigurationArrayOutput() MetricStreamStatisticsConfigurationArrayOutput

func (MetricStreamStatisticsConfigurationArray) ToMetricStreamStatisticsConfigurationArrayOutputWithContext added in v0.16.0 

func (i MetricStreamStatisticsConfigurationArray) ToMetricStreamStatisticsConfigurationArrayOutputWithContext(ctx context.Context) MetricStreamStatisticsConfigurationArrayOutput

type MetricStreamStatisticsConfigurationArrayInput added in v0.16.0 

type MetricStreamStatisticsConfigurationArrayInput interface {
	pulumi.Input

	ToMetricStreamStatisticsConfigurationArrayOutput() MetricStreamStatisticsConfigurationArrayOutput
	ToMetricStreamStatisticsConfigurationArrayOutputWithContext(context.Context) MetricStreamStatisticsConfigurationArrayOutput
}

MetricStreamStatisticsConfigurationArrayInput is an input type that accepts MetricStreamStatisticsConfigurationArray and MetricStreamStatisticsConfigurationArrayOutput values. You can construct a concrete instance of `MetricStreamStatisticsConfigurationArrayInput` via: 

MetricStreamStatisticsConfigurationArray{ MetricStreamStatisticsConfigurationArgs{...} }

type MetricStreamStatisticsConfigurationArrayOutput added in v0.16.0 

type MetricStreamStatisticsConfigurationArrayOutput struct{ *pulumi.OutputState }

func (MetricStreamStatisticsConfigurationArrayOutput) ElementType added in v0.16.0 

func (MetricStreamStatisticsConfigurationArrayOutput) ElementType() reflect.Type

func (MetricStreamStatisticsConfigurationArrayOutput) Index added in v0.16.0 

func (o MetricStreamStatisticsConfigurationArrayOutput) Index(i pulumi.IntInput) MetricStreamStatisticsConfigurationOutput

func (MetricStreamStatisticsConfigurationArrayOutput) ToMetricStreamStatisticsConfigurationArrayOutput added in v0.16.0 

func (o MetricStreamStatisticsConfigurationArrayOutput) ToMetricStreamStatisticsConfigurationArrayOutput() MetricStreamStatisticsConfigurationArrayOutput

func (MetricStreamStatisticsConfigurationArrayOutput) ToMetricStreamStatisticsConfigurationArrayOutputWithContext added in v0.16.0 

func (o MetricStreamStatisticsConfigurationArrayOutput) ToMetricStreamStatisticsConfigurationArrayOutputWithContext(ctx context.Context) MetricStreamStatisticsConfigurationArrayOutput

type MetricStreamStatisticsConfigurationInput added in v0.16.0 

type MetricStreamStatisticsConfigurationInput interface {
	pulumi.Input

	ToMetricStreamStatisticsConfigurationOutput() MetricStreamStatisticsConfigurationOutput
	ToMetricStreamStatisticsConfigurationOutputWithContext(context.Context) MetricStreamStatisticsConfigurationOutput
}

MetricStreamStatisticsConfigurationInput is an input type that accepts MetricStreamStatisticsConfigurationArgs and MetricStreamStatisticsConfigurationOutput values. You can construct a concrete instance of `MetricStreamStatisticsConfigurationInput` via: 

MetricStreamStatisticsConfigurationArgs{...}

type MetricStreamStatisticsConfigurationOutput added in v0.16.0 

type MetricStreamStatisticsConfigurationOutput struct{ *pulumi.OutputState }

This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.

func (MetricStreamStatisticsConfigurationOutput) AdditionalStatistics added in v0.16.0 

func (o MetricStreamStatisticsConfigurationOutput) AdditionalStatistics() pulumi.StringArrayOutput

The additional statistics to stream for the metrics listed in IncludeMetrics.

func (MetricStreamStatisticsConfigurationOutput) ElementType added in v0.16.0 

func (MetricStreamStatisticsConfigurationOutput) ElementType() reflect.Type

func (MetricStreamStatisticsConfigurationOutput) IncludeMetrics added in v0.16.0 

func (o MetricStreamStatisticsConfigurationOutput) IncludeMetrics() MetricStreamStatisticsMetricArrayOutput

An array that defines the metrics that are to have additional statistics streamed.

func (MetricStreamStatisticsConfigurationOutput) ToMetricStreamStatisticsConfigurationOutput added in v0.16.0 

func (o MetricStreamStatisticsConfigurationOutput) ToMetricStreamStatisticsConfigurationOutput() MetricStreamStatisticsConfigurationOutput

func (MetricStreamStatisticsConfigurationOutput) ToMetricStreamStatisticsConfigurationOutputWithContext added in v0.16.0 

func (o MetricStreamStatisticsConfigurationOutput) ToMetricStreamStatisticsConfigurationOutputWithContext(ctx context.Context) MetricStreamStatisticsConfigurationOutput

type MetricStreamStatisticsMetric added in v0.16.0 

type MetricStreamStatisticsMetric struct {
	// The name of the metric.
	MetricName string `pulumi:"metricName"`
	// The namespace of the metric.
	Namespace string `pulumi:"namespace"`
}

A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.

type MetricStreamStatisticsMetricArgs added in v0.16.0 

type MetricStreamStatisticsMetricArgs struct {
	// The name of the metric.
	MetricName pulumi.StringInput `pulumi:"metricName"`
	// The namespace of the metric.
	Namespace pulumi.StringInput `pulumi:"namespace"`
}

A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.

func (MetricStreamStatisticsMetricArgs) ElementType added in v0.16.0 

func (MetricStreamStatisticsMetricArgs) ElementType() reflect.Type

func (MetricStreamStatisticsMetricArgs) ToMetricStreamStatisticsMetricOutput added in v0.16.0 

func (i MetricStreamStatisticsMetricArgs) ToMetricStreamStatisticsMetricOutput() MetricStreamStatisticsMetricOutput

func (MetricStreamStatisticsMetricArgs) ToMetricStreamStatisticsMetricOutputWithContext added in v0.16.0 

func (i MetricStreamStatisticsMetricArgs) ToMetricStreamStatisticsMetricOutputWithContext(ctx context.Context) MetricStreamStatisticsMetricOutput

type MetricStreamStatisticsMetricArray added in v0.16.0 

type MetricStreamStatisticsMetricArray []MetricStreamStatisticsMetricInput

func (MetricStreamStatisticsMetricArray) ElementType added in v0.16.0 

func (MetricStreamStatisticsMetricArray) ElementType() reflect.Type

func (MetricStreamStatisticsMetricArray) ToMetricStreamStatisticsMetricArrayOutput added in v0.16.0 

func (i MetricStreamStatisticsMetricArray) ToMetricStreamStatisticsMetricArrayOutput() MetricStreamStatisticsMetricArrayOutput

func (MetricStreamStatisticsMetricArray) ToMetricStreamStatisticsMetricArrayOutputWithContext added in v0.16.0 

func (i MetricStreamStatisticsMetricArray) ToMetricStreamStatisticsMetricArrayOutputWithContext(ctx context.Context) MetricStreamStatisticsMetricArrayOutput

type MetricStreamStatisticsMetricArrayInput added in v0.16.0 

type MetricStreamStatisticsMetricArrayInput interface {
	pulumi.Input

	ToMetricStreamStatisticsMetricArrayOutput() MetricStreamStatisticsMetricArrayOutput
	ToMetricStreamStatisticsMetricArrayOutputWithContext(context.Context) MetricStreamStatisticsMetricArrayOutput
}

MetricStreamStatisticsMetricArrayInput is an input type that accepts MetricStreamStatisticsMetricArray and MetricStreamStatisticsMetricArrayOutput values. You can construct a concrete instance of `MetricStreamStatisticsMetricArrayInput` via: 

MetricStreamStatisticsMetricArray{ MetricStreamStatisticsMetricArgs{...} }

type MetricStreamStatisticsMetricArrayOutput added in v0.16.0 

type MetricStreamStatisticsMetricArrayOutput struct{ *pulumi.OutputState }

func (MetricStreamStatisticsMetricArrayOutput) ElementType added in v0.16.0 

func (MetricStreamStatisticsMetricArrayOutput) ElementType() reflect.Type

func (MetricStreamStatisticsMetricArrayOutput) Index added in v0.16.0 

func (o MetricStreamStatisticsMetricArrayOutput) Index(i pulumi.IntInput) MetricStreamStatisticsMetricOutput

func (MetricStreamStatisticsMetricArrayOutput) ToMetricStreamStatisticsMetricArrayOutput added in v0.16.0 

func (o MetricStreamStatisticsMetricArrayOutput) ToMetricStreamStatisticsMetricArrayOutput() MetricStreamStatisticsMetricArrayOutput

func (MetricStreamStatisticsMetricArrayOutput) ToMetricStreamStatisticsMetricArrayOutputWithContext added in v0.16.0 

func (o MetricStreamStatisticsMetricArrayOutput) ToMetricStreamStatisticsMetricArrayOutputWithContext(ctx context.Context) MetricStreamStatisticsMetricArrayOutput

type MetricStreamStatisticsMetricInput added in v0.16.0 

type MetricStreamStatisticsMetricInput interface {
	pulumi.Input

	ToMetricStreamStatisticsMetricOutput() MetricStreamStatisticsMetricOutput
	ToMetricStreamStatisticsMetricOutputWithContext(context.Context) MetricStreamStatisticsMetricOutput
}

MetricStreamStatisticsMetricInput is an input type that accepts MetricStreamStatisticsMetricArgs and MetricStreamStatisticsMetricOutput values. You can construct a concrete instance of `MetricStreamStatisticsMetricInput` via: 

MetricStreamStatisticsMetricArgs{...}

type MetricStreamStatisticsMetricOutput added in v0.16.0 

type MetricStreamStatisticsMetricOutput struct{ *pulumi.OutputState }

A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.

func (MetricStreamStatisticsMetricOutput) ElementType added in v0.16.0 

func (MetricStreamStatisticsMetricOutput) ElementType() reflect.Type

func (MetricStreamStatisticsMetricOutput) MetricName added in v0.16.0 

func (o MetricStreamStatisticsMetricOutput) MetricName() pulumi.StringOutput

The name of the metric.

func (MetricStreamStatisticsMetricOutput) Namespace added in v0.16.0 

func (o MetricStreamStatisticsMetricOutput) Namespace() pulumi.StringOutput

The namespace of the metric.

func (MetricStreamStatisticsMetricOutput) ToMetricStreamStatisticsMetricOutput added in v0.16.0 

func (o MetricStreamStatisticsMetricOutput) ToMetricStreamStatisticsMetricOutput() MetricStreamStatisticsMetricOutput

func (MetricStreamStatisticsMetricOutput) ToMetricStreamStatisticsMetricOutputWithContext added in v0.16.0 

func (o MetricStreamStatisticsMetricOutput) ToMetricStreamStatisticsMetricOutputWithContext(ctx context.Context) MetricStreamStatisticsMetricOutput

type MetricStreamTag 

type MetricStreamTag struct {
	// A unique identifier for the tag.
	Key string `pulumi:"key"`
	// String which you can use to describe or define the tag.
	Value string `pulumi:"value"`
}

Metadata that you can assign to a Metric Stream, consisting of a key-value pair.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.