Skip to content

create_launch_configuration async

create_launch_configuration(
    *,
    config_overrides: Optional[AsyncAutoScalingClientConfig] = None,
    launch_configuration_name: Optional[XmlStringMaxLen255] = None,
    image_id: Optional[XmlStringMaxLen255] = None,
    key_name: Optional[XmlStringMaxLen255] = None,
    security_groups: Optional[SecurityGroups] = None,
    classic_link_vpc_id: Optional[XmlStringMaxLen255] = None,
    classic_link_vpc_security_groups: Optional[ClassicLinkVPCSecurityGroups] = None,
    user_data: Optional[XmlStringUserData] = None,
    instance_id: Optional[XmlStringMaxLen19] = None,
    instance_type: Optional[XmlStringMaxLen255] = None,
    kernel_id: Optional[XmlStringMaxLen255] = None,
    ramdisk_id: Optional[XmlStringMaxLen255] = None,
    block_device_mappings: Optional[BlockDeviceMappings] = None,
    instance_monitoring: Optional[InstanceMonitoring] = None,
    spot_price: Optional[SpotPrice] = None,
    iam_instance_profile: Optional[XmlStringMaxLen1600] = None,
    ebs_optimized: Optional[EbsOptimized] = None,
    associate_public_ip_address: Optional[AssociatePublicIpAddress] = None,
    placement_tenancy: Optional[XmlStringMaxLen64] = None,
    metadata_options: Optional[InstanceMetadataOptions] = None,
) -> None

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.

