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 UpdateStackInput struct { AgentVersion *string `type:"string"` Attributes map[string]*string `type:"map"` ChefConfiguration *ChefConfiguration `type:"structure"` ConfigurationManager *StackConfigurationManager `type:"structure"` CustomCookbooksSource *Source `type:"structure"` CustomJson *string `type:"string"` DefaultAvailabilityZone *string `type:"string"` DefaultInstanceProfileArn *string `type:"string"` DefaultOs *string `type:"string"` DefaultRootDeviceType *string `type:"string" enum:"RootDeviceType"` DefaultSshKeyName *string `type:"string"` DefaultSubnetId *string `type:"string"` HostnameTheme *string `type:"string"` Name *string `type:"string"` ServiceRoleArn *string `type:"string"` StackId *string `type:"string" required:"true"` UseCustomCookbooks *bool `type:"boolean"` UseOpsworksSecurityGroups *bool `type:"boolean"` }


Type: *string

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. 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.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.


Type: map[string]*string

One or more user-defined key-value pairs to be added to the stack attributes.


Describes the Chef configuration.


Describes the configuration manager.


Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps ( or Custom Recipes and Cookbooks (


Type: *string

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes (


Type: *string

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints ( If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.


Type: *string

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers (


Type: *string

The stack'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 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.

The default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems (


Type: *string

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device (


Type: *string

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance ( and Managing SSH Access ( You can override this setting by specifying a different key pair, or no key pair, when you create an instance (


Type: *string

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.


Type: *string

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.


Type: *string

The stack's new name.


Type: *string

Do not use this parameter. You cannot update a stack's service role.


Type: *string

The stack ID.

StackId is a required field


Type: *bool

Whether the stack uses custom cookbooks.


Type: *bool

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack (



func (s UpdateStackInput) GoString() string

GoString returns the string representation


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

SetAgentVersion sets the AgentVersion field's value.


func (s *UpdateStackInput) SetAttributes(v map[string]*string) *UpdateStackInput

SetAttributes sets the Attributes field's value.


func (s *UpdateStackInput) SetChefConfiguration(v *ChefConfiguration) *UpdateStackInput

SetChefConfiguration sets the ChefConfiguration field's value.


func (s *UpdateStackInput) SetConfigurationManager(v *StackConfigurationManager) *UpdateStackInput

SetConfigurationManager sets the ConfigurationManager field's value.


func (s *UpdateStackInput) SetCustomCookbooksSource(v *Source) *UpdateStackInput

SetCustomCookbooksSource sets the CustomCookbooksSource field's value.


func (s *UpdateStackInput) SetCustomJson(v string) *UpdateStackInput

SetCustomJson sets the CustomJson field's value.


func (s *UpdateStackInput) SetDefaultAvailabilityZone(v string) *UpdateStackInput

SetDefaultAvailabilityZone sets the DefaultAvailabilityZone field's value.


func (s *UpdateStackInput) SetDefaultInstanceProfileArn(v string) *UpdateStackInput

SetDefaultInstanceProfileArn sets the DefaultInstanceProfileArn field's value.


func (s *UpdateStackInput) SetDefaultOs(v string) *UpdateStackInput

SetDefaultOs sets the DefaultOs field's value.


func (s *UpdateStackInput) SetDefaultRootDeviceType(v string) *UpdateStackInput

SetDefaultRootDeviceType sets the DefaultRootDeviceType field's value.


func (s *UpdateStackInput) SetDefaultSshKeyName(v string) *UpdateStackInput

SetDefaultSshKeyName sets the DefaultSshKeyName field's value.


func (s *UpdateStackInput) SetDefaultSubnetId(v string) *UpdateStackInput

SetDefaultSubnetId sets the DefaultSubnetId field's value.


func (s *UpdateStackInput) SetHostnameTheme(v string) *UpdateStackInput

SetHostnameTheme sets the HostnameTheme field's value.


func (s *UpdateStackInput) SetName(v string) *UpdateStackInput

SetName sets the Name field's value.


func (s *UpdateStackInput) SetServiceRoleArn(v string) *UpdateStackInput

SetServiceRoleArn sets the ServiceRoleArn field's value.


func (s *UpdateStackInput) SetStackId(v string) *UpdateStackInput

SetStackId sets the StackId field's value.


func (s *UpdateStackInput) SetUseCustomCookbooks(v bool) *UpdateStackInput

SetUseCustomCookbooks sets the UseCustomCookbooks field's value.


func (s *UpdateStackInput) SetUseOpsworksSecurityGroups(v bool) *UpdateStackInput

SetUseOpsworksSecurityGroups sets the UseOpsworksSecurityGroups field's value.


func (s UpdateStackInput) String() string

String returns the string representation


func (s *UpdateStackInput) Validate() error

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

On this page: