AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the UpdateStack operation against AWS OpsWorks.

Syntax

Update-OPSStack
-StackId <String>
-AgentVersion <String>
-Attribute <Hashtable>
-ChefConfiguration_BerkshelfVersion <String>
-CustomJson <String>
-DefaultAvailabilityZone <String>
-DefaultInstanceProfileArn <String>
-DefaultOs <String>
-DefaultRootDeviceType <RootDeviceType>
-DefaultSshKeyName <String>
-DefaultSubnetId <String>
-HostnameTheme <String>
-ChefConfiguration_ManageBerkshelf <Boolean>
-ConfigurationManager_Name <String>
-Name <String>
-CustomCookbooksSource_Password <String>
-CustomCookbooksSource_Revision <String>
-ServiceRoleArn <String>
-CustomCookbooksSource_SshKey <String>
-CustomCookbooksSource_Type <SourceType>
-CustomCookbooksSource_Url <String>
-UseCustomCookbook <Boolean>
-UseOpsworksSecurityGroup <Boolean>
-CustomCookbooksSource_Username <String>
-ConfigurationManager_Version <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Updates a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

-AgentVersion <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.
Required?False
Position?Named
Accept pipeline input?False
-Attribute <Hashtable>
One or more user-defined key-value pairs to be added to the stack attributes.
Required?False
Position?Named
Accept pipeline input?False
-ChefConfiguration_BerkshelfVersion <String>
The Berkshelf version.
Required?False
Position?Named
Accept pipeline input?False
-ChefConfiguration_ManageBerkshelf <Boolean>
Whether to enable Berkshelf.
Required?False
Position?Named
Accept pipeline input?False
-ConfigurationManager_Name <String>
The name. This parameter must be set to "Chef".
Required?False
Position?Named
Accept pipeline input?False
-ConfigurationManager_Version <String>
The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.
Required?False
Position?Named
Accept pipeline input?False
-CustomCookbooksSource_Password <String>
When included in a request, the parameter depends on the repository type.
  • For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
  • For HTTP bundles and Subversion repositories, set Password to the password.
For more information on how to safely handle IAM credentials, see http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
Required?False
Position?Named
Accept pipeline input?False
-CustomCookbooksSource_Revision <String>
The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
Required?False
Position?Named
Accept pipeline input?False
-CustomCookbooksSource_SshKey <String>
In requests, the repository's SSH key.In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
Required?False
Position?Named
Accept pipeline input?False
-CustomCookbooksSource_Type <SourceType>
The repository type.
Required?False
Position?Named
Accept pipeline input?False
-CustomCookbooksSource_Url <String>
The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.
Required?False
Position?Named
Accept pipeline input?False
-CustomCookbooksSource_Username <String>
This parameter depends on the repository type.
  • For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
  • For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.
Required?False
Position?Named
Accept pipeline input?False
-CustomJson <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 on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
Required?False
Position?Named
Accept pipeline input?False
-DefaultAvailabilityZone <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.
Required?False
Position?Named
Accept pipeline input?False
-DefaultInstanceProfileArn <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.
Required?False
Position?Named
Accept pipeline input?False
-DefaultOs <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.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.
  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
Required?False
Position?Named
Accept pipeline input?False
-DefaultRootDeviceType <RootDeviceType>
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.
Required?False
Position?Named
Accept pipeline input?False
-DefaultSshKeyName <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.
Required?False
Position?Named
Accept pipeline input?False
-DefaultSubnetId <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.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-HostnameTheme <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.
Required?False
Position?Named
Accept pipeline input?False
-Name <String>
The stack's new name.
Required?False
Position?Named
Accept pipeline input?False
-PassThru <SwitchParameter>
Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-ServiceRoleArn <String>
Do not use this parameter. You cannot update a stack's service role.
Required?False
Position?Named
Accept pipeline input?False
-StackId <String>
The stack ID.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-UseCustomCookbook <Boolean>
Whether the stack uses custom cookbooks.
Required?False
Position?Named
Accept pipeline input?False
-UseOpsworksSecurityGroup <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the StackId parameter.

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateStackResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z