Launches the specified number of instances using an AMI for which you have permissions.
See https://www.paws-r-sdk.com/docs/ec2_run_instances/ for full documentation.
ec2_run_instances(
BlockDeviceMappings = NULL,
ImageId = NULL,
InstanceType = NULL,
Ipv6AddressCount = NULL,
Ipv6Addresses = NULL,
KernelId = NULL,
KeyName = NULL,
MaxCount,
MinCount,
Monitoring = NULL,
Placement = NULL,
RamdiskId = NULL,
SecurityGroupIds = NULL,
SecurityGroups = NULL,
SubnetId = NULL,
UserData = NULL,
AdditionalInfo = NULL,
ClientToken = NULL,
DisableApiTermination = NULL,
DryRun = NULL,
EbsOptimized = NULL,
IamInstanceProfile = NULL,
InstanceInitiatedShutdownBehavior = NULL,
NetworkInterfaces = NULL,
PrivateIpAddress = NULL,
ElasticGpuSpecification = NULL,
ElasticInferenceAccelerators = NULL,
TagSpecifications = NULL,
LaunchTemplate = NULL,
InstanceMarketOptions = NULL,
CreditSpecification = NULL,
CpuOptions = NULL,
CapacityReservationSpecification = NULL,
HibernationOptions = NULL,
LicenseSpecifications = NULL,
MetadataOptions = NULL,
EnclaveOptions = NULL,
PrivateDnsNameOptions = NULL,
MaintenanceOptions = NULL,
DisableApiStop = NULL,
EnablePrimaryIpv6 = NULL
)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.
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
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.
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.
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.
The name of the key pair. You can create a key pair using
create_key_pair or
import_key_pair.
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.
[required] 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.
[required] 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.
Specifies whether detailed monitoring is enabled for the instance.
The placement for the instance.
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.
The IDs of the security groups. You can create a security group using
create_security_group.
If you specify a network interface, you must specify any security groups as part of the network interface.
[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.
Default: Amazon EC2 uses the default security group.
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.
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.
Reserved.
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
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
modify_instance_attribute.
Alternatively, if you set InstanceInitiatedShutdownBehavior to
terminate, you can terminate the instance by running the shutdown
command from the instance.
Default: false
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.
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
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
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.
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see
create_tags.
The launch template to use to launch the instances. Any parameters that
you specify in run_instances override the same
parameters in the launch template. You can specify either the name or ID
of a launch template, but not both.
The market (purchasing) option for the instances.
For run_instances, persistent Spot Instance
requests are only supported when InstanceInterruptionBehavior is set
to either hibernate or stop.
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.
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
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).
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.
The license configurations.
The metadata options for the instance. For more information, see Instance metadata and user data.
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.
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.
The maintenance and recovery options for the instance.
Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
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.