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

App

A description of the app.

Contents

AppId

The app ID.

Type: String

Required: No

AppSource

A Source object that describes the app repository.

Type: Source object

Required: No

Attributes

The stack attributes.

Type: String to string map

Valid Keys: DocumentRoot | RailsEnv | AutoBundleOnDeploy | AwsFlowRubySettings

Required: No

CreatedAt

When the app was created.

Type: String

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 vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

Type: Array of strings

Required: No

EnableSsl

Whether to enable SSL 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.

Note

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.

Type: Array of EnvironmentVariable objects

Required: No

Name

The app name.

Type: String

Required: No

Shortname

The app's short name.

Type: String

Required: No

SslConfiguration

An SslConfiguration object with the SSL configuration.

Type: SslConfiguration object

Required: No

StackId

The app stack ID.

Type: String

Required: No

Type

The app type.

Type: String

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

Required: No

See Also

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

On this page: