ResponseLaunchTemplateData

The information for a launch template.

blockDeviceMappingSet

The block device mappings.

Type: Array of LaunchTemplateBlockDeviceMapping objects

Required: No

capacityReservationSpecification

Information about the Capacity Reservation targeting option.

Type: LaunchTemplateCapacityReservationSpecificationResponse object

Required: No

cpuOptions

The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.

Type: LaunchTemplateCpuOptions object

Required: No

creditSpecification

The credit option for CPU usage of the instance.

Type: CreditSpecification object

Required: No

disableApiStop

Indicates whether the instance is enabled for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.

Type: Boolean

Required: No

disableApiTermination

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

Type: Boolean

Required: No

ebsOptimized

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

Type: Boolean

Required: No

elasticGpuSpecificationSet

Deprecated.

Note

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.

Type: Array of ElasticGpuSpecificationResponse objects

Required: No

elasticInferenceAcceleratorSet

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.

Note

Starting April 15, 2023, Amazon will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

Type: Array of LaunchTemplateElasticInferenceAcceleratorResponse objects

Required: No

enclaveOptions

Indicates whether the instance is enabled for Amazon Nitro Enclaves.

Type: LaunchTemplateEnclaveOptions object

Required: No

hibernationOptions

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

Type: LaunchTemplateHibernationOptions object

Required: No

iamInstanceProfile

The IAM instance profile.

Type: LaunchTemplateIamInstanceProfileSpecification object

Required: No

imageId

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 Elastic Compute Cloud User Guide.

Type: String

Required: No

instanceInitiatedShutdownBehavior

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

Type: String

Valid Values: stop | terminate

Required: No

instanceMarketOptions

The market (purchasing) option for the instances.

Type: LaunchTemplateInstanceMarketOptions object

Required: No

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.

Type: InstanceRequirements object

Required: No

instanceType

The instance type.

Type: String

Required: No

kernelId

The ID of the kernel, if applicable.

Type: String

Required: No

keyName

The name of the key pair.

Type: String

Required: No

licenseSet

The license configurations.

Type: Array of LaunchTemplateLicenseConfiguration objects

Required: No

maintenanceOptions

The maintenance options for your instance.

Type: LaunchTemplateInstanceMaintenanceOptions object

Required: No

metadataOptions

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

Type: LaunchTemplateInstanceMetadataOptions object

Required: No

monitoring

The monitoring for the instance.

Type: LaunchTemplatesMonitoring object

Required: No

networkInterfaceSet

The network interfaces.

Type: Array of LaunchTemplateInstanceNetworkInterfaceSpecification objects

Required: No

placement

The placement of the instance.

Type: LaunchTemplatePlacement object

Required: No

privateDnsNameOptions

The options for the instance hostname.

Type: LaunchTemplatePrivateDnsNameOptions object

Required: No

ramDiskId

The ID of the RAM disk, if applicable.

Type: String

Required: No

securityGroupIdSet

The security group IDs.

Type: Array of strings

Required: No

securityGroupSet

The security group names.

Type: Array of strings

Required: No

tagSpecificationSet

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

Type: Array of LaunchTemplateTagSpecification objects

Required: No

userData

The user data for the instance.

Type: String

Required: No

ResponseLaunchTemplateData

Contents

Note

Note

See Also