Skip to content

ResponseLaunchTemplateData

Source code in docs_src/capo_ec2/types/response_launch_template_data.py
class ResponseLaunchTemplateData(TypedDict, closed=True):
    kernel_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the kernel, if applicable.</p>"""
    ebs_optimized: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the instance is optimized for Amazon EBS I/O. </p>"""
    iam_instance_profile: NotRequired[
        "capo_ec2.types.launch_template_iam_instance_profile_specification.LaunchTemplateIamInstanceProfileSpecification"
    ]
    """<p>The IAM instance profile.</p>"""
    block_device_mappings: NotRequired[
        "capo_ec2.types.launch_template_block_device_mapping_list.LaunchTemplateBlockDeviceMappingList"
    ]
    """<p>The block device mappings.</p>"""
    network_interfaces: NotRequired[
        "capo_ec2.types.launch_template_instance_network_interface_specification_list.LaunchTemplateInstanceNetworkInterfaceSpecificationList"
    ]
    """<p>The network interfaces.</p>"""
    image_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.</p> <p>The value depends on what you specified in the request. The possible values are:</p> <ul> <li> <p>If an AMI ID was specified in the request, then this is the AMI ID.</p> </li> <li> <p>If a Systems Manager parameter was specified in the request, and <code>ResolveAlias</code> was configured as <code>true</code>, then this is the AMI ID that the parameter is mapped to in the Parameter Store.</p> </li> <li> <p>If a Systems Manager parameter was specified in the request, and <code>ResolveAlias</code> was configured as <code>false</code>, then this is the parameter value.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#use-an-ssm-parameter-instead-of-an-ami-id">Use a Systems Manager parameter instead of an AMI ID</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    instance_type: NotRequired["capo_ec2.types.instance_type.InstanceType"]
    """<p>The instance type.</p>"""
    key_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the key pair.</p>"""
    monitoring: NotRequired[
        "capo_ec2.types.launch_templates_monitoring.LaunchTemplatesMonitoring"
    ]
    """<p>The monitoring for the instance.</p>"""
    placement: NotRequired[
        "capo_ec2.types.launch_template_placement.LaunchTemplatePlacement"
    ]
    """<p>The placement of the instance.</p>"""
    ram_disk_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the RAM disk, if applicable.</p>"""
    disable_api_termination: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>If set to <code>true</code>, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.</p>"""
    instance_initiated_shutdown_behavior: NotRequired[
        "capo_ec2.types.shutdown_behavior.ShutdownBehavior"
    ]
    """<p>Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).</p>"""
    user_data: NotRequired["capo_ec2.types.sensitive_user_data.SensitiveUserData"]
    """<p>The user data for the instance. </p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.launch_template_tag_specification_list.LaunchTemplateTagSpecificationList"
    ]
    """<p>The tags that are applied to the resources that are created during instance launch.</p>"""
    elastic_gpu_specifications: NotRequired[
        "capo_ec2.types.elastic_gpu_specification_response_list.ElasticGpuSpecificationResponseList"
    ]
    """<p>Deprecated.</p> <note> <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p> </note>"""
    elastic_inference_accelerators: NotRequired[
        "capo_ec2.types.launch_template_elastic_inference_accelerator_response_list.LaunchTemplateElasticInferenceAcceleratorResponseList"
    ]
    """<note> <p>Amazon Elastic Inference is no longer available.</p> </note> <p>An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.</p> <p>You cannot specify accelerators from different generations in the same request.</p>"""
    security_group_ids: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>The security group IDs.</p>"""
    security_groups: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>The security group names.</p>"""
    instance_market_options: NotRequired[
        "capo_ec2.types.launch_template_instance_market_options.LaunchTemplateInstanceMarketOptions"
    ]
    """<p>The market (purchasing) option for the instances.</p>"""
    credit_specification: NotRequired[
        "capo_ec2.types.credit_specification.CreditSpecification"
    ]
    """<p>The credit option for CPU usage of the instance.</p>"""
    cpu_options: NotRequired[
        "capo_ec2.types.launch_template_cpu_options.LaunchTemplateCpuOptions"
    ]
    """<p>The CPU options for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html">CPU options for Amazon EC2 instances</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    capacity_reservation_specification: NotRequired[
        "capo_ec2.types.launch_template_capacity_reservation_specification_response.LaunchTemplateCapacityReservationSpecificationResponse"
    ]
    """<p>Information about the Capacity Reservation targeting option.</p>"""
    license_specifications: NotRequired[
        "capo_ec2.types.launch_template_license_list.LaunchTemplateLicenseList"
    ]
    """<p>The license configurations.</p>"""
    hibernation_options: NotRequired[
        "capo_ec2.types.launch_template_hibernation_options.LaunchTemplateHibernationOptions"
    ]
    """<p>Indicates whether an instance is configured for hibernation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html">Hibernate your Amazon EC2 instance</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    metadata_options: NotRequired[
        "capo_ec2.types.launch_template_instance_metadata_options.LaunchTemplateInstanceMetadataOptions"
    ]
    """<p>The metadata options for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure the Instance Metadata Service options</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    enclave_options: NotRequired[
        "capo_ec2.types.launch_template_enclave_options.LaunchTemplateEnclaveOptions"
    ]
    """<p>Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.</p>"""
    instance_requirements: NotRequired[
        "capo_ec2.types.instance_requirements.InstanceRequirements"
    ]
    """<p>The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.</p> <p>If you specify <code>InstanceRequirements</code>, you can't specify <code>InstanceTypes</code>.</p>"""
    private_dns_name_options: NotRequired[
        "capo_ec2.types.launch_template_private_dns_name_options.LaunchTemplatePrivateDnsNameOptions"
    ]
    """<p>The options for the instance hostname.</p>"""
    maintenance_options: NotRequired[
        "capo_ec2.types.launch_template_instance_maintenance_options.LaunchTemplateInstanceMaintenanceOptions"
    ]
    """<p>The maintenance options for your instance.</p>"""
    disable_api_stop: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the instance is enabled for stop protection. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html">Enable stop protection for your EC2 instances</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    operator: NotRequired["capo_ec2.types.operator_response.OperatorResponse"]
    """<p>The entity that manages the launch template.</p>"""
    network_performance_options: NotRequired[
        "capo_ec2.types.launch_template_network_performance_options.LaunchTemplateNetworkPerformanceOptions"
    ]
    """<p>Contains the launch template settings for network performance options for your instance.</p>"""
    secondary_interfaces: NotRequired[
        "capo_ec2.types.launch_template_instance_secondary_interface_specification_list.LaunchTemplateInstanceSecondaryInterfaceSpecificationList"
    ]
    """<p>The secondary interfaces associated with the launch template.</p>"""

