public class CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateInstance operation.
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer .
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
NOOP| Constructor and Description |
|---|
CreateInstanceRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateInstanceRequest |
clone() |
boolean |
equals(Object obj) |
String |
getAmiId()
A custom AMI ID to be used to create the instance.
|
String |
getArchitecture()
The instance architecture.
|
String |
getAutoScalingType()
For load-based or time-based instances, the type.
|
String |
getAvailabilityZone()
The instance Availability Zone.
|
List<BlockDeviceMapping> |
getBlockDeviceMappings()
An array of
BlockDeviceMapping objects that specify the
instance's block devices. |
Boolean |
getEbsOptimized()
Whether to create an Amazon EBS-optimized instance.
|
String |
getHostname()
The instance host name.
|
Boolean |
getInstallUpdatesOnBoot()
Whether to install operating system and package updates when the
instance boots.
|
String |
getInstanceType()
The instance type.
|
List<String> |
getLayerIds()
An array that contains the instance layer IDs.
|
String |
getOs()
The instance's operating system, which must be set to one of the
following.
|
String |
getRootDeviceType()
The instance root device type.
|
String |
getSshKeyName()
The instance's Amazon EC2 key pair name.
|
String |
getStackId()
The stack ID.
|
String |
getSubnetId()
The ID of the instance's subnet.
|
String |
getVirtualizationType()
The instance's virtualization type,
paravirtual or
hvm. |
int |
hashCode() |
Boolean |
isEbsOptimized()
Whether to create an Amazon EBS-optimized instance.
|
Boolean |
isInstallUpdatesOnBoot()
Whether to install operating system and package updates when the
instance boots.
|
void |
setAmiId(String amiId)
A custom AMI ID to be used to create the instance.
|
void |
setArchitecture(Architecture architecture)
The instance architecture.
|
void |
setArchitecture(String architecture)
The instance architecture.
|
void |
setAutoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
|
void |
setAutoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
|
void |
setAvailabilityZone(String availabilityZone)
The instance Availability Zone.
|
void |
setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array of
BlockDeviceMapping objects that specify the
instance's block devices. |
void |
setEbsOptimized(Boolean ebsOptimized)
Whether to create an Amazon EBS-optimized instance.
|
void |
setHostname(String hostname)
The instance host name.
|
void |
setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the
instance boots.
|
void |
setInstanceType(String instanceType)
The instance type.
|
void |
setLayerIds(Collection<String> layerIds)
An array that contains the instance layer IDs.
|
void |
setOs(String os)
The instance's operating system, which must be set to one of the
following.
|
void |
setRootDeviceType(RootDeviceType rootDeviceType)
The instance root device type.
|
void |
setRootDeviceType(String rootDeviceType)
The instance root device type.
|
void |
setSshKeyName(String sshKeyName)
The instance's Amazon EC2 key pair name.
|
void |
setStackId(String stackId)
The stack ID.
|
void |
setSubnetId(String subnetId)
The ID of the instance's subnet.
|
void |
setVirtualizationType(String virtualizationType)
The instance's virtualization type,
paravirtual or
hvm. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateInstanceRequest |
withAmiId(String amiId)
A custom AMI ID to be used to create the instance.
|
CreateInstanceRequest |
withArchitecture(Architecture architecture)
The instance architecture.
|
CreateInstanceRequest |
withArchitecture(String architecture)
The instance architecture.
|
CreateInstanceRequest |
withAutoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
|
CreateInstanceRequest |
withAutoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
|
CreateInstanceRequest |
withAvailabilityZone(String availabilityZone)
The instance Availability Zone.
|
CreateInstanceRequest |
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
An array of
BlockDeviceMapping objects that specify the
instance's block devices. |
CreateInstanceRequest |
withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array of
BlockDeviceMapping objects that specify the
instance's block devices. |
CreateInstanceRequest |
withEbsOptimized(Boolean ebsOptimized)
Whether to create an Amazon EBS-optimized instance.
|
CreateInstanceRequest |
withHostname(String hostname)
The instance host name.
|
CreateInstanceRequest |
withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the
instance boots.
|
CreateInstanceRequest |
withInstanceType(String instanceType)
The instance type.
|
CreateInstanceRequest |
withLayerIds(Collection<String> layerIds)
An array that contains the instance layer IDs.
|
CreateInstanceRequest |
withLayerIds(String... layerIds)
An array that contains the instance layer IDs.
|
CreateInstanceRequest |
withOs(String os)
The instance's operating system, which must be set to one of the
following.
|
CreateInstanceRequest |
withRootDeviceType(RootDeviceType rootDeviceType)
The instance root device type.
|
CreateInstanceRequest |
withRootDeviceType(String rootDeviceType)
The instance root device type.
|
CreateInstanceRequest |
withSshKeyName(String sshKeyName)
The instance's Amazon EC2 key pair name.
|
CreateInstanceRequest |
withStackId(String stackId)
The stack ID.
|
CreateInstanceRequest |
withSubnetId(String subnetId)
The ID of the instance's subnet.
|
CreateInstanceRequest |
withVirtualizationType(String virtualizationType)
The instance's virtualization type,
paravirtual or
hvm. |
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic String getStackId()
public void setStackId(String stackId)
stackId - The stack ID.public CreateInstanceRequest withStackId(String stackId)
Returns a reference to this object so that method calls can be chained together.
stackId - The stack ID.public List<String> getLayerIds()
public void setLayerIds(Collection<String> layerIds)
layerIds - An array that contains the instance layer IDs.public CreateInstanceRequest withLayerIds(String... layerIds)
NOTE: This method appends the values to the existing list (if
any). Use setLayerIds(java.util.Collection) or withLayerIds(java.util.Collection) if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
layerIds - An array that contains the instance layer IDs.public CreateInstanceRequest withLayerIds(Collection<String> layerIds)
Returns a reference to this object so that method calls can be chained together.
layerIds - An array that contains the instance layer IDs.public String getInstanceType()
public void setInstanceType(String instanceType)
instanceType - The instance type. AWS OpsWorks supports all instance types except
Cluster Compute, Cluster GPU, and High Memory Cluster. For more
information, see Instance
Families and Types. The parameter values that you use to specify
the various types are in the API Name column of the Available Instance
Types table.public CreateInstanceRequest withInstanceType(String instanceType)
Returns a reference to this object so that method calls can be chained together.
instanceType - The instance type. AWS OpsWorks supports all instance types except
Cluster Compute, Cluster GPU, and High Memory Cluster. For more
information, see Instance
Families and Types. The parameter values that you use to specify
the various types are in the API Name column of the Available Instance
Types table.public String getAutoScalingType()
Constraints:
Allowed Values: load, timer
AutoScalingTypepublic void setAutoScalingType(String autoScalingType)
Constraints:
Allowed Values: load, timer
autoScalingType - For load-based or time-based instances, the type.AutoScalingTypepublic CreateInstanceRequest withAutoScalingType(String autoScalingType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: load, timer
autoScalingType - For load-based or time-based instances, the type.AutoScalingTypepublic void setAutoScalingType(AutoScalingType autoScalingType)
Constraints:
Allowed Values: load, timer
autoScalingType - For load-based or time-based instances, the type.AutoScalingTypepublic CreateInstanceRequest withAutoScalingType(AutoScalingType autoScalingType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: load, timer
autoScalingType - For load-based or time-based instances, the type.AutoScalingTypepublic String getHostname()
public void setHostname(String hostname)
hostname - The instance host name.public CreateInstanceRequest withHostname(String hostname)
Returns a reference to this object so that method calls can be chained together.
hostname - The instance host name.public String getOs()
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
public void setOs(String os)
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
os - The instance's operating system, which must be set to one of the
following. Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
public CreateInstanceRequest withOs(String os)
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
Returns a reference to this object so that method calls can be chained together.
os - The instance's operating system, which must be set to one of the
following. Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
public String getAmiId()
Os to
Custom.Os to
Custom.public void setAmiId(String amiId)
Os to
Custom.amiId - A custom AMI ID to be used to create the instance. The AMI should be
based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu
12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances.
Os to
Custom.public CreateInstanceRequest withAmiId(String amiId)
Os to
Custom.Returns a reference to this object so that method calls can be chained together.
amiId - A custom AMI ID to be used to create the instance. The AMI should be
based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu
12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances.
Os to
Custom.public String getSshKeyName()
public void setSshKeyName(String sshKeyName)
sshKeyName - The instance's Amazon EC2 key pair name.public CreateInstanceRequest withSshKeyName(String sshKeyName)
Returns a reference to this object so that method calls can be chained together.
sshKeyName - The instance's Amazon EC2 key pair name.public String getAvailabilityZone()
public void setAvailabilityZone(String availabilityZone)
availabilityZone - The instance Availability Zone. For more information, see Regions
and Endpoints.public CreateInstanceRequest withAvailabilityZone(String availabilityZone)
Returns a reference to this object so that method calls can be chained together.
availabilityZone - The instance Availability Zone. For more information, see Regions
and Endpoints.public String getVirtualizationType()
paravirtual or
hvm.paravirtual or
hvm.public void setVirtualizationType(String virtualizationType)
paravirtual or
hvm.virtualizationType - The instance's virtualization type, paravirtual or
hvm.public CreateInstanceRequest withVirtualizationType(String virtualizationType)
paravirtual or
hvm.
Returns a reference to this object so that method calls can be chained together.
virtualizationType - The instance's virtualization type, paravirtual or
hvm.public String getSubnetId()
public void setSubnetId(String subnetId)
subnetId - The ID of the instance's subnet. If the stack is running in a VPC, you
can use this parameter to override the stack's default subnet ID value
and direct AWS OpsWorks to launch the instance in a different subnet.public CreateInstanceRequest withSubnetId(String subnetId)
Returns a reference to this object so that method calls can be chained together.
subnetId - The ID of the instance's subnet. If the stack is running in a VPC, you
can use this parameter to override the stack's default subnet ID value
and direct AWS OpsWorks to launch the instance in a different subnet.public String getArchitecture()
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Constraints:
Allowed Values: x86_64, i386
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecturepublic void setArchitecture(String architecture)
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Constraints:
Allowed Values: x86_64, i386
architecture - The instance architecture. The default option is x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecturepublic CreateInstanceRequest withArchitecture(String architecture)
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: x86_64, i386
architecture - The instance architecture. The default option is x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecturepublic void setArchitecture(Architecture architecture)
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Constraints:
Allowed Values: x86_64, i386
architecture - The instance architecture. The default option is x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecturepublic CreateInstanceRequest withArchitecture(Architecture architecture)
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: x86_64, i386
architecture - The instance architecture. The default option is x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.Architecturepublic String getRootDeviceType()
Constraints:
Allowed Values: ebs, instance-store
RootDeviceTypepublic void setRootDeviceType(String rootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType - The instance root device type. For more information, see Storage
for the Root Device.RootDeviceTypepublic CreateInstanceRequest withRootDeviceType(String rootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType - The instance root device type. For more information, see Storage
for the Root Device.RootDeviceTypepublic void setRootDeviceType(RootDeviceType rootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType - The instance root device type. For more information, see Storage
for the Root Device.RootDeviceTypepublic CreateInstanceRequest withRootDeviceType(RootDeviceType rootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType - The instance root device type. For more information, see Storage
for the Root Device.RootDeviceTypepublic List<BlockDeviceMapping> getBlockDeviceMappings()
BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.blockDeviceMappings - An array of BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.public CreateInstanceRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.
NOTE: This method appends the values to the existing list (if
any). Use setBlockDeviceMappings(java.util.Collection) or
withBlockDeviceMappings(java.util.Collection) if you want to
override the existing values.
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings - An array of BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.public CreateInstanceRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings - An array of BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block
Device Mapping.public Boolean isInstallUpdatesOnBoot()
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
public void setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
installUpdatesOnBoot - Whether to install operating system and package updates when the
instance boots. The default value is true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
public CreateInstanceRequest withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
Returns a reference to this object so that method calls can be chained together.
installUpdatesOnBoot - Whether to install operating system and package updates when the
instance boots. The default value is true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
public Boolean getInstallUpdatesOnBoot()
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
public Boolean isEbsOptimized()
public void setEbsOptimized(Boolean ebsOptimized)
ebsOptimized - Whether to create an Amazon EBS-optimized instance.public CreateInstanceRequest withEbsOptimized(Boolean ebsOptimized)
Returns a reference to this object so that method calls can be chained together.
ebsOptimized - Whether to create an Amazon EBS-optimized instance.public Boolean getEbsOptimized()
public String toString()
toString in class ObjectObject.toString()public CreateInstanceRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2015. All rights reserved.