CfnAppPropsMixin

class aws_cdk.mixins_preview.aws_opsworks.mixins.CfnAppPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html
CloudformationResource:: AWS::OpsWorks::App
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_opsworks import mixins as opsworks_mixins

cfn_app_props_mixin = opsworks_mixins.CfnAppPropsMixin(opsworks_mixins.CfnAppMixinProps(
    app_source=opsworks_mixins.CfnAppPropsMixin.SourceProperty(
        password="password",
        revision="revision",
        ssh_key="sshKey",
        type="type",
        url="url",
        username="username"
    ),
    attributes={
        "attributes_key": "attributes"
    },
    data_sources=[opsworks_mixins.CfnAppPropsMixin.DataSourceProperty(
        arn="arn",
        database_name="databaseName",
        type="type"
    )],
    description="description",
    domains=["domains"],
    enable_ssl=False,
    environment=[opsworks_mixins.CfnAppPropsMixin.EnvironmentVariableProperty(
        key="key",
        secure=False,
        value="value"
    )],
    name="name",
    shortname="shortname",
    ssl_configuration=opsworks_mixins.CfnAppPropsMixin.SslConfigurationProperty(
        certificate="certificate",
        chain="chain",
        private_key="privateKey"
    ),
    stack_id="stackId",
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::OpsWorks::App.

Parameters:

props (Union[CfnAppMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['appSource', 'attributes', 'dataSources', 'description', 'domains', 'enableSsl', 'environment', 'name', 'shortname', 'sslConfiguration', 'stackId', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DataSourceProperty

class CfnAppPropsMixin.DataSourceProperty(*, arn=None, database_name=None, type=None)

Bases: object

Parameters:

arn (Optional[str]) – The data source’s ARN.
database_name (Optional[str]) – The database name.
type (Optional[str]) – The data source’s type, AutoSelectOpsworksMysqlInstance , OpsworksMysqlInstance , RdsDbInstance , or None .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.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.mixins_preview.aws_opsworks import mixins as opsworks_mixins

data_source_property = opsworks_mixins.CfnAppPropsMixin.DataSourceProperty(
    arn="arn",
    database_name="databaseName",
    type="type"
)

Attributes

arn

The data source’s ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn

database_name

The database name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename

type

The data source’s type, AutoSelectOpsworksMysqlInstance , OpsworksMysqlInstance , RdsDbInstance , or None .

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

EnvironmentVariableProperty

class CfnAppPropsMixin.EnvironmentVariableProperty(*, key=None, secure=None, value=None)

Bases: object

Parameters:

key (Optional[str]) – (Required) The environment variable’s name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
secure (Union[bool, IResolvable, None]) – (Optional) Whether the variable’s value is returned by the DescribeApps action. To hide an environment variable’s value, set Secure to true . DescribeApps returns *****FILTERED***** instead of the actual value. The default value for Secure is false .
value (Optional[str]) – (Optional) The environment variable’s value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.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.mixins_preview.aws_opsworks import mixins as opsworks_mixins

environment_variable_property = opsworks_mixins.CfnAppPropsMixin.EnvironmentVariableProperty(
    key="key",
    secure=False,
    value="value"
)

Attributes

key

(Required) The environment variable’s name, which can consist of up to 64 characters and must be specified.

The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-key

secure

(Optional) Whether the variable’s value is returned by the DescribeApps action.

To hide an environment variable’s value, set Secure to true . DescribeApps returns *****FILTERED***** instead of the actual value. The default value for Secure is false .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-secure

value

(Optional) The environment variable’s value, which can be left empty.

If you specify a value, it can contain up to 256 characters, which must all be printable.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-value

SourceProperty

class CfnAppPropsMixin.SourceProperty(*, password=None, revision=None, ssh_key=None, type=None, url=None, username=None)

Bases: object

Parameters:

password (Optional[str]) – When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set Password to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set Password to the password. For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ . In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
revision (Optional[str]) – The application’s version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
ssh_key (Optional[str]) – In requests, the repository’s SSH key. In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
type (Optional[str]) – The repository type.
url (Optional[str]) – The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz .
username (Optional[str]) – This parameter depends on the repository type. - For Amazon S3 bundles, set Username to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.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.mixins_preview.aws_opsworks import mixins as opsworks_mixins

source_property = opsworks_mixins.CfnAppPropsMixin.SourceProperty(
    password="password",
    revision="revision",
    ssh_key="sshKey",
    type="type",
    url="url",
    username="username"
)

Attributes

password

When included in a request, the parameter depends on the repository type.

For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
For HTTP bundles and Subversion repositories, set Password to the password.

For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ .

In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-password

revision

The application’s version.

OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-revision

ssh_key

In requests, the repository’s SSH key.

In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-sshkey

type

The repository type.

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

url

The source URL.

The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-url

username

This parameter depends on the repository type.

For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-username

SslConfigurationProperty

class CfnAppPropsMixin.SslConfigurationProperty(*, certificate=None, chain=None, private_key=None)

Bases: object

Parameters:

certificate (Optional[str]) – The contents of the certificate’s domain.crt file.
chain (Optional[str]) – Optional. Can be used to specify an intermediate certificate authority key or client authentication.
private_key (Optional[str]) – The private key; the contents of the certificate’s domain.kex file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.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.mixins_preview.aws_opsworks import mixins as opsworks_mixins

ssl_configuration_property = opsworks_mixins.CfnAppPropsMixin.SslConfigurationProperty(
    certificate="certificate",
    chain="chain",
    private_key="privateKey"
)

Attributes

certificate

The contents of the certificate’s domain.crt file.

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

chain

Optional.

Can be used to specify an intermediate certificate authority key or client authentication.

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

private_key

The private key;

the contents of the certificate’s domain.kex file.

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