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

Inherits:

Struct

Object
Struct
Aws::EC2::Types::RequestLaunchTemplateData

show all

Defined in:: gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

The information to include in the launch template.

You must specify at least one parameter for the launch template data.

Constant Summary collapse

SENSITIVE =

[:user_data]

Instance Attribute Summary collapse

#block_device_mappings ⇒ Array<Types::LaunchTemplateBlockDeviceMappingRequest>
The block device mapping.
#capacity_reservation_specification ⇒ Types::LaunchTemplateCapacityReservationSpecificationRequest
The Capacity Reservation targeting option.
#cpu_options ⇒ Types::LaunchTemplateCpuOptionsRequest
The CPU options for the instance.
#credit_specification ⇒ Types::CreditSpecificationRequest
The credit option for CPU usage of the instance.
#disable_api_stop ⇒ Boolean
Indicates whether to enable the instance for stop protection.
#disable_api_termination ⇒ Boolean
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
#ebs_optimized ⇒ Boolean
Indicates whether the instance is optimized for Amazon EBS I/O.
#elastic_gpu_specifications ⇒ Array<Types::ElasticGpuSpecification>
Deprecated.
#elastic_inference_accelerators ⇒ Array<Types::LaunchTemplateElasticInferenceAccelerator>
An elastic inference accelerator to associate with the instance.
#enclave_options ⇒ Types::LaunchTemplateEnclaveOptionsRequest
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
#hibernation_options ⇒ Types::LaunchTemplateHibernationOptionsRequest
Indicates whether an instance is enabled for hibernation.
#iam_instance_profile ⇒ Types::LaunchTemplateIamInstanceProfileSpecificationRequest
The name or Amazon Resource Name (ARN) of an IAM instance profile.
#image_id ⇒ String
The ID of the AMI.
#instance_initiated_shutdown_behavior ⇒ String
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
#instance_market_options ⇒ Types::LaunchTemplateInstanceMarketOptionsRequest
The market (purchasing) option for the instances.
#instance_requirements ⇒ Types::InstanceRequirementsRequest
The attributes for the instance types.
#instance_type ⇒ String
The instance type.
#kernel_id ⇒ String
The ID of the kernel.
#key_name ⇒ String
The name of the key pair.
#license_specifications ⇒ Array<Types::LaunchTemplateLicenseConfigurationRequest>
The license configurations.
#maintenance_options ⇒ Types::LaunchTemplateInstanceMaintenanceOptionsRequest
The maintenance options for the instance.
#metadata_options ⇒ Types::LaunchTemplateInstanceMetadataOptionsRequest
The metadata options for the instance.
#monitoring ⇒ Types::LaunchTemplatesMonitoringRequest
The monitoring for the instance.
#network_interfaces ⇒ Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>
The network interfaces for the instance.
#placement ⇒ Types::LaunchTemplatePlacementRequest
The placement for the instance.
#private_dns_name_options ⇒ Types::LaunchTemplatePrivateDnsNameOptionsRequest
The options for the instance hostname.
#ram_disk_id ⇒ String
The ID of the RAM disk.
#security_group_ids ⇒ Array<String>
The IDs of the security groups.
#security_groups ⇒ Array<String>
The names of the security groups.
#tag_specifications ⇒ Array<Types::LaunchTemplateTagSpecificationRequest>
The tags to apply to the resources that are created during instance launch.
#user_data ⇒ String
The user data to make available to the instance.

Instance Attribute Details

#block_device_mappings ⇒ `Array<Types::LaunchTemplateBlockDeviceMappingRequest>`

The block device mapping.

Returns:

