API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see

We welcome your feedback on this new version of the documentation. Send your comments to


import ""

type UpdateInstanceInput struct { AgentVersion *string `type:"string"` AmiId *string `type:"string"` Architecture *string `type:"string" enum:"Architecture"` AutoScalingType *string `type:"string" enum:"AutoScalingType"` EbsOptimized *bool `type:"boolean"` Hostname *string `type:"string"` InstallUpdatesOnBoot *bool `type:"boolean"` InstanceId *string `type:"string" required:"true"` InstanceType *string `type:"string"` LayerIds []*string `type:"list"` Os *string `type:"string"` SshKeyName *string `type:"string"` }


Type: *string

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.


Type: *string

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.


Type: *string

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 (


Type: *string

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.


Type: *bool

This property cannot be updated.


Type: *string

The instance host name.


Type: *bool

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.


Type: *string

The instance ID.

InstanceId is a required field


Type: *string

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.


Type: []*string

The instance's layer IDs.


Type: *string

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.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 (

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.


Type: *string

The instance's Amazon EC2 key name.



func (s UpdateInstanceInput) GoString() string

GoString returns the string representation


func (s *UpdateInstanceInput) SetAgentVersion(v string) *UpdateInstanceInput

SetAgentVersion sets the AgentVersion field's value.


func (s *UpdateInstanceInput) SetAmiId(v string) *UpdateInstanceInput

SetAmiId sets the AmiId field's value.


func (s *UpdateInstanceInput) SetArchitecture(v string) *UpdateInstanceInput

SetArchitecture sets the Architecture field's value.


func (s *UpdateInstanceInput) SetAutoScalingType(v string) *UpdateInstanceInput

SetAutoScalingType sets the AutoScalingType field's value.


func (s *UpdateInstanceInput) SetEbsOptimized(v bool) *UpdateInstanceInput

SetEbsOptimized sets the EbsOptimized field's value.


func (s *UpdateInstanceInput) SetHostname(v string) *UpdateInstanceInput

SetHostname sets the Hostname field's value.


func (s *UpdateInstanceInput) SetInstallUpdatesOnBoot(v bool) *UpdateInstanceInput

SetInstallUpdatesOnBoot sets the InstallUpdatesOnBoot field's value.


func (s *UpdateInstanceInput) SetInstanceId(v string) *UpdateInstanceInput

SetInstanceId sets the InstanceId field's value.


func (s *UpdateInstanceInput) SetInstanceType(v string) *UpdateInstanceInput

SetInstanceType sets the InstanceType field's value.


func (s *UpdateInstanceInput) SetLayerIds(v []*string) *UpdateInstanceInput

SetLayerIds sets the LayerIds field's value.


func (s *UpdateInstanceInput) SetOs(v string) *UpdateInstanceInput

SetOs sets the Os field's value.


func (s *UpdateInstanceInput) SetSshKeyName(v string) *UpdateInstanceInput

SetSshKeyName sets the SshKeyName field's value.


func (s UpdateInstanceInput) String() string

String returns the string representation


func (s *UpdateInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: