Skip to main content

launch_configurations

Creates, updates, deletes, gets or lists a launch_configurations resource.

Overview​

Namelaunch_configurations
TypeResource
Idaws.autoscaling.launch_configurations

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
associate_public_ip_addressbooleanSpecifies 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. For more information, see Provide network connectivity for your Auto Scaling instances using Amazon VPC in the Amazon EC2 Auto Scaling User Guide.
block_device_mappingsstringThe 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.
classic_link_vpc_idstringAvailable for backward compatibility.
classic_link_vpc_security_groupsstringAvailable for backward compatibility.
created_timestringThe creation date and time for the launch configuration.
ebs_optimizedbooleanSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false). For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide.
iam_instance_profilestringThe 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_idstringThe ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide.
instance_monitoringstringControls whether instances in this group are launched with detailed (true) or basic (false) monitoring. For more information, see Configure monitoring for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
instance_typestringThe instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide.
kernel_idstringThe ID of the kernel associated with the AMI.
key_namestringThe name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide.
launch_configuration_arnstringThe Amazon Resource Name (ARN) of the launch configuration.
launch_configuration_namestringThe name of the launch configuration.
metadata_optionsstringThe metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.
placement_tenancystringThe tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
ramdisk_idstringThe ID of the RAM disk associated with the AMI.
security_groupsstringA list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide.
spot_pricestringThe 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 Requesting Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
user_datastringThe 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. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_launch_configurationsselectregionLaunchConfigurationNames, NextToken, MaxRecordsGets information about the launch configurations in the account and Region.
create_launch_configurationinsertLaunchConfigurationName, regionImageId, KeyName, SecurityGroups, ClassicLinkVPCId, ClassicLinkVPCSecurityGroups, UserData, InstanceId, InstanceType, KernelId, RamdiskId, BlockDeviceMappings, InstanceMonitoring, SpotPrice, IamInstanceProfile, EbsOptimized, AssociatePublicIpAddress, PlacementTenancy, MetadataOptionsCreates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide. Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
delete_launch_configurationdeleteLaunchConfigurationName, regionDeletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
LaunchConfigurationNamestringThe name of the launch configuration.
regionstringAWS region (default: us-east-1)
AssociatePublicIpAddressbooleanSpecifies 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 Provide network connectivity for your Auto Scaling instances using Amazon 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.
BlockDeviceMappingsarrayThe 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.
ClassicLinkVPCIdstringAvailable for backward compatibility.
ClassicLinkVPCSecurityGroupsarrayAvailable for backward compatibility.
EbsOptimizedbooleanSpecifies 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. The default value is false.
IamInstanceProfilestringThe 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.
ImageIdstringThe ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Find a Linux AMI in the Amazon EC2 User Guide. If you specify InstanceId, an ImageId is not required.
InstanceIdstringThe ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping. To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request. For more information, see Create a launch configuration in the Amazon EC2 Auto Scaling User Guide.
InstanceMonitoringobjectControls whether instances in this group are launched with detailed (true) or basic (false) monitoring. The default value is true (enabled). 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.
InstanceTypestringSpecifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide. If you specify InstanceId, an InstanceType is not required.
KernelIdstringThe 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.
KeyNamestringThe name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide.
LaunchConfigurationNamesarrayThe launch configuration names. If you omit this property, all launch configurations are described. Array Members: Maximum number of 50 items.
MaxRecordsintegerThe maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
MetadataOptionsobjectThe metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.
NextTokenstringThe token for the next set of items to return. (You received this token from a previous call.)
PlacementTenancystringThe tenancy of the instance, either default or dedicated. 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 to default), you must set the value of this property to dedicated. If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group. Valid values: default | dedicated
RamdiskIdstringThe 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.
SecurityGroupsarrayA list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to your Amazon Web Services resources using security groups in the Amazon Virtual Private Cloud User Guide.
SpotPricestringThe 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 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.
UserDatastringThe user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

SELECT examples​

Gets information about the launch configurations in the account and Region.

SELECT
associate_public_ip_address,
block_device_mappings,
classic_link_vpc_id,
classic_link_vpc_security_groups,
created_time,
ebs_optimized,
iam_instance_profile,
image_id,
instance_monitoring,
instance_type,
kernel_id,
key_name,
launch_configuration_arn,
launch_configuration_name,
metadata_options,
placement_tenancy,
ramdisk_id,
security_groups,
spot_price,
user_data
FROM aws.autoscaling.launch_configurations
WHERE region = '{{ region }}' -- required
AND LaunchConfigurationNames = '{{ LaunchConfigurationNames }}'
AND NextToken = '{{ NextToken }}'
AND MaxRecords = '{{ MaxRecords }}'
;

INSERT examples​

Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide. Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

INSERT INTO aws.autoscaling.launch_configurations (
LaunchConfigurationName,
region,
ImageId,
KeyName,
SecurityGroups,
ClassicLinkVPCId,
ClassicLinkVPCSecurityGroups,
UserData,
InstanceId,
InstanceType,
KernelId,
RamdiskId,
BlockDeviceMappings,
InstanceMonitoring,
SpotPrice,
IamInstanceProfile,
EbsOptimized,
AssociatePublicIpAddress,
PlacementTenancy,
MetadataOptions
)
SELECT 
'{{ LaunchConfigurationName }}',
'{{ region }}',
'{{ ImageId }}',
'{{ KeyName }}',
'{{ SecurityGroups }}',
'{{ ClassicLinkVPCId }}',
'{{ ClassicLinkVPCSecurityGroups }}',
'{{ UserData }}',
'{{ InstanceId }}',
'{{ InstanceType }}',
'{{ KernelId }}',
'{{ RamdiskId }}',
'{{ BlockDeviceMappings }}',
'{{ InstanceMonitoring }}',
'{{ SpotPrice }}',
'{{ IamInstanceProfile }}',
'{{ EbsOptimized }}',
'{{ AssociatePublicIpAddress }}',
'{{ PlacementTenancy }}',
'{{ MetadataOptions }}'
;

DELETE examples​

Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

DELETE FROM aws.autoscaling.launch_configurations
WHERE LaunchConfigurationName = '{{ LaunchConfigurationName }}' --required
AND region = '{{ region }}' --required
;
Last updated on