Class: Aws::EC2::Types::RunInstancesRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::RunInstancesRequest

show all

Includes:: Structure

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

Overview

Note:

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

{
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        encrypted: false,
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
      },
      no_device: "String",
    },
  ],
  image_id: "String", # required
  instance_type: "t1.micro", # accepts t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.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, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, 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, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.16xlarge
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
    },
  ],
  kernel_id: "String",
  key_name: "String",
  max_count: 1, # required
  min_count: 1, # required
  monitoring: {
    enabled: false, # required
  },
  placement: {
    availability_zone: "String",
    affinity: "String",
    group_name: "String",
    host_id: "String",
    tenancy: "default", # accepts default, dedicated, host
    spread_domain: "String",
  },
  ramdisk_id: "String",
  security_group_ids: ["String"],
  security_groups: ["String"],
  subnet_id: "String",
  user_data: "String",
  additional_info: "String",
  client_token: "String",
  disable_api_termination: false,
  dry_run: false,
  ebs_optimized: false,
  iam_instance_profile: {
    arn: "String",
    name: "String",
  },
  instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
  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", # required
        },
      ],
      secondary_private_ip_address_count: 1,
      subnet_id: "String",
    },
  ],
  private_ip_address: "String",
  elastic_gpu_specification: [
    {
      type: "String", # required
    },
  ],
  tag_specifications: [
    {
      resource_type: "customer-gateway", # accepts customer-gateway, dhcp-options, image, instance, internet-gateway, network-acl, network-interface, reserved-instances, route-table, snapshot, spot-instances-request, subnet, security-group, volume, vpc, vpn-connection, vpn-gateway
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Contains the parameters for RunInstances.

Instance Attribute Summary collapse

#additional_info ⇒ String

Reserved.
#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

The block device mapping.
#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
#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.
#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#ebs_optimized ⇒ Boolean

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

An Elastic GPU to associate with the instance.
#iam_instance_profile ⇒ Types::IamInstanceProfileSpecification

The IAM instance profile.
#image_id ⇒ String

The ID of the AMI, which you can get by calling 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_type ⇒ String

The instance type.
#ipv_6_address_count ⇒ Integer

[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface.
#ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>

[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface.
#kernel_id ⇒ String

The ID of the kernel.
#key_name ⇒ String

The name of the key pair.
#max_count ⇒ Integer

The maximum number of instances to launch.
#min_count ⇒ Integer

The minimum number of instances to launch.
#monitoring ⇒ Types::RunInstancesMonitoringEnabled

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

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

The placement for the instance.
#private_ip_address ⇒ String

[EC2-VPC] The primary IPv4 address.
#ramdisk_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.
#subnet_id ⇒ String

[EC2-VPC] The ID of the subnet to launch the instance into.
#tag_specifications ⇒ Array<Types::TagSpecification>

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

The user data to make available to the instance.

Instance Attribute Details

#additional_info ⇒ `String`

Reserved.

Returns:

(String)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

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

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::BlockDeviceMapping>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#client_token ⇒ `String`

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency].

Constraints: Maximum 64 ASCII characters

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

Returns:

(String)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  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 to ‘false` after launch, use ModifyInstanceAttribute. Alternatively, if you set `InstanceInitiatedShutdownBehavior` to `terminate`, you can terminate the instance by running the shutdown command from the instance.

Default: ‘false`

Returns:

(Boolean)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

(Boolean)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#ebs_optimized ⇒ `Boolean`

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: ‘false`

Returns:

(Boolean)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

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

An Elastic GPU to associate with the instance.

Returns:

(Array<Types::ElasticGpuSpecification>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#iam_instance_profile ⇒ `Types::IamInstanceProfileSpecification`

The IAM instance profile.

Returns:

(Types::IamInstanceProfileSpecification)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#image_id ⇒ `String`

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

Returns:

(String)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_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 21268

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_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*.

Default: ‘m1.small`

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

Returns:

(String)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#ipv_6_address_count ⇒ `Integer`

[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you’ve specified a minimum number of instances to launch.

Returns:

(Integer)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#ipv_6_addresses ⇒ `Array<Types::InstanceIpv6Address>`

[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you’ve specified a minimum number of instances to launch.

Returns:

(Array<Types::InstanceIpv6Address>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_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 [ PV-GRUB] 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 21268

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_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 21268

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#max_count ⇒ `Integer`

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above ‘MinCount`.

Constraints: Between 1 and the maximum number you’re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see [How many instances can I run in Amazon EC2] in the Amazon EC2 FAQ.

[1]: aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2

Returns:

(Integer)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#min_count ⇒ `Integer`

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

[1]: aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2

Returns:

(Integer)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#monitoring ⇒ `Types::RunInstancesMonitoringEnabled`

The monitoring for the instance.

Returns:

(Types::RunInstancesMonitoringEnabled)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

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

One or more network interfaces.

Returns:

(Array<Types::InstanceNetworkInterfaceSpecification>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#placement ⇒ `Types::Placement`

The placement for the instance.

Returns:

(Types::Placement)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#private_ip_address ⇒ `String`

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can’t specify this option if you’ve specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you’re launching more than one instance in the request.

Returns:

(String)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#ramdisk_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 [ PV-GRUB] 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 21268

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

Returns:

(Array<String>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_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.

Default: Amazon EC2 uses the default security group.

Returns:

(Array<String>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#subnet_id ⇒ `String`

[EC2-VPC] The ID of the subnet to launch the instance into.

Returns:

(String)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

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

The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.

Returns:

(Array<Types::TagSpecification>)

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

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

#user_data ⇒ `String`

The 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). If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

[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 21268

class RunInstancesRequest < Struct.new(
  :block_device_mappings,
  :image_id,
  :instance_type,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :kernel_id,
  :key_name,
  :max_count,
  :min_count,
  :monitoring,
  :placement,
  :ramdisk_id,
  :security_group_ids,
  :security_groups,
  :subnet_id,
  :user_data,
  :additional_info,
  :client_token,
  :disable_api_termination,
  :dry_run,
  :ebs_optimized,
  :iam_instance_profile,
  :instance_initiated_shutdown_behavior,
  :network_interfaces,
  :private_ip_address,
  :elastic_gpu_specification,
  :tag_specifications)
  include Aws::Structure
end

Class: Aws::EC2::Types::RunInstancesRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#additional_info ⇒ String

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

#client_token ⇒ String

#disable_api_termination ⇒ Boolean

#dry_run ⇒ Boolean

#ebs_optimized ⇒ Boolean

#elastic_gpu_specification ⇒ Array<Types::ElasticGpuSpecification>

#iam_instance_profile ⇒ Types::IamInstanceProfileSpecification

#image_id ⇒ String

#instance_initiated_shutdown_behavior ⇒ String

#instance_type ⇒ String

#ipv_6_address_count ⇒ Integer

#ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>

#kernel_id ⇒ String

#key_name ⇒ String

#max_count ⇒ Integer

#min_count ⇒ Integer

#monitoring ⇒ Types::RunInstancesMonitoringEnabled

#network_interfaces ⇒ Array<Types::InstanceNetworkInterfaceSpecification>

#placement ⇒ Types::Placement

#private_ip_address ⇒ String

#ramdisk_id ⇒ String

#security_group_ids ⇒ Array<String>

#security_groups ⇒ Array<String>

#subnet_id ⇒ String

#tag_specifications ⇒ Array<Types::TagSpecification>

#user_data ⇒ String

#additional_info ⇒ `String`

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

#client_token ⇒ `String`

#disable_api_termination ⇒ `Boolean`

#dry_run ⇒ `Boolean`

#ebs_optimized ⇒ `Boolean`

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

#iam_instance_profile ⇒ `Types::IamInstanceProfileSpecification`

#image_id ⇒ `String`

#instance_initiated_shutdown_behavior ⇒ `String`

#instance_type ⇒ `String`

#ipv_6_address_count ⇒ `Integer`

#ipv_6_addresses ⇒ `Array<Types::InstanceIpv6Address>`

#kernel_id ⇒ `String`

#key_name ⇒ `String`

#max_count ⇒ `Integer`

#min_count ⇒ `Integer`

#monitoring ⇒ `Types::RunInstancesMonitoringEnabled`

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

#placement ⇒ `Types::Placement`

#private_ip_address ⇒ `String`

#ramdisk_id ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#security_groups ⇒ `Array<String>`

#subnet_id ⇒ `String`

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

#user_data ⇒ `String`