CfnEnvironmentPropsMixin

class aws_cdk.mixins_preview.aws_elasticbeanstalk.mixins.CfnEnvironmentPropsMixin(props, *, strategy=None)

Bases: Mixin

Specify an AWS Elastic Beanstalk environment by using the AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html
CloudformationResource:: AWS::ElasticBeanstalk::Environment
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_elasticbeanstalk import mixins as elasticbeanstalk_mixins

cfn_environment_props_mixin = elasticbeanstalk_mixins.CfnEnvironmentPropsMixin(elasticbeanstalk_mixins.CfnEnvironmentMixinProps(
    application_name="applicationName",
    cname_prefix="cnamePrefix",
    description="description",
    environment_name="environmentName",
    operations_role="operationsRole",
    option_settings=[elasticbeanstalk_mixins.CfnEnvironmentPropsMixin.OptionSettingProperty(
        namespace="namespace",
        option_name="optionName",
        resource_name="resourceName",
        value="value"
    )],
    platform_arn="platformArn",
    solution_stack_name="solutionStackName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    template_name="templateName",
    tier=elasticbeanstalk_mixins.CfnEnvironmentPropsMixin.TierProperty(
        name="name",
        type="type",
        version="version"
    ),
    version_label="versionLabel"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ElasticBeanstalk::Environment.

Parameters:

props (Union[CfnEnvironmentMixinProps, 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 = ['applicationName', 'cnamePrefix', 'description', 'environmentName', 'operationsRole', 'optionSettings', 'platformArn', 'solutionStackName', 'tags', 'templateName', 'tier', 'versionLabel']

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

OptionSettingProperty

class CfnEnvironmentPropsMixin.OptionSettingProperty(*, namespace=None, option_name=None, resource_name=None, value=None)

Bases: object

Use the OptionSetting property type to specify an option for an AWS Elastic Beanstalk environment when defining an AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The OptionSetting property type specifies an option for an AWS Elastic Beanstalk environment.

The OptionSettings property of the AWS::ElasticBeanstalk::Environment resource contains a list of OptionSetting property types.

For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide .

Parameters:

namespace (Optional[str]) – A unique namespace that identifies the option’s associated AWS resource.
option_name (Optional[str]) – The name of the configuration option.
resource_name (Optional[str]) – A unique resource name for the option setting. Use it for a time–based scaling configuration option.
value (Optional[str]) – The current value for the configuration option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.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_elasticbeanstalk import mixins as elasticbeanstalk_mixins

option_setting_property = elasticbeanstalk_mixins.CfnEnvironmentPropsMixin.OptionSettingProperty(
    namespace="namespace",
    option_name="optionName",
    resource_name="resourceName",
    value="value"
)

Attributes

namespace

A unique namespace that identifies the option’s associated AWS resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-namespace

option_name

The name of the configuration option.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-optionname

resource_name

A unique resource name for the option setting.

Use it for a time–based scaling configuration option.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-resourcename

value

The current value for the configuration option.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-value

TierProperty

class CfnEnvironmentPropsMixin.TierProperty(*, name=None, type=None, version=None)

Bases: object

Use the Tier property type to specify the environment tier for an AWS Elastic Beanstalk environment when defining an AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

Describes the environment tier for an AWS::ElasticBeanstalk::Environment resource. For more information, see Environment Tiers in the AWS Elastic Beanstalk Developer Guide .

Parameters:

name (Optional[str]) – The name of this environment tier. Valid values: - For Web server tier – WebServer - For Worker tier – Worker
type (Optional[str]) – The type of this environment tier. Valid values: - For Web server tier – Standard - For Worker tier – SQS/HTTP
version (Optional[str]) – The version of this environment tier. When you don’t set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. .. epigraph:: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.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_elasticbeanstalk import mixins as elasticbeanstalk_mixins

tier_property = elasticbeanstalk_mixins.CfnEnvironmentPropsMixin.TierProperty(
    name="name",
    type="type",
    version="version"
)

Attributes

name

The name of this environment tier.

Valid values:

For Web server tier – WebServer
For Worker tier – Worker

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-name

type

The type of this environment tier.

Valid values:

For Web server tier – Standard
For Worker tier – SQS/HTTP

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-type

version

The version of this environment tier.

When you don’t set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. .. epigraph:

This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-tier.html#cfn-elasticbeanstalk-environment-tier-version