Parameters:

  • launch_configuration_name (Optional[XmlStringMaxLen255], default: None ) –

    The name of the launch configuration. This name must be unique per Region per account.

  • image_id (Optional[XmlStringMaxLen255], default: None ) –

    The 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.

  • key_name (Optional[XmlStringMaxLen255], default: None ) –

    The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2 instances in the Amazon EC2 User Guide.

  • security_groups (Optional[SecurityGroups], default: None ) –

    A 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.

  • classic_link_vpc_id (Optional[XmlStringMaxLen255], default: None ) –

    Available for backward compatibility.

  • classic_link_vpc_security_groups (Optional[ClassicLinkVPCSecurityGroups], default: None ) –

    Available for backward compatibility.

  • user_data (Optional[XmlStringUserData], default: None ) –

    The 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.

  • instance_id (Optional[XmlStringMaxLen19], default: None ) –

    The 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.

  • instance_type (Optional[XmlStringMaxLen255], default: None ) –

    Specifies 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.

  • kernel_id (Optional[XmlStringMaxLen255], default: None ) –

    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.

  • ramdisk_id (Optional[XmlStringMaxLen255], default: None ) –

    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.

  • block_device_mappings (Optional[BlockDeviceMappings], default: 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.

  • instance_monitoring (Optional[InstanceMonitoring], default: None ) –

    Controls 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.

  • spot_price (Optional[SpotPrice], default: None ) –

    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

    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.

  • iam_instance_profile (Optional[XmlStringMaxLen1600], default: None ) –

    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.

  • ebs_optimized (Optional[EbsOptimized], default: 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.

    The default value is false.

  • associate_public_ip_address (Optional[AssociatePublicIpAddress], default: 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 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.

  • placement_tenancy (Optional[XmlStringMaxLen64], default: None ) –

    The 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

  • metadata_options (Optional[InstanceMetadataOptions], default: None ) –

    The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.

Raises:

  • AlreadyExistsFault –

    You already have an Auto Scaling group or launch configuration with this name.

  • LimitExceededFault –

    You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.

  • ResourceContentionFault –

    You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

To create a launch configuration This example creates a launch configuration.

>>> await client.create_launch_configuration(launch_configuration_name='my-launch-config', image_id='ami-12345678', security_groups=['sg-eb2af88e'], instance_type='m3.medium', iam_instance_profile='my-iam-role')
Source code in docs_src/capo_auto_scaling/_services/async_auto_scaling.py
async def create_launch_configuration(
    self,
    *,
    config_overrides: Optional[AsyncAutoScalingClientConfig] = None,
    launch_configuration_name: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    image_id: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    key_name: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    security_groups: Optional[
        "capo_auto_scaling.types.security_groups.SecurityGroups"
    ] = None,
    classic_link_vpc_id: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    classic_link_vpc_security_groups: Optional[
        "capo_auto_scaling.types.classic_link_vpc_security_groups.ClassicLinkVPCSecurityGroups"
    ] = None,
    user_data: Optional[
        "capo_auto_scaling.types.xml_string_user_data.XmlStringUserData"
    ] = None,
    instance_id: Optional[
        "capo_auto_scaling.types.xml_string_max_len19.XmlStringMaxLen19"
    ] = None,
    instance_type: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    kernel_id: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    ramdisk_id: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
    block_device_mappings: Optional[
        "capo_auto_scaling.types.block_device_mappings.BlockDeviceMappings"
    ] = None,
    instance_monitoring: Optional[
        "capo_auto_scaling.types.instance_monitoring.InstanceMonitoring"
    ] = None,
    spot_price: Optional["capo_auto_scaling.types.spot_price.SpotPrice"] = None,
    iam_instance_profile: Optional[
        "capo_auto_scaling.types.xml_string_max_len1600.XmlStringMaxLen1600"
    ] = None,
    ebs_optimized: Optional[
        "capo_auto_scaling.types.ebs_optimized.EbsOptimized"
    ] = None,
    associate_public_ip_address: Optional[
        "capo_auto_scaling.types.associate_public_ip_address.AssociatePublicIpAddress"
    ] = None,
    placement_tenancy: Optional[
        "capo_auto_scaling.types.xml_string_max_len64.XmlStringMaxLen64"
    ] = None,
    metadata_options: Optional[
        "capo_auto_scaling.types.instance_metadata_options.InstanceMetadataOptions"
    ] = None,
) -> None:
    """<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html">DescribeAccountLimits</a> API. For information about updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html">Launch configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html">Launch templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> </note>

    Args:
        launch_configuration_name: <p>The name of the launch configuration. This name must be unique per Region per account.</p>
        image_id: <p>The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Find a Linux AMI</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>If you specify <code>InstanceId</code>, an <code>ImageId</code> is not required.</p>
        key_name: <p>The name of the key pair. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Amazon EC2 instances</a> in the <i>Amazon EC2 User Guide</i>.</p>
        security_groups: <p>A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html">Control traffic to your Amazon Web Services resources using security groups</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
        classic_link_vpc_id: <p>Available for backward compatibility.</p>
        classic_link_vpc_security_groups: <p>Available for backward compatibility.</p>
        user_data: <p>The user data to make available to the launched EC2 instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance metadata and user data</a> (Linux) and <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html">Instance metadata and user data</a> (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.</p>
        instance_id: <p>The 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.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html">Create a launch configuration</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
        instance_type: <p>Specifies the instance type of the EC2 instance. For information about available instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes">Available instance types</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>If you specify <code>InstanceId</code>, an <code>InstanceType</code> is not required.</p>
        kernel_id: <p>The ID of the kernel associated with the AMI.</p> <note> <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided kernels</a> in the <i>Amazon EC2 User Guide</i>.</p> </note>
        ramdisk_id: <p>The ID of the RAM disk to select.</p> <note> <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided kernels</a> in the <i>Amazon EC2 User Guide</i>.</p> </note>
        block_device_mappings: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device mappings</a> in the <i>Amazon EC2 User Guide</i>.</p>
        instance_monitoring: <p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring.</p> <p>The default value is <code>true</code> (enabled).</p> <important> <p>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 <a href="https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html">Configure monitoring for Auto Scaling instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> </important>
        spot_price: <p>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 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html">Request Spot Instances for fault-tolerant and flexible applications</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid Range: Minimum value of 0.001</p> <note> <p>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.</p> </note>
        iam_instance_profile: <p>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 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html">IAM role for applications that run on Amazon EC2 instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
        ebs_optimized: <p>Specifies whether the launch configuration is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html">Amazon EBS-optimized instances</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>The default value is <code>false</code>.</p>
        associate_public_ip_address: <p>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.</p> <p>If you specify <code>true</code>, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html">Provide network connectivity for your Auto Scaling instances using Amazon VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify this property, you must specify at least one subnet for <code>VPCZoneIdentifier</code> when you create your group.</p>
        placement_tenancy: <p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An instance with <code>dedicated</code> 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 <code>default</code>), you must set the value of this property to <code>dedicated</code>.</p> <p>If you specify <code>PlacementTenancy</code>, you must specify at least one subnet for <code>VPCZoneIdentifier</code> when you create your group.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>
        metadata_options: <p>The metadata options for the instances. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds">Configure the instance metadata options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>

    Raises:
        capo_auto_scaling.errors.already_exists_fault.AlreadyExistsFault: <p>You already have an Auto Scaling group or launch configuration with this name.</p>
        capo_auto_scaling.errors.limit_exceeded_fault.LimitExceededFault: <p>You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html">DescribeAccountLimits</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p>
        capo_auto_scaling.errors.resource_contention_fault.ResourceContentionFault: <p>You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).</p>
        capo_auto_scaling.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create a launch configuration
        This example creates a launch configuration.

        >>> await client.create_launch_configuration(launch_configuration_name='my-launch-config', image_id='ami-12345678', security_groups=['sg-eb2af88e'], instance_type='m3.medium', iam_instance_profile='my-iam-role')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_auto_scaling.types.create_launch_configuration_type.CreateLaunchConfigurationType]",
    ) -> AsyncOperationResponse[None]:
        import capo_auto_scaling._operations.auto_scaling_2011_01_01.create_launch_configuration

        (
            output,
            http_response,
        ) = await capo_auto_scaling._operations.auto_scaling_2011_01_01.create_launch_configuration.async_create_launch_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateLaunchConfiguration")
    )
    input_: capo_auto_scaling.types.create_launch_configuration_type.CreateLaunchConfigurationType = {}
    if launch_configuration_name is not None:
        input_["launch_configuration_name"] = launch_configuration_name
    if image_id is not None:
        input_["image_id"] = image_id
    if key_name is not None:
        input_["key_name"] = key_name
    if security_groups is not None:
        input_["security_groups"] = security_groups
    if classic_link_vpc_id is not None:
        input_["classic_link_vpc_id"] = classic_link_vpc_id
    if classic_link_vpc_security_groups is not None:
        input_["classic_link_vpc_security_groups"] = (
            classic_link_vpc_security_groups
        )
    if user_data is not None:
        input_["user_data"] = user_data
    if instance_id is not None:
        input_["instance_id"] = instance_id
    if instance_type is not None:
        input_["instance_type"] = instance_type
    if kernel_id is not None:
        input_["kernel_id"] = kernel_id
    if ramdisk_id is not None:
        input_["ramdisk_id"] = ramdisk_id
    if block_device_mappings is not None:
        input_["block_device_mappings"] = block_device_mappings
    if instance_monitoring is not None:
        input_["instance_monitoring"] = instance_monitoring
    if spot_price is not None:
        input_["spot_price"] = spot_price
    if iam_instance_profile is not None:
        input_["iam_instance_profile"] = iam_instance_profile
    if ebs_optimized is not None:
        input_["ebs_optimized"] = ebs_optimized
    if associate_public_ip_address is not None:
        input_["associate_public_ip_address"] = associate_public_ip_address
    if placement_tenancy is not None:
        input_["placement_tenancy"] = placement_tenancy
    if metadata_options is not None:
        input_["metadata_options"] = metadata_options

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output