CfnApp

class aws_cdk.aws_opsworks.CfnApp(scope, id, *, 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: CfnResource

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
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 = opsworks.CfnApp(self, "MyCfnApp",
    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"
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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[IResolvable, SourceProperty, Dict[str, Any], 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[IResolvable, DataSourceProperty, Dict[str, Any]]], 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[IResolvable, EnvironmentVariableProperty, Dict[str, Any]]], 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[IResolvable, SslConfigurationProperty, Dict[str, Any], None]) – An SslConfiguration object with the SSL configuration.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::OpsWorks::App'

app_source: A Source object that specifies the app repository.

attr_id

Id

Type:: cloudformationAttribute

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

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_sources: The app’s data source.

description: A description of the app.

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

enable_ssl: Whether to enable SSL for the app.

environment: An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The app name.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

shortname: The app’s short name.

ssl_configuration: An SslConfiguration object with the SSL configuration.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stack_id: The stack ID.

type: The app type.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

DataSourceProperty

class CfnApp.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 import aws_opsworks as opsworks

data_source_property = opsworks.CfnApp.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 CfnApp.EnvironmentVariableProperty(*, key, value, secure=None)

Bases: object

Parameters:

key (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.
value (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.
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 .

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 import aws_opsworks as opsworks

environment_variable_property = opsworks.CfnApp.EnvironmentVariableProperty(
    key="key",
    value="value",

    # the properties below are optional
    secure=False
)

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 CfnApp.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, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
revision (Optional[str]) – The application’s version. AWS 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, AWS 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 import aws_opsworks as opsworks

source_property = opsworks.CfnApp.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, AWS 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.

AWS 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, AWS 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 CfnApp.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 import aws_opsworks as opsworks

ssl_configuration_property = opsworks.CfnApp.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