interface CfnAppProps

Language	Type name
.NET	`Amazon.CDK.AWS.OpsWorks.CfnAppProps`
Java	`software.amazon.awscdk.services.opsworks.CfnAppProps`
Python	`aws_cdk.aws_opsworks.CfnAppProps`
TypeScript	`@aws-cdk/aws-opsworks` » `CfnAppProps`

Properties for defining a CfnApp.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as opsworks from '@aws-cdk/aws-opsworks';
const cfnAppProps: opsworks.CfnAppProps = {
  name: 'name',
  stackId: 'stackId',
  type: 'type',

  // the properties below are optional
  appSource: {
    password: 'password',
    revision: 'revision',
    sshKey: 'sshKey',
    type: 'type',
    url: 'url',
    username: 'username',
  },
  attributes: {
    attributesKey: 'attributes',
  },
  dataSources: [{
    arn: 'arn',
    databaseName: 'databaseName',
    type: 'type',
  }],
  description: 'description',
  domains: ['domains'],
  enableSsl: false,
  environment: [{
    key: 'key',
    value: 'value',

    // the properties below are optional
    secure: false,
  }],
  shortname: 'shortname',
  sslConfiguration: {
    certificate: 'certificate',
    chain: 'chain',
    privateKey: 'privateKey',
  },
};

Properties

Name	Type	Description
name	`string`	The app name.
stackId	`string`	The stack ID.
type	`string`	The app type.
appSource?	`SourceProperty` `\|` `IResolvable`	A `Source` object that specifies the app repository.
attributes?	`IResolvable` `\| { [string]: string }`	One or more user-defined key/value pairs to be added to the stack attributes.
dataSources?	`IResolvable` `\|` `IResolvable` `\|` `DataSourceProperty[]`	The app's data source.
description?	`string`	A description of the app.
domains?	`string[]`	The app virtual host settings, with multiple domains separated by commas.
enableSsl?	`boolean \|` `IResolvable`	Whether to enable SSL for the app.
environment?	`IResolvable` `\|` `IResolvable` `\|` `EnvironmentVariableProperty[]`	An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
shortname?	`string`	The app's short name.
sslConfiguration?	`IResolvable` `\|` `SslConfigurationProperty`	An `SslConfiguration` object with the SSL configuration.

name

Type: string

The app name.

stackId

Type: string

The stack ID.

type

Type: string

The app type.

Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other .

appSource?

Type: SourceProperty | IResolvable (optional)

A Source object that specifies the app repository.

attributes?

Type: IResolvable | { [string]: string } (optional)

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

dataSources?

Type: IResolvable | IResolvable | DataSourceProperty[] (optional)

The app's data source.

description?

Type: string (optional)

A description of the app.

domains?

Type: string[] (optional)

The app virtual host settings, with multiple domains separated by commas.

For example: 'www.example.com, example.com'

enableSsl?

Type: boolean | IResolvable (optional)

Whether to enable SSL for the app.

environment?

Type: IResolvable | IResolvable | EnvironmentVariableProperty[] (optional)

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 instance. 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 20KB)."

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

shortname?

Type: string (optional)

The app's short name.

sslConfiguration?

Type: IResolvable | SslConfigurationProperty (optional)

An SslConfiguration object with the SSL configuration.