/AWS1/CL_EC2=>RUNINSTANCES()

About RunInstances

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

• If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

• All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

• Not all instance types support IPv6 addresses. For more information, see Instance types.

• If you don't specify a security group ID, we use the default security group. For more information, see Security groups.

• If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.

For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.

Method Signature

IMPORTING

Required arguments:

IV_MAXCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

IV_MINCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

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

Optional arguments:

IT_BLOCKDEVICEMAPPINGS TYPE /AWS1/CL_EC2BLOCKDEVICEMAPPING=>TT_BLOCKDEVICEMAPREQUESTLIST TT_BLOCKDEVICEMAPREQUESTLIST

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.

IV_IMAGEID TYPE /AWS1/EC2IMAGEID /AWS1/EC2IMAGEID

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

IV_INSTANCETYPE TYPE /AWS1/EC2INSTANCETYPE /AWS1/EC2INSTANCETYPE

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

IV_IPV6ADDRESSCOUNT TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

IT_IPV6ADDRESSES TYPE /AWS1/CL_EC2INSTIPV6ADDRESS=>TT_INSTANCEIPV6ADDRESSLIST TT_INSTANCEIPV6ADDRESSLIST

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.

IV_KERNELID TYPE /AWS1/EC2KERNELID /AWS1/EC2KERNELID

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.

IV_KEYNAME TYPE /AWS1/EC2KEYPAIRNAME /AWS1/EC2KEYPAIRNAME

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.

IO_MONITORING TYPE REF TO /AWS1/CL_EC2RUNINSTSMONENABLED /AWS1/CL_EC2RUNINSTSMONENABLED

Specifies whether detailed monitoring is enabled for the instance.

IO_PLACEMENT TYPE REF TO /AWS1/CL_EC2PLACEMENT /AWS1/CL_EC2PLACEMENT

The placement for the instance.

IV_RAMDISKID TYPE /AWS1/EC2RAMDISKID /AWS1/EC2RAMDISKID

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.

IT_SECURITYGROUPIDS TYPE /AWS1/CL_EC2SECGRPIDSTRLIST_W=>TT_SECURITYGROUPIDSTRINGLIST TT_SECURITYGROUPIDSTRINGLIST

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.

IT_SECURITYGROUPS TYPE /AWS1/CL_EC2SECGROUPSTRLIST_W=>TT_SECURITYGROUPSTRINGLIST TT_SECURITYGROUPSTRINGLIST

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

IV_SUBNETID TYPE /AWS1/EC2SUBNETID /AWS1/EC2SUBNETID

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.

IV_USERDATA TYPE /AWS1/EC2RUNINSTANCESUSERDATA /AWS1/EC2RUNINSTANCESUSERDATA

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.

IV_ADDITIONALINFO TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Reserved.

IV_CLIENTTOKEN TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

IV_DISABLEAPITERMINATION TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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

IV_DRYRUN TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

IV_EBSOPTIMIZED TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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

IO_IAMINSTANCEPROFILE TYPE REF TO /AWS1/CL_EC2IAMINSTPROFILESPEC /AWS1/CL_EC2IAMINSTPROFILESPEC

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

IV_INSTINITIATEDSHUTDOWNBE00 TYPE /AWS1/EC2SHUTDOWNBEHAVIOR /AWS1/EC2SHUTDOWNBEHAVIOR

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

Default: stop

IT_NETWORKINTERFACES TYPE /AWS1/CL_EC2INSTNETWORKINTER03=>TT_INSTNETWORKINTERFACESPECLST TT_INSTNETWORKINTERFACESPECLST

The network interfaces to associate with the instance.

IV_PRIVATEIPADDRESS TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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.

IT_ELASTICGPUSPECIFICATION TYPE /AWS1/CL_EC2ELASTICGPUSPEC=>TT_ELASTICGPUSPECIFICATIONS TT_ELASTICGPUSPECIFICATIONS

An elastic GPU to associate with the instance.

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

IT_ELASTICINFERENCEACCELER00 TYPE /AWS1/CL_EC2ELASTICINFERENCE01=>TT_ELASTICINFERENCEACCELERAT01 TT_ELASTICINFERENCEACCELERAT01

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.

IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

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.

IO_LAUNCHTEMPLATE TYPE REF TO /AWS1/CL_EC2LAUNCHTEMPLATESPEC /AWS1/CL_EC2LAUNCHTEMPLATESPEC

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

IO_INSTANCEMARKETOPTIONS TYPE REF TO /AWS1/CL_EC2INSTMARKETOPTSREQ /AWS1/CL_EC2INSTMARKETOPTSREQ

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.

IO_CREDITSPECIFICATION TYPE REF TO /AWS1/CL_EC2CREDITSPECREQUEST /AWS1/CL_EC2CREDITSPECREQUEST

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.

IO_CPUOPTIONS TYPE REF TO /AWS1/CL_EC2CPUOPTIONSREQUEST /AWS1/CL_EC2CPUOPTIONSREQUEST

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

IO_CAPACITYRESERVATIONSPEC TYPE REF TO /AWS1/CL_EC2CAPACITYRSVPEC /AWS1/CL_EC2CAPACITYRSVPEC

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

IO_HIBERNATIONOPTIONS TYPE REF TO /AWS1/CL_EC2HIBERNATIONOPTSREQ /AWS1/CL_EC2HIBERNATIONOPTSREQ

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.

IT_LICENSESPECIFICATIONS TYPE /AWS1/CL_EC2LICENSECONFREQUEST=>TT_LICENSESPECLISTREQUEST TT_LICENSESPECLISTREQUEST

The license configurations.

IO_METADATAOPTIONS TYPE REF TO /AWS1/CL_EC2INSTMETOPTSREQUEST /AWS1/CL_EC2INSTMETOPTSREQUEST

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

IO_ENCLAVEOPTIONS TYPE REF TO /AWS1/CL_EC2ENCLOPTIONSREQUEST /AWS1/CL_EC2ENCLOPTIONSREQUEST

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.

IO_PRIVATEDNSNAMEOPTIONS TYPE REF TO /AWS1/CL_EC2PVTDNSNAMEOPTSREQ /AWS1/CL_EC2PVTDNSNAMEOPTSREQ

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.

IO_MAINTENANCEOPTIONS TYPE REF TO /AWS1/CL_EC2INSTMAINTENANCEO01 /AWS1/CL_EC2INSTMAINTENANCEO01

The maintenance and recovery options for the instance.

IV_DISABLEAPISTOP TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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

IV_ENABLEPRIMARYIPV6 TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_EC2RESERVATION /AWS1/CL_EC2RESERVATION