Skip to content

aws.ec2.get_launch_template_data

Example SQL Queries

SELECT * FROM
aws.ec2.get_launch_template_data
WHERE
"instance_id" = 'VALUE';

Description

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, and DescribeInstanceAttribute. Or, you can allow describe* depending on your instance requirements.

Table Definition

Column NameColumn Data Type
instance_id Required Input Column

The ID of the instance.

VARCHAR
dry_run Input Column

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

BOOLEAN
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
launch_template_data

The instance data.

STRUCT(
"kernel_id" VARCHAR,
"ebs_optimized" BOOLEAN,
"iam_instance_profile" STRUCT(
"arn" VARCHAR,
"name" VARCHAR
),
"block_device_mappings" STRUCT(
"device_name" VARCHAR,
"virtual_name" VARCHAR,
"ebs" STRUCT(
"encrypted" BOOLEAN,
"delete_on_termination" BOOLEAN,
"iops" BIGINT,
"kms_key_id" VARCHAR,
"snapshot_id" VARCHAR,
"volume_size" BIGINT,
"volume_type" VARCHAR,
"throughput" BIGINT
),
"no_device" VARCHAR
)[],
"network_interfaces" STRUCT(
"associate_carrier_ip_address" BOOLEAN,
"associate_public_ip_address" BOOLEAN,
"delete_on_termination" BOOLEAN,
"description" VARCHAR,
"device_index" BIGINT,
"groups" VARCHAR[],
"interface_type" VARCHAR,
"ipv6_address_count" BIGINT,
"ipv6_addresses" STRUCT(
"ipv6_address" VARCHAR,
"is_primary_ipv6" BOOLEAN
)[],
"network_interface_id" VARCHAR,
"private_ip_address" VARCHAR,
"private_ip_addresses" STRUCT(
"primary" BOOLEAN,
"private_ip_address" VARCHAR
)[],
"secondary_private_ip_address_count" BIGINT,
"subnet_id" VARCHAR,
"network_card_index" BIGINT,
"ipv4_prefixes" STRUCT(
"ipv4_prefix" VARCHAR
)[],
"ipv4_prefix_count" BIGINT,
"ipv6_prefixes" STRUCT(
"ipv6_prefix" VARCHAR
)[],
"ipv6_prefix_count" BIGINT,
"primary_ipv6" BOOLEAN,
"ena_srd_specification" STRUCT(
"ena_srd_enabled" BOOLEAN,
"ena_srd_udp_specification" STRUCT(
"ena_srd_udp_enabled" BOOLEAN
)
),
"connection_tracking_specification" STRUCT(
"tcp_established_timeout" BIGINT,
"udp_timeout" BIGINT,
"udp_stream_timeout" BIGINT
)
)[],
"image_id" VARCHAR,
"instance_type" VARCHAR,
"key_name" VARCHAR,
"monitoring" STRUCT(
"enabled" BOOLEAN
),
"placement" STRUCT(
"availability_zone" VARCHAR,
"affinity" VARCHAR,
"group_name" VARCHAR,
"host_id" VARCHAR,
"tenancy" VARCHAR,
"spread_domain" VARCHAR,
"host_resource_group_arn" VARCHAR,
"partition_number" BIGINT,
"group_id" VARCHAR
),
"ram_disk_id" VARCHAR,
"disable_api_termination" BOOLEAN,
"instance_initiated_shutdown_behavior" VARCHAR,
"user_data" VARCHAR,
"tag_specifications" STRUCT(
"resource_type" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[],
"elastic_gpu_specifications" STRUCT(
"type" VARCHAR
)[],
"elastic_inference_accelerators" STRUCT(
"type" VARCHAR,
"count" BIGINT
)[],
"security_group_ids" VARCHAR[],
"security_groups" VARCHAR[],
"instance_market_options" STRUCT(
"market_type" VARCHAR,
"spot_options" STRUCT(
"max_price" VARCHAR,
"spot_instance_type" VARCHAR,
"block_duration_minutes" BIGINT,
"valid_until" TIMESTAMP_S,
"instance_interruption_behavior" VARCHAR
)
),
"credit_specification" STRUCT(
"cpu_credits" VARCHAR
),
"cpu_options" STRUCT(
"core_count" BIGINT,
"threads_per_core" BIGINT,
"amd_sev_snp" VARCHAR
),
"capacity_reservation_specification" STRUCT(
"capacity_reservation_preference" VARCHAR,
"capacity_reservation_target" STRUCT(
"capacity_reservation_id" VARCHAR,
"capacity_reservation_resource_group_arn" VARCHAR
)
),
"license_specifications" STRUCT(
"license_configuration_arn" VARCHAR
)[],
"hibernation_options" STRUCT(
"configured" BOOLEAN
),
"metadata_options" STRUCT(
"state" VARCHAR,
"http_tokens" VARCHAR,
"http_put_response_hop_limit" BIGINT,
"http_endpoint" VARCHAR,
"http_protocol_ipv6" VARCHAR,
"instance_metadata_tags" VARCHAR
),
"enclave_options" STRUCT(
"enabled" BOOLEAN
),
"instance_requirements" STRUCT(
"v_cpu_count" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"memory_mi_b" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"cpu_manufacturers" VARCHAR[],
"memory_gi_b_per_v_cpu" STRUCT(
"min" DOUBLE,
"max" DOUBLE
),
"excluded_instance_types" VARCHAR[],
"instance_generations" VARCHAR[],
"spot_max_price_percentage_over_lowest_price" BIGINT,
"on_demand_max_price_percentage_over_lowest_price" BIGINT,
"bare_metal" VARCHAR,
"burstable_performance" VARCHAR,
"require_hibernate_support" BOOLEAN,
"network_interface_count" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"local_storage" VARCHAR,
"local_storage_types" VARCHAR[],
"total_local_storage_gb" STRUCT(
"min" DOUBLE,
"max" DOUBLE
),
"baseline_ebs_bandwidth_mbps" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"accelerator_types" VARCHAR[],
"accelerator_count" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"accelerator_manufacturers" VARCHAR[],
"accelerator_names" VARCHAR[],
"accelerator_total_memory_mi_b" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"network_bandwidth_gbps" STRUCT(
"min" DOUBLE,
"max" DOUBLE
),
"allowed_instance_types" VARCHAR[],
"max_spot_price_as_percentage_of_optimal_on_demand_price" BIGINT
),
"private_dns_name_options" STRUCT(
"hostname_type" VARCHAR,
"enable_resource_name_dns_a_record" BOOLEAN,
"enable_resource_name_dns_aaaa_record" BOOLEAN
),
"maintenance_options" STRUCT(
"auto_recovery" VARCHAR
),
"disable_api_stop" BOOLEAN
)
Show child fields
launch_template_data.block_device_mappings[]
Show child fields
launch_template_data.block_device_mappings[].device_name

The device name.

launch_template_data.block_device_mappings[].ebs

Information about the block device for an EBS volume.

Show child fields
launch_template_data.block_device_mappings[].ebs.delete_on_termination

Indicates whether the EBS volume is deleted on instance termination.

launch_template_data.block_device_mappings[].ebs.encrypted

Indicates whether the EBS volume is encrypted.

launch_template_data.block_device_mappings[].ebs.iops

The number of I/O operations per second (IOPS) that the volume supports.

launch_template_data.block_device_mappings[].ebs.kms_key_id

The ARN of the Key Management Service (KMS) CMK used for encryption.

launch_template_data.block_device_mappings[].ebs.snapshot_id

The ID of the snapshot.

launch_template_data.block_device_mappings[].ebs.throughput

The throughput that the volume supports, in MiB/s.

launch_template_data.block_device_mappings[].ebs.volume_size

The size of the volume, in GiB.

launch_template_data.block_device_mappings[].ebs.volume_type

The volume type.

launch_template_data.block_device_mappings[].no_device

To omit the device from the block device mapping, specify an empty string.

launch_template_data.block_device_mappings[].virtual_name

The virtual device name (ephemeralN).

launch_template_data.capacity_reservation_specification

Information about the Capacity Reservation targeting option.

Show child fields
launch_template_data.capacity_reservation_specification.capacity_reservation_preference

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

launch_template_data.capacity_reservation_specification.capacity_reservation_target

Information about the target Capacity Reservation or Capacity Reservation group.

Show child fields
launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id

The ID of the targeted Capacity Reservation.

launch_template_data.capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn

The ARN of the targeted Capacity Reservation group.

launch_template_data.cpu_options

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

Show child fields
launch_template_data.cpu_options.amd_sev_snp

Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.

launch_template_data.cpu_options.core_count

The number of CPU cores for the instance.

launch_template_data.cpu_options.threads_per_core

The number of threads per CPU core.

launch_template_data.credit_specification

The credit option for CPU usage of the instance.

Show child fields
launch_template_data.credit_specification.cpu_credits

The credit option for CPU usage of a T instance.

Valid values: standard | unlimited

launch_template_data.disable_api_stop

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

launch_template_data.disable_api_termination

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

launch_template_data.ebs_optimized

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

launch_template_data.elastic_gpu_specifications[]
Show child fields
launch_template_data.elastic_gpu_specifications[].type

Deprecated.

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.

launch_template_data.elastic_inference_accelerators[]
Show child fields
launch_template_data.elastic_inference_accelerators[].count

The number of elastic inference accelerators to attach to the instance.

Default: 1

launch_template_data.elastic_inference_accelerators[].type

The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

launch_template_data.enclave_options

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

Show child fields
launch_template_data.enclave_options.enabled

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

launch_template_data.hibernation_options

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

Show child fields
launch_template_data.hibernation_options.configured

If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

launch_template_data.iam_instance_profile

The IAM instance profile.

Show child fields
launch_template_data.iam_instance_profile.arn

The Amazon Resource Name (ARN) of the instance profile.

launch_template_data.iam_instance_profile.name

The name of the instance profile.

launch_template_data.image_id

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.

launch_template_data.instance_initiated_shutdown_behavior

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

launch_template_data.instance_market_options

The market (purchasing) option for the instances.

Show child fields
launch_template_data.instance_market_options.market_type

The market type.

launch_template_data.instance_market_options.spot_options

The options for Spot Instances.

Show child fields
launch_template_data.instance_market_options.spot_options.block_duration_minutes

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

launch_template_data.instance_market_options.spot_options.instance_interruption_behavior

The behavior when a Spot Instance is interrupted.

launch_template_data.instance_market_options.spot_options.max_price

The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

launch_template_data.instance_market_options.spot_options.spot_instance_type

The Spot Instance request type.

launch_template_data.instance_market_options.spot_options.valid_until

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

launch_template_data.instance_requirements

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.

Show child fields
launch_template_data.instance_requirements.accelerator_count

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

To exclude accelerator-enabled instance types, set Max to 0.

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.accelerator_count.max

The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.accelerator_count.min

The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.accelerator_manufacturers[]
launch_template_data.instance_requirements.accelerator_names[]
launch_template_data.instance_requirements.accelerator_total_memory_mi_b

The minimum and maximum amount of total accelerator memory, in MiB.

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.accelerator_total_memory_mi_b.max

The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.accelerator_total_memory_mi_b.min

The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.accelerator_types[]
launch_template_data.instance_requirements.allowed_instance_types[]
launch_template_data.instance_requirements.bare_metal

Indicates whether bare metal instance types must be included, excluded, or required.

  • To include bare metal instance types, specify included.

  • To require only bare metal instance types, specify required.

  • To exclude bare metal instance types, specify excluded.

Default: excluded

launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.max

The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.baseline_ebs_bandwidth_mbps.min

The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.burstable_performance

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.

  • To include burstable performance instance types, specify included.

  • To require only burstable performance instance types, specify required.

  • To exclude burstable performance instance types, specify excluded.

Default: excluded

launch_template_data.instance_requirements.cpu_manufacturers[]
launch_template_data.instance_requirements.excluded_instance_types[]
launch_template_data.instance_requirements.instance_generations[]
launch_template_data.instance_requirements.local_storage

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.

  • To include instance types with instance store volumes, specify included.

  • To require only instance types with instance store volumes, specify required.

  • To exclude instance types with instance store volumes, specify excluded.

Default: included

launch_template_data.instance_requirements.local_storage_types[]
launch_template_data.instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price

[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.

Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.

launch_template_data.instance_requirements.memory_gi_b_per_v_cpu

The minimum and maximum amount of memory per vCPU, in GiB.

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.max

The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.memory_gi_b_per_v_cpu.min

The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.memory_mi_b

The minimum and maximum amount of memory, in MiB.

Show child fields
launch_template_data.instance_requirements.memory_mi_b.max

The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.memory_mi_b.min

The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.network_bandwidth_gbps

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.network_bandwidth_gbps.max

The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.network_bandwidth_gbps.min

The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.network_interface_count

The minimum and maximum number of network interfaces.

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.network_interface_count.max

The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.network_interface_count.min

The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.on_demand_max_price_percentage_over_lowest_price

[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

To turn off price protection, specify a high value, such as 999999.

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

Default: 20

launch_template_data.instance_requirements.require_hibernate_support

Indicates whether instance types must support hibernation for On-Demand Instances.

This parameter is not supported for GetSpotPlacementScores.

Default: false

launch_template_data.instance_requirements.spot_max_price_percentage_over_lowest_price

[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.

Default: 100

launch_template_data.instance_requirements.total_local_storage_gb

The minimum and maximum amount of total local storage, in GB.

Default: No minimum or maximum limits

Show child fields
launch_template_data.instance_requirements.total_local_storage_gb.max

The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.total_local_storage_gb.min

The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

launch_template_data.instance_requirements.v_cpu_count

The minimum and maximum number of vCPUs.

Show child fields
launch_template_data.instance_requirements.v_cpu_count.max

The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

launch_template_data.instance_requirements.v_cpu_count.min

The minimum number of vCPUs. If the value is 0, there is no minimum limit.

launch_template_data.instance_type

The instance type.

launch_template_data.kernel_id

The ID of the kernel, if applicable.

launch_template_data.key_name

The name of the key pair.

launch_template_data.license_specifications[]
Show child fields
launch_template_data.license_specifications[].license_configuration_arn

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

launch_template_data.maintenance_options

The maintenance options for your instance.

Show child fields
launch_template_data.maintenance_options.auto_recovery

Disables the automatic recovery behavior of your instance or sets it to default.

launch_template_data.metadata_options

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Show child fields
launch_template_data.metadata_options.http_endpoint

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

launch_template_data.metadata_options.http_protocol_ipv6

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

launch_template_data.metadata_options.http_put_response_hop_limit

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

Possible values: Integers from 1 to 64

launch_template_data.metadata_options.http_tokens

Indicates whether IMDSv2 is required.

  • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

  • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

launch_template_data.metadata_options.instance_metadata_tags

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

launch_template_data.metadata_options.state

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

launch_template_data.monitoring

The monitoring for the instance.

Show child fields
launch_template_data.monitoring.enabled

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

launch_template_data.network_interfaces[]
Show child fields
launch_template_data.network_interfaces[].associate_carrier_ip_address

Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.

launch_template_data.network_interfaces[].associate_public_ip_address

Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

launch_template_data.network_interfaces[].connection_tracking_specification

A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the Amazon EC2 User Guide.

Show child fields
launch_template_data.network_interfaces[].connection_tracking_specification.tcp_established_timeout

Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.

launch_template_data.network_interfaces[].connection_tracking_specification.udp_stream_timeout

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.

launch_template_data.network_interfaces[].connection_tracking_specification.udp_timeout

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

launch_template_data.network_interfaces[].delete_on_termination

Indicates whether the network interface is deleted when the instance is terminated.

launch_template_data.network_interfaces[].description

A description for the network interface.

launch_template_data.network_interfaces[].device_index

The device index for the network interface attachment.

launch_template_data.network_interfaces[].ena_srd_specification

Contains the ENA Express settings for instances launched from your launch template.

Show child fields
launch_template_data.network_interfaces[].ena_srd_specification.ena_srd_enabled

Indicates whether ENA Express is enabled for the network interface.

launch_template_data.network_interfaces[].ena_srd_specification.ena_srd_udp_specification

Configures ENA Express for UDP network traffic.

Show child fields
launch_template_data.network_interfaces[].ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.

launch_template_data.network_interfaces[].groups[]
launch_template_data.network_interfaces[].interface_type

The type of network interface.

launch_template_data.network_interfaces[].ipv4_prefix_count

The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.

launch_template_data.network_interfaces[].ipv4_prefixes[]
Show child fields
launch_template_data.network_interfaces[].ipv4_prefixes[].ipv4_prefix

The IPv4 delegated prefixes assigned to the network interface.

launch_template_data.network_interfaces[].ipv6_address_count

The number of IPv6 addresses for the network interface.

launch_template_data.network_interfaces[].ipv6_addresses[]
Show child fields
launch_template_data.network_interfaces[].ipv6_addresses[].ipv6_address

The IPv6 address.

launch_template_data.network_interfaces[].ipv6_addresses[].is_primary_ipv6

Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.

launch_template_data.network_interfaces[].ipv6_prefix_count

The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.

launch_template_data.network_interfaces[].ipv6_prefixes[]
Show child fields
launch_template_data.network_interfaces[].ipv6_prefixes[].ipv6_prefix

The IPv6 delegated prefixes assigned to the network interface.

launch_template_data.network_interfaces[].network_card_index

The index of the network card.

launch_template_data.network_interfaces[].network_interface_id

The ID of the network interface.

launch_template_data.network_interfaces[].primary_ipv6

The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.

launch_template_data.network_interfaces[].private_ip_address

The primary private IPv4 address of the network interface.

launch_template_data.network_interfaces[].private_ip_addresses[]
Show child fields
launch_template_data.network_interfaces[].private_ip_addresses[].primary

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

launch_template_data.network_interfaces[].private_ip_addresses[].private_ip_address

The private IPv4 address.

launch_template_data.network_interfaces[].secondary_private_ip_address_count

The number of secondary private IPv4 addresses for the network interface.

launch_template_data.network_interfaces[].subnet_id

The ID of the subnet for the network interface.

launch_template_data.placement

The placement of the instance.

Show child fields
launch_template_data.placement.affinity

The affinity setting for the instance on the Dedicated Host.

launch_template_data.placement.availability_zone

The Availability Zone of the instance.

launch_template_data.placement.group_id

The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement group.

launch_template_data.placement.group_name

The name of the placement group for the instance.

launch_template_data.placement.host_id

The ID of the Dedicated Host for the instance.

launch_template_data.placement.host_resource_group_arn

The ARN of the host resource group in which to launch the instances.

launch_template_data.placement.partition_number

The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

launch_template_data.placement.spread_domain

Reserved for future use.

launch_template_data.placement.tenancy

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

launch_template_data.private_dns_name_options

The options for the instance hostname.

Show child fields
launch_template_data.private_dns_name_options.enable_resource_name_dns_a_record

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

launch_template_data.private_dns_name_options.enable_resource_name_dns_aaaa_record

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

launch_template_data.private_dns_name_options.hostname_type

The type of hostname to assign to an instance.

launch_template_data.ram_disk_id

The ID of the RAM disk, if applicable.

launch_template_data.security_group_ids[]
launch_template_data.security_groups[]
launch_template_data.tag_specifications[]
Show child fields
launch_template_data.tag_specifications[].resource_type

The type of resource to tag.

launch_template_data.tag_specifications[].tags[]
Show child fields
launch_template_data.tag_specifications[].tags[].key

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

launch_template_data.tag_specifications[].tags[].value

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

launch_template_data.user_data

The user data for the instance.