@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RunInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<RunInstancesRequest>
Contains the parameters for RunInstances.
NOOP
Constructor and Description |
---|
RunInstancesRequest()
Default constructor for RunInstancesRequest object.
|
RunInstancesRequest(String imageId,
Integer minCount,
Integer maxCount)
Constructs a new RunInstancesRequest object.
|
Modifier and Type | Method and Description |
---|---|
RunInstancesRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAdditionalInfo()
Reserved.
|
List<BlockDeviceMapping> |
getBlockDeviceMappings()
One or more block device mapping entries.
|
String |
getClientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
|
Boolean |
getDisableApiTermination()
If you set this parameter to
true , you can't terminate the instance using the Amazon EC2 console,
CLI, or API; otherwise, you can. |
Request<RunInstancesRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
Boolean |
getEbsOptimized()
Indicates whether the instance is optimized for Amazon EBS I/O.
|
List<ElasticGpuSpecification> |
getElasticGpuSpecification()
An Elastic GPU to associate with the instance.
|
IamInstanceProfileSpecification |
getIamInstanceProfile()
The IAM instance profile.
|
String |
getImageId()
The ID of the AMI, which you can get by calling DescribeImages.
|
String |
getInstanceInitiatedShutdownBehavior()
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the
operating system command for system shutdown).
|
String |
getInstanceType()
The instance type.
|
Integer |
getIpv6AddressCount()
[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface.
|
List<InstanceIpv6Address> |
getIpv6Addresses()
[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network
interface.
|
String |
getKernelId()
The ID of the kernel.
|
String |
getKeyName()
The name of the key pair.
|
Integer |
getMaxCount()
The maximum number of instances to launch.
|
Integer |
getMinCount()
The minimum number of instances to launch.
|
Boolean |
getMonitoring()
The monitoring for the instance.
|
List<InstanceNetworkInterfaceSpecification> |
getNetworkInterfaces()
One or more network interfaces.
|
Placement |
getPlacement()
The placement for the instance.
|
String |
getPrivateIpAddress()
[EC2-VPC] The primary IPv4 address.
|
String |
getRamdiskId()
The ID of the RAM disk.
|
List<String> |
getSecurityGroupIds()
One or more security group IDs.
|
List<String> |
getSecurityGroups()
[EC2-Classic, default VPC] One or more security group names.
|
String |
getSubnetId()
[EC2-VPC] The ID of the subnet to launch the instance into.
|
List<TagSpecification> |
getTagSpecifications()
The tags to apply to the resources during launch.
|
String |
getUserData()
The user data to make available to the instance.
|
int |
hashCode() |
Boolean |
isDisableApiTermination()
If you set this parameter to
true , you can't terminate the instance using the Amazon EC2 console,
CLI, or API; otherwise, you can. |
Boolean |
isEbsOptimized()
Indicates whether the instance is optimized for Amazon EBS I/O.
|
Boolean |
isMonitoring()
The monitoring for the instance.
|
void |
setAdditionalInfo(String additionalInfo)
Reserved.
|
void |
setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
One or more block device mapping entries.
|
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
|
void |
setDisableApiTermination(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. |
void |
setEbsOptimized(Boolean ebsOptimized)
Indicates whether the instance is optimized for Amazon EBS I/O.
|
void |
setElasticGpuSpecification(Collection<ElasticGpuSpecification> elasticGpuSpecification)
An Elastic GPU to associate with the instance.
|
void |
setIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
|
void |
setImageId(String imageId)
The ID of the AMI, which you can get by calling DescribeImages.
|
void |
setInstanceInitiatedShutdownBehavior(ShutdownBehavior instanceInitiatedShutdownBehavior)
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the
operating system command for system shutdown).
|
void |
setInstanceInitiatedShutdownBehavior(String instanceInitiatedShutdownBehavior)
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the
operating system command for system shutdown).
|
void |
setInstanceType(InstanceType instanceType)
The instance type.
|
void |
setInstanceType(String instanceType)
The instance type.
|
void |
setIpv6AddressCount(Integer ipv6AddressCount)
[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface.
|
void |
setIpv6Addresses(Collection<InstanceIpv6Address> ipv6Addresses)
[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network
interface.
|
void |
setKernelId(String kernelId)
The ID of the kernel.
|
void |
setKeyName(String keyName)
The name of the key pair.
|
void |
setMaxCount(Integer maxCount)
The maximum number of instances to launch.
|
void |
setMinCount(Integer minCount)
The minimum number of instances to launch.
|
void |
setMonitoring(Boolean monitoring)
The monitoring for the instance.
|
void |
setNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
|
void |
setPlacement(Placement placement)
The placement for the instance.
|
void |
setPrivateIpAddress(String privateIpAddress)
[EC2-VPC] The primary IPv4 address.
|
void |
setRamdiskId(String ramdiskId)
The ID of the RAM disk.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
One or more security group IDs.
|
void |
setSecurityGroups(Collection<String> securityGroups)
[EC2-Classic, default VPC] One or more security group names.
|
void |
setSubnetId(String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
|
void |
setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the resources during launch.
|
void |
setUserData(String userData)
The user data to make available to the instance.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
RunInstancesRequest |
withAdditionalInfo(String additionalInfo)
Reserved.
|
RunInstancesRequest |
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
One or more block device mapping entries.
|
RunInstancesRequest |
withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
One or more block device mapping entries.
|
RunInstancesRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
|
RunInstancesRequest |
withDisableApiTermination(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 |
withEbsOptimized(Boolean ebsOptimized)
Indicates whether the instance is optimized for Amazon EBS I/O.
|
RunInstancesRequest |
withElasticGpuSpecification(Collection<ElasticGpuSpecification> elasticGpuSpecification)
An Elastic GPU to associate with the instance.
|
RunInstancesRequest |
withElasticGpuSpecification(ElasticGpuSpecification... elasticGpuSpecification)
An Elastic GPU to associate with the instance.
|
RunInstancesRequest |
withIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
|
RunInstancesRequest |
withImageId(String imageId)
The ID of the AMI, which you can get by calling DescribeImages.
|
RunInstancesRequest |
withInstanceInitiatedShutdownBehavior(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 |
withInstanceInitiatedShutdownBehavior(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 |
withInstanceType(InstanceType instanceType)
The instance type.
|
RunInstancesRequest |
withInstanceType(String instanceType)
The instance type.
|
RunInstancesRequest |
withIpv6AddressCount(Integer ipv6AddressCount)
[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface.
|
RunInstancesRequest |
withIpv6Addresses(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 |
withIpv6Addresses(InstanceIpv6Address... ipv6Addresses)
[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network
interface.
|
RunInstancesRequest |
withKernelId(String kernelId)
The ID of the kernel.
|
RunInstancesRequest |
withKeyName(String keyName)
The name of the key pair.
|
RunInstancesRequest |
withMaxCount(Integer maxCount)
The maximum number of instances to launch.
|
RunInstancesRequest |
withMinCount(Integer minCount)
The minimum number of instances to launch.
|
RunInstancesRequest |
withMonitoring(Boolean monitoring)
The monitoring for the instance.
|
RunInstancesRequest |
withNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
|
RunInstancesRequest |
withNetworkInterfaces(InstanceNetworkInterfaceSpecification... networkInterfaces)
One or more network interfaces.
|
RunInstancesRequest |
withPlacement(Placement placement)
The placement for the instance.
|
RunInstancesRequest |
withPrivateIpAddress(String privateIpAddress)
[EC2-VPC] The primary IPv4 address.
|
RunInstancesRequest |
withRamdiskId(String ramdiskId)
The ID of the RAM disk.
|
RunInstancesRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
One or more security group IDs.
|
RunInstancesRequest |
withSecurityGroupIds(String... securityGroupIds)
One or more security group IDs.
|
RunInstancesRequest |
withSecurityGroups(Collection<String> securityGroups)
[EC2-Classic, default VPC] One or more security group names.
|
RunInstancesRequest |
withSecurityGroups(String... securityGroups)
[EC2-Classic, default VPC] One or more security group names.
|
RunInstancesRequest |
withSubnetId(String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
|
RunInstancesRequest |
withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the resources during launch.
|
RunInstancesRequest |
withTagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the resources during launch.
|
RunInstancesRequest |
withUserData(String userData)
The user data to make available to the instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public RunInstancesRequest()
public RunInstancesRequest(String imageId, Integer minCount, Integer maxCount)
imageId
- The ID of the AMI, which you can get by calling DescribeImages.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.
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 List<BlockDeviceMapping> getBlockDeviceMappings()
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.
public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
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.
blockDeviceMappings
- 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.public RunInstancesRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
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.
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.
blockDeviceMappings
- 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.public RunInstancesRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
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.
blockDeviceMappings
- 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.public void setImageId(String imageId)
The ID of the AMI, which you can get by calling DescribeImages.
imageId
- The ID of the AMI, which you can get by calling DescribeImages.public String getImageId()
The ID of the AMI, which you can get by calling DescribeImages.
public RunInstancesRequest withImageId(String imageId)
The ID of the AMI, which you can get by calling DescribeImages.
imageId
- The ID of the AMI, which you can get by calling DescribeImages.public void setInstanceType(String instanceType)
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
instanceType
- The instance type. For more information, see Instance Types in the
Amazon Elastic Compute Cloud User Guide.
Default: m1.small
InstanceType
public String getInstanceType()
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
Default: m1.small
InstanceType
public RunInstancesRequest withInstanceType(String instanceType)
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
instanceType
- The instance type. For more information, see Instance Types in the
Amazon Elastic Compute Cloud User Guide.
Default: m1.small
InstanceType
public void setInstanceType(InstanceType instanceType)
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
instanceType
- The instance type. For more information, see Instance Types in the
Amazon Elastic Compute Cloud User Guide.
Default: m1.small
InstanceType
public RunInstancesRequest withInstanceType(InstanceType instanceType)
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
instanceType
- The instance type. For more information, see Instance Types in the
Amazon Elastic Compute Cloud User Guide.
Default: m1.small
InstanceType
public void setIpv6AddressCount(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.
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.public Integer getIpv6AddressCount()
[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.
public RunInstancesRequest withIpv6AddressCount(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.
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.public List<InstanceIpv6Address> getIpv6Addresses()
[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.
public void setIpv6Addresses(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.
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.public RunInstancesRequest withIpv6Addresses(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.
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.public RunInstancesRequest withIpv6Addresses(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.
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.public void setKernelId(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.
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.
public String getKernelId()
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.
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.
public RunInstancesRequest withKernelId(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.
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.
public void setKeyName(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.
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 String getKeyName()
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.
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 RunInstancesRequest withKeyName(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.
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 void setMaxCount(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.
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 Integer getMaxCount()
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.
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 RunInstancesRequest withMaxCount(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.
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 void setMinCount(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.
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 Integer getMinCount()
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.
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 RunInstancesRequest withMinCount(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.
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 void setMonitoring(Boolean monitoring)
The monitoring for the instance.
monitoring
- The monitoring for the instance.public Boolean getMonitoring()
The monitoring for the instance.
public RunInstancesRequest withMonitoring(Boolean monitoring)
The monitoring for the instance.
monitoring
- The monitoring for the instance.public Boolean isMonitoring()
The monitoring for the instance.
public void setPlacement(Placement placement)
The placement for the instance.
placement
- The placement for the instance.public Placement getPlacement()
The placement for the instance.
public RunInstancesRequest withPlacement(Placement placement)
The placement for the instance.
placement
- The placement for the instance.public void setRamdiskId(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.
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.
public String getRamdiskId()
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.
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.
public RunInstancesRequest withRamdiskId(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.
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.
public List<String> getSecurityGroupIds()
One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
Default: Amazon EC2 uses the default security group.
public void setSecurityGroupIds(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.
securityGroupIds
- One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
public RunInstancesRequest withSecurityGroupIds(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.
securityGroupIds
- One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
public RunInstancesRequest withSecurityGroupIds(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.
securityGroupIds
- One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
public List<String> getSecurityGroups()
[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.
Default: Amazon EC2 uses the default security group.
public void setSecurityGroups(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.
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.
public RunInstancesRequest withSecurityGroups(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.
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.
public RunInstancesRequest withSecurityGroups(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.
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.
public void setSubnetId(String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
subnetId
- [EC2-VPC] The ID of the subnet to launch the instance into.public String getSubnetId()
[EC2-VPC] The ID of the subnet to launch the instance into.
public RunInstancesRequest withSubnetId(String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
subnetId
- [EC2-VPC] The ID of the subnet to launch the instance into.public void setUserData(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 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.
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.public String getUserData()
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.
public RunInstancesRequest withUserData(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 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.
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.public void setAdditionalInfo(String additionalInfo)
Reserved.
additionalInfo
- Reserved.public String getAdditionalInfo()
Reserved.
public RunInstancesRequest withAdditionalInfo(String additionalInfo)
Reserved.
additionalInfo
- Reserved.public void setClientToken(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
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
public String getClientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
Constraints: Maximum 64 ASCII characters
public RunInstancesRequest withClientToken(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
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
public void setDisableApiTermination(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
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
public Boolean getDisableApiTermination()
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
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
public RunInstancesRequest withDisableApiTermination(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
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
public Boolean isDisableApiTermination()
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
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
public void setEbsOptimized(Boolean 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
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 Boolean getEbsOptimized()
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
Default: false
public RunInstancesRequest withEbsOptimized(Boolean 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
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 Boolean isEbsOptimized()
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
Default: false
public void setIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
iamInstanceProfile
- The IAM instance profile.public IamInstanceProfileSpecification getIamInstanceProfile()
The IAM instance profile.
public RunInstancesRequest withIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
iamInstanceProfile
- The IAM instance profile.public void setInstanceInitiatedShutdownBehavior(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
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
ShutdownBehavior
public String getInstanceInitiatedShutdownBehavior()
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
Default: stop
ShutdownBehavior
public RunInstancesRequest withInstanceInitiatedShutdownBehavior(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
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
ShutdownBehavior
public void setInstanceInitiatedShutdownBehavior(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
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
ShutdownBehavior
public RunInstancesRequest withInstanceInitiatedShutdownBehavior(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
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
ShutdownBehavior
public List<InstanceNetworkInterfaceSpecification> getNetworkInterfaces()
One or more network interfaces.
public void setNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
networkInterfaces
- One or more network interfaces.public RunInstancesRequest withNetworkInterfaces(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.
networkInterfaces
- One or more network interfaces.public RunInstancesRequest withNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
networkInterfaces
- One or more network interfaces.public void setPrivateIpAddress(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.
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.
public String getPrivateIpAddress()
[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.
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.
public RunInstancesRequest withPrivateIpAddress(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.
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.
public List<ElasticGpuSpecification> getElasticGpuSpecification()
An Elastic GPU to associate with the instance.
public void setElasticGpuSpecification(Collection<ElasticGpuSpecification> elasticGpuSpecification)
An Elastic GPU to associate with the instance.
elasticGpuSpecification
- An Elastic GPU to associate with the instance.public RunInstancesRequest withElasticGpuSpecification(ElasticGpuSpecification... elasticGpuSpecification)
An Elastic GPU to associate with the instance.
NOTE: This method appends the values to the existing list (if any). Use
setElasticGpuSpecification(java.util.Collection)
or
withElasticGpuSpecification(java.util.Collection)
if you want to override the existing values.
elasticGpuSpecification
- An Elastic GPU to associate with the instance.public RunInstancesRequest withElasticGpuSpecification(Collection<ElasticGpuSpecification> elasticGpuSpecification)
An Elastic GPU to associate with the instance.
elasticGpuSpecification
- An Elastic GPU to associate with the instance.public List<TagSpecification> getTagSpecifications()
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.
public void setTagSpecifications(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.
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.public RunInstancesRequest withTagSpecifications(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.
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.public RunInstancesRequest withTagSpecifications(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.
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.public Request<RunInstancesRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<RunInstancesRequest>
public String toString()
toString
in class Object
Object.toString()
public RunInstancesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.