Package software.amazon.awssdk.services.ec2.model

Interface RunInstancesRequest.Builder

All Superinterfaces:

CopyableBuilder<RunInstancesRequest.Builder,RunInstancesRequest>, SdkBuilder<RunInstancesRequest.Builder,RunInstancesRequest>

Enclosing class:

RunInstancesRequest

public static interface RunInstancesRequest.Builder
extends CopyableBuilder<RunInstancesRequest.Builder,RunInstancesRequest>

Method Summary

Modifier and Type	Method	Description
RunInstancesRequest.Builder	additionalInfo(String additionalInfo)	Reserved.
RunInstancesRequest.Builder	blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)	The block device mapping.
RunInstancesRequest.Builder	blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)	The block device mapping.
RunInstancesRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
RunInstancesRequest.Builder	disableApiTermination(Boolean 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.
RunInstancesRequest.Builder	ebsOptimized(Boolean ebsOptimized)	Indicates whether the instance is optimized for EBS I/O.
RunInstancesRequest.Builder	iamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)	The IAM instance profile.
RunInstancesRequest.Builder	imageId(String imageId)	The ID of the AMI, which you can get by calling DescribeImages.
RunInstancesRequest.Builder	instanceInitiatedShutdownBehavior(String instanceInitiatedShutdownBehavior)	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
RunInstancesRequest.Builder	instanceInitiatedShutdownBehavior(ShutdownBehavior instanceInitiatedShutdownBehavior)	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
RunInstancesRequest.Builder	instanceType(String instanceType)	The instance type.
RunInstancesRequest.Builder	instanceType(InstanceType instanceType)	The instance type.
RunInstancesRequest.Builder	ipv6AddressCount(Integer ipv6AddressCount)	[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface.
RunInstancesRequest.Builder	ipv6Addresses(Collection<InstanceIpv6Address> ipv6Addresses)	[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface.
RunInstancesRequest.Builder	ipv6Addresses(InstanceIpv6Address... ipv6Addresses)	[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface.
RunInstancesRequest.Builder	kernelId(String kernelId)	The ID of the kernel.
RunInstancesRequest.Builder	keyName(String keyName)	The name of the key pair.
RunInstancesRequest.Builder	maxCount(Integer maxCount)	The maximum number of instances to launch.
RunInstancesRequest.Builder	minCount(Integer minCount)	The minimum number of instances to launch.
RunInstancesRequest.Builder	monitoring(Boolean monitoring)	The monitoring for the instance.
RunInstancesRequest.Builder	networkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)	One or more network interfaces.
RunInstancesRequest.Builder	networkInterfaces(InstanceNetworkInterfaceSpecification... networkInterfaces)	One or more network interfaces.
RunInstancesRequest.Builder	placement(Placement placement)	The placement for the instance.
RunInstancesRequest.Builder	privateIpAddress(String privateIpAddress)	[EC2-VPC] The primary IPv4 address.
RunInstancesRequest.Builder	ramdiskId(String ramdiskId)	The ID of the RAM disk.
RunInstancesRequest.Builder	securityGroupIds(String... securityGroupIds)	One or more security group IDs.
RunInstancesRequest.Builder	securityGroupIds(Collection<String> securityGroupIds)	One or more security group IDs.
RunInstancesRequest.Builder	securityGroups(String... securityGroups)	[EC2-Classic, default VPC] One or more security group names.
RunInstancesRequest.Builder	securityGroups(Collection<String> securityGroups)	[EC2-Classic, default VPC] One or more security group names.
RunInstancesRequest.Builder	subnetId(String subnetId)	[EC2-VPC] The ID of the subnet to launch the instance into.
RunInstancesRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications)	The tags to apply to the resources during launch.
RunInstancesRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications)	The tags to apply to the resources during launch.
RunInstancesRequest.Builder	userData(String userData)	The user data to make available to the instance.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

blockDeviceMappings

RunInstancesRequest.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

Parameters:

blockDeviceMappings - The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockDeviceMappings

RunInstancesRequest.Builder blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

NOTE: This method appends the values to the existing list (if any). Use #setBlockDeviceMappings(java.util.Collection) or #withBlockDeviceMappings(java.util.Collection) if you want to override the existing values.

Parameters:

blockDeviceMappings - The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageId

RunInstancesRequest.Builder imageId(String imageId)

The ID of the AMI, which you can get by calling DescribeImages.

Parameters:

