CfnAppProps

class aws_cdk.aws_opsworks.CfnAppProps(*, name, stack_id, type, app_source=None, attributes=None, data_sources=None, description=None, domains=None, enable_ssl=None, environment=None, shortname=None, ssl_configuration=None)

Bases: object

Properties for defining a CfnApp.

Parameters
  • name (str) – The app name.

  • stack_id (str) – The stack ID.

  • type (str) – 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 .

  • app_source (Union[SourceProperty, Dict[str, Any], IResolvable, None]) – A Source object that specifies the app repository.

  • attributes (Union[IResolvable, Mapping[str, str], None]) – One or more user-defined key/value pairs to be added to the stack attributes.

  • data_sources (Union[IResolvable, Sequence[Union[DataSourceProperty, Dict[str, Any], IResolvable]], None]) – The app’s data source.

  • description (Optional[str]) – A description of the app.

  • domains (Optional[Sequence[str]]) – The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

  • enable_ssl (Union[bool, IResolvable, None]) – Whether to enable SSL for the app.

  • environment (Union[IResolvable, Sequence[Union[EnvironmentVariableProperty, Dict[str, Any], IResolvable]], None]) – 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).” .. epigraph:: If you have specified one or more environment variables, you cannot modify the stack’s Chef version.

  • shortname (Optional[str]) – The app’s short name.

  • ssl_configuration (Union[SslConfigurationProperty, Dict[str, Any], IResolvable, None]) – An SslConfiguration object with the SSL configuration.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opsworks as opsworks

cfn_app_props = opsworks.CfnAppProps(
    name="name",
    stack_id="stackId",
    type="type",

    # the properties below are optional
    app_source=opsworks.CfnApp.SourceProperty(
        password="password",
        revision="revision",
        ssh_key="sshKey",
        type="type",
        url="url",
        username="username"
    ),
    attributes={
        "attributes_key": "attributes"
    },
    data_sources=[opsworks.CfnApp.DataSourceProperty(
        arn="arn",
        database_name="databaseName",
        type="type"
    )],
    description="description",
    domains=["domains"],
    enable_ssl=False,
    environment=[opsworks.CfnApp.EnvironmentVariableProperty(
        key="key",
        value="value",

        # the properties below are optional
        secure=False
    )],
    shortname="shortname",
    ssl_configuration=opsworks.CfnApp.SslConfigurationProperty(
        certificate="certificate",
        chain="chain",
        private_key="privateKey"
    )
)

Attributes

app_source

A Source object that specifies the app repository.

Link

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

Return type

Union[SourceProperty, IResolvable, None]

attributes

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

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

data_sources

The app’s data source.

Link

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

Return type

Union[IResolvable, List[Union[DataSourceProperty, IResolvable]], None]

description

A description of the app.

Link

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

Return type

Optional[str]

domains

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

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

Link

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

Return type

Optional[List[str]]

enable_ssl

Whether to enable SSL for the app.

Link

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

Return type

Union[bool, IResolvable, None]

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 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).” .. epigraph:

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

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

Return type

Union[IResolvable, List[Union[EnvironmentVariableProperty, IResolvable]], None]

name

The app name.

Link

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

Return type

str

shortname

The app’s short name.

Link

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

Return type

Optional[str]

ssl_configuration

An SslConfiguration object with the SSL configuration.

Link

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

Return type

Union[SslConfigurationProperty, IResolvable, None]

stack_id

The stack ID.

Link

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

Return type

str

type

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 .

Link

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

Return type

str