public static interface UpdateInstanceRequest.Builder extends OpsWorksRequest.Builder, CopyableBuilder<UpdateInstanceRequest.Builder,UpdateInstanceRequest>
Modifier and Type | Method and Description |
---|---|
UpdateInstanceRequest.Builder |
agentVersion(String agentVersion)
The default AWS OpsWorks Stacks agent version.
|
UpdateInstanceRequest.Builder |
amiId(String amiId)
The ID of the AMI that was used to create the instance.
|
UpdateInstanceRequest.Builder |
architecture(Architecture architecture)
The instance architecture.
|
UpdateInstanceRequest.Builder |
architecture(String architecture)
The instance architecture.
|
UpdateInstanceRequest.Builder |
autoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
|
UpdateInstanceRequest.Builder |
autoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
|
UpdateInstanceRequest.Builder |
ebsOptimized(Boolean ebsOptimized)
This property cannot be updated.
|
UpdateInstanceRequest.Builder |
hostname(String hostname)
The instance host name.
|
UpdateInstanceRequest.Builder |
installUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots.
|
UpdateInstanceRequest.Builder |
instanceId(String instanceId)
The instance ID.
|
UpdateInstanceRequest.Builder |
instanceType(String instanceType)
The instance type, such as
t2.micro . |
UpdateInstanceRequest.Builder |
layerIds(Collection<String> layerIds)
The instance's layer IDs.
|
UpdateInstanceRequest.Builder |
layerIds(String... layerIds)
The instance's layer IDs.
|
UpdateInstanceRequest.Builder |
os(String os)
The instance's operating system, which must be set to one of the following.
|
UpdateInstanceRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateInstanceRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
UpdateInstanceRequest.Builder |
sshKeyName(String sshKeyName)
The instance's Amazon EC2 key name.
|
build
overrideConfiguration
copy
applyMutation, build
UpdateInstanceRequest.Builder instanceId(String instanceId)
The instance ID.
instanceId
- The instance ID.UpdateInstanceRequest.Builder layerIds(Collection<String> layerIds)
The instance's layer IDs.
layerIds
- The instance's layer IDs.UpdateInstanceRequest.Builder layerIds(String... layerIds)
The instance's layer IDs.
layerIds
- The instance's layer IDs.UpdateInstanceRequest.Builder instanceType(String 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.
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.UpdateInstanceRequest.Builder autoScalingType(String autoScalingType)
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.AutoScalingType
,
AutoScalingType
UpdateInstanceRequest.Builder autoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.AutoScalingType
,
AutoScalingType
UpdateInstanceRequest.Builder hostname(String hostname)
The instance host name.
hostname
- The instance host name.UpdateInstanceRequest.Builder os(String 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 2017.03
,
Amazon Linux 2016.09
, Amazon Linux 2016.03
, Amazon Linux 2015.09
, or
Amazon Linux 2015.03
.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS
, Ubuntu 14.04 LTS
, or
Ubuntu 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
, or
Microsoft Windows Server 2012 R2 with SQL Server Web
.
For more information on the 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 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.
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 2017.03
, Amazon Linux 2016.09
, Amazon Linux 2016.03
,
Amazon Linux 2015.09
, or Amazon Linux 2015.03
.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS
,
Ubuntu 14.04 LTS
, or Ubuntu 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
, or
Microsoft Windows Server 2012 R2 with SQL Server Web
.
For more information on the 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 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.
UpdateInstanceRequest.Builder amiId(String 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.
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.UpdateInstanceRequest.Builder sshKeyName(String sshKeyName)
The instance's Amazon EC2 key name.
sshKeyName
- The instance's Amazon EC2 key name.UpdateInstanceRequest.Builder architecture(String 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
- 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
,
Architecture
UpdateInstanceRequest.Builder architecture(Architecture 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
- 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
,
Architecture
UpdateInstanceRequest.Builder installUpdatesOnBoot(Boolean 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.
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.
UpdateInstanceRequest.Builder ebsOptimized(Boolean ebsOptimized)
This property cannot be updated.
ebsOptimized
- This property cannot be updated.UpdateInstanceRequest.Builder agentVersion(String 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.
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.
UpdateInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.UpdateInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.