AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the RunInstances operation. 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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.RunInstancesRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class RunInstancesRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The RunInstancesRequest type exposes the following members

Constructors

NameDescription
Public Method RunInstancesRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method RunInstancesRequest(string, int, int)

Instantiates RunInstancesRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AdditionalInfo System.String

Gets and sets the property AdditionalInfo.

Reserved.

Public Property BlockDeviceMappings System.Collections.Generic.List<Amazon.EC2.Model.BlockDeviceMapping>

Gets and sets the property BlockDeviceMappings.

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.

Public Property CapacityReservationSpecification Amazon.EC2.Model.CapacityReservationSpecification

Gets and sets the property 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).

Public Property ClientToken System.String

Gets and sets the property ClientToken.

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

Public Property CpuOptions Amazon.EC2.Model.CpuOptionsRequest

Gets and sets the property CpuOptions.

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

Public Property CreditSpecification Amazon.EC2.Model.CreditSpecificationRequest

Gets and sets the property CreditSpecification.

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

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

Public Property DisableApiTermination System.Boolean

Gets and sets the property DisableApiTermination.

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

Public Property EbsOptimized System.Boolean

Gets and sets the property EbsOptimized.

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

Public Property ElasticGpuSpecification System.Collections.Generic.List<Amazon.EC2.Model.ElasticGpuSpecification>

Gets and sets the property ElasticGpuSpecification.

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.

Public Property ElasticInferenceAccelerators System.Collections.Generic.List<Amazon.EC2.Model.ElasticInferenceAccelerator>

Gets and sets the property ElasticInferenceAccelerators.

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.

Public Property EnclaveOptions Amazon.EC2.Model.EnclaveOptionsRequest

Gets and sets the property EnclaveOptions.

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.

Public Property HibernationOptions Amazon.EC2.Model.HibernationOptionsRequest

Gets and sets the property HibernationOptions.

Indicates whether an instance is enabled for hibernation. 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.

Public Property IamInstanceProfile Amazon.EC2.Model.IamInstanceProfileSpecification

Gets and sets the property IamInstanceProfile.

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

Public Property ImageId System.String

Gets and sets the property ImageId.

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

Public Property InstanceInitiatedShutdownBehavior Amazon.EC2.ShutdownBehavior

Gets and sets the property InstanceInitiatedShutdownBehavior.

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

Default: stop

Public Property InstanceMarketOptions Amazon.EC2.Model.InstanceMarketOptionsRequest

Gets and sets the property InstanceMarketOptions.

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.

Public Property InstanceType Amazon.EC2.InstanceType

Gets and sets the property InstanceType.

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

Default: m1.small

Public Property Ipv6AddressCount System.Int32

Gets and sets the property Ipv6AddressCount.

[EC2-VPC] 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.

Public Property Ipv6Addresses System.Collections.Generic.List<Amazon.EC2.Model.InstanceIpv6Address>

Gets and sets the property Ipv6Addresses.

[EC2-VPC] 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.

Public Property KernelId System.String

Gets and sets the property KernelId.

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.

Public Property KeyName System.String

Gets and sets the property KeyName.

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.

Public Property LaunchTemplate Amazon.EC2.Model.LaunchTemplateSpecification

Gets and sets the property LaunchTemplate.

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.

Public Property LicenseSpecifications System.Collections.Generic.List<Amazon.EC2.Model.LicenseConfigurationRequest>

Gets and sets the property LicenseSpecifications.

The license configurations.

Public Property MaxCount System.Int32

Gets and sets the property MaxCount.

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.

Public Property MetadataOptions Amazon.EC2.Model.InstanceMetadataOptionsRequest

Gets and sets the property MetadataOptions.

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

Public Property MinCount System.Int32

Gets and sets the property MinCount.

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.

Public Property Monitoring System.Boolean

Gets and sets the property Monitoring.

Specifies whether detailed monitoring is enabled for the instance.

Public Property NetworkInterfaces System.Collections.Generic.List<Amazon.EC2.Model.InstanceNetworkInterfaceSpecification>

Gets and sets the property NetworkInterfaces.

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.

Public Property Placement Amazon.EC2.Model.Placement

Gets and sets the property Placement.

The placement for the instance.

Public Property PrivateIpAddress System.String

Gets and sets the property PrivateIpAddress.

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

Public Property RamdiskId System.String

Gets and sets the property RamdiskId.

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.

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

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.

Public Property SecurityGroups System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroups.

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

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.

Public Property SubnetId System.String

Gets and sets the property SubnetId.

[EC2-VPC] 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.

Public Property TagSpecifications System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>

Gets and sets the property TagSpecifications.

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.

Public Property UserData System.String

Gets and sets the property UserData.

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. User data is limited to 16 KB.

Examples

This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.

To launch an instance


var client = new AmazonEC2Client();
var response = client.RunInstances(new RunInstancesRequest 
{
    BlockDeviceMappings = new List<BlockDeviceMapping> {
        new BlockDeviceMapping {
            DeviceName = "/dev/sdh",
            Ebs = new EbsBlockDevice { VolumeSize = 100 }
        }
    },
    ImageId = "ami-abc12345",
    InstanceType = "t2.micro",
    KeyName = "my-key-pair",
    MaxCount = 1,
    MinCount = 1,
    SecurityGroupIds = new List<string> {
        "sg-1a2b3c4d"
    },
    SubnetId = "subnet-6e7f829e",
    TagSpecifications = new List<TagSpecification> {
        new TagSpecification {
            ResourceType = "instance",
            Tags = new List<Tag> {
                new Tag {
                    Key = "Purpose",
                    Value = "test"
                }
            }
        }
    }
});


            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5