RequestLaunchTemplateDataDict¶
Dictionary Type¶
RequestLaunchTemplateDataDict
¶
Bases: TypedDict
Dictionary form of RequestLaunchTemplateData.
Attributes¶
block_device_mappings
instance-attribute
¶
block_device_mappings: Sequence[LaunchTemplateBlockDeviceMappingRequest | LaunchTemplateBlockDeviceMappingRequestDict] | None
The block device mapping.
capacity_reservation_specification
instance-attribute
¶
capacity_reservation_specification: LaunchTemplateCapacityReservationSpecificationRequest | LaunchTemplateCapacityReservationSpecificationRequestDict | None
The Capacity Reservation targeting option. If you do not specify this
parameter, the instance's Capacity Reservation preference defaults to
open, which enables it to run in any open Capacity Reservation that
has matching attributes (instance type, platform, Availability Zone).
cpu_options
instance-attribute
¶
cpu_options: LaunchTemplateCpuOptionsRequest | LaunchTemplateCpuOptionsRequestDict | None
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: CreditSpecificationRequest | CreditSpecificationRequestDict | None
The credit option for CPU usage of the instance. Valid only for T instances.
disable_api_stop
instance-attribute
¶
disable_api_stop: bool | None
Indicates whether to enable the instance 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: bool | None
Indicates whether termination protection is enabled for the instance.
The default is false, which means that you can terminate the instance
using the Amazon EC2 console, command line tools, or API. You can enable
termination protection when you launch an instance, while the instance
is running, or while the instance is stopped.
ebs_optimized
instance-attribute
¶
ebs_optimized: bool | None
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
elastic_gpu_specifications
instance-attribute
¶
elastic_gpu_specifications: Sequence[ElasticGpuSpecification | ElasticGpuSpecificationDict] | None
Deprecated.
Note
Amazon Elastic Graphics reached end of life on January 8, 2024.
elastic_inference_accelerators
instance-attribute
¶
elastic_inference_accelerators: Sequence[LaunchTemplateElasticInferenceAccelerator | LaunchTemplateElasticInferenceAcceleratorDict] | None
Note
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: LaunchTemplateEnclaveOptionsRequest | LaunchTemplateEnclaveOptionsRequestDict | None
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
hibernation_options
instance-attribute
¶
hibernation_options: LaunchTemplateHibernationOptionsRequest | LaunchTemplateHibernationOptionsRequestDict | None
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
iam_instance_profile
instance-attribute
¶
iam_instance_profile: LaunchTemplateIamInstanceProfileSpecificationRequest | LaunchTemplateIamInstanceProfileSpecificationRequestDict | None
The name or Amazon Resource Name (ARN) of an IAM instance profile.
image_id
instance-attribute
¶
image_id: str | None
The ID of the AMI in the format ami-0ac394d6a3example.
Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.
To reference a public parameter:
resolve:ssm:public-parameter
To reference a parameter stored in the same account:
-
resolve:ssm:parameter-name -
resolve:ssm:parameter-name:version-number -
resolve:ssm:parameter-name:label
To reference a parameter shared from another Amazon Web Services account:
-
resolve:ssm:parameter-ARN -
resolve:ssm:parameter-ARN:version-number -
resolve:ssm:parameter-ARN:label
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
Note
If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:
-
Only EC2 Fleets of type
instantsupport specifying a Systems Manager parameter. -
For EC2 Fleets of type
maintainorrequest, or for Spot Fleets, you must specify the AMI ID.
instance_initiated_shutdown_behavior
instance-attribute
¶
instance_initiated_shutdown_behavior: str | None
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
instance_market_options
instance-attribute
¶
instance_market_options: LaunchTemplateInstanceMarketOptionsRequest | LaunchTemplateInstanceMarketOptionsRequestDict | None
The market (purchasing) option for the instances.
instance_requirements
instance-attribute
¶
instance_requirements: InstanceRequirementsRequest | InstanceRequirementsRequestDict | None
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are
optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
-
AllowedInstanceTypes- The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. -
ExcludedInstanceTypes- The instance types to exclude from the list, even if they match your specified attributes.
Note
If you specify InstanceRequirements, you can't specify
InstanceType.
Attribute-based instance type selection is only supported when using
Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If
you plan to use the launch template in the launch instance
wizard,
or with the
RunInstances
API or
AWS::EC2::Instance
Amazon Web Services CloudFormation resource, you can't specify
InstanceRequirements.
For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot placement score in the Amazon EC2 User Guide.
instance_type
instance-attribute
¶
instance_type: str | None
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
If you specify InstanceType, you can't specify
InstanceRequirements.
kernel_id
instance-attribute
¶
kernel_id: str | None
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Linux 2 User Guide.
key_name
instance-attribute
¶
key_name: str | None
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
license_specifications
instance-attribute
¶
license_specifications: Sequence[LaunchTemplateLicenseConfigurationRequest | LaunchTemplateLicenseConfigurationRequestDict] | None
The license configurations.
maintenance_options
instance-attribute
¶
maintenance_options: LaunchTemplateInstanceMaintenanceOptionsRequest | LaunchTemplateInstanceMaintenanceOptionsRequestDict | None
The maintenance options for the instance.
metadata_options
instance-attribute
¶
metadata_options: LaunchTemplateInstanceMetadataOptionsRequest | LaunchTemplateInstanceMetadataOptionsRequestDict | None
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: LaunchTemplatesMonitoringRequest | LaunchTemplatesMonitoringRequestDict | None
The monitoring for the instance.
network_interfaces
instance-attribute
¶
network_interfaces: Sequence[LaunchTemplateInstanceNetworkInterfaceSpecificationRequest | LaunchTemplateInstanceNetworkInterfaceSpecificationRequestDict] | None
The network interfaces for the instance.
network_performance_options
instance-attribute
¶
network_performance_options: LaunchTemplateNetworkPerformanceOptionsRequest | LaunchTemplateNetworkPerformanceOptionsRequestDict | None
Contains launch template settings to boost network performance for the type of workload that runs on your instance.
operator
instance-attribute
¶
operator: OperatorRequest | OperatorRequestDict | None
The entity that manages the launch template.
placement
instance-attribute
¶
placement: LaunchTemplatePlacementRequest | LaunchTemplatePlacementRequestDict | None
The placement for the instance.
private_dns_name_options
instance-attribute
¶
private_dns_name_options: LaunchTemplatePrivateDnsNameOptionsRequest | LaunchTemplatePrivateDnsNameOptionsRequestDict | None
The options for the instance hostname. The default values are inherited from the subnet.
ram_disk_id
instance-attribute
¶
ram_disk_id: str | None
The ID of the RAM disk.
Warning
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.
secondary_interfaces
instance-attribute
¶
secondary_interfaces: Sequence[LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest | LaunchTemplateInstanceSecondaryInterfaceSpecificationRequestDict] | None
The secondary interfaces to associate with instances launched from the template.
security_group_ids
instance-attribute
¶
The IDs of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
security_groups
instance-attribute
¶
The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[LaunchTemplateTagSpecificationRequest | LaunchTemplateTagSpecificationRequestDict] | None
The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.
user_data
instance-attribute
¶
user_data: str | None
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands when you launch an EC2 instance with user data input in the Amazon EC2 User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.