ec2/aws.sdk.kotlin.services.ec2.model/RunInstancesRequest/Builder

Builder

Properties

Reserved.

var blockDeviceMappings: List<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.

capacityReservationSpecification

var capacityReservationSpecification: 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).

clientToken

var clientToken: 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.

cpuOptions

var cpuOptions: CpuOptionsRequest?

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

creditSpecification

var creditSpecification: 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.

disableApiStop

var disableApiStop: Boolean?

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

disableApiTermination

var disableApiTermination: 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.

dryRun

var dryRun: 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.

ebsOptimized

var ebsOptimized: 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.

elasticGpuSpecification

var elasticGpuSpecification: List<ElasticGpuSpecification>?

Deprecated.

elasticInferenceAccelerators

var elasticInferenceAccelerators: List<ElasticInferenceAccelerator>?

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.

enablePrimaryIpv6

var enablePrimaryIpv6: 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.

enclaveOptions

var enclaveOptions: 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.

hibernationOptions

var hibernationOptions: 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.

iamInstanceProfile

var iamInstanceProfile: IamInstanceProfileSpecification?

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

imageId

var imageId: 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.

instanceInitiatedShutdownBehavior

var instanceInitiatedShutdownBehavior: ShutdownBehavior?

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

instanceMarketOptions

var instanceMarketOptions: InstanceMarketOptionsRequest?

The market (purchasing) option for the instances.

instanceType

var instanceType: InstanceType?

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

ipv6AddressCount

var ipv6AddressCount: Int?

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.

ipv6Addresses

var ipv6Addresses: List<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.

kernelId

var kernelId: String?

The ID of the kernel.

keyName

var keyName: String?

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

launchTemplate

var launchTemplate: LaunchTemplateSpecification?

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.

licenseSpecifications

var licenseSpecifications: List<LicenseConfigurationRequest>?

The license configurations.

maintenanceOptions

var maintenanceOptions: InstanceMaintenanceOptionsRequest?

The maintenance and recovery options for the instance.

maxCount

var maxCount: Int?

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.

metadataOptions

var metadataOptions: InstanceMetadataOptionsRequest?

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

minCount

var minCount: Int?

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.

monitoring

var monitoring: RunInstancesMonitoringEnabled?

Specifies whether detailed monitoring is enabled for the instance.

networkInterfaces

var networkInterfaces: List<InstanceNetworkInterfaceSpecification>?

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.

placement

var placement: Placement?

The placement for the instance.

privateDnsNameOptions

var privateDnsNameOptions: 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.

privateIpAddress

var privateIpAddress: String?

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

ramdiskId

var ramdiskId: 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.

securityGroupIds

var securityGroupIds: List<String>?

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

securityGroups

var securityGroups: List<String>?

[Default VPC] The names of the security groups.

subnetId

var subnetId: String?

The ID of the subnet to launch the instance into.

tagSpecifications

var tagSpecifications: List<TagSpecification>?

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

userData

var userData: 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.