public class UpdateInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
UpdateInstance operation
.
Updates a specified instance.
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 |
---|
UpdateInstanceRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateInstanceRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getAgentVersion()
The default AWS OpsWorks agent version.
|
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.
|
Boolean |
getEbsOptimized()
This property cannot be updated.
|
String |
getHostname()
The instance host name.
|
Boolean |
getInstallUpdatesOnBoot()
Whether to install operating system and package updates when the
instance boots.
|
String |
getInstanceId()
The instance ID.
|
String |
getInstanceType()
The instance type, such as
t2.micro . |
List<String> |
getLayerIds()
The instance's layer IDs.
|
String |
getOs()
The instance's operating system, which must be set to one of the
following.
|
String |
getSshKeyName()
The instance's Amazon EC2 key name.
|
int |
hashCode() |
Boolean |
isEbsOptimized()
This property cannot be updated.
|
Boolean |
isInstallUpdatesOnBoot()
Whether to install operating system and package updates when the
instance boots.
|
void |
setAgentVersion(String agentVersion)
The default AWS OpsWorks agent version.
|
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 |
setEbsOptimized(Boolean ebsOptimized)
This property cannot be updated.
|
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 |
setInstanceId(String instanceId)
The instance ID.
|
void |
setInstanceType(String instanceType)
The instance type, such as
t2.micro . |
void |
setLayerIds(Collection<String> layerIds)
The instance's layer IDs.
|
void |
setOs(String os)
The instance's operating system, which must be set to one of the
following.
|
void |
setSshKeyName(String sshKeyName)
The instance's Amazon EC2 key name.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateInstanceRequest |
withAgentVersion(String agentVersion)
The default AWS OpsWorks agent version.
|
UpdateInstanceRequest |
withAmiId(String amiId)
A custom AMI ID to be used to create the instance.
|
UpdateInstanceRequest |
withArchitecture(Architecture architecture)
The instance architecture.
|
UpdateInstanceRequest |
withArchitecture(String architecture)
The instance architecture.
|
UpdateInstanceRequest |
withAutoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
|
UpdateInstanceRequest |
withAutoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
|
UpdateInstanceRequest |
withEbsOptimized(Boolean ebsOptimized)
This property cannot be updated.
|
UpdateInstanceRequest |
withHostname(String hostname)
The instance host name.
|
UpdateInstanceRequest |
withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the
instance boots.
|
UpdateInstanceRequest |
withInstanceId(String instanceId)
The instance ID.
|
UpdateInstanceRequest |
withInstanceType(String instanceType)
The instance type, such as
t2.micro . |
UpdateInstanceRequest |
withLayerIds(Collection<String> layerIds)
The instance's layer IDs.
|
UpdateInstanceRequest |
withLayerIds(String... layerIds)
The instance's layer IDs.
|
UpdateInstanceRequest |
withOs(String os)
The instance's operating system, which must be set to one of the
following.
|
UpdateInstanceRequest |
withSshKeyName(String sshKeyName)
The instance's Amazon EC2 key name.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getInstanceId()
public void setInstanceId(String instanceId)
instanceId
- The instance ID.public UpdateInstanceRequest withInstanceId(String instanceId)
Returns a reference to this object so that method calls can be chained together.
instanceId
- The instance ID.public List<String> getLayerIds()
public void setLayerIds(Collection<String> layerIds)
layerIds
- The instance's layer IDs.public UpdateInstanceRequest 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
- The instance's layer IDs.public UpdateInstanceRequest withLayerIds(Collection<String> layerIds)
Returns a reference to this object so that method calls can be chained together.
layerIds
- The instance's layer IDs.public String getInstanceType()
t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. 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.t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. 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 void setInstanceType(String instanceType)
t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. 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.instanceType
- The instance type, such as t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. 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 UpdateInstanceRequest withInstanceType(String instanceType)
t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. 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.
Returns a reference to this object so that method calls can be chained together.
instanceType
- The instance type, such as t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. 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
AutoScalingType
public void setAutoScalingType(String autoScalingType)
Constraints:
Allowed Values: load, timer
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can
use only time-based instances.AutoScalingType
public UpdateInstanceRequest 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. Windows stacks can
use only time-based instances.AutoScalingType
public void setAutoScalingType(AutoScalingType autoScalingType)
Constraints:
Allowed Values: load, timer
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can
use only time-based instances.AutoScalingType
public UpdateInstanceRequest 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. Windows stacks can
use only time-based instances.AutoScalingType
public String getHostname()
public void setHostname(String hostname)
hostname
- The instance host name.public UpdateInstanceRequest 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 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
Amazon Linux 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
public void setOs(String os)
Amazon Linux 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For 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 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
public UpdateInstanceRequest withOs(String os)
Amazon Linux 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For 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 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For 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 must be
based on one of the supported operating systems. For more information,
see Instances
Os
to
Custom
.public UpdateInstanceRequest 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 must be
based on one of the supported operating systems. For more information,
see Instances
Os
to
Custom
.public String getSshKeyName()
public void setSshKeyName(String sshKeyName)
sshKeyName
- The instance's Amazon EC2 key name.public UpdateInstanceRequest withSshKeyName(String sshKeyName)
Returns a reference to this object so that method calls can be chained together.
sshKeyName
- The instance's Amazon EC2 key name.public String getArchitecture()
Constraints:
Allowed Values: x86_64, i386
Architecture
public void setArchitecture(String architecture)
Constraints:
Allowed Values: x86_64, i386
architecture
- The instance architecture. 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.Architecture
public UpdateInstanceRequest withArchitecture(String architecture)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: x86_64, i386
architecture
- The instance architecture. 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.Architecture
public void setArchitecture(Architecture architecture)
Constraints:
Allowed Values: x86_64, i386
architecture
- The instance architecture. 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.Architecture
public UpdateInstanceRequest withArchitecture(Architecture architecture)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: x86_64, i386
architecture
- The instance architecture. 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.Architecture
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 by 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 by 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 by 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 by 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 UpdateInstanceRequest 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 by 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 by 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 by 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 by 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
- This property cannot be updated.public UpdateInstanceRequest withEbsOptimized(Boolean ebsOptimized)
Returns a reference to this object so that method calls can be chained together.
ebsOptimized
- This property cannot be updated.public Boolean getEbsOptimized()
public String getAgentVersion()
INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
public void setAgentVersion(String agentVersion)
INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
agentVersion
- The default AWS OpsWorks agent version. You have the following
options: INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
public UpdateInstanceRequest withAgentVersion(String agentVersion)
INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
Returns a reference to this object so that method calls can be chained together.
agentVersion
- The default AWS OpsWorks agent version. You have the following
options: INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
public String toString()
toString
in class Object
Object.toString()
public UpdateInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.