CfnConfigurationTemplatePropsMixin

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

Bases: Mixin

Specify an AWS Elastic Beanstalk configuration template by using the AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. .. epigraph:

The Elastic Beanstalk console and documentation often refer to configuration templates as *saved configurations* . When you set configuration options in a saved configuration (configuration template), Elastic Beanstalk applies them with a particular precedence as part of applying options from multiple sources. For more information, see `Configuration Options <https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html>`_ in the *AWS Elastic Beanstalk Developer Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html
CloudformationResource:: AWS::ElasticBeanstalk::ConfigurationTemplate
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_configuration_template_props_mixin = elasticbeanstalk_mixins.CfnConfigurationTemplatePropsMixin(elasticbeanstalk_mixins.CfnConfigurationTemplateMixinProps(
    application_name="applicationName",
    description="description",
    environment_id="environmentId",
    option_settings=[elasticbeanstalk_mixins.CfnConfigurationTemplatePropsMixin.ConfigurationOptionSettingProperty(
        namespace="namespace",
        option_name="optionName",
        resource_name="resourceName",
        value="value"
    )],
    platform_arn="platformArn",
    solution_stack_name="solutionStackName",
    source_configuration=elasticbeanstalk_mixins.CfnConfigurationTemplatePropsMixin.SourceConfigurationProperty(
        application_name="applicationName",
        template_name="templateName"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnConfigurationTemplateMixinProps, 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', 'description', 'environmentId', 'optionSettings', 'platformArn', 'solutionStackName', 'sourceConfiguration']

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

ConfigurationOptionSettingProperty

class CfnConfigurationTemplatePropsMixin.ConfigurationOptionSettingProperty(*, namespace=None, option_name=None, resource_name=None, value=None)

Bases: object

Use the ConfigurationOptionSetting property type to specify an option for an AWS Elastic Beanstalk configuration template when defining an AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The ConfigurationOptionSetting property type specifies an option for an AWS Elastic Beanstalk configuration template.

The OptionSettings property of the AWS::ElasticBeanstalk::ConfigurationTemplate resource contains a list of ConfigurationOptionSetting 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-configurationtemplate-configurationoptionsetting.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

configuration_option_setting_property = elasticbeanstalk_mixins.CfnConfigurationTemplatePropsMixin.ConfigurationOptionSettingProperty(
    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-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-namespace

option_name

The name of the configuration option.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-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-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-resourcename

value

The current value for the configuration option.

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

SourceConfigurationProperty

class CfnConfigurationTemplatePropsMixin.SourceConfigurationProperty(*, application_name=None, template_name=None)

Bases: object

Use the SourceConfiguration property type to specify another AWS Elastic Beanstalk configuration template as the base to creating a new AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

An AWS Elastic Beanstalk configuration template to base a new one on. You can use it to define a AWS::ElasticBeanstalk::ConfigurationTemplate resource.

Parameters:

application_name (Optional[str]) – The name of the application associated with the configuration.
template_name (Optional[str]) – The name of the configuration template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.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

source_configuration_property = elasticbeanstalk_mixins.CfnConfigurationTemplatePropsMixin.SourceConfigurationProperty(
    application_name="applicationName",
    template_name="templateName"
)

Attributes

application_name

The name of the application associated with the configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-applicationname

template_name

The name of the configuration template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-templatename