2.233.0

interface CfnAppMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.OpsWorks.Mixins.CfnAppMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsopsworks/mixins#CfnAppMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.opsworks.mixins.CfnAppMixinProps
Pythonaws_cdk.mixins_preview.aws_opsworks.mixins.CfnAppMixinProps
TypeScript @aws-cdk/mixins-preview » aws_opsworks » mixins » CfnAppMixinProps

Properties for CfnAppPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as opsworks_mixins } from '@aws-cdk/mixins-preview/aws-opsworks';
const cfnAppMixinProps: opsworks_mixins.CfnAppMixinProps = {
  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',
    secure: false,
    value: 'value',
  }],
  name: 'name',
  shortname: 'shortname',
  sslConfiguration: {
    certificate: 'certificate',
    chain: 'chain',
    privateKey: 'privateKey',
  },
  stackId: 'stackId',
  type: 'type',
};

Properties

NameTypeDescription
appSource?IResolvable | SourcePropertyA Source object that specifies the app repository.
attributes?{ [string]: string } | IResolvableOne or more user-defined key/value pairs to be added to the stack attributes.
dataSources?IResolvable | (IResolvable | DataSourceProperty)[]The app's data source.
description?stringA description of the app.
domains?string[]The app virtual host settings, with multiple domains separated by commas.
enableSsl?boolean | IResolvableWhether 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.
name?stringThe app name.
shortname?stringThe app's short name.
sslConfiguration?IResolvable | SslConfigurationPropertyAn SslConfiguration object with the SSL configuration.
stackId?stringThe stack ID.
type?stringThe app type.

appSource?

Type: IResolvable | SourceProperty (optional)

A Source object that specifies the app repository.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource

attributes?

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes

dataSources?

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

The app's data source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources

description?

Type: string (optional)

A description of the app.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description

domains?

Type: string[] (optional)

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains

enableSsl?

Type: boolean | IResolvable (optional)

Whether to enable SSL for the app.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment

name?

Type: string (optional)

The app name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name

shortname?

Type: string (optional)

The app's short name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname

sslConfiguration?

Type: IResolvable | SslConfigurationProperty (optional)

An SslConfiguration object with the SSL configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration

stackId?

Type: string (optional)

The stack ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid

type?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type

← PreviousNext →