Paws::CloudWatch::PutMetricAlarm - Arguments for method PutMetricAlarm on Paws::CloudWatch
This class represents the parameters used for calling the method PutMetricAlarm on the Amazon CloudWatch service. Use the attributes of this class as arguments to method PutMetricAlarm.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutMetricAlarm.
my $monitoring = Paws->service('CloudWatch'); $monitoring->PutMetricAlarm( AlarmName => 'MyAlarmName', ComparisonOperator => 'GreaterThanOrEqualToThreshold', EvaluationPeriods => 1, Threshold => 1, ActionsEnabled => 1, # OPTIONAL AlarmActions => [ 'MyResourceName', ... # min: 1, max: 1024 ], # OPTIONAL AlarmDescription => 'MyAlarmDescription', # OPTIONAL DatapointsToAlarm => 1, # OPTIONAL Dimensions => [ { Name => 'MyDimensionName', # min: 1, max: 255 Value => 'MyDimensionValue', # min: 1, max: 255 }, ... ], # OPTIONAL EvaluateLowSampleCountPercentile => 'MyEvaluateLowSampleCountPercentile', # OPTIONAL ExtendedStatistic => 'MyExtendedStatistic', # OPTIONAL InsufficientDataActions => [ 'MyResourceName', ... # min: 1, max: 1024 ], # OPTIONAL MetricName => 'MyMetricName', # OPTIONAL Metrics => [ { Id => 'MyMetricId', # min: 1, max: 255 Expression => 'MyMetricExpression', # min: 1, max: 1024; OPTIONAL Label => 'MyMetricLabel', # OPTIONAL MetricStat => { Metric => { Dimensions => [ { Name => 'MyDimensionName', # min: 1, max: 255 Value => 'MyDimensionValue', # min: 1, max: 255 }, ... ], # max: 10 MetricName => 'MyMetricName', # min: 1, max: 255 Namespace => 'MyNamespace', # min: 1, max: 255; OPTIONAL }, Period => 1, # min: 1 Stat => 'MyStat', Unit => 'Seconds' , # 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, None; OPTIONAL }, # OPTIONAL ReturnData => 1, # OPTIONAL }, ... ], # OPTIONAL Namespace => 'MyNamespace', # OPTIONAL OKActions => [ 'MyResourceName', ... # min: 1, max: 1024 ], # OPTIONAL Period => 1, # OPTIONAL Statistic => 'SampleCount', # OPTIONAL TreatMissingData => 'MyTreatMissingData', # OPTIONAL Unit => 'Seconds', # OPTIONAL );
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/monitoring/PutMetricAlarm
Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
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).
ALARM
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:recover
arn:aws:sns:region:account-id:sns-topic-name
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
The description for the alarm.
The name for the alarm. This name must be unique within your AWS account.
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
Valid values are: "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
"GreaterThanOrEqualToThreshold"
"GreaterThanThreshold"
"LessThanThreshold"
"LessThanOrEqualToThreshold"
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. For more information, see Evaluating an Alarm (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the Amazon CloudWatch User Guide.
The dimensions for the metric specified in MetricName.
MetricName
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 (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples).
ignore
evaluate
Valid Values: evaluate | ignore
evaluate | ignore
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.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
Period
The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.
PutMetricAlarm
Statistic
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).
INSUFFICIENT_DATA
Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
The name for the metric associated with the alarm.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.
Dimensions
Namespace
ExtendedStatistic
Metrics
An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. Each item in the Metrics array either retrieves a metric or performs a math expression.
MetricDataQuery
If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, 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.
The namespace for the metric associated specified in MetricName.
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).
OK
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
arn:aws:automate:region:ec2:reboot
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 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 may often lapse into INSUFFICENT_DATA status. Specifying 10 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 (https://aws.amazon.com/cloudwatch/pricing/).
PutMetricData
StorageResolution
An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
EvaluationPeriods
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.
Valid values are: "SampleCount", "Average", "Sum", "Minimum", "Maximum"
"SampleCount"
"Average"
"Sum"
"Minimum"
"Maximum"
The value against which the specified statistic is compared.
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 (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).
TreatMissingData
missing
Valid Values: breaching | notBreaching | ignore | missing
breaching | notBreaching | ignore | missing
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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.
INSUFFICIENT DATA
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", "None"
"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"
"None"
This class forms part of Paws, documenting arguments for method PutMetricAlarm in Paws::CloudWatch
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.