AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::OpsWorks::App

CfnApp

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html.

Import

import { CfnApp } from 'aws-cdk-lib/aws-opsworks';

Or use the module namespace:

import * as opsworks from 'aws-cdk-lib/aws-opsworks';
// opsworks.CfnApp

Properties

Configuration passed to the constructor as CfnAppProps.

nameRequired
string

The app name.

stackIdRequired
string

The stack ID.

typeRequired
string

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. 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` .

appSourceOptional
IResolvable | SourceProperty

A `Source` object that specifies the app repository.

attributesOptional
{ [key: string]: string } | IResolvable

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

dataSourcesOptional
IResolvable | IResolvable | DataSourceProperty[]

The app's data source.

descriptionOptional
string

A description of the app.

domainsOptional
string[]

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

enableSslOptional
boolean | IResolvable

Whether to enable SSL for the app.

environmentOptional
IResolvable | IResolvable | EnvironmentVariableProperty[]

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](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment) . 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.

shortnameOptional
string

The app's short name.

sslConfigurationOptional
IResolvable | SslConfigurationProperty

An `SslConfiguration` object with the SSL configuration.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::OpsWorks::AppView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-opsworks
CFN TypeAWS::OpsWorks::App
Properties12

Related Constructs

Explore This Service

External Links