Skip to content

LaunchConfiguration

Source code in docs_src/capo_auto_scaling/types/launch_configuration.py
class LaunchConfiguration(TypedDict, closed=True):
    launch_configuration_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the launch configuration.</p>"""
    launch_configuration_arn: NotRequired[
        "capo_auto_scaling.types.resource_name.ResourceName"
    ]
    """<p>The Amazon Resource Name (ARN) of the launch configuration.</p>"""
    image_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. 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>"""
    key_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the key pair.</p> <p>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: NotRequired[
        "capo_auto_scaling.types.security_groups.SecurityGroups"
    ]
    """<p>A list that contains the security groups 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: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>Available for backward compatibility.</p>"""
    classic_link_vpc_security_groups: NotRequired[
        "capo_auto_scaling.types.classic_link_vpc_security_groups.ClassicLinkVPCSecurityGroups"
    ]
    """<p>Available for backward compatibility.</p>"""
    user_data: NotRequired[
        "capo_auto_scaling.types.xml_string_user_data.XmlStringUserData"
    ]
    """<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> in the <i>Amazon EC2 User Guide</i>. 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_type: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The instance type for the instances. 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>"""
    kernel_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The ID of the kernel associated with the AMI.</p>"""
    ramdisk_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The ID of the RAM disk associated with the AMI.</p>"""
    block_device_mappings: NotRequired[
        "capo_auto_scaling.types.block_device_mappings.BlockDeviceMappings"
    ]
    """<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: NotRequired[
        "capo_auto_scaling.types.instance_monitoring.InstanceMonitoring"
    ]
    """<p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring.</p> <p>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>"""
    spot_price: NotRequired["capo_auto_scaling.types.spot_price.SpotPrice"]
    """<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">Requesting Spot Instances for fault-tolerant and flexible applications</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"""
    iam_instance_profile: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len1600.XmlStringMaxLen1600"
    ]
    """<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>"""
    created_time: NotRequired["capo_auto_scaling.types.timestamp_type.TimestampType"]
    """<p>The creation date and time for the launch configuration.</p>"""
    ebs_optimized: NotRequired["capo_auto_scaling.types.ebs_optimized.EbsOptimized"]
    """<p>Specifies whether the launch configuration is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). 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>"""
    associate_public_ip_address: NotRequired[
        "capo_auto_scaling.types.associate_public_ip_address.AssociatePublicIpAddress"
    ]
    """<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. 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>"""
    placement_tenancy: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len64.XmlStringMaxLen64"
    ]
    """<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.</p>"""
    metadata_options: NotRequired[
        "capo_auto_scaling.types.instance_metadata_options.InstanceMetadataOptions"
    ]
    """<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>"""

associate_public_ip_address instance-attribute

associate_public_ip_address: NotRequired[AssociatePublicIpAddress]

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. 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_mappings instance-attribute

block_device_mappings: NotRequired[BlockDeviceMappings]

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.

classic_link_vpc_id: NotRequired[XmlStringMaxLen255]

Available for backward compatibility.

classic_link_vpc_security_groups: NotRequired[ClassicLinkVPCSecurityGroups]

Available for backward compatibility.

created_time instance-attribute

created_time: NotRequired[TimestampType]

The creation date and time for the launch configuration.

ebs_optimized instance-attribute

ebs_optimized: NotRequired[EbsOptimized]

Specifies 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_profile instance-attribute

iam_instance_profile: NotRequired[XmlStringMaxLen1600]

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 instance-attribute

image_id: NotRequired[XmlStringMaxLen255]

The 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_monitoring instance-attribute

instance_monitoring: NotRequired[InstanceMonitoring]

Controls 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_type instance-attribute

instance_type: NotRequired[XmlStringMaxLen255]

The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide.

kernel_id instance-attribute

kernel_id: NotRequired[XmlStringMaxLen255]

The ID of the kernel associated with the AMI.

key_name instance-attribute

key_name: NotRequired[XmlStringMaxLen255]

The 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_arn instance-attribute

launch_configuration_arn: NotRequired[ResourceName]

The Amazon Resource Name (ARN) of the launch configuration.

launch_configuration_name instance-attribute

launch_configuration_name: NotRequired[XmlStringMaxLen255]

The name of the launch configuration.

metadata_options instance-attribute

metadata_options: NotRequired[InstanceMetadataOptions]

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

placement_tenancy instance-attribute

placement_tenancy: NotRequired[XmlStringMaxLen64]

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.

ramdisk_id instance-attribute

ramdisk_id: NotRequired[XmlStringMaxLen255]

The ID of the RAM disk associated with the AMI.

security_groups instance-attribute

security_groups: NotRequired[SecurityGroups]

A 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_price instance-attribute

spot_price: NotRequired[SpotPrice]

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 Requesting Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.

user_data instance-attribute

user_data: NotRequired[XmlStringUserData]

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