A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.aws.amazon.com/powershell/latest/reference/items/Write-CWMetricAlarm.html below:

CloudWatch: Write-CWMetricAlarm Cmdlet | AWS Tools for PowerShell

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

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The actions to execute when this alarm transitions to the

ALARM

state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

EC2 actions: Autoscaling action: Lambda actions: SNS notification action: SSM integration actions: Start a Amazon Q Developer operational investigation arn:aws:aiops: region: account-id:investigation-group: investigation-group-id

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases AlarmActions

The description for the alarm.

Required? False Position? 2 Accept pipeline input? True (ByPropertyName)

The name for the alarm. This name must be unique within the Region.The name must contain only UTF-8 characters, and can't contain ASCII control characters

Required? True Position? 1 Accept pipeline input? True (ByValue, ByPropertyName)

Amazon.PowerShell.Cmdlets.CW.AmazonCloudWatchClientCmdlet.ClientConfig

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.The values LessThanLowerOrGreaterThanUpperThreshold , LessThanLowerThreshold , and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

Required? True Position? Named Accept pipeline input? True (ByPropertyName)

-DatapointsToAlarm <

Int32

>

The number of data points 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. For more information, see

Evaluating an Alarm

in the

Amazon CloudWatch User Guide

.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The dimensions for the metric specified in MetricName . Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases Dimensions

-EvaluateLowSampleCountPercentile <

String

>

Used only for alarms based on percentiles. If you specify

ignore

, the alarm state does not change during periods with too few data points to be statistically significant. If you specify

evaluate

or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see

Percentile-Based CloudWatch Alarms and Low Data Samples

.Valid Values:

evaluate | ignore Required? False Position? Named Accept pipeline input? True (ByPropertyName)

-EvaluationPeriod <

Int32

>

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.

Required? True Position? Named Accept pipeline input? True (ByPropertyName) Aliases EvaluationPeriods

The extended statistic for the metric specified in

MetricName

. When you call

PutMetricAlarm

and specify a

MetricName

, you must specify either

Statistic

or

ExtendedStatistic

but not both.If you specify

ExtendedStatistic

, the following are valid values:

For more information about these extended statistics, see

CloudWatch statistics definitions

.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

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). Valid values:

EC2 actions: Autoscaling action: Lambda actions: SNS notification action: SSM integration actions:

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases InsufficientDataActions

An array of

MetricDataQuery

structures that enable you to create an alarm based on the result of a metric math expression. For each

PutMetricAlarm

operation, you must specify either

MetricName

or a

Metrics

array.Each item in the

Metrics

array either retrieves a metric or performs a math expression.One item in the

Metrics

array is the expression that the alarm watches. You designate this expression by setting

ReturnData

to true for this object in the array. For more information, see

MetricDataQuery

.If you use the

Metrics

parameter, you cannot include the

Namespace

,

MetricName

,

Dimensions

,

Period

,

Unit

,

Statistic

, or

ExtendedStatistic

parameters of

PutMetricAlarm

in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the

Metrics

array. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases Metrics

The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Namespace , Dimensions , Period , Unit , Statistic , or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The namespace for the metric associated specified in MetricName .

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The actions to execute when this alarm transitions to an

OK

state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

EC2 actions: Autoscaling action: Lambda actions: SNS notification action: SSM integration actions:

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases OKActions

The length, in seconds, used each time the metric specified in

MetricName

is evaluated. Valid values are 10, 20, 30, and any multiple of 60.

Period

is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the

Metrics

array.Be sure to specify 10, 20, or 30 only for metrics that are stored by a

PutMetricData

call with a

StorageResolution

of 1. If you specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see

Amazon CloudWatch Pricing

.An alarm's total current evaluation period can be no longer than seven days, so

Period

multiplied by

EvaluationPeriods

can't be more than 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatch.Model.PutMetricAlarmResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The statistic for the metric specified in MetricName , other than percentile. For percentile statistics, use ExtendedStatistic . When you call PutMetricAlarm and specify a MetricName , you must specify either Statistic or ExtendedStatistic, but not both.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

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.If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use

TagResource

or

UntagResource

.To use this field to set tags for an alarm when you create it, you must be signed on with both the

cloudwatch:PutMetricAlarm

and

cloudwatch:TagResource

permissions. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases Tags

The value against which the specified statistic is compared.This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.If your alarm uses this parameter, it cannot have Auto Scaling actions.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Sets how this alarm is to handle missing data points. If

TreatMissingData

is omitted, the default behavior of

missing

is used. For more information, see

Configuring How CloudWatch Alarms Treats Missing Data

.Valid Values:

breaching | notBreaching | ignore | missing

Alarms that evaluate metrics in the

AWS/DynamoDB

namespace always

ignore

missing data even if you choose a different option for

TreatMissingData

. When an

AWS/DynamoDB

metric has missing data, alarms that evaluate that metric remain in their current state.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.If you don't specify Unit , CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4