< Back
Add-CfnAutoScaling_LaunchConfigurationResource
Post
NAME Add-CfnAutoScaling_LaunchConfigurationResource
SYNOPSIS
The AWS::AutoScaling::LaunchConfiguration type creates an Auto Scaling launch configuration that can be used by an
Auto Scaling group to configure EC2 instances in the Auto Scaling group.
SYNTAX
Add-CfnAutoScaling_LaunchConfigurationResource [-ResourceName] <String> [-AssociatePublicIpAddress <Boolean>]
[-BlockDeviceMappings <IDictionary[]>] [-ClassicLinkVPCId <String>] [-ClassicLinkVPCSecurityGroups <String[]>]
[-EbsOptimized <Boolean>] [-IamInstanceProfile <String>] [-ImageId <String>] [-InstanceId <String>]
[-InstanceMonitoring <Boolean>] [-InstanceType <String>] [-KernelId <String>] [-KeyName <String>]
[-PlacementTenancy <String>] [-RamdiskId <String>] [-SecurityGroups <String[]>] [-SpotPrice <String>] [-UserData
<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
-AssociatePublicIpAddress <Boolean>
Indicates whether Amazon EC2 instances in the Auto Scaling group receive public IP addresses. If you specify
true, each instance in the Auto Scaling receives a unique public IP address.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-BlockDeviceMappings <IDictionary[]>
Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClassicLinkVPCId <String>
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. You can specify this property only
for EC2-Classic instances.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClassicLinkVPCSecurityGroups <String[]>
The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EbsOptimized <Boolean>
Specifies whether the launch configuration is optimized for EBS I/O. This optimization provides dedicated
throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance.
Additional fees are incurred when using EBS-optimized instances.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IamInstanceProfile <String>
Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for
the instance. The instance profile contains the IAM role.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ImageId <String>
Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
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 launch configuration. Use this property if you
want the launch configuration to use settings from an existing Amazon EC2 instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstanceMonitoring <Boolean>
Indicates whether or not instance monitoring should be enabled for this autoscaling group. This is enabled by
default. To turn it off, set InstanceMonitoring to "false".
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-InstanceType <String>
The instance type. For example, "m1.small".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-KernelId <String>
The kernel ID
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-KeyName <String>
Provides the name of the EC2 key pair.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PlacementTenancy <String>
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can
only be launched in a VPC.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RamdiskId <String>
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel
requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer
to the AWS Resource Center and search for the kernel ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecurityGroups <String[]>
A list containing the EC2 security groups to assign to the Amazon EC2 instances in the Auto Scaling group. The
list can contain the name of existing EC2 security groups, references to AWS::EC2::SecurityGroup resources
created in the template, or both.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SpotPrice <String>
The spot price for this autoscaling group. If a spot price is set, then the autoscaling group will launch when
the current spot price is less than the amount specified in the template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserData <String>
The user data available to the launched EC2 instances.
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 ... LaunchConf
iguration
SYNOPSIS
The AWS::AutoScaling::LaunchConfiguration type creates an Auto Scaling launch configuration that can be used by an
Auto Scaling group to configure EC2 instances in the Auto Scaling group.
SYNTAX
Add-CfnAutoScaling_LaunchConfigurationResource [-ResourceName] <String> [-AssociatePublicIpAddress <Boolean>]
[-BlockDeviceMappings <IDictionary[]>] [-ClassicLinkVPCId <String>] [-ClassicLinkVPCSecurityGroups <String[]>]
[-EbsOptimized <Boolean>] [-IamInstanceProfile <String>] [-ImageId <String>] [-InstanceId <String>]
[-InstanceMonitoring <Boolean>] [-InstanceType <String>] [-KernelId <String>] [-KeyName <String>]
[-PlacementTenancy <String>] [-RamdiskId <String>] [-SecurityGroups <String[]>] [-SpotPrice <String>] [-UserData
<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
-AssociatePublicIpAddress <Boolean>
Indicates whether Amazon EC2 instances in the Auto Scaling group receive public IP addresses. If you specify
true, each instance in the Auto Scaling receives a unique public IP address.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-BlockDeviceMappings <IDictionary[]>
Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClassicLinkVPCId <String>
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. You can specify this property only
for EC2-Classic instances.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClassicLinkVPCSecurityGroups <String[]>
The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EbsOptimized <Boolean>
Specifies whether the launch configuration is optimized for EBS I/O. This optimization provides dedicated
throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance.
Additional fees are incurred when using EBS-optimized instances.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IamInstanceProfile <String>
Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for
the instance. The instance profile contains the IAM role.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ImageId <String>
Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
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 launch configuration. Use this property if you
want the launch configuration to use settings from an existing Amazon EC2 instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstanceMonitoring <Boolean>
Indicates whether or not instance monitoring should be enabled for this autoscaling group. This is enabled by
default. To turn it off, set InstanceMonitoring to "false".
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-InstanceType <String>
The instance type. For example, "m1.small".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-KernelId <String>
The kernel ID
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-KeyName <String>
Provides the name of the EC2 key pair.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PlacementTenancy <String>
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can
only be launched in a VPC.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RamdiskId <String>
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel
requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer
to the AWS Resource Center and search for the kernel ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecurityGroups <String[]>
A list containing the EC2 security groups to assign to the Amazon EC2 instances in the Auto Scaling group. The
list can contain the name of existing EC2 security groups, references to AWS::EC2::SecurityGroup resources
created in the template, or both.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SpotPrice <String>
The spot price for this autoscaling group. If a spot price is set, then the autoscaling group will launch when
the current spot price is less than the amount specified in the template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserData <String>
The user data available to the launched EC2 instances.
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 ... LaunchConf
iguration