public class RunInstancesRequest extends AmazonWebServiceRequest implements java.io.Serializable, DryRunSupportedRequest<RunInstancesRequest>
RunInstances operation
.
Launches the specified number of instances using an AMI for which you have permissions.
When you launch an instance, it enters the pending
state.
After the instance is ready for you, it enters the
running
state. To check the state of your instance, call
DescribeInstances.
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.
To tag your instance, ensure that it is running
as
CreateTags requires a resource ID. For more information about tagging,
see
Tagging Your Amazon EC2 Resources
.
If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide .
[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.
[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide .
If any of the AMIs have a product code attached for which the user has
not subscribed, RunInstances
fails.
Some instance types can only be launched into a VPC. If you do not
have a default VPC, or if you do not specify a subnet ID in the
request, RunInstances
fails. For more information, see
Instance Types Available Only in a VPC
.
For more information about troubleshooting, see What To Do If An Instance Immediately Terminates , and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide .
Constructor and Description |
---|
RunInstancesRequest()
Default constructor for a new RunInstancesRequest object.
|
RunInstancesRequest(java.lang.String imageId,
java.lang.Integer minCount,
java.lang.Integer maxCount)
Constructs a new RunInstancesRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAdditionalInfo()
Reserved.
|
java.util.List<BlockDeviceMapping> |
getBlockDeviceMappings()
The block device mapping.
|
java.lang.String |
getClientToken()
Unique, case-sensitive identifier you provide to ensure the
idempotency of the request.
|
java.lang.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.
|
java.lang.Boolean |
getEbsOptimized()
Indicates whether the instance is optimized for EBS I/O.
|
IamInstanceProfileSpecification |
getIamInstanceProfile()
The IAM instance profile.
|
java.lang.String |
getImageId()
The ID of the AMI, which you can get by calling DescribeImages.
|
java.lang.String |
getInstanceInitiatedShutdownBehavior()
Indicates whether an instance stops or terminates when you initiate
shutdown from the instance (using the operating system command for
system shutdown).
|
java.lang.String |
getInstanceType()
The instance type.
|
java.lang.String |
getKernelId()
The ID of the kernel.
|
java.lang.String |
getKeyName()
The name of the key pair.
|
java.lang.Integer |
getMaxCount()
The maximum number of instances to launch.
|
java.lang.Integer |
getMinCount()
The minimum number of instances to launch.
|
java.lang.Boolean |
getMonitoring()
The monitoring for the instance.
|
java.util.List<InstanceNetworkInterfaceSpecification> |
getNetworkInterfaces()
One or more network interfaces.
|
Placement |
getPlacement()
The placement for the instance.
|
java.lang.String |
getPrivateIpAddress()
[EC2-VPC] The primary IP address.
|
java.lang.String |
getRamdiskId()
The ID of the RAM disk.
|
java.util.List<java.lang.String> |
getSecurityGroupIds()
One or more security group IDs.
|
java.util.List<java.lang.String> |
getSecurityGroups()
[EC2-Classic, default VPC] One or more security group names.
|
java.lang.String |
getSubnetId()
[EC2-VPC] The ID of the subnet to launch the instance into.
|
java.lang.String |
getUserData()
Data to configure the instance, or a script to run during instance
launch.
|
int |
hashCode() |
java.lang.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. |
java.lang.Boolean |
isEbsOptimized()
Indicates whether the instance is optimized for EBS I/O.
|
java.lang.Boolean |
isMonitoring()
The monitoring for the instance.
|
void |
setAdditionalInfo(java.lang.String additionalInfo)
Reserved.
|
void |
setBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mapping.
|
void |
setClientToken(java.lang.String clientToken)
Unique, case-sensitive identifier you provide to ensure the
idempotency of the request.
|
void |
setDisableApiTermination(java.lang.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(java.lang.Boolean ebsOptimized)
Indicates whether the instance is optimized for EBS I/O.
|
void |
setIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
|
void |
setImageId(java.lang.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(java.lang.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(java.lang.String instanceType)
The instance type.
|
void |
setKernelId(java.lang.String kernelId)
The ID of the kernel.
|
void |
setKeyName(java.lang.String keyName)
The name of the key pair.
|
void |
setMaxCount(java.lang.Integer maxCount)
The maximum number of instances to launch.
|
void |
setMinCount(java.lang.Integer minCount)
The minimum number of instances to launch.
|
void |
setMonitoring(java.lang.Boolean monitoring)
The monitoring for the instance.
|
void |
setNetworkInterfaces(java.util.Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
|
void |
setPlacement(Placement placement)
The placement for the instance.
|
void |
setPrivateIpAddress(java.lang.String privateIpAddress)
[EC2-VPC] The primary IP address.
|
void |
setRamdiskId(java.lang.String ramdiskId)
The ID of the RAM disk.
|
void |
setSecurityGroupIds(java.util.Collection<java.lang.String> securityGroupIds)
One or more security group IDs.
|
void |
setSecurityGroups(java.util.Collection<java.lang.String> securityGroups)
[EC2-Classic, default VPC] One or more security group names.
|
void |
setSubnetId(java.lang.String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
|
void |
setUserData(java.lang.String userData)
Data to configure the instance, or a script to run during instance
launch.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RunInstancesRequest |
withAdditionalInfo(java.lang.String additionalInfo)
Reserved.
|
RunInstancesRequest |
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
The block device mapping.
|
RunInstancesRequest |
withBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mapping.
|
RunInstancesRequest |
withClientToken(java.lang.String clientToken)
Unique, case-sensitive identifier you provide to ensure the
idempotency of the request.
|
RunInstancesRequest |
withDisableApiTermination(java.lang.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(java.lang.Boolean ebsOptimized)
Indicates whether the instance is optimized for EBS I/O.
|
RunInstancesRequest |
withIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
|
RunInstancesRequest |
withImageId(java.lang.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(java.lang.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(java.lang.String instanceType)
The instance type.
|
RunInstancesRequest |
withKernelId(java.lang.String kernelId)
The ID of the kernel.
|
RunInstancesRequest |
withKeyName(java.lang.String keyName)
The name of the key pair.
|
RunInstancesRequest |
withMaxCount(java.lang.Integer maxCount)
The maximum number of instances to launch.
|
RunInstancesRequest |
withMinCount(java.lang.Integer minCount)
The minimum number of instances to launch.
|
RunInstancesRequest |
withMonitoring(java.lang.Boolean monitoring)
The monitoring for the instance.
|
RunInstancesRequest |
withNetworkInterfaces(java.util.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(java.lang.String privateIpAddress)
[EC2-VPC] The primary IP address.
|
RunInstancesRequest |
withRamdiskId(java.lang.String ramdiskId)
The ID of the RAM disk.
|
RunInstancesRequest |
withSecurityGroupIds(java.util.Collection<java.lang.String> securityGroupIds)
One or more security group IDs.
|
RunInstancesRequest |
withSecurityGroupIds(java.lang.String... securityGroupIds)
One or more security group IDs.
|
RunInstancesRequest |
withSecurityGroups(java.util.Collection<java.lang.String> securityGroups)
[EC2-Classic, default VPC] One or more security group names.
|
RunInstancesRequest |
withSecurityGroups(java.lang.String... securityGroups)
[EC2-Classic, default VPC] One or more security group names.
|
RunInstancesRequest |
withSubnetId(java.lang.String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
|
RunInstancesRequest |
withUserData(java.lang.String userData)
Data to configure the instance, or a script to run during instance
launch.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public RunInstancesRequest()
public RunInstancesRequest(java.lang.String imageId, java.lang.Integer minCount, java.lang.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 java.lang.String getImageId()
public void setImageId(java.lang.String imageId)
imageId
- The ID of the AMI, which you can get by calling DescribeImages.public RunInstancesRequest withImageId(java.lang.String imageId)
Returns a reference to this object so that method calls can be chained together.
imageId
- The ID of the AMI, which you can get by calling DescribeImages.public java.lang.Integer getMinCount()
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 void setMinCount(java.lang.Integer 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 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 RunInstancesRequest withMinCount(java.lang.Integer 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 General FAQ.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.Integer getMaxCount()
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 void setMaxCount(java.lang.Integer maxCount)
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 RunInstancesRequest withMaxCount(java.lang.Integer maxCount)
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 a reference to this object so that method calls can be chained together.
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 java.lang.String getKeyName()
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 void setKeyName(java.lang.String keyName)
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 RunInstancesRequest withKeyName(java.lang.String keyName)
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 a reference to this object so that method calls can be chained together.
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 java.util.List<java.lang.String> getSecurityGroups()
Default: Amazon EC2 uses the default security group.
Default: Amazon EC2 uses the default security group.
public void setSecurityGroups(java.util.Collection<java.lang.String> securityGroups)
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(java.lang.String... securityGroups)
Default: Amazon EC2 uses the default security group.
Returns a reference to this object so that method calls can be chained together.
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(java.util.Collection<java.lang.String> securityGroups)
Default: Amazon EC2 uses the default security group.
Returns a reference to this object so that method calls can be chained together.
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 java.util.List<java.lang.String> getSecurityGroupIds()
Default: Amazon EC2 uses the default security group.
Default: Amazon EC2 uses the default security group.
public void setSecurityGroupIds(java.util.Collection<java.lang.String> securityGroupIds)
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(java.lang.String... securityGroupIds)
Default: Amazon EC2 uses the default security group.
Returns a reference to this object so that method calls can be chained together.
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(java.util.Collection<java.lang.String> securityGroupIds)
Default: Amazon EC2 uses the default security group.
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- One or more security group IDs. You can create a security group using
CreateSecurityGroup. Default: Amazon EC2 uses the default security group.
public java.lang.String getUserData()
public void setUserData(java.lang.String userData)
userData
- Data to configure the instance, or a script to run during instance
launch. For more information, see Running
Commands on Your Linux Instance at Launch (Linux) and Adding
User Data (Windows). For API calls, the text must be
base64-encoded. For command line tools, the encoding is performed for
you, and you can load the text from a file.public RunInstancesRequest withUserData(java.lang.String userData)
Returns a reference to this object so that method calls can be chained together.
userData
- Data to configure the instance, or a script to run during instance
launch. For more information, see Running
Commands on Your Linux Instance at Launch (Linux) and Adding
User Data (Windows). For API calls, the text must be
base64-encoded. For command line tools, the encoding is performed for
you, and you can load the text from a file.public java.lang.String getInstanceType()
Default: m1.small
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
Default: m1.small
InstanceType
public void setInstanceType(java.lang.String instanceType)
Default: m1.small
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
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(java.lang.String instanceType)
Default: m1.small
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
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)
Default: m1.small
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
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)
Default: m1.small
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
instanceType
- The instance type. For more information, see Instance
Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
InstanceType
public Placement getPlacement()
public void setPlacement(Placement placement)
placement
- The placement for the instance.public RunInstancesRequest withPlacement(Placement placement)
Returns a reference to this object so that method calls can be chained together.
placement
- The placement for the instance.public java.lang.String getKernelId()
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 void setKernelId(java.lang.String kernelId)
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 RunInstancesRequest withKernelId(java.lang.String kernelId)
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 a reference to this object so that method calls can be chained together.
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 java.lang.String getRamdiskId()
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 void setRamdiskId(java.lang.String ramdiskId)
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 RunInstancesRequest withRamdiskId(java.lang.String ramdiskId)
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 a reference to this object so that method calls can be chained together.
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 java.util.List<BlockDeviceMapping> getBlockDeviceMappings()
public void setBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
blockDeviceMappings
- The block device mapping.public RunInstancesRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings
- The block device mapping.public RunInstancesRequest withBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings
- The block device mapping.public java.lang.Boolean isMonitoring()
public void setMonitoring(java.lang.Boolean monitoring)
monitoring
- The monitoring for the instance.public RunInstancesRequest withMonitoring(java.lang.Boolean monitoring)
Returns a reference to this object so that method calls can be chained together.
monitoring
- The monitoring for the instance.public java.lang.Boolean getMonitoring()
public java.lang.String getSubnetId()
public void setSubnetId(java.lang.String subnetId)
subnetId
- [EC2-VPC] The ID of the subnet to launch the instance into.public RunInstancesRequest withSubnetId(java.lang.String subnetId)
Returns a reference to this object so that method calls can be chained together.
subnetId
- [EC2-VPC] The ID of the subnet to launch the instance into.public java.lang.Boolean isDisableApiTermination()
true
, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using 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. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using 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 setDisableApiTermination(java.lang.Boolean disableApiTermination)
true
, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using 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. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using 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(java.lang.Boolean disableApiTermination)
true
, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using ModifyInstanceAttribute.
Alternatively, if you set
InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the
shutdown command from the instance. Default: false
Returns a reference to this object so that method calls can be chained together.
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. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using ModifyInstanceAttribute.
Alternatively, if you set
InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the
shutdown command from the instance. Default: false
public java.lang.Boolean getDisableApiTermination()
true
, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using 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. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using ModifyInstanceAttribute.
Alternatively, if you set
InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the
shutdown command from the instance. Default: false
public java.lang.String getInstanceInitiatedShutdownBehavior()
Default: stop
Constraints:
Allowed Values: stop, terminate
Default: stop
ShutdownBehavior
public void setInstanceInitiatedShutdownBehavior(java.lang.String instanceInitiatedShutdownBehavior)
Default: stop
Constraints:
Allowed Values: stop, terminate
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(java.lang.String instanceInitiatedShutdownBehavior)
Default: stop
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: stop, terminate
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)
Default: stop
Constraints:
Allowed Values: stop, terminate
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)
Default: stop
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: stop, terminate
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 java.lang.String getPrivateIpAddress()
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
public void setPrivateIpAddress(java.lang.String privateIpAddress)
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
privateIpAddress
- [EC2-VPC] The primary IP address. You must specify a value from the IP
address range of the subnet. Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
public RunInstancesRequest withPrivateIpAddress(java.lang.String privateIpAddress)
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
Returns a reference to this object so that method calls can be chained together.
privateIpAddress
- [EC2-VPC] The primary IP address. You must specify a value from the IP
address range of the subnet. Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
public java.lang.String getClientToken()
Constraints: Maximum 64 ASCII characters
Constraints: Maximum 64 ASCII characters
public void setClientToken(java.lang.String clientToken)
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 RunInstancesRequest withClientToken(java.lang.String clientToken)
Constraints: Maximum 64 ASCII characters
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getAdditionalInfo()
public void setAdditionalInfo(java.lang.String additionalInfo)
additionalInfo
- Reserved.public RunInstancesRequest withAdditionalInfo(java.lang.String additionalInfo)
Returns a reference to this object so that method calls can be chained together.
additionalInfo
- Reserved.public java.util.List<InstanceNetworkInterfaceSpecification> getNetworkInterfaces()
public void setNetworkInterfaces(java.util.Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
networkInterfaces
- One or more network interfaces.public RunInstancesRequest withNetworkInterfaces(InstanceNetworkInterfaceSpecification... networkInterfaces)
Returns a reference to this object so that method calls can be chained together.
networkInterfaces
- One or more network interfaces.public RunInstancesRequest withNetworkInterfaces(java.util.Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
Returns a reference to this object so that method calls can be chained together.
networkInterfaces
- One or more network interfaces.public IamInstanceProfileSpecification getIamInstanceProfile()
public void setIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
iamInstanceProfile
- The IAM instance profile.public RunInstancesRequest withIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
Returns a reference to this object so that method calls can be chained together.
iamInstanceProfile
- The IAM instance profile.public java.lang.Boolean isEbsOptimized()
Default:
false
Default:
false
public void setEbsOptimized(java.lang.Boolean ebsOptimized)
Default:
false
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
public RunInstancesRequest withEbsOptimized(java.lang.Boolean ebsOptimized)
Default:
false
Returns a reference to this object so that method calls can be chained together.
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
public java.lang.Boolean getEbsOptimized()
Default:
false
Default:
false
public Request<RunInstancesRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<RunInstancesRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.