Class UpdateInstanceRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The default AWS OpsWorks agent version.getAmiId()
A custom AMI ID to be used to create the instance.The instance architecture.For load-based or time-based instances, the type.This property cannot be updated.The instance host name.Whether to install operating system and package updates when the instance boots.The instance ID.The instance type, such ast2.micro
.The instance's layer IDs.getOs()
The instance's operating system, which must be set to one of the following.The instance's Amazon EC2 key name.int
hashCode()
This property cannot be updated.Whether to install operating system and package updates when the instance boots.void
setAgentVersion
(String agentVersion) The default AWS OpsWorks agent version.void
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 ast2.micro
.void
setLayerIds
(Collection<String> layerIds) The instance's layer IDs.void
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.toString()
Returns a string representation of this object; useful for testing and debugging.withAgentVersion
(String agentVersion) The default AWS OpsWorks agent version.A custom AMI ID to be used to create the instance.withArchitecture
(Architecture architecture) The instance architecture.withArchitecture
(String architecture) The instance architecture.withAutoScalingType
(AutoScalingType autoScalingType) For load-based or time-based instances, the type.withAutoScalingType
(String autoScalingType) For load-based or time-based instances, the type.withEbsOptimized
(Boolean ebsOptimized) This property cannot be updated.withHostname
(String hostname) The instance host name.withInstallUpdatesOnBoot
(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.withInstanceId
(String instanceId) The instance ID.withInstanceType
(String instanceType) The instance type, such ast2.micro
.withLayerIds
(String... layerIds) The instance's layer IDs.withLayerIds
(Collection<String> layerIds) The instance's layer IDs.The instance's operating system, which must be set to one of the following.withSshKeyName
(String sshKeyName) The instance's Amazon EC2 key name.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 Details
-
UpdateInstanceRequest
public UpdateInstanceRequest()
-
-
Method Details
-
setInstanceId
The instance ID.
- Parameters:
instanceId
- The instance ID.
-
getInstanceId
The instance ID.
- Returns:
- The instance ID.
-
withInstanceId
The instance ID.
- Parameters:
instanceId
- The instance ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLayerIds
The instance's layer IDs.
- Returns:
- The instance's layer IDs.
-
setLayerIds
The instance's layer IDs.
- Parameters:
layerIds
- The instance's layer IDs.
-
withLayerIds
The instance's layer IDs.
NOTE: This method appends the values to the existing list (if any). Use
setLayerIds(java.util.Collection)
orwithLayerIds(java.util.Collection)
if you want to override the existing values.- Parameters:
layerIds
- The instance's layer IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLayerIds
The instance's layer IDs.
- Parameters:
layerIds
- The instance's layer IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInstanceType
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.- Parameters:
instanceType
- The instance type, such ast2.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.
-
getInstanceType
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.- Returns:
- 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.
-
withInstanceType
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.- Parameters:
instanceType
- The instance type, such ast2.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:
- Returns a reference to this object so that method calls can be chained together.
-
setAutoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- See Also:
-
getAutoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Returns:
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- See Also:
-
withAutoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAutoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- See Also:
-
withAutoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setHostname
The instance host name.
- Parameters:
hostname
- The instance host name.
-
getHostname
The instance host name.
- Returns:
- The instance host name.
-
withHostname
The instance host name.
- Parameters:
hostname
- The instance host name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOs
The instance's operating system, which must be set to one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
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.You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. - Parameters:
os
- The instance's operating system, which must be set to one of the following.- A supported Linux operating system: An Amazon Linux version,
such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
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.You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. - A supported Linux operating system: An Amazon Linux version,
such as
- A supported Linux operating system: An Amazon Linux version, such as
-
getOs
The instance's operating system, which must be set to one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
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.You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. - Returns:
- The instance's operating system, which must be set to one of the
following.
- A supported Linux operating system: An Amazon Linux version,
such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
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.You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. - A supported Linux operating system: An Amazon Linux version,
such as
- A supported Linux operating system: An Amazon Linux version, such as
-
withOs
The instance's operating system, which must be set to one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
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.You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. - Parameters:
os
- The instance's operating system, which must be set to one of the following.- A supported Linux operating system: An Amazon Linux version,
such as
Amazon Linux 2015.03
,Red Hat Enterprise Linux 7
,Ubuntu 12.04 LTS
, orUbuntu 14.04 LTS
. Microsoft Windows Server 2012 R2 Base
.- A custom AMI:
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.You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. - A supported Linux operating system: An Amazon Linux version,
such as
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- A supported Linux operating system: An Amazon Linux version, such as
-
setAmiId
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
If you specify a custom AMI, you must set Os
toCustom
.- Parameters:
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 InstancesIf you specify a custom AMI, you must set Os
toCustom
.
-
getAmiId
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
If you specify a custom AMI, you must set Os
toCustom
.- Returns:
- 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
If you specify a custom AMI, you must set Os
toCustom
.
-
withAmiId
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
If you specify a custom AMI, you must set Os
toCustom
.- Parameters:
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 InstancesIf you specify a custom AMI, you must set Os
toCustom
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSshKeyName
The instance's Amazon EC2 key name.
- Parameters:
sshKeyName
- The instance's Amazon EC2 key name.
-
getSshKeyName
The instance's Amazon EC2 key name.
- Returns:
- The instance's Amazon EC2 key name.
-
withSshKeyName
The instance's Amazon EC2 key name.
- Parameters:
sshKeyName
- The instance's Amazon EC2 key name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setArchitecture
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.
- Parameters:
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.- See Also:
-
getArchitecture
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.
- Returns:
- 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.
- See Also:
-
withArchitecture
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setArchitecture
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.
- Parameters:
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.- See Also:
-
withArchitecture
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setInstallUpdatesOnBoot
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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.- Parameters:
installUpdatesOnBoot
- Whether to install operating system and package updates when the instance boots. The default value istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
getInstallUpdatesOnBoot
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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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:
- 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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
withInstallUpdatesOnBoot
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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.- Parameters:
installUpdatesOnBoot
- Whether to install operating system and package updates when the instance boots. The default value istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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:
- Returns a reference to this object so that method calls can be chained together.
-
isInstallUpdatesOnBoot
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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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:
- 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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
setEbsOptimized
This property cannot be updated.
- Parameters:
ebsOptimized
- This property cannot be updated.
-
getEbsOptimized
This property cannot be updated.
- Returns:
- This property cannot be updated.
-
withEbsOptimized
This property cannot be updated.
- Parameters:
ebsOptimized
- This property cannot be updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEbsOptimized
This property cannot be updated.
- Returns:
- This property cannot be updated.
-
setAgentVersion
The default AWS OpsWorks agent version. You have the following options:
INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
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.- Parameters:
agentVersion
- The default AWS OpsWorks agent version. You have the following options:INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
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.
-
getAgentVersion
The default AWS OpsWorks agent version. You have the following options:
INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
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:
- The default AWS OpsWorks agent version. You have the following
options:
INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
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.
-
withAgentVersion
The default AWS OpsWorks agent version. You have the following options:
INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
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.- Parameters:
agentVersion
- The default AWS OpsWorks agent version. You have the following options:INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
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:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-