CfnStackPropsMixin

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

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html
CloudformationResource:: AWS::OpsWorks::Stack
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

# custom_json: Any

cfn_stack_props_mixin = opsworks_mixins.CfnStackPropsMixin(opsworks_mixins.CfnStackMixinProps(
    agent_version="agentVersion",
    attributes={
        "attributes_key": "attributes"
    },
    chef_configuration=opsworks_mixins.CfnStackPropsMixin.ChefConfigurationProperty(
        berkshelf_version="berkshelfVersion",
        manage_berkshelf=False
    ),
    clone_app_ids=["cloneAppIds"],
    clone_permissions=False,
    configuration_manager=opsworks_mixins.CfnStackPropsMixin.StackConfigurationManagerProperty(
        name="name",
        version="version"
    ),
    custom_cookbooks_source=opsworks_mixins.CfnStackPropsMixin.SourceProperty(
        password="password",
        revision="revision",
        ssh_key="sshKey",
        type="type",
        url="url",
        username="username"
    ),
    custom_json=custom_json,
    default_availability_zone="defaultAvailabilityZone",
    default_instance_profile_arn="defaultInstanceProfileArn",
    default_os="defaultOs",
    default_root_device_type="defaultRootDeviceType",
    default_ssh_key_name="defaultSshKeyName",
    default_subnet_id="defaultSubnetId",
    ecs_cluster_arn="ecsClusterArn",
    elastic_ips=[opsworks_mixins.CfnStackPropsMixin.ElasticIpProperty(
        ip="ip",
        name="name"
    )],
    hostname_theme="hostnameTheme",
    name="name",
    rds_db_instances=[opsworks_mixins.CfnStackPropsMixin.RdsDbInstanceProperty(
        db_password="dbPassword",
        db_user="dbUser",
        rds_db_instance_arn="rdsDbInstanceArn"
    )],
    service_role_arn="serviceRoleArn",
    source_stack_id="sourceStackId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_custom_cookbooks=False,
    use_opsworks_security_groups=False,
    vpc_id="vpcId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnStackMixinProps, 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 = ['agentVersion', 'attributes', 'chefConfiguration', 'cloneAppIds', 'clonePermissions', 'configurationManager', 'customCookbooksSource', 'customJson', 'defaultAvailabilityZone', 'defaultInstanceProfileArn', 'defaultOs', 'defaultRootDeviceType', 'defaultSshKeyName', 'defaultSubnetId', 'ecsClusterArn', 'elasticIps', 'hostnameTheme', 'name', 'rdsDbInstances', 'serviceRoleArn', 'sourceStackId', 'tags', 'useCustomCookbooks', 'useOpsworksSecurityGroups', 'vpcId']

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

ChefConfigurationProperty

class CfnStackPropsMixin.ChefConfigurationProperty(*, berkshelf_version=None, manage_berkshelf=None)

Bases: object

Parameters:

berkshelf_version (Optional[str]) – The Berkshelf version.
manage_berkshelf (Union[bool, IResolvable, None]) – Whether to enable Berkshelf.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.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

chef_configuration_property = opsworks_mixins.CfnStackPropsMixin.ChefConfigurationProperty(
    berkshelf_version="berkshelfVersion",
    manage_berkshelf=False
)

Attributes

berkshelf_version

The Berkshelf version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-stack-chefconfiguration-berkshelfversion

manage_berkshelf

Whether to enable Berkshelf.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-stack-chefconfiguration-manageberkshelf

ElasticIpProperty

class CfnStackPropsMixin.ElasticIpProperty(*, ip=None, name=None)

Bases: object

Parameters:

ip (Optional[str]) – The IP address.
name (Optional[str]) – The name, which can be a maximum of 32 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.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

elastic_ip_property = opsworks_mixins.CfnStackPropsMixin.ElasticIpProperty(
    ip="ip",
    name="name"
)

Attributes

ip

The IP address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-ip

name

The name, which can be a maximum of 32 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-name

RdsDbInstanceProperty

class CfnStackPropsMixin.RdsDbInstanceProperty(*, db_password=None, db_user=None, rds_db_instance_arn=None)

Bases: object

Parameters:

db_password (Optional[str]) – OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
db_user (Optional[str]) – The master user name.
rds_db_instance_arn (Optional[str]) – The instance’s ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.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

rds_db_instance_property = opsworks_mixins.CfnStackPropsMixin.RdsDbInstanceProperty(
    db_password="dbPassword",
    db_user="dbUser",
    rds_db_instance_arn="rdsDbInstanceArn"
)

Attributes

db_password

OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword

db_user

The master user name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbuser

rds_db_instance_arn

The instance’s ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-rdsdbinstancearn

SourceProperty

class CfnStackPropsMixin.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]) – The repository’s SSH key. For more information, see Using Git Repository SSH Keys in the OpsWorks User Guide . To pass in an SSH key as a parameter, see the following example: "Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...
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-stack-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.CfnStackPropsMixin.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-stack-source.html#cfn-opsworks-stack-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-stack-source.html#cfn-opsworks-stack-source-revision

ssh_key

The repository’s SSH key.

For more information, see Using Git Repository SSH Keys in the OpsWorks User Guide . To pass in an SSH key as a parameter, see the following example:

"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...

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

type

The repository type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-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-stack-source.html#cfn-opsworks-stack-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-stack-source.html#cfn-opsworks-stack-source-username

StackConfigurationManagerProperty

class CfnStackPropsMixin.StackConfigurationManagerProperty(*, name=None, version=None)

Bases: object

Parameters:

name (Optional[str]) – The name. This parameter must be set to Chef .
version (Optional[str]) – The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigurationmanager.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

stack_configuration_manager_property = opsworks_mixins.CfnStackPropsMixin.StackConfigurationManagerProperty(
    name="name",
    version="version"
)

Attributes

name

The name.

This parameter must be set to Chef .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigurationmanager.html#cfn-opsworks-stack-stackconfigurationmanager-name

version

The Chef version.

This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigurationmanager.html#cfn-opsworks-stack-stackconfigurationmanager-version