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

Inherits:

Struct

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

show all

Includes:: Structure

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

Overview

Note:

When making an API call, you may pass RequestLaunchTemplateData data as a hash:

{
  kernel_id: "String",
  ebs_optimized: false,
  iam_instance_profile: {
    arn: "String",
    name: "String",
  },
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        encrypted: false,
        delete_on_termination: false,
        iops: 1,
        kms_key_id: "String",
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
      },
      no_device: "String",
    },
  ],
  network_interfaces: [
    {
      associate_public_ip_address: false,
      delete_on_termination: false,
      description: "String",
      device_index: 1,
      groups: ["String"],
      ipv_6_address_count: 1,
      ipv_6_addresses: [
        {
          ipv_6_address: "String",
        },
      ],
      network_interface_id: "String",
      private_ip_address: "String",
      private_ip_addresses: [
        {
          primary: false,
          private_ip_address: "String",
        },
      ],
      secondary_private_ip_address_count: 1,
      subnet_id: "String",
    },
  ],
  image_id: "String",
  instance_type: "t1.micro", # accepts t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.12xlarge, r5a.24xlarge, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.18xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.18xlarge, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.12xlarge, m5.24xlarge, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.12xlarge, m5a.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.12xlarge, m5d.24xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge
  key_name: "String",
  monitoring: {
    enabled: false,
  },
  placement: {
    availability_zone: "String",
    affinity: "String",
    group_name: "String",
    host_id: "String",
    tenancy: "default", # accepts default, dedicated, host
    spread_domain: "String",
  },
  ram_disk_id: "String",
  disable_api_termination: false,
  instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
  user_data: "String",
  tag_specifications: [
    {
      resource_type: "customer-gateway", # accepts customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, image, instance, internet-gateway, launch-template, natgateway, network-acl, network-interface, reserved-instances, route-table, security-group, snapshot, spot-instances-request, subnet, transit-gateway, transit-gateway-attachment, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  elastic_gpu_specifications: [
    {
      type: "String", # required
    },
  ],
  elastic_inference_accelerators: [
    {
      type: "String", # required
    },
  ],
  security_group_ids: ["String"],
  security_groups: ["String"],
  instance_market_options: {
    market_type: "spot", # accepts spot
    spot_options: {
      max_price: "String",
      spot_instance_type: "one-time", # accepts one-time, persistent
      block_duration_minutes: 1,
      valid_until: Time.now,
      instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
    },
  },
  credit_specification: {
    cpu_credits: "String", # required
  },
  cpu_options: {
    core_count: 1,
    threads_per_core: 1,
  },
  capacity_reservation_specification: {
    capacity_reservation_preference: "open", # accepts open, none
    capacity_reservation_target: {
      capacity_reservation_id: "String",
    },
  },
  hibernation_options: {
    configured: false,
  },
  license_specifications: [
    {
      license_configuration_arn: "String",
    },
  ],
}

The information to include in the launch template.

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

If set to ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API.
#ebs_optimized ⇒ Boolean

Indicates whether the instance is optimized for Amazon EBS I/O.
#elastic_gpu_specifications ⇒ Array<Types::ElasticGpuSpecification>

An elastic GPU to associate with the instance.
#elastic_inference_accelerators ⇒ Array<Types::LaunchTemplateElasticInferenceAccelerator>

The elastic inference accelerator for the instance.
#hibernation_options ⇒ Types::LaunchTemplateHibernationOptionsRequest

Indicates whether an instance is enabled for hibernation.
#iam_instance_profile ⇒ Types::LaunchTemplateIamInstanceProfileSpecificationRequest

The IAM instance profile.
#image_id ⇒ String

The ID of the AMI, which you can get by using DescribeImages.
#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_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.
#monitoring ⇒ Types::LaunchTemplatesMonitoringRequest

The monitoring for the instance.
#network_interfaces ⇒ Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>

One or more network interfaces.
#placement ⇒ Types::LaunchTemplatePlacementRequest

The placement for the instance.
#ram_disk_id ⇒ String

The ID of the RAM disk.
#security_group_ids ⇒ Array<String>

One or more security group IDs.
#security_groups ⇒ Array<String>

[EC2-Classic, default VPC] One or more security group names.
#tag_specifications ⇒ Array<Types::LaunchTemplateTagSpecificationRequest>

The tags to apply to the resources during launch.
#user_data ⇒ String

The Base64-encoded user data to make available to the instance.

Instance Attribute Details

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

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

Returns:

(Array<Types::LaunchTemplateBlockDeviceMappingRequest>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#capacity_reservation_specification ⇒ `Types::LaunchTemplateCapacityReservationSpecificationRequest`

The Capacity Reservation targeting option.

Returns:

(Types::LaunchTemplateCapacityReservationSpecificationRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#cpu_options ⇒ `Types::LaunchTemplateCpuOptionsRequest`

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

Optimizing CPU Options][1: in the *Amazon Elastic Compute Cloud

User Guide*.

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

Returns:

(Types::LaunchTemplateCpuOptionsRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#credit_specification ⇒ `Types::CreditSpecificationRequest`

The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.

Returns:

(Types::CreditSpecificationRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#disable_api_termination ⇒ `Boolean`

If set to ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to ‘false` after launch, use ModifyInstanceAttribute.

Returns:

(Boolean)

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

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,
  :hibernation_options,
  :license_specifications)
  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 'lib/aws-sdk-ec2/types.rb', line 29638

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

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

An elastic GPU to associate with the instance.

Returns:

(Array<Types::ElasticGpuSpecification>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

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

The elastic inference accelerator for the instance.

Returns:

(Array<Types::LaunchTemplateElasticInferenceAccelerator>)

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

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,
  :hibernation_options,
  :license_specifications)
  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]. Hibernation is currently supported only for Amazon Linux. For more information, see [Hibernate Your Instance] in the *Amazon Elastic Compute Cloud User Guide*.

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

Returns:

(Types::LaunchTemplateHibernationOptionsRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#iam_instance_profile ⇒ `Types::LaunchTemplateIamInstanceProfileSpecificationRequest`

The IAM instance profile.

Returns:

(Types::LaunchTemplateIamInstanceProfileSpecificationRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#image_id ⇒ `String`

The ID of the AMI, which you can get by using DescribeImages.

Returns:

(String)

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

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,
  :hibernation_options,
  :license_specifications)
  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 'lib/aws-sdk-ec2/types.rb', line 29638

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#instance_market_options ⇒ `Types::LaunchTemplateInstanceMarketOptionsRequest`

The market (purchasing) option for the instances.

Returns:

(Types::LaunchTemplateInstanceMarketOptionsRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#instance_type ⇒ `String`

The instance type. For more information, see [Instance Types] in the *Amazon Elastic Compute Cloud User Guide*.

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

Returns:

(String)

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

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,
  :hibernation_options,
  :license_specifications)
  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*.

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

Returns:

(String)

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

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,
  :hibernation_options,
  :license_specifications)
  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 'lib/aws-sdk-ec2/types.rb', line 29638

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

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

The license configurations.

Returns:

(Array<Types::LaunchTemplateLicenseConfigurationRequest>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#monitoring ⇒ `Types::LaunchTemplatesMonitoringRequest`

The monitoring for the instance.

Returns:

(Types::LaunchTemplatesMonitoringRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

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

One or more network interfaces.

Returns:

(Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#placement ⇒ `Types::LaunchTemplatePlacementRequest`

The placement for the instance.

Returns:

(Types::LaunchTemplatePlacementRequest)

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

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,
  :hibernation_options,
  :license_specifications)
  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*.

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

Returns:

(String)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.

Returns:

(Array<String>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#security_groups ⇒ `Array<String>`

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

Returns:

(Array<String>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

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

The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.

Returns:

(Array<Types::LaunchTemplateTagSpecificationRequest>)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

#user_data ⇒ `String`

The Base64-encoded user data to make available to the instance. For more information, see [Running Commands on Your Linux Instance at Launch] (Linux) and [Adding User Data] (Windows).

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html [2]: docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data

Returns:

(String)

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

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,
  :hibernation_options,
  :license_specifications)
  include Aws::Structure
end

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

Overview

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

#ebs_optimized ⇒ Boolean

#elastic_gpu_specifications ⇒ Array<Types::ElasticGpuSpecification>

#elastic_inference_accelerators ⇒ Array<Types::LaunchTemplateElasticInferenceAccelerator>

#hibernation_options ⇒ Types::LaunchTemplateHibernationOptionsRequest

#iam_instance_profile ⇒ Types::LaunchTemplateIamInstanceProfileSpecificationRequest

#image_id ⇒ String

#instance_initiated_shutdown_behavior ⇒ String

#instance_market_options ⇒ Types::LaunchTemplateInstanceMarketOptionsRequest

#instance_type ⇒ String

#kernel_id ⇒ String

#key_name ⇒ String

#license_specifications ⇒ Array<Types::LaunchTemplateLicenseConfigurationRequest>

#monitoring ⇒ Types::LaunchTemplatesMonitoringRequest

#network_interfaces ⇒ Array<Types::LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>

#placement ⇒ Types::LaunchTemplatePlacementRequest

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

#ebs_optimized ⇒ `Boolean`

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

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

#hibernation_options ⇒ `Types::LaunchTemplateHibernationOptionsRequest`

#iam_instance_profile ⇒ `Types::LaunchTemplateIamInstanceProfileSpecificationRequest`

#image_id ⇒ `String`

#instance_initiated_shutdown_behavior ⇒ `String`

#instance_market_options ⇒ `Types::LaunchTemplateInstanceMarketOptionsRequest`

#instance_type ⇒ `String`

#kernel_id ⇒ `String`

#key_name ⇒ `String`

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

#monitoring ⇒ `Types::LaunchTemplatesMonitoringRequest`

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

#placement ⇒ `Types::LaunchTemplatePlacementRequest`

#ram_disk_id ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#security_groups ⇒ `Array<String>`

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

#user_data ⇒ `String`