(Array<Types::LaunchTemplateBlockDeviceMappingRequest>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_specification ⇒ `Types::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).

Returns:

(Types::LaunchTemplateCapacityReservationSpecificationRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::LaunchTemplateCpuOptionsRequest`

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

Returns:

(Types::LaunchTemplateCpuOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_specification ⇒ `Types::CreditSpecificationRequest`

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

Returns:

(Types::CreditSpecificationRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_stop ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_termination ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_optimized ⇒ `Boolean`

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_specifications ⇒ `Array<Types::ElasticGpuSpecification>`

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.

Returns:

(Array<Types::ElasticGpuSpecification>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_accelerators ⇒ `Array<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.

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.

Returns:

(Array<Types::LaunchTemplateElasticInferenceAccelerator>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::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.

Returns:

(Types::LaunchTemplateEnclaveOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::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 instance in the Amazon Elastic Compute Cloud User Guide.

Returns:

(Types::LaunchTemplateHibernationOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_profile ⇒ `Types::LaunchTemplateIamInstanceProfileSpecificationRequest`

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

Returns:

(Types::LaunchTemplateIamInstanceProfileSpecificationRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_id ⇒ `String`

The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.

Valid formats:

ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter

Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_behavior ⇒ `String`

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::LaunchTemplateInstanceMarketOptionsRequest`

The market (purchasing) option for the instances.

Returns:

(Types::LaunchTemplateInstanceMarketOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_requirements ⇒ `Types::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.

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

Returns:

(Types::InstanceRequirementsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_type ⇒ `String`

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_name ⇒ `String`

The name of the key pair. You can create a key pair using CreateKeyPair 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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_specifications ⇒ `Array<Types::LaunchTemplateLicenseConfigurationRequest>`

The license configurations.

Returns:

(Array<Types::LaunchTemplateLicenseConfigurationRequest>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::LaunchTemplateInstanceMaintenanceOptionsRequest`

The maintenance options for the instance.

Returns:

(Types::LaunchTemplateInstanceMaintenanceOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::LaunchTemplateInstanceMetadataOptionsRequest`

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

Returns:

(Types::LaunchTemplateInstanceMetadataOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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

#monitoring ⇒ `Types::LaunchTemplatesMonitoringRequest`

The monitoring for the instance.

Returns:

(Types::LaunchTemplatesMonitoringRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_interfaces ⇒ `Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>`

The network interfaces for the instance.

Returns:

(Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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

#placement ⇒ `Types::LaunchTemplatePlacementRequest`

The placement for the instance.

Returns:

(Types::LaunchTemplatePlacementRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_options ⇒ `Types::LaunchTemplatePrivateDnsNameOptionsRequest`

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

Returns:

(Types::LaunchTemplatePrivateDnsNameOptionsRequest)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_ids ⇒ `Array<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>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_groups ⇒ `Array<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>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_specifications ⇒ `Array<Types::LaunchTemplateTagSpecificationRequest>`

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

Returns:

(Array<Types::LaunchTemplateTagSpecificationRequest>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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_data ⇒ `String`

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 Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud 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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 56508

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#block_device_mappings ⇒ Array<Types::LaunchTemplateBlockDeviceMappingRequest>

#capacity_reservation_specification ⇒ Types::LaunchTemplateCapacityReservationSpecificationRequest

#cpu_options ⇒ Types::LaunchTemplateCpuOptionsRequest

#credit_specification ⇒ Types::CreditSpecificationRequest

#disable_api_stop ⇒ Boolean

#disable_api_termination ⇒ Boolean

#ebs_optimized ⇒ Boolean

#elastic_gpu_specifications ⇒ Array<Types::ElasticGpuSpecification>

#elastic_inference_accelerators ⇒ Array<Types::LaunchTemplateElasticInferenceAccelerator>

#enclave_options ⇒ Types::LaunchTemplateEnclaveOptionsRequest

#hibernation_options ⇒ Types::LaunchTemplateHibernationOptionsRequest

#iam_instance_profile ⇒ Types::LaunchTemplateIamInstanceProfileSpecificationRequest

#image_id ⇒ String

#instance_initiated_shutdown_behavior ⇒ String

#instance_market_options ⇒ Types::LaunchTemplateInstanceMarketOptionsRequest

#instance_requirements ⇒ Types::InstanceRequirementsRequest

#instance_type ⇒ String

#kernel_id ⇒ String

#key_name ⇒ String

#license_specifications ⇒ Array<Types::LaunchTemplateLicenseConfigurationRequest>

#maintenance_options ⇒ Types::LaunchTemplateInstanceMaintenanceOptionsRequest

#metadata_options ⇒ Types::LaunchTemplateInstanceMetadataOptionsRequest

#monitoring ⇒ Types::LaunchTemplatesMonitoringRequest

#network_interfaces ⇒ Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>

#placement ⇒ Types::LaunchTemplatePlacementRequest

#private_dns_name_options ⇒ Types::LaunchTemplatePrivateDnsNameOptionsRequest

#ram_disk_id ⇒ String

#security_group_ids ⇒ Array<String>

#security_groups ⇒ Array<String>

#tag_specifications ⇒ Array<Types::LaunchTemplateTagSpecificationRequest>

#user_data ⇒ String

#block_device_mappings ⇒ `Array<Types::LaunchTemplateBlockDeviceMappingRequest>`

#capacity_reservation_specification ⇒ `Types::LaunchTemplateCapacityReservationSpecificationRequest`

#cpu_options ⇒ `Types::LaunchTemplateCpuOptionsRequest`

#credit_specification ⇒ `Types::CreditSpecificationRequest`

#disable_api_stop ⇒ `Boolean`

#disable_api_termination ⇒ `Boolean`

#ebs_optimized ⇒ `Boolean`

#elastic_gpu_specifications ⇒ `Array<Types::ElasticGpuSpecification>`

#elastic_inference_accelerators ⇒ `Array<Types::LaunchTemplateElasticInferenceAccelerator>`

#enclave_options ⇒ `Types::LaunchTemplateEnclaveOptionsRequest`

#hibernation_options ⇒ `Types::LaunchTemplateHibernationOptionsRequest`

#iam_instance_profile ⇒ `Types::LaunchTemplateIamInstanceProfileSpecificationRequest`

#image_id ⇒ `String`

#instance_initiated_shutdown_behavior ⇒ `String`

#instance_market_options ⇒ `Types::LaunchTemplateInstanceMarketOptionsRequest`

#instance_requirements ⇒ `Types::InstanceRequirementsRequest`

#instance_type ⇒ `String`

#kernel_id ⇒ `String`

#key_name ⇒ `String`

#license_specifications ⇒ `Array<Types::LaunchTemplateLicenseConfigurationRequest>`

#maintenance_options ⇒ `Types::LaunchTemplateInstanceMaintenanceOptionsRequest`

#metadata_options ⇒ `Types::LaunchTemplateInstanceMetadataOptionsRequest`

#monitoring ⇒ `Types::LaunchTemplatesMonitoringRequest`

#network_interfaces ⇒ `Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>`

#placement ⇒ `Types::LaunchTemplatePlacementRequest`

#private_dns_name_options ⇒ `Types::LaunchTemplatePrivateDnsNameOptionsRequest`

#ram_disk_id ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#security_groups ⇒ `Array<String>`

#tag_specifications ⇒ `Array<Types::LaunchTemplateTagSpecificationRequest>`

#user_data ⇒ `String`