< Back
Add-CfnCloudWatch_AlarmResource
Post
NAME Add-CfnCloudWatch_AlarmResource
SYNOPSIS
The AWS::CloudWatch::Alarm type creates an Amazon CloudWatch alarm.
SYNTAX
Add-CfnCloudWatch_AlarmResource [-ResourceName] <String> [-ActionsEnabled <String>] [-AlarmActions <String[]>]
[-AlarmDescription <String>] [-AlarmName <String>] [-ComparisonOperator <String>] [-Dimensions <IDictionary[]>]
[-EvaluationPeriods <String>] [-InsufficientDataActions <String[]>] [-MetricName <String>] [-Namespace <String>]
[-OKActions <String[]>] [-Period <String>] [-Statistic <String>] [-Threshold <String>] [-Unit <String>]
[-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>]
[-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ActionsEnabled <String>
Indicates whether or not actions should be executed during any changes to the alarm's state. Either true or
false.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AlarmActions <String[]>
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each
action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to
an Amazon SNS topic or an Amazon Auto Scaling policy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AlarmDescription <String>
The description for the alarm.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AlarmName <String>
A name for the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses
that ID for the alarm name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComparisonOperator <String>
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic
value is used as the first operand.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Dimensions <IDictionary[]>
The dimensions for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EvaluationPeriods <String>
The number of periods over which data is compared to the specified threshold.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InsufficientDataActions <String[]>
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other
state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is
publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MetricName <String>
The name for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Namespace <String>
The namespace for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OKActions <String[]>
The list of actions to execute when this alarm transitions into an OK state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an
Amazon SNS topic or an Amazon Auto Scaling policy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Period <String>
The period in seconds over which the specified statistic is applied.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Statistic <String>
The statistic to apply to the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Threshold <String>
The value against which the specified statistic is compared.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Unit <String>
The unit for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... tch::Alarm
SYNOPSIS
The AWS::CloudWatch::Alarm type creates an Amazon CloudWatch alarm.
SYNTAX
Add-CfnCloudWatch_AlarmResource [-ResourceName] <String> [-ActionsEnabled <String>] [-AlarmActions <String[]>]
[-AlarmDescription <String>] [-AlarmName <String>] [-ComparisonOperator <String>] [-Dimensions <IDictionary[]>]
[-EvaluationPeriods <String>] [-InsufficientDataActions <String[]>] [-MetricName <String>] [-Namespace <String>]
[-OKActions <String[]>] [-Period <String>] [-Statistic <String>] [-Threshold <String>] [-Unit <String>]
[-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>]
[-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ActionsEnabled <String>
Indicates whether or not actions should be executed during any changes to the alarm's state. Either true or
false.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AlarmActions <String[]>
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each
action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to
an Amazon SNS topic or an Amazon Auto Scaling policy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AlarmDescription <String>
The description for the alarm.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AlarmName <String>
A name for the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses
that ID for the alarm name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComparisonOperator <String>
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic
value is used as the first operand.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Dimensions <IDictionary[]>
The dimensions for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EvaluationPeriods <String>
The number of periods over which data is compared to the specified threshold.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InsufficientDataActions <String[]>
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other
state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is
publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MetricName <String>
The name for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Namespace <String>
The namespace for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OKActions <String[]>
The list of actions to execute when this alarm transitions into an OK state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an
Amazon SNS topic or an Amazon Auto Scaling policy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Period <String>
The period in seconds over which the specified statistic is applied.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Statistic <String>
The statistic to apply to the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Threshold <String>
The value against which the specified statistic is compared.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Unit <String>
The unit for the alarm's associated metric.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... tch::Alarm