< Back
Add-CfnAutoScaling_TriggerResource
Post
NAME Add-CfnAutoScaling_TriggerResource
SYNOPSIS
Creates an Auto Scaling trigger that determines when scaling activities should occur for the Auto Scaling group.
This type does not support updates.
SYNTAX
Add-CfnAutoScaling_TriggerResource [-ResourceName] <String> [-AutoScalingGroupName <String>] [-BreachDuration
<String>] [-Dimensions <IDictionary[]>] [-LowerBreachScaleIncrement <String>] [-LowerThreshold <String>]
[-MetricName <String>] [-Namespace <String>] [-Period <String>] [-Statistic <String>] [-Unit <String>]
[-UpperBreachScaleIncrement <String>] [-UpperThreshold <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
-AutoScalingGroupName <String>
The name of the Auto Scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BreachDuration <String>
The amount of time to wait while the trigger is firing before performing scaling activities in response to the
breach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Dimensions <IDictionary[]>
A list of CloudWatch dimensions used to retrieve metric statistics that the trigger uses to determine when to
fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LowerBreachScaleIncrement <String>
The incremental amount to use when performing scaling activities when the lower threshold has been breached.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LowerThreshold <String>
The lower limit for the metric. The trigger fires if all data points in the last BreachDuration seconds exceed
the upper threshold or fall below the lower threshold.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MetricName <String>
The metric name used by the trigger to determine when to fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Namespace <String>
The namespace used by the trigger to determine when to fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Period <String>
The period used in retrieving metric statistics used by the trigger to determine when to fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Statistic <String>
The statistic used by the trigger to determine which metric statistics to examine.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Unit <String>
The standard unit associated with a measure, used by the trigger when fetching the metric statistics it uses
to determine when to activate.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpperBreachScaleIncrement <String>
The incremental amount to use when performing scaling activities when the upper threshold has been breached.
Must be a negative or positive integer, or integer percentage value.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpperThreshold <String>
The upper limit of the metric used. The trigger fires if all data points in the last BreachDuration seconds
exceed the upper threshold or fall below the lower threshold.
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 ... g::Trigger
SYNOPSIS
Creates an Auto Scaling trigger that determines when scaling activities should occur for the Auto Scaling group.
This type does not support updates.
SYNTAX
Add-CfnAutoScaling_TriggerResource [-ResourceName] <String> [-AutoScalingGroupName <String>] [-BreachDuration
<String>] [-Dimensions <IDictionary[]>] [-LowerBreachScaleIncrement <String>] [-LowerThreshold <String>]
[-MetricName <String>] [-Namespace <String>] [-Period <String>] [-Statistic <String>] [-Unit <String>]
[-UpperBreachScaleIncrement <String>] [-UpperThreshold <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
-AutoScalingGroupName <String>
The name of the Auto Scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BreachDuration <String>
The amount of time to wait while the trigger is firing before performing scaling activities in response to the
breach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Dimensions <IDictionary[]>
A list of CloudWatch dimensions used to retrieve metric statistics that the trigger uses to determine when to
fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LowerBreachScaleIncrement <String>
The incremental amount to use when performing scaling activities when the lower threshold has been breached.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LowerThreshold <String>
The lower limit for the metric. The trigger fires if all data points in the last BreachDuration seconds exceed
the upper threshold or fall below the lower threshold.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MetricName <String>
The metric name used by the trigger to determine when to fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Namespace <String>
The namespace used by the trigger to determine when to fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Period <String>
The period used in retrieving metric statistics used by the trigger to determine when to fire.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Statistic <String>
The statistic used by the trigger to determine which metric statistics to examine.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Unit <String>
The standard unit associated with a measure, used by the trigger when fetching the metric statistics it uses
to determine when to activate.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpperBreachScaleIncrement <String>
The incremental amount to use when performing scaling activities when the upper threshold has been breached.
Must be a negative or positive integer, or integer percentage value.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpperThreshold <String>
The upper limit of the metric used. The trigger fires if all data points in the last BreachDuration seconds
exceed the upper threshold or fall below the lower threshold.
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 ... g::Trigger