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

Inherits:

Struct

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

show all

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

Overview

Constant Summary collapse

SENSITIVE =

[:user_data]

Instance Attribute Summary collapse

#additional_info ⇒ String
Reserved.
#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>
The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch.
#capacity_reservation_specification ⇒ Types::CapacityReservationSpecification
Information about the Capacity Reservation targeting option.
#client_token ⇒ String
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
#cpu_options ⇒ Types::CpuOptionsRequest
The CPU options for the instance.
#credit_specification ⇒ Types::CreditSpecificationRequest
The credit option for CPU usage of the burstable performance instance.
#disable_api_stop ⇒ Boolean
Indicates whether an instance is enabled 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.
#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 Amazon EBS I/O.
#elastic_gpu_specification ⇒ Array<Types::ElasticGpuSpecification>
An elastic GPU to associate with the instance.
#elastic_inference_accelerators ⇒ Array<Types::ElasticInferenceAccelerator>
An elastic inference accelerator to associate with the instance.
#enable_primary_ipv_6 ⇒ Boolean
If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address.
#enclave_options ⇒ Types::EnclaveOptionsRequest
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
#hibernation_options ⇒ Types::HibernationOptionsRequest
Indicates whether an instance is enabled for hibernation.
#iam_instance_profile ⇒ Types::IamInstanceProfileSpecification
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::InstanceMarketOptionsRequest
The market (purchasing) option for the instances.
#instance_type ⇒ String
The instance type.
#ipv_6_address_count ⇒ Integer
The number of IPv6 addresses to associate with the primary network interface.
#ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>
The 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.
#launch_template ⇒ Types::LaunchTemplateSpecification
The launch template.
#license_specifications ⇒ Array<Types::LicenseConfigurationRequest>
The license configurations.
#maintenance_options ⇒ Types::InstanceMaintenanceOptionsRequest
The maintenance and recovery options for the instance.
#max_count ⇒ Integer
The maximum number of instances to launch.
#metadata_options ⇒ Types::InstanceMetadataOptionsRequest
The metadata options for the instance.
#min_count ⇒ Integer
The minimum number of instances to launch.
#monitoring ⇒ Types::RunInstancesMonitoringEnabled
Specifies whether detailed monitoring is enabled for the instance.
#network_interfaces ⇒ Array<Types::InstanceNetworkInterfaceSpecification>
The network interfaces to associate with the instance.
#placement ⇒ Types::Placement
The placement for the instance.
#private_dns_name_options ⇒ Types::PrivateDnsNameOptionsRequest
The options for the instance hostname.
#private_ip_address ⇒ String
The primary IPv4 address.
#ramdisk_id ⇒ String
The ID of the RAM disk to select.
#security_group_ids ⇒ Array<String>
The IDs of the security groups.
#security_groups ⇒ Array<String>
[Default VPC] The names of the security groups.
#subnet_id ⇒ String
The ID of the subnet to launch the instance into.
#tag_specifications ⇒ Array<Types::TagSpecification>
The tags to apply to the resources that are created during instance launch.
#user_data ⇒ String
The user data script to make available to the instance.

Instance Attribute Details

#additional_info ⇒ `String`

Reserved.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.

Returns:

(Array<Types::BlockDeviceMapping>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#capacity_reservation_specification ⇒ `Types::CapacityReservationSpecification`

Information about 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::CapacityReservationSpecification)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#client_token ⇒ `String`

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#cpu_options ⇒ `Types::CpuOptionsRequest`

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

Returns:

(Types::CpuOptionsRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#credit_specification ⇒ `Types::CreditSpecificationRequest`

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

Returns:

(Types::CreditSpecificationRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#disable_api_stop ⇒ `Boolean`

Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.

Returns:

(Boolean)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  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.

Default: false

Returns:

(Boolean)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59258

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  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.

Default: false

Returns:

(Boolean)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

An elastic GPU to associate with the instance.

Amazon Elastic Graphics reached end of life on January 8, 2024.

Returns:

(Array<Types::ElasticGpuSpecification>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

An elastic inference accelerator to associate with the instance.

Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.

Returns:

(Array<Types::ElasticInferenceAccelerator>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#enable_primary_ipv_6 ⇒ `Boolean`

If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

Returns:

(Boolean)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#enclave_options ⇒ `Types::EnclaveOptionsRequest`

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

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#hibernation_options ⇒ `Types::HibernationOptionsRequest`

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 EC2 User Guide.

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

Returns:

(Types::HibernationOptionsRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#iam_instance_profile ⇒ `Types::IamInstanceProfileSpecification`

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

Returns:

(Types::IamInstanceProfileSpecification)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#image_id ⇒ `String`

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  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 59258

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#instance_market_options ⇒ `Types::InstanceMarketOptionsRequest`

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

Returns:

(Types::InstanceMarketOptionsRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#instance_type ⇒ `String`

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

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#ipv_6_address_count ⇒ `Integer`

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

You cannot specify this option and the network interfaces option in the same request.

Returns:

(Integer)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

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

You cannot specify this option and the network interfaces option in the same request.

Returns:

(Array<Types::InstanceIpv6Address>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  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 PV-GRUB in the Amazon EC2 User Guide.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  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 59258

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#launch_template ⇒ `Types::LaunchTemplateSpecification`

The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

Returns:

(Types::LaunchTemplateSpecification)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

The license configurations.

Returns:

(Array<Types::LicenseConfigurationRequest>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#maintenance_options ⇒ `Types::InstanceMaintenanceOptionsRequest`

The maintenance and recovery options for the instance.

Returns:

(Types::InstanceMaintenanceOptionsRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  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.

Returns:

(Integer)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#metadata_options ⇒ `Types::InstanceMetadataOptionsRequest`

The metadata options for the instance. For more information, see Instance metadata and user data.

Returns:

(Types::InstanceMetadataOptionsRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  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.

Returns:

(Integer)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#monitoring ⇒ `Types::RunInstancesMonitoringEnabled`

Specifies whether detailed monitoring is enabled for the instance.

Returns:

(Types::RunInstancesMonitoringEnabled)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

The network interfaces to associate with the instance.

Returns:

(Array<Types::InstanceNetworkInterfaceSpecification>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#placement ⇒ `Types::Placement`

The placement for the instance.

Returns:

(Types::Placement)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#private_dns_name_options ⇒ `Types::PrivateDnsNameOptionsRequest`

The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.

Returns:

(Types::PrivateDnsNameOptionsRequest)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#private_ip_address ⇒ `String`

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.

You cannot specify this option and the network interfaces option in the same request.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#ramdisk_id ⇒ `String`

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

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 59258

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#security_groups ⇒ `Array<String>`

[Default VPC] The names 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.

Default: Amazon EC2 uses the default security group.

Returns:

(Array<String>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#subnet_id ⇒ `String`

The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

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

You can specify tags for the following resources only:

Instances
Volumes
Spot Instance requests
Network interfaces

To tag a resource after it has been created, see CreateTags.

Returns:

(Array<Types::TagSpecification>)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

#user_data ⇒ `String`

The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a 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. User data is limited to 16 KB.

Returns:

(String)

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

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,
  :elastic_inference_accelerators,
  :tag_specifications,
  :launch_template,
  :instance_market_options,
  :credit_specification,
  :cpu_options,
  :capacity_reservation_specification,
  :hibernation_options,
  :license_specifications,
  :metadata_options,
  :enclave_options,
  :private_dns_name_options,
  :maintenance_options,
  :disable_api_stop,
  :enable_primary_ipv_6)
  SENSITIVE = [:user_data]
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_info ⇒ String

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

#capacity_reservation_specification ⇒ Types::CapacityReservationSpecification

#client_token ⇒ String

#cpu_options ⇒ Types::CpuOptionsRequest

#credit_specification ⇒ Types::CreditSpecificationRequest

#disable_api_stop ⇒ Boolean

#disable_api_termination ⇒ Boolean

#dry_run ⇒ Boolean

#ebs_optimized ⇒ Boolean

#elastic_gpu_specification ⇒ Array<Types::ElasticGpuSpecification>

#elastic_inference_accelerators ⇒ Array<Types::ElasticInferenceAccelerator>

#enable_primary_ipv_6 ⇒ Boolean

#enclave_options ⇒ Types::EnclaveOptionsRequest

#hibernation_options ⇒ Types::HibernationOptionsRequest

#iam_instance_profile ⇒ Types::IamInstanceProfileSpecification

#image_id ⇒ String

#instance_initiated_shutdown_behavior ⇒ String

#instance_market_options ⇒ Types::InstanceMarketOptionsRequest

#instance_type ⇒ String

#ipv_6_address_count ⇒ Integer

#ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>

#kernel_id ⇒ String

#key_name ⇒ String

#launch_template ⇒ Types::LaunchTemplateSpecification

#license_specifications ⇒ Array<Types::LicenseConfigurationRequest>

#maintenance_options ⇒ Types::InstanceMaintenanceOptionsRequest

#max_count ⇒ Integer

#metadata_options ⇒ Types::InstanceMetadataOptionsRequest

#min_count ⇒ Integer

#monitoring ⇒ Types::RunInstancesMonitoringEnabled

#network_interfaces ⇒ Array<Types::InstanceNetworkInterfaceSpecification>

#placement ⇒ Types::Placement

#private_dns_name_options ⇒ Types::PrivateDnsNameOptionsRequest

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

#capacity_reservation_specification ⇒ `Types::CapacityReservationSpecification`

#client_token ⇒ `String`

#cpu_options ⇒ `Types::CpuOptionsRequest`

#credit_specification ⇒ `Types::CreditSpecificationRequest`

#disable_api_stop ⇒ `Boolean`

#disable_api_termination ⇒ `Boolean`

#dry_run ⇒ `Boolean`

#ebs_optimized ⇒ `Boolean`

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

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

#enable_primary_ipv_6 ⇒ `Boolean`

#enclave_options ⇒ `Types::EnclaveOptionsRequest`

#hibernation_options ⇒ `Types::HibernationOptionsRequest`

#iam_instance_profile ⇒ `Types::IamInstanceProfileSpecification`

#image_id ⇒ `String`

#instance_initiated_shutdown_behavior ⇒ `String`

#instance_market_options ⇒ `Types::InstanceMarketOptionsRequest`

#instance_type ⇒ `String`

#ipv_6_address_count ⇒ `Integer`

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

#kernel_id ⇒ `String`

#key_name ⇒ `String`

#launch_template ⇒ `Types::LaunchTemplateSpecification`

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

#maintenance_options ⇒ `Types::InstanceMaintenanceOptionsRequest`

#max_count ⇒ `Integer`

#metadata_options ⇒ `Types::InstanceMetadataOptionsRequest`

#min_count ⇒ `Integer`

#monitoring ⇒ `Types::RunInstancesMonitoringEnabled`

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

#placement ⇒ `Types::Placement`

#private_dns_name_options ⇒ `Types::PrivateDnsNameOptionsRequest`

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