imageId - The ID of the AMI, which you can get by calling DescribeImages.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

RunInstancesRequest.Builder instanceType(String instanceType)

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

Parameters:

instanceType - The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceType

instanceType

RunInstancesRequest.Builder instanceType(InstanceType instanceType)

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

Parameters:

instanceType - The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceType

ipv6AddressCount

RunInstancesRequest.Builder ipv6AddressCount(Integer ipv6AddressCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ipv6Addresses

RunInstancesRequest.Builder ipv6Addresses(Collection<InstanceIpv6Address> ipv6Addresses)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ipv6Addresses

RunInstancesRequest.Builder ipv6Addresses(InstanceIpv6Address... ipv6Addresses)

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

NOTE: This method appends the values to the existing list (if any). Use #setIpv6Addresses(java.util.Collection) or #withIpv6Addresses(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

kernelId

RunInstancesRequest.Builder kernelId(String 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 Elastic Compute Cloud User Guide.

Parameters:

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 Elastic Compute Cloud User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyName

RunInstancesRequest.Builder keyName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxCount

RunInstancesRequest.Builder maxCount(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

minCount

RunInstancesRequest.Builder minCount(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

monitoring

RunInstancesRequest.Builder monitoring(Boolean monitoring)

The monitoring for the instance.

Parameters:

monitoring - The monitoring for the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

placement

RunInstancesRequest.Builder placement(Placement placement)

The placement for the instance.

Parameters:

placement - The placement for the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

ramdiskId

RunInstancesRequest.Builder ramdiskId(String ramdiskId)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

RunInstancesRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

Parameters:

securityGroupIds - One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

RunInstancesRequest.Builder securityGroupIds(String... securityGroupIds)

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroupIds(java.util.Collection) or #withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroupIds - One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroups

RunInstancesRequest.Builder securityGroups(Collection<String> securityGroups)

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

Parameters:

securityGroups - [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroups

RunInstancesRequest.Builder securityGroups(String... securityGroups)

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroups(java.util.Collection) or #withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroups - [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetId

RunInstancesRequest.Builder subnetId(String subnetId)

[EC2-VPC] The ID of the subnet to launch the instance into.

Parameters:

subnetId - [EC2-VPC] The ID of the subnet to launch the instance into.

Returns:

Returns a reference to this object so that method calls can be chained together.

userData

RunInstancesRequest.Builder userData(String 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 an AWS SDK or 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.

Parameters:

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 an AWS SDK or 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalInfo

RunInstancesRequest.Builder additionalInfo(String additionalInfo)

Reserved.

Parameters:

additionalInfo - Reserved.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

RunInstancesRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

Returns:

Returns a reference to this object so that method calls can be chained together.

disableApiTermination

RunInstancesRequest.Builder disableApiTermination(Boolean 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 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ebsOptimized

RunInstancesRequest.Builder ebsOptimized(Boolean ebsOptimized)

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal 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

Parameters:

ebsOptimized - Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal 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

Returns:

Returns a reference to this object so that method calls can be chained together.

iamInstanceProfile

RunInstancesRequest.Builder iamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)

The IAM instance profile.

Parameters:

iamInstanceProfile - The IAM instance profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceInitiatedShutdownBehavior

RunInstancesRequest.Builder instanceInitiatedShutdownBehavior(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ShutdownBehavior

instanceInitiatedShutdownBehavior

RunInstancesRequest.Builder instanceInitiatedShutdownBehavior(ShutdownBehavior 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ShutdownBehavior

networkInterfaces

RunInstancesRequest.Builder networkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)

One or more network interfaces.

Parameters:

networkInterfaces - One or more network interfaces.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkInterfaces

RunInstancesRequest.Builder networkInterfaces(InstanceNetworkInterfaceSpecification... networkInterfaces)

One or more network interfaces.

NOTE: This method appends the values to the existing list (if any). Use #setNetworkInterfaces(java.util.Collection) or #withNetworkInterfaces(java.util.Collection) if you want to override the existing values.

Parameters:

networkInterfaces - One or more network interfaces.

Returns:

Returns a reference to this object so that method calls can be chained together.

privateIpAddress

RunInstancesRequest.Builder privateIpAddress(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

RunInstancesRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.

Parameters:

tagSpecifications - The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

RunInstancesRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.

NOTE: This method appends the values to the existing list (if any). Use #setTagSpecifications(java.util.Collection) or #withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.

Returns:

Returns a reference to this object so that method calls can be chained together.