< Back
Add-CfnAutoScaling_AutoScalingGroupResource
Post
NAME Add-CfnAutoScaling_AutoScalingGroupResource
SYNOPSIS
The AWS::AutoScaling::AutoScalingGroup type creates an Auto Scaling group.
SYNTAX
Add-CfnAutoScaling_AutoScalingGroupResource [-ResourceName] <String> [-AvailabilityZones <String[]>] [-Cooldown
<String>] [-DesiredCapacity <String>] [-HealthCheckGracePeriod <Int32>] [-HealthCheckType <String>] [-InstanceId
<String>] [-LaunchConfigurationName <String>] [-LoadBalancerNames <String[]>] [-MaxSize <String>]
[-MetricsCollection <IDictionary[]>] [-MinSize <String>] [-NotificationConfiguration <IDictionary>]
[-NotificationConfigurations <IDictionary[]>] [-PlacementGroup <String>] [-Tags <IDictionary>]
[-TerminationPolicies <String[]>] [-VPCZoneIdentifier <String[]>] [-DeletionPolicy <String>] [-Metadata
<Hashtable>] [-CreationPolicy <Hashtable>] [-UpdatePolicy <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
-AvailabilityZones <String[]>
Contains a list of Availability Zones for the group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Cooldown <String>
The number of seconds after a scaling activity completes before any further scaling activities can start.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DesiredCapacity <String>
Specifies the desired capacity for the auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HealthCheckGracePeriod <Int32>
The length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking
its health.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-HealthCheckType <String>
The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are "EC2" or
"ELB."
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstanceId <String>
The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this property if you
want to create an Auto Scaling group by using an existing Amazon EC2 instance instead of a launch
configuration.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LaunchConfigurationName <String>
Specifies the name of the associated AWS::AutoScaling::LaunchConfiguration.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoadBalancerNames <String[]>
A list of load balancers associated with this auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxSize <String>
The maximum size of the auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MetricsCollection <IDictionary[]>
Enables the monitoring of group metrics of an Auto Scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MinSize <String>
The minimum size of the auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotificationConfiguration <IDictionary>
An embedded property that configures an auto scaling group to send notifications when specified events take
place.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotificationConfigurations <IDictionary[]>
An embedded property that configures an auto scaling group to send notifications when specified events take
place.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PlacementGroup <String>
The name of an existing cluster placement group into which you want to launch your instances.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags you want to attach to this resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TerminationPolicies <String[]>
A termination policy or a list of termination policies that are used to select the instances to terminate. The
policies are executed in the order that you list them.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VPCZoneIdentifier <String[]>
A list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
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
-CreationPolicy <Hashtable>
You associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete
until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To
signal a resource, you can use the cfn-signal helper script or SignalResource API. AWS CloudFormation
publishes valid signals to the stack events so that you track the number of signals sent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpdatePolicy <Hashtable>
You can use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the
AWS::AutoScaling::AutoScalingGroup resource.
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 ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... olicy.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 ... AutoScalin
gGroup
SYNOPSIS
The AWS::AutoScaling::AutoScalingGroup type creates an Auto Scaling group.
SYNTAX
Add-CfnAutoScaling_AutoScalingGroupResource [-ResourceName] <String> [-AvailabilityZones <String[]>] [-Cooldown
<String>] [-DesiredCapacity <String>] [-HealthCheckGracePeriod <Int32>] [-HealthCheckType <String>] [-InstanceId
<String>] [-LaunchConfigurationName <String>] [-LoadBalancerNames <String[]>] [-MaxSize <String>]
[-MetricsCollection <IDictionary[]>] [-MinSize <String>] [-NotificationConfiguration <IDictionary>]
[-NotificationConfigurations <IDictionary[]>] [-PlacementGroup <String>] [-Tags <IDictionary>]
[-TerminationPolicies <String[]>] [-VPCZoneIdentifier <String[]>] [-DeletionPolicy <String>] [-Metadata
<Hashtable>] [-CreationPolicy <Hashtable>] [-UpdatePolicy <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
-AvailabilityZones <String[]>
Contains a list of Availability Zones for the group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Cooldown <String>
The number of seconds after a scaling activity completes before any further scaling activities can start.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DesiredCapacity <String>
Specifies the desired capacity for the auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HealthCheckGracePeriod <Int32>
The length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking
its health.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-HealthCheckType <String>
The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are "EC2" or
"ELB."
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstanceId <String>
The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this property if you
want to create an Auto Scaling group by using an existing Amazon EC2 instance instead of a launch
configuration.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LaunchConfigurationName <String>
Specifies the name of the associated AWS::AutoScaling::LaunchConfiguration.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoadBalancerNames <String[]>
A list of load balancers associated with this auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxSize <String>
The maximum size of the auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MetricsCollection <IDictionary[]>
Enables the monitoring of group metrics of an Auto Scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MinSize <String>
The minimum size of the auto scaling group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotificationConfiguration <IDictionary>
An embedded property that configures an auto scaling group to send notifications when specified events take
place.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotificationConfigurations <IDictionary[]>
An embedded property that configures an auto scaling group to send notifications when specified events take
place.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PlacementGroup <String>
The name of an existing cluster placement group into which you want to launch your instances.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags you want to attach to this resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TerminationPolicies <String[]>
A termination policy or a list of termination policies that are used to select the instances to terminate. The
policies are executed in the order that you list them.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VPCZoneIdentifier <String[]>
A list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
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
-CreationPolicy <Hashtable>
You associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete
until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To
signal a resource, you can use the cfn-signal helper script or SignalResource API. AWS CloudFormation
publishes valid signals to the stack events so that you track the number of signals sent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpdatePolicy <Hashtable>
You can use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the
AWS::AutoScaling::AutoScalingGroup resource.
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 ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... olicy.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 ... AutoScalin
gGroup