block_device_mappings instance-attribute

block_device_mappings: NotRequired[LaunchTemplateBlockDeviceMappingList]

The block device mappings.

capacity_reservation_specification instance-attribute

capacity_reservation_specification: NotRequired[
    LaunchTemplateCapacityReservationSpecificationResponse
]

Information about the Capacity Reservation targeting option.

cpu_options instance-attribute

cpu_options: NotRequired[LaunchTemplateCpuOptions]

The CPU options for the instance. For more information, see CPU options for Amazon EC2 instances in the Amazon EC2 User Guide.

credit_specification instance-attribute

credit_specification: NotRequired[CreditSpecification]

The credit option for CPU usage of the instance.

disable_api_stop instance-attribute

disable_api_stop: NotRequired[Boolean]

Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances in the Amazon EC2 User Guide.

disable_api_termination instance-attribute

disable_api_termination: NotRequired[Boolean]

If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

ebs_optimized instance-attribute

ebs_optimized: NotRequired[Boolean]

Indicates whether the instance is optimized for Amazon EBS I/O.

elastic_gpu_specifications instance-attribute

elastic_gpu_specifications: NotRequired[ElasticGpuSpecificationResponseList]

Deprecated.

Amazon Elastic Graphics reached end of life on January 8, 2024.

elastic_inference_accelerators instance-attribute

elastic_inference_accelerators: NotRequired[
    LaunchTemplateElasticInferenceAcceleratorResponseList
]

Amazon Elastic Inference is no longer available.

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

enclave_options instance-attribute

enclave_options: NotRequired[LaunchTemplateEnclaveOptions]

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

hibernation_options instance-attribute

hibernation_options: NotRequired[LaunchTemplateHibernationOptions]

Indicates whether an instance is configured for hibernation. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

iam_instance_profile instance-attribute

iam_instance_profile: NotRequired[LaunchTemplateIamInstanceProfileSpecification]

The IAM instance profile.

image_id instance-attribute

image_id: NotRequired[String]

The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.

The value depends on what you specified in the request. The possible values are:

  • If an AMI ID was specified in the request, then this is the AMI ID.

  • If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as true, then this is the AMI ID that the parameter is mapped to in the Parameter Store.

  • If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as false, then this is the parameter value.

For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.

instance_initiated_shutdown_behavior instance-attribute

instance_initiated_shutdown_behavior: NotRequired[ShutdownBehavior]

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

instance_market_options instance-attribute

instance_market_options: NotRequired[LaunchTemplateInstanceMarketOptions]

The market (purchasing) option for the instances.

instance_requirements instance-attribute

instance_requirements: NotRequired[InstanceRequirements]

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

If you specify InstanceRequirements, you can't specify InstanceTypes.

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

The instance type.

kernel_id instance-attribute

kernel_id: NotRequired[String]

The ID of the kernel, if applicable.

key_name instance-attribute

key_name: NotRequired[String]

The name of the key pair.

license_specifications instance-attribute

license_specifications: NotRequired[LaunchTemplateLicenseList]

The license configurations.

maintenance_options instance-attribute

maintenance_options: NotRequired[LaunchTemplateInstanceMaintenanceOptions]

The maintenance options for your instance.

metadata_options instance-attribute

metadata_options: NotRequired[LaunchTemplateInstanceMetadataOptions]

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options in the Amazon EC2 User Guide.

monitoring instance-attribute

monitoring: NotRequired[LaunchTemplatesMonitoring]

The monitoring for the instance.

network_interfaces instance-attribute

The network interfaces.

network_performance_options instance-attribute

network_performance_options: NotRequired[LaunchTemplateNetworkPerformanceOptions]

Contains the launch template settings for network performance options for your instance.

operator instance-attribute

operator: NotRequired[OperatorResponse]

The entity that manages the launch template.

placement instance-attribute

placement: NotRequired[LaunchTemplatePlacement]

The placement of the instance.

private_dns_name_options instance-attribute

private_dns_name_options: NotRequired[LaunchTemplatePrivateDnsNameOptions]

The options for the instance hostname.

ram_disk_id instance-attribute

ram_disk_id: NotRequired[String]

The ID of the RAM disk, if applicable.

secondary_interfaces instance-attribute

secondary_interfaces: NotRequired[
    LaunchTemplateInstanceSecondaryInterfaceSpecificationList
]

The secondary interfaces associated with the launch template.

security_group_ids instance-attribute

security_group_ids: NotRequired[ValueStringList]

The security group IDs.

security_groups instance-attribute

security_groups: NotRequired[ValueStringList]

The security group names.

tag_specifications instance-attribute

tag_specifications: NotRequired[LaunchTemplateTagSpecificationList]

The tags that are applied to the resources that are created during instance launch.

user_data instance-attribute

user_data: NotRequired[SensitiveUserData]

The user data for the instance.