CfnLaunchConfigurationProps
- class aws_cdk.aws_autoscaling.CfnLaunchConfigurationProps(*, image_id, instance_type, associate_public_ip_address=None, block_device_mappings=None, classic_link_vpc_id=None, classic_link_vpc_security_groups=None, ebs_optimized=None, iam_instance_profile=None, instance_id=None, instance_monitoring=None, kernel_id=None, key_name=None, launch_configuration_name=None, metadata_options=None, placement_tenancy=None, ram_disk_id=None, security_groups=None, spot_price=None, user_data=None)
Bases:
object
Properties for defining a
CfnLaunchConfiguration
.- Parameters:
image_id (
str
) – The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances . If you specifyInstanceId
, anImageId
is not required.instance_type (
str
) – Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances . If you specifyInstanceId
, anInstanceType
is not required.associate_public_ip_address (
Union
[bool
,IResolvable
,None
]) – Specifies whether to assign a public IPv4 address to the group’s instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. If you specifytrue
, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide . If you specify this property, you must specify at least one subnet forVPCZoneIdentifier
when you create your group.block_device_mappings (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,BlockDeviceMappingProperty
,Dict
[str
,Any
]]],None
]) – The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances .classic_link_vpc_id (
Optional
[str
]) – Available for backward compatibility.classic_link_vpc_security_groups (
Optional
[Sequence
[str
]]) – Available for backward compatibility.ebs_optimized (
Union
[bool
,IResolvable
,None
]) – Specifies whether the launch configuration is optimized for EBS I/O (true
) or not (false
). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances . The default value isfalse
.iam_instance_profile (
Optional
[str
]) – 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. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide .instance_id (
Optional
[str
]) – The ID of the Amazon EC2 instance to use to create the launch configuration. When you use an instance to create a launch configuration, all properties are derived from the instance with the exception ofBlockDeviceMapping
andAssociatePublicIpAddress
. You can override any properties from the instance by specifying them in the launch configuration.instance_monitoring (
Union
[bool
,IResolvable
,None
]) – Controls whether instances in this group are launched with detailed (true
) or basic (false
) monitoring. The default value istrue
(enabled). .. epigraph:: When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide .kernel_id (
Optional
[str
]) – The ID of the kernel associated with the AMI. .. epigraph:: We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances .key_name (
Optional
[str
]) – The name of the key pair. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances .launch_configuration_name (
Optional
[str
]) – The name of the launch configuration. This name must be unique per Region per account.metadata_options (
Union
[IResolvable
,MetadataOptionsProperty
,Dict
[str
,Any
],None
]) – The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide .placement_tenancy (
Optional
[str
]) – The tenancy of the instance, eitherdefault
ordedicated
. An instance withdedicated
tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set todefault
), you must set the value of this property todedicated
. For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide . If you specifyPlacementTenancy
, you must specify at least one subnet forVPCZoneIdentifier
when you create your group. Valid values:default
|dedicated
ram_disk_id (
Optional
[str
]) –The ID of the RAM disk to select. .. epigraph:: We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances .
security_groups (
Optional
[Sequence
[str
]]) – A list that contains the security groups to assign to the instances in the Auto Scaling group. The list can contain both the IDs of existing security groups and references to SecurityGroup resources created in the template. For more information, see Control traffic to resources using security groups in the Amazon Virtual Private Cloud User Guide .spot_price (
Optional
[str
]) – The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide . Valid Range: Minimum value of 0.001 .. epigraph:: When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.user_data (
Optional
[str
]) – The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances .
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_autoscaling as autoscaling cfn_launch_configuration_props = autoscaling.CfnLaunchConfigurationProps( image_id="imageId", instance_type="instanceType", # the properties below are optional associate_public_ip_address=False, block_device_mappings=[autoscaling.CfnLaunchConfiguration.BlockDeviceMappingProperty( device_name="deviceName", # the properties below are optional ebs=autoscaling.CfnLaunchConfiguration.BlockDeviceProperty( delete_on_termination=False, encrypted=False, iops=123, snapshot_id="snapshotId", throughput=123, volume_size=123, volume_type="volumeType" ), no_device=False, virtual_name="virtualName" )], classic_link_vpc_id="classicLinkVpcId", classic_link_vpc_security_groups=["classicLinkVpcSecurityGroups"], ebs_optimized=False, iam_instance_profile="iamInstanceProfile", instance_id="instanceId", instance_monitoring=False, kernel_id="kernelId", key_name="keyName", launch_configuration_name="launchConfigurationName", metadata_options=autoscaling.CfnLaunchConfiguration.MetadataOptionsProperty( http_endpoint="httpEndpoint", http_put_response_hop_limit=123, http_tokens="httpTokens" ), placement_tenancy="placementTenancy", ram_disk_id="ramDiskId", security_groups=["securityGroups"], spot_price="spotPrice", user_data="userData" )
Attributes
- associate_public_ip_address
Specifies whether to assign a public IPv4 address to the group’s instances.
If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.
If you specify
true
, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide .If you specify this property, you must specify at least one subnet for
VPCZoneIdentifier
when you create your group.
- block_device_mappings
The block device mapping entries that define the block devices to attach to the instances at launch.
By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings in the Amazon EC2 User Guide for Linux Instances .
- classic_link_vpc_id
Available for backward compatibility.
- classic_link_vpc_security_groups
Available for backward compatibility.
- ebs_optimized
Specifies whether the launch configuration is optimized for EBS I/O (
true
) or not (false
).The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances .
The default value is
false
.
- iam_instance_profile
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. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide .
- image_id
The ID of the Amazon Machine Image (AMI) that was assigned during registration.
For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances .
If you specify
InstanceId
, anImageId
is not required.
- instance_id
The ID of the Amazon EC2 instance to use to create the launch configuration.
When you use an instance to create a launch configuration, all properties are derived from the instance with the exception of
BlockDeviceMapping
andAssociatePublicIpAddress
. You can override any properties from the instance by specifying them in the launch configuration.
- instance_monitoring
Controls whether instances in this group are launched with detailed (
true
) or basic (false
) monitoring.The default value is
true
(enabled). .. epigraph:When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see `Configure Monitoring for Auto Scaling Instances <https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html>`_ in the *Amazon EC2 Auto Scaling User Guide* .
- instance_type
Specifies the instance type of the EC2 instance.
For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances .
If you specify
InstanceId
, anInstanceType
is not required.
- kernel_id
The ID of the kernel associated with the AMI.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances .
- key_name
The name of the key pair.
For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances .
- launch_configuration_name
The name of the launch configuration.
This name must be unique per Region per account.
- metadata_options
The metadata options for the instances.
For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide .
- placement_tenancy
The tenancy of the instance, either
default
ordedicated
.An instance with
dedicated
tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set todefault
), you must set the value of this property todedicated
. For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .If you specify
PlacementTenancy
, you must specify at least one subnet forVPCZoneIdentifier
when you create your group.Valid values:
default
|dedicated
- ram_disk_id
The ID of the RAM disk to select.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances .
- security_groups
A list that contains the security groups to assign to the instances in the Auto Scaling group.
The list can contain both the IDs of existing security groups and references to SecurityGroup resources created in the template.
For more information, see Control traffic to resources using security groups in the Amazon Virtual Private Cloud User Guide .
- spot_price
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.
Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide .
Valid Range: Minimum value of 0.001 .. epigraph:
When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
- user_data
The Base64-encoded user data to make available to the launched EC2 instances.
For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances .