Launches the specified number of instances using an AMI for which you have permissions.
ec2_run_instances(BlockDeviceMappings, ImageId, InstanceType,
Ipv6AddressCount, Ipv6Addresses, KernelId, KeyName, MaxCount, MinCount,
Monitoring, Placement, RamdiskId, SecurityGroupIds, SecurityGroups,
SubnetId, UserData, AdditionalInfo, ClientToken, DisableApiTermination,
DryRun, EbsOptimized, IamInstanceProfile,
InstanceInitiatedShutdownBehavior, NetworkInterfaces, PrivateIpAddress,
ElasticGpuSpecification, ElasticInferenceAccelerators,
TagSpecifications, LaunchTemplate, InstanceMarketOptions,
CreditSpecification, CpuOptions, CapacityReservationSpecification,
HibernationOptions, LicenseSpecifications)One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
The ID of the AMI, which you can get by calling DescribeImages. An AMI 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 Elastic Compute Cloud User Guide.
Default: m1.small
[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.
You cannot specify this option and the network interfaces option in the same request.
[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.
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 Elastic Compute Cloud User Guide.
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.
[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.
The monitoring for the instance.
The placement for the instance.
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.
One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
You cannot specify this option and the network interfaces option in the same request.
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
You cannot specify this option and the network interfaces option in the same request.
Default: Amazon EC2 uses the default security group.
[EC2-VPC] The ID of the subnet to launch the instance into.
You cannot specify this option and the network interfaces option in the same request.
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 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.
Reserved.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. 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 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
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 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
One or more network interfaces.
You cannot specify this option and the network interfaces option in the same request.
[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.
You cannot specify this option and the network interfaces option in the same request.
An elastic GPU to associate with the instance.
An elastic inference accelerator.
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances 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 RunInstances, persistent Spot Instance requests are only supported
when InstanceInterruptionBehavior is set to either hibernate or
stop.
The credit option for CPU usage of the 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 Elastic Compute Cloud User Guide.
Default: standard (T2 instances) or unlimited (T3 instances)
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud 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. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
The license configurations.
svc$run_instances(
BlockDeviceMappings = list(
list(
DeviceName = "string",
VirtualName = "string",
Ebs = list(
DeleteOnTermination = TRUE|FALSE,
Iops = 123,
SnapshotId = "string",
VolumeSize = 123,
VolumeType = "standard"|"io1"|"gp2"|"sc1"|"st1",
Encrypted = TRUE|FALSE,
KmsKeyId = "string"
),
NoDevice = "string"
)
),
ImageId = "string",
InstanceType = "t1.micro"|"t2.nano"|"t2.micro"|"t2.small"|"t2.medium"|"t2.large"|"t2.xlarge"|"t2.2xlarge"|"t3.nano"|"t3.micro"|"t3.small"|"t3.medium"|"t3.large"|"t3.xlarge"|"t3.2xlarge"|"m1.small"|"m1.medium"|"m1.large"|"m1.xlarge"|"m3.medium"|"m3.large"|"m3.xlarge"|"m3.2xlarge"|"m4.large"|"m4.xlarge"|"m4.2xlarge"|"m4.4xlarge"|"m4.10xlarge"|"m4.16xlarge"|"m2.xlarge"|"m2.2xlarge"|"m2.4xlarge"|"cr1.8xlarge"|"r3.large"|"r3.xlarge"|"r3.2xlarge"|"r3.4xlarge"|"r3.8xlarge"|"r4.large"|"r4.xlarge"|"r4.2xlarge"|"r4.4xlarge"|"r4.8xlarge"|"r4.16xlarge"|"r5.large"|"r5.xlarge"|"r5.2xlarge"|"r5.4xlarge"|"r5.12xlarge"|"r5.24xlarge"|"r5.metal"|"r5a.large"|"r5a.xlarge"|"r5a.2xlarge"|"r5a.4xlarge"|"r5a.12xlarge"|"r5a.24xlarge"|"r5d.large"|"r5d.xlarge"|"r5d.2xlarge"|"r5d.4xlarge"|"r5d.12xlarge"|"r5d.24xlarge"|"r5d.metal"|"r5ad.large"|"r5ad.xlarge"|"r5ad.2xlarge"|"r5ad.4xlarge"|"r5ad.8xlarge"|"r5ad.12xlarge"|"r5ad.16xlarge"|"r5ad.24xlarge"|"x1.16xlarge"|"x1.32xlarge"|"x1e.xlarge"|"x1e.2xlarge"|"x1e.4xlarge"|"x1e.8xlarge"|"x1e.16xlarge"|"x1e.32xlarge"|"i2.xlarge"|"i2.2xlarge"|"i2.4xlarge"|"i2.8xlarge"|"i3.large"|"i3.xlarge"|"i3.2xlarge"|"i3.4xlarge"|"i3.8xlarge"|"i3.16xlarge"|"i3.metal"|"hi1.4xlarge"|"hs1.8xlarge"|"c1.medium"|"c1.xlarge"|"c3.large"|"c3.xlarge"|"c3.2xlarge"|"c3.4xlarge"|"c3.8xlarge"|"c4.large"|"c4.xlarge"|"c4.2xlarge"|"c4.4xlarge"|"c4.8xlarge"|"c5.large"|"c5.xlarge"|"c5.2xlarge"|"c5.4xlarge"|"c5.9xlarge"|"c5.18xlarge"|"c5d.large"|"c5d.xlarge"|"c5d.2xlarge"|"c5d.4xlarge"|"c5d.9xlarge"|"c5d.18xlarge"|"c5n.large"|"c5n.xlarge"|"c5n.2xlarge"|"c5n.4xlarge"|"c5n.9xlarge"|"c5n.18xlarge"|"cc1.4xlarge"|"cc2.8xlarge"|"g2.2xlarge"|"g2.8xlarge"|"g3.4xlarge"|"g3.8xlarge"|"g3.16xlarge"|"g3s.xlarge"|"cg1.4xlarge"|"p2.xlarge"|"p2.8xlarge"|"p2.16xlarge"|"p3.2xlarge"|"p3.8xlarge"|"p3.16xlarge"|"p3dn.24xlarge"|"d2.xlarge"|"d2.2xlarge"|"d2.4xlarge"|"d2.8xlarge"|"f1.2xlarge"|"f1.4xlarge"|"f1.16xlarge"|"m5.large"|"m5.xlarge"|"m5.2xlarge"|"m5.4xlarge"|"m5.12xlarge"|"m5.24xlarge"|"m5.metal"|"m5a.large"|"m5a.xlarge"|"m5a.2xlarge"|"m5a.4xlarge"|"m5a.12xlarge"|"m5a.24xlarge"|"m5d.large"|"m5d.xlarge"|"m5d.2xlarge"|"m5d.4xlarge"|"m5d.12xlarge"|"m5d.24xlarge"|"m5d.metal"|"m5ad.large"|"m5ad.xlarge"|"m5ad.2xlarge"|"m5ad.4xlarge"|"m5ad.8xlarge"|"m5ad.12xlarge"|"m5ad.16xlarge"|"m5ad.24xlarge"|"h1.2xlarge"|"h1.4xlarge"|"h1.8xlarge"|"h1.16xlarge"|"z1d.large"|"z1d.xlarge"|"z1d.2xlarge"|"z1d.3xlarge"|"z1d.6xlarge"|"z1d.12xlarge"|"z1d.metal"|"u-6tb1.metal"|"u-9tb1.metal"|"u-12tb1.metal"|"a1.medium"|"a1.large"|"a1.xlarge"|"a1.2xlarge"|"a1.4xlarge",
Ipv6AddressCount = 123,
Ipv6Addresses = list(
list(
Ipv6Address = "string"
)
),
KernelId = "string",
KeyName = "string",
MaxCount = 123,
MinCount = 123,
Monitoring = list(
Enabled = TRUE|FALSE
),
Placement = list(
AvailabilityZone = "string",
Affinity = "string",
GroupName = "string",
PartitionNumber = 123,
HostId = "string",
Tenancy = "default"|"dedicated"|"host",
SpreadDomain = "string"
),
RamdiskId = "string",
SecurityGroupIds = list(
"string"
),
SecurityGroups = list(
"string"
),
SubnetId = "string",
UserData = "string",
AdditionalInfo = "string",
ClientToken = "string",
DisableApiTermination = TRUE|FALSE,
DryRun = TRUE|FALSE,
EbsOptimized = TRUE|FALSE,
IamInstanceProfile = list(
Arn = "string",
Name = "string"
),
InstanceInitiatedShutdownBehavior = "stop"|"terminate",
NetworkInterfaces = list(
list(
AssociatePublicIpAddress = TRUE|FALSE,
DeleteOnTermination = TRUE|FALSE,
Description = "string",
DeviceIndex = 123,
Groups = list(
"string"
),
Ipv6AddressCount = 123,
Ipv6Addresses = list(
list(
Ipv6Address = "string"
)
),
NetworkInterfaceId = "string",
PrivateIpAddress = "string",
PrivateIpAddresses = list(
list(
Primary = TRUE|FALSE,
PrivateIpAddress = "string"
)
),
SecondaryPrivateIpAddressCount = 123,
SubnetId = "string"
)
),
PrivateIpAddress = "string",
ElasticGpuSpecification = list(
list(
Type = "string"
)
),
ElasticInferenceAccelerators = list(
list(
Type = "string"
)
),
TagSpecifications = list(
list(
ResourceType = "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"elastic-ip"|"fleet"|"fpga-image"|"host-reservation"|"image"|"instance"|"internet-gateway"|"launch-template"|"natgateway"|"network-acl"|"network-interface"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-instances-request"|"subnet"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
LaunchTemplate = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
InstanceMarketOptions = list(
MarketType = "spot",
SpotOptions = list(
MaxPrice = "string",
SpotInstanceType = "one-time"|"persistent",
BlockDurationMinutes = 123,
ValidUntil = as.POSIXct(
"2015-01-01"
),
InstanceInterruptionBehavior = "hibernate"|"stop"|"terminate"
)
),
CreditSpecification = list(
CpuCredits = "string"
),
CpuOptions = list(
CoreCount = 123,
ThreadsPerCore = 123
),
CapacityReservationSpecification = list(
CapacityReservationPreference = "open"|"none",
CapacityReservationTarget = list(
CapacityReservationId = "string"
)
),
HibernationOptions = list(
Configured = TRUE|FALSE
),
LicenseSpecifications = list(
list(
LicenseConfigurationArn = "string"
)
)
)
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] 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.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] 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 in the Amazon Elastic Compute Cloud User Guide.
For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
# NOT RUN {
# This example launches an instance using the specified AMI, instance
# type, security group, subnet, block device mapping, and tags.
# }
# NOT RUN {
svc$run_instances(
BlockDeviceMappings = list(
list(
DeviceName = "/dev/sdh",
Ebs = list(
VolumeSize = 100L
)
)
),
ImageId = "ami-abc12345",
InstanceType = "t2.micro",
KeyName = "my-key-pair",
MaxCount = 1L,
MinCount = 1L,
SecurityGroupIds = list(
"sg-1a2b3c4d"
),
SubnetId = "subnet-6e7f829e",
TagSpecifications = list(
list(
ResourceType = "instance",
Tags = list(
list(
Key = "Purpose",
Value = "test"
)
)
)
)
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab