class Aws::OpsWorks::Types::UpdateInstanceRequest

@note When making an API call, you may pass UpdateInstanceRequest

data as a hash:

    {
      instance_id: "String", # required
      layer_ids: ["String"],
      instance_type: "String",
      auto_scaling_type: "load", # accepts load, timer
      hostname: "String",
      os: "String",
      ami_id: "String",
      ssh_key_name: "String",
      architecture: "x86_64", # accepts x86_64, i386
      install_updates_on_boot: false,
      ebs_optimized: false,
      agent_version: "String",
    }

@!attribute [rw] instance_id

The instance ID.
@return [String]

@!attribute [rw] layer_ids

The instance's layer IDs.
@return [Array<String>]

@!attribute [rw] instance_type

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][1]. The parameter values that you use to specify the various
types are in the **API Name** column of the **Available Instance
Types** table.

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
@return [String]

@!attribute [rw] auto_scaling_type

For load-based or time-based instances, the type. Windows stacks can
use only time-based instances.
@return [String]

@!attribute [rw] hostname

The instance host name.
@return [String]

@!attribute [rw] 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`, 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 about supported operating systems, see [AWS
OpsWorks Stacks Operating Systems][1].

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][1]. For
more information about how to use custom AMIs with OpsWorks, see
[Using Custom AMIs][2].

<note markdown="1"> You can specify a different Linux operating system for the updated
stack, but you cannot change from Linux to Windows or Windows to
Linux.

 </note>

[1]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html
[2]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html
@return [String]

@!attribute [rw] ami_id

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.
@return [String]

@!attribute [rw] ssh_key_name

The instance's Amazon EC2 key name.
@return [String]

@!attribute [rw] 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][1].

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
@return [String]

@!attribute [rw] install_updates_on_boot

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.

<note markdown="1"> We strongly recommend using the default value of `true`, to ensure
that your instances have the latest security updates.

 </note>
@return [Boolean]

@!attribute [rw] ebs_optimized

This property cannot be updated.
@return [Boolean]

@!attribute [rw] agent_version

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/UpdateInstanceRequest AWS API Documentation

Constants

SENSITIVE