Class: Aws::EC2::Types::RequestLaunchTemplateData

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

The information to include in the launch template.

<note markdown=“1”> You must specify at least one parameter for the launch template data.

</note>

Constant Summary collapse

SENSITIVE =
[:user_data]

Instance Attribute Summary collapse

Instance Attribute Details

#block_device_mappingsArray<Types::LaunchTemplateBlockDeviceMappingRequest>

The block device mapping.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#capacity_reservation_specificationTypes::LaunchTemplateCapacityReservationSpecificationRequest

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



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#cpu_optionsTypes::LaunchTemplateCpuOptionsRequest

The CPU options for the instance. For more information, see

Optimize CPU options][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#credit_specificationTypes::CreditSpecificationRequest

The credit option for CPU usage of the instance. Valid only for T instances.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#disable_api_stopBoolean

Indicates whether to enable the instance for stop protection. For more information, see [Enable stop protection for your instance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html

Returns:

  • (Boolean)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#disable_api_terminationBoolean

If you set this parameter to ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute]. Alternatively, if you set ‘InstanceInitiatedShutdownBehavior` to `terminate`, you can terminate the instance by running the shutdown command from the instance.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html

Returns:

  • (Boolean)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#ebs_optimizedBoolean

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.

Returns:

  • (Boolean)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#elastic_gpu_specificationsArray<Types::ElasticGpuSpecification>

Deprecated.

<note markdown=“1”> 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.

</note>

Returns:



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#elastic_inference_acceleratorsArray<Types::LaunchTemplateElasticInferenceAccelerator>

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 markdown=“1”> Starting April 15, 2023, Amazon Web Services 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.

</note>


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#enclave_optionsTypes::LaunchTemplateEnclaveOptionsRequest

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see [What is Amazon Web Services 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.

[1]: docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#hibernation_optionsTypes::LaunchTemplateHibernationOptionsRequest

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#iam_instance_profileTypes::LaunchTemplateIamInstanceProfileSpecificationRequest

The name or Amazon Resource Name (ARN) of an IAM instance profile.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#image_idString

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 markdown=“1”> If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:

* Only EC2 Fleets of type `instant` support specifying a Systems
 Manager parameter.
  • For EC2 Fleets of type ‘maintain` or `request`, or for Spot Fleets, you must specify the AMI ID.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#use-an-ssm-parameter-instead-of-an-ami-id

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#instance_initiated_shutdown_behaviorString

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

Default: ‘stop`

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#instance_market_optionsTypes::LaunchTemplateInstanceMarketOptionsRequest

The market (purchasing) option for the instances.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#instance_requirementsTypes::InstanceRequirementsRequest

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 markdown=“1”> 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][3

Amazon Web Services CloudFormation resource,

you can’t specify ‘InstanceRequirements`.

</note>

For more information, see [Attribute-based instance type selection for EC2 Fleet], [Attribute-based instance type selection for Spot Fleet], and [Spot placement score] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html [3]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html [4]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html [5]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html [6]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#instance_typeString

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#kernel_idString

The ID of the kernel.

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#key_nameString

The name of the key pair. You can create a key pair using

CreateKeyPair][1

or [ImportKeyPair].

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#license_specificationsArray<Types::LaunchTemplateLicenseConfigurationRequest>

The license configurations.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#maintenance_optionsTypes::LaunchTemplateInstanceMaintenanceOptionsRequest

The maintenance options for the instance.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#metadata_optionsTypes::LaunchTemplateInstanceMetadataOptionsRequest

The metadata options for the instance. For more information, see

Instance metadata and user data][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#monitoringTypes::LaunchTemplatesMonitoringRequest

The monitoring for the instance.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#network_interfacesArray<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>

The network interfaces for the instance.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#placementTypes::LaunchTemplatePlacementRequest

The placement for the instance.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#private_dns_name_optionsTypes::LaunchTemplatePrivateDnsNameOptionsRequest

The options for the instance hostname. The default values are inherited from the subnet.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#ram_disk_idString

The ID of the RAM disk.

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#security_group_idsArray<String>

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.

Returns:

  • (Array<String>)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#security_groupsArray<String>

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.

Returns:

  • (Array<String>)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#tag_specificationsArray<Types::LaunchTemplateTagSpecificationRequest>

The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.



57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#user_dataString

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 on your Amazon EC2 instance at launch] 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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html [2]: cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive [3]: docs.aws.amazon.com/batch/latest/userguide/launch-templates.html

Returns:

  • (String)


57463
57464
57465
57466
57467
57468
57469
57470
57471
57472
57473
57474
57475
57476
57477
57478
57479
57480
57481
57482
57483
57484
57485
57486
57487
57488
57489
57490
57491
57492
57493
57494
57495
57496
57497
# File 'lib/aws-sdk-ec2/types.rb', line 57463

class RequestLaunchTemplateData < Struct.new(
  :kernel_id,
  :ebs_optimized,
  :iam_instance_profile,
  :block_device_mappings,
  :network_interfaces,
  :image_id,
  :instance_type,
  :key_name,
  :monitoring,
  :placement,
  :ram_disk_id,
  :disable_api_termination,
  :instance_initiated_shutdown_behavior,
  :user_data,
  :tag_specifications,
  :elastic_gpu_specifications,
  :elastic_inference_accelerators,
  :security_group_ids,
  :security_groups,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :license_specifications,
  :hibernation_options,
  :metadata_options,
  :enclave_options,
  :instance_requirements,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop)
  SENSITIVE = [:user_data]
  include Aws::Structure
end