Class UpdateInstanceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateInstanceRequest.Builder,
UpdateInstanceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The default AWS OpsWorks Stacks agent version.final String
amiId()
The ID of the AMI that was used to create the instance.final Architecture
The instance architecture.final String
The instance architecture.final AutoScalingType
For load-based or time-based instances, the type.final String
For load-based or time-based instances, the type.builder()
final Boolean
This property cannot be updated.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LayerIds property.final String
hostname()
The instance host name.final Boolean
Whether to install operating system and package updates when the instance boots.final String
The instance ID.final String
The instance type, such ast2.micro
.layerIds()
The instance's layer IDs.final String
os()
The instance's operating system, which must be set to one of the following.static Class
<? extends UpdateInstanceRequest.Builder> final String
The instance's Amazon EC2 key name.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceId
The instance ID.
- Returns:
- The instance ID.
-
hasLayerIds
public final boolean hasLayerIds()For responses, this returns true if the service returned a value for the LayerIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
layerIds
The instance's layer IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLayerIds()
method.- Returns:
- The instance's layer IDs.
-
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.- 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.
-
autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
If the service returns an enum value that is not available in the current SDK version,
autoScalingType
will returnAutoScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoScalingTypeAsString()
.- Returns:
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- See Also:
-
autoScalingTypeAsString
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
If the service returns an enum value that is not available in the current SDK version,
autoScalingType
will returnAutoScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoScalingTypeAsString()
.- Returns:
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
- See Also:
-
hostname
The instance host name.
- Returns:
- The instance host name.
-
os
The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.
-
A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. -
CentOS Linux 7
-
Red Hat Enterprise Linux 7
-
A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
.
For more information about supported operating systems, see AWS OpsWorks Stacks 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 about supported operating systems, see Operating Systems. For more information about 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. You cannot update an instance
that is using a custom AMI.
-
A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. -
CentOS Linux 7
-
Red Hat Enterprise Linux 7
-
A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
.
For more information about supported operating systems, see AWS OpsWorks Stacks 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 about supported operating systems, see Operating Systems. For more information about 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.
-
-
-
amiId
The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.
- Returns:
- The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.
-
sshKeyName
The instance's Amazon EC2 key name.
- Returns:
- The instance's Amazon EC2 key name.
-
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.
If the service returns an enum value that is not available in the current SDK version,
architecture
will returnArchitecture.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromarchitectureAsString()
.- 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:
-
architectureAsString
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.
If the service returns an enum value that is not available in the current SDK version,
architecture
will returnArchitecture.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromarchitectureAsString()
.- 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:
-
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 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.
-
ebsOptimized
This property cannot be updated.
- Returns:
- This property cannot be updated.
-
agentVersion
The default AWS OpsWorks Stacks 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 Stacks 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.AgentVersion cannot be set to Chef 12.2.
- Returns:
- The default AWS OpsWorks Stacks 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 Stacks 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.AgentVersion cannot be set to Chef 12.2.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateInstanceRequest.Builder,
UpdateInstanceRequest> - Specified by:
toBuilder
in classOpsWorksRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-