Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

UpdateApp

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.

Request Syntax

{ "AppId": "string", "AppSource": { "Password": "string", "Revision": "string", "SshKey": "string", "Type": "string", "Url": "string", "Username": "string" }, "Attributes": { "string" : "string" }, "DataSources": [ { "Arn": "string", "DatabaseName": "string", "Type": "string" } ], "Description": "string", "Domains": [ "string" ], "EnableSsl": boolean, "Environment": [ { "Key": "string", "Secure": boolean, "Value": "string" } ], "Name": "string", "SslConfiguration": { "Certificate": "string", "Chain": "string", "PrivateKey": "string" }, "Type": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AppId

The app ID.

Type: String

Required: Yes

AppSource

A Source object that specifies the app repository.

Type: Source object

Required: No

Attributes

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

Type: String to string map

Valid Keys: DocumentRoot | RailsEnv | AutoBundleOnDeploy | AwsFlowRubySettings

Required: No

DataSources

The app's data sources.

Type: Array of DataSource objects

Required: No

Description

A description of the app.

Type: String

Required: No

Domains

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

Type: Array of strings

Required: No

EnableSsl

Whether SSL is enabled for the app.

Type: Boolean

Required: No

Environment

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)."

Note

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Type: Array of EnvironmentVariable objects

Required: No

Name

The app name.

Type: String

Required: No

SslConfiguration

An SslConfiguration object with the SSL configuration.

Type: SslConfiguration object

Required: No

Type

The app type.

Type: String

Valid Values: aws-flow-ruby | java | rails | php | nodejs | static | other

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: