Class RunInstancesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.RunInstancesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<RunInstancesRequest>
,Serializable
,Cloneable
public class RunInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<RunInstancesRequest>
Contains the parameters for RunInstances.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description RunInstancesRequest()
Default constructor for RunInstancesRequest object.RunInstancesRequest(String imageId, Integer minCount, Integer maxCount)
Constructs a new RunInstancesRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RunInstancesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getAdditionalInfo()
Reserved.List<BlockDeviceMapping>
getBlockDeviceMappings()
The block device mapping.String
getClientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.Boolean
getDisableApiTermination()
If you set this parameter totrue
, 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 EBS I/O.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.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 IP 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.String
getUserData()
Data to configure the instance, or a script to run during instance launch.int
hashCode()
Boolean
isDisableApiTermination()
If you set this parameter totrue
, 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 EBS I/O.Boolean
isMonitoring()
The monitoring for the instance.void
setAdditionalInfo(String additionalInfo)
Reserved.void
setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mapping.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 totrue
, 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 EBS I/O.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
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 IP 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
setUserData(String userData)
Data to configure the instance, or a script to run during instance launch.String
toString()
Returns a string representation of this object; useful for testing and debugging.RunInstancesRequest
withAdditionalInfo(String additionalInfo)
Reserved.RunInstancesRequest
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
The block device mapping.RunInstancesRequest
withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mapping.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 totrue
, 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 EBS I/O.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
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(InstanceNetworkInterfaceSpecification... networkInterfaces)
One or more network interfaces.RunInstancesRequest
withNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.RunInstancesRequest
withPlacement(Placement placement)
The placement for the instance.RunInstancesRequest
withPrivateIpAddress(String privateIpAddress)
[EC2-VPC] The primary IP address.RunInstancesRequest
withRamdiskId(String ramdiskId)
The ID of the RAM disk.RunInstancesRequest
withSecurityGroupIds(String... securityGroupIds)
One or more security group IDs.RunInstancesRequest
withSecurityGroupIds(Collection<String> securityGroupIds)
One or more security group IDs.RunInstancesRequest
withSecurityGroups(String... securityGroups)
[EC2-Classic, default VPC] One or more security group names.RunInstancesRequest
withSecurityGroups(Collection<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
withUserData(String userData)
Data to configure the instance, or a script to run during instance launch.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
RunInstancesRequest
public RunInstancesRequest()
Default constructor for RunInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
RunInstancesRequest
public RunInstancesRequest(String imageId, Integer minCount, Integer maxCount)
Constructs a new RunInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
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 aboveMinCount
.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.
-
-
Method Detail
-
setImageId
public void setImageId(String imageId)
The ID of the AMI, which you can get by calling DescribeImages.
- Parameters:
imageId
- The ID of the AMI, which you can get by calling DescribeImages.
-
getImageId
public String getImageId()
The ID of the AMI, which you can get by calling DescribeImages.
- Returns:
- The ID of the AMI, which you can get by calling DescribeImages.
-
withImageId
public RunInstancesRequest withImageId(String imageId)
The ID of the AMI, which you can get by calling DescribeImages.
- Parameters:
imageId
- The ID of the AMI, which you can get by calling DescribeImages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMinCount
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.
- Parameters:
minCount
- The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
-
getMinCount
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.
- Returns:
- 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.
-
withMinCount
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.
- Parameters:
minCount
- The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxCount
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.
- Parameters:
maxCount
- The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances aboveMinCount
.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.
-
getMaxCount
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.
- Returns:
- 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.
-
withMaxCount
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.
- Parameters:
maxCount
- The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances aboveMinCount
.Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKeyName
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.
- Parameters:
keyName
- The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
-
getKeyName
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.
- Returns:
- 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.
-
withKeyName
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.
- Parameters:
keyName
- The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSecurityGroups
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.
- Returns:
- [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.
-
setSecurityGroups
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.
- Parameters:
securityGroups
- [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.Default: Amazon EC2 uses the default security group.
-
withSecurityGroups
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)
orwithSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
securityGroups
- [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.Default: Amazon EC2 uses the default security group.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSecurityGroups
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.
- Parameters:
securityGroups
- [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.Default: Amazon EC2 uses the default security group.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSecurityGroupIds
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.
- Returns:
- One or more security group IDs. You can create a security group
using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
-
setSecurityGroupIds
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.
- Parameters:
securityGroupIds
- One or more security group IDs. You can create a security group using CreateSecurityGroup.Default: Amazon EC2 uses the default security group.
-
withSecurityGroupIds
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)
orwithSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
securityGroupIds
- One or more security group IDs. You can create a security group using CreateSecurityGroup.Default: Amazon EC2 uses the default security group.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSecurityGroupIds
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.
- Parameters:
securityGroupIds
- One or more security group IDs. You can create a security group using CreateSecurityGroup.Default: Amazon EC2 uses the default security group.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUserData
public void setUserData(String 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.
- Parameters:
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.
-
getUserData
public String getUserData()
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.
- Returns:
- 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.
-
withUserData
public RunInstancesRequest withUserData(String 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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInstanceType
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
- Parameters:
instanceType
- The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.Default:
m1.small
- See Also:
InstanceType
-
getInstanceType
public String getInstanceType()
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default:
m1.small
- Returns:
- The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User
Guide.
Default:
m1.small
- See Also:
InstanceType
-
withInstanceType
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
- Parameters:
instanceType
- The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.Default:
m1.small
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceType
-
setInstanceType
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
- Parameters:
instanceType
- The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.Default:
m1.small
- See Also:
InstanceType
-
withInstanceType
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
- Parameters:
instanceType
- The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.Default:
m1.small
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceType
-
setPlacement
public void setPlacement(Placement placement)
The placement for the instance.
- Parameters:
placement
- The placement for the instance.
-
getPlacement
public Placement getPlacement()
The placement for the instance.
- Returns:
- The placement for the instance.
-
withPlacement
public RunInstancesRequest withPlacement(Placement placement)
The placement for the instance.
- Parameters:
placement
- The placement for the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKernelId
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.
- Parameters:
kernelId
- The ID of the kernel.We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
-
getKernelId
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.
- Returns:
- 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.
-
withKernelId
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.
- Parameters:
kernelId
- The ID of the kernel.We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRamdiskId
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.
- Parameters:
ramdiskId
- The ID of the RAM disk.We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
-
getRamdiskId
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.
- Returns:
- 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.
-
withRamdiskId
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.
- Parameters:
ramdiskId
- The ID of the RAM disk.We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getBlockDeviceMappings
public List<BlockDeviceMapping> getBlockDeviceMappings()
The block device mapping.
- Returns:
- The block device mapping.
-
setBlockDeviceMappings
public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mapping.
- Parameters:
blockDeviceMappings
- The block device mapping.
-
withBlockDeviceMappings
public RunInstancesRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
The block device mapping.
NOTE: This method appends the values to the existing list (if any). Use
setBlockDeviceMappings(java.util.Collection)
orwithBlockDeviceMappings(java.util.Collection)
if you want to override the existing values.- Parameters:
blockDeviceMappings
- The block device mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withBlockDeviceMappings
public RunInstancesRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mapping.
- Parameters:
blockDeviceMappings
- The block device mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMonitoring
public void setMonitoring(Boolean monitoring)
The monitoring for the instance.
- Parameters:
monitoring
- The monitoring for the instance.
-
getMonitoring
public Boolean getMonitoring()
The monitoring for the instance.
- Returns:
- The monitoring for the instance.
-
withMonitoring
public RunInstancesRequest withMonitoring(Boolean monitoring)
The monitoring for the instance.
- Parameters:
monitoring
- The monitoring for the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isMonitoring
public Boolean isMonitoring()
The monitoring for the instance.
- Returns:
- The monitoring for the instance.
-
setSubnetId
public void setSubnetId(String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
- Parameters:
subnetId
- [EC2-VPC] The ID of the subnet to launch the instance into.
-
getSubnetId
public String getSubnetId()
[EC2-VPC] The ID of the subnet to launch the instance into.
- Returns:
- [EC2-VPC] The ID of the subnet to launch the instance into.
-
withSubnetId
public RunInstancesRequest withSubnetId(String subnetId)
[EC2-VPC] The ID of the subnet to launch the instance into.
- Parameters:
subnetId
- [EC2-VPC] The ID of the subnet to launch the instance into.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDisableApiTermination
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. If you set this parameter totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
- Parameters:
disableApiTermination
- If you set this parameter totrue
, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
-
getDisableApiTermination
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. If you set this parameter totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
- Returns:
- 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 totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
-
withDisableApiTermination
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. If you set this parameter totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
- Parameters:
disableApiTermination
- If you set this parameter totrue
, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isDisableApiTermination
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. If you set this parameter totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
- Returns:
- 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 totrue
and then later want to be able to terminate the instance, you must first change the value of thedisableApiTermination
attribute tofalse
using ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehavior
toterminate
, you can terminate the instance by running the shutdown command from the instance.Default:
false
-
setInstanceInitiatedShutdownBehavior
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
- Parameters:
instanceInitiatedShutdownBehavior
- Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).Default:
stop
- See Also:
ShutdownBehavior
-
getInstanceInitiatedShutdownBehavior
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
- Returns:
- Indicates whether an instance stops or terminates when you
initiate shutdown from the instance (using the operating system
command for system shutdown).
Default:
stop
- See Also:
ShutdownBehavior
-
withInstanceInitiatedShutdownBehavior
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
- Parameters:
instanceInitiatedShutdownBehavior
- Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).Default:
stop
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ShutdownBehavior
-
setInstanceInitiatedShutdownBehavior
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
- Parameters:
instanceInitiatedShutdownBehavior
- Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).Default:
stop
- See Also:
ShutdownBehavior
-
withInstanceInitiatedShutdownBehavior
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
- Parameters:
instanceInitiatedShutdownBehavior
- Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).Default:
stop
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ShutdownBehavior
-
setPrivateIpAddress
public void setPrivateIpAddress(String 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 totrue
andPrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.Default: We select an IP address from the IP address range of the subnet.
- Parameters:
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 totrue
andPrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.Default: We select an IP address from the IP address range of the subnet.
-
getPrivateIpAddress
public String getPrivateIpAddress()
[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 totrue
andPrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.Default: We select an IP address from the IP address range of the subnet.
- Returns:
- [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 totrue
andPrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.Default: We select an IP address from the IP address range of the subnet.
-
withPrivateIpAddress
public RunInstancesRequest withPrivateIpAddress(String 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 totrue
andPrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.Default: We select an IP address from the IP address range of the subnet.
- Parameters:
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 totrue
andPrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.Default: We select an IP address from the IP address range of the subnet.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClientToken
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
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.Constraints: Maximum 64 ASCII characters
-
getClientToken
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
- Returns:
- Unique, case-sensitive identifier you provide to ensure the
idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
-
withClientToken
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
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.Constraints: Maximum 64 ASCII characters
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAdditionalInfo
public void setAdditionalInfo(String additionalInfo)
Reserved.
- Parameters:
additionalInfo
- Reserved.
-
getAdditionalInfo
public String getAdditionalInfo()
Reserved.
- Returns:
- Reserved.
-
withAdditionalInfo
public RunInstancesRequest withAdditionalInfo(String additionalInfo)
Reserved.
- Parameters:
additionalInfo
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getNetworkInterfaces
public List<InstanceNetworkInterfaceSpecification> getNetworkInterfaces()
One or more network interfaces.
- Returns:
- One or more network interfaces.
-
setNetworkInterfaces
public void setNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
- Parameters:
networkInterfaces
- One or more network interfaces.
-
withNetworkInterfaces
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)
orwithNetworkInterfaces(java.util.Collection)
if you want to override the existing values.- Parameters:
networkInterfaces
- One or more network interfaces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withNetworkInterfaces
public RunInstancesRequest withNetworkInterfaces(Collection<InstanceNetworkInterfaceSpecification> networkInterfaces)
One or more network interfaces.
- Parameters:
networkInterfaces
- One or more network interfaces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIamInstanceProfile
public void setIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
- Parameters:
iamInstanceProfile
- The IAM instance profile.
-
getIamInstanceProfile
public IamInstanceProfileSpecification getIamInstanceProfile()
The IAM instance profile.
- Returns:
- The IAM instance profile.
-
withIamInstanceProfile
public RunInstancesRequest withIamInstanceProfile(IamInstanceProfileSpecification iamInstanceProfile)
The IAM instance profile.
- Parameters:
iamInstanceProfile
- The IAM instance profile.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEbsOptimized
public void setEbsOptimized(Boolean ebsOptimized)
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default:
false
- Parameters:
ebsOptimized
- Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.Default:
false
-
getEbsOptimized
public Boolean getEbsOptimized()
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default:
false
- Returns:
- 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
-
withEbsOptimized
public RunInstancesRequest withEbsOptimized(Boolean ebsOptimized)
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default:
false
- Parameters:
ebsOptimized
- Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEbsOptimized
public Boolean isEbsOptimized()
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default:
false
- Returns:
- 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
-
getDryRunRequest
public Request<RunInstancesRequest> getDryRunRequest()
This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.- Specified by:
getDryRunRequest
in interfaceDryRunSupportedRequest<RunInstancesRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public RunInstancesRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-