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

Calls the AWS OpsWorks UpdateApp API operation.

Syntax

Update-OPSApp
-AppId <String>
-Attribute <Hashtable>
-SslConfiguration_Certificate <String>
-SslConfiguration_Chain <String>
-DataSource <DataSource[]>
-Description <String>
-Domain <String[]>
-EnableSsl <Boolean>
-Environment <EnvironmentVariable[]>
-Name <String>
-AppSource_Password <String>
-SslConfiguration_PrivateKey <String>
-AppSource_Revision <String>
-AppSource_SshKey <String>
-AppSource_Type <SourceType>
-Type <AppType>
-AppSource_Url <String>
-AppSource_Username <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonOpsWorksConfig>

Description

Updates a specified app. Required Permissions: To use this action, an IAM user must have a Deploy or 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

-AppId <String>
The app ID.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AppSource_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 https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppSource_Revision <String>
The application's version. 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?True (ByPropertyName)
-AppSource_SshKey <String>
In requests, the repository's SSH key.In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppSource_Type <SourceType>
The repository type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppSource_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?True (ByPropertyName)
-AppSource_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?True (ByPropertyName)
-Attribute <Hashtable>
One or more user-defined key/value pairs to be added to the stack attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributes
-ClientConfig <AmazonOpsWorksConfig>
Amazon.PowerShell.Cmdlets.OPS.AmazonOpsWorksClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSource <DataSource[]>
The app's data sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSources
-Description <String>
A description of the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String[]>
The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomains
-EnableSsl <Boolean>
Whether SSL is enabled for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment <EnvironmentVariable[]>
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."If you have specified one or more environment variables, you cannot modify the stack's Chef version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-Name <String>
The app name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorks.Model.UpdateAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SslConfiguration_Certificate <String>
The contents of the certificate's domain.crt file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SslConfiguration_Chain <String>
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SslConfiguration_PrivateKey <String>
The private key; the contents of the certificate's domain.kex file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <AppType>
The app type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.OpsWorks.Model.UpdateAppResponse
This cmdlet does not generate any output.The service response (type Amazon.OpsWorks.Model.UpdateAppResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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