CfnEnvironmentProps

class aws_cdk.aws_elasticbeanstalk.CfnEnvironmentProps(*, application_name, cname_prefix=None, description=None, environment_name=None, operations_role=None, option_settings=None, platform_arn=None, solution_stack_name=None, tags=None, template_name=None, tier=None, version_label=None)

Bases: object

Properties for defining a AWS::ElasticBeanstalk::Environment.

Parameters
  • application_name (str) – AWS::ElasticBeanstalk::Environment.ApplicationName.

  • cname_prefix (Optional[str]) – AWS::ElasticBeanstalk::Environment.CNAMEPrefix.

  • description (Optional[str]) – AWS::ElasticBeanstalk::Environment.Description.

  • environment_name (Optional[str]) – AWS::ElasticBeanstalk::Environment.EnvironmentName.

  • operations_role (Optional[str]) – AWS::ElasticBeanstalk::Environment.OperationsRole.

  • option_settings (Union[IResolvable, Sequence[Union[IResolvable, OptionSettingProperty]], None]) – AWS::ElasticBeanstalk::Environment.OptionSettings.

  • platform_arn (Optional[str]) – AWS::ElasticBeanstalk::Environment.PlatformArn.

  • solution_stack_name (Optional[str]) – AWS::ElasticBeanstalk::Environment.SolutionStackName.

  • tags (Optional[Sequence[CfnTag]]) – AWS::ElasticBeanstalk::Environment.Tags.

  • template_name (Optional[str]) – AWS::ElasticBeanstalk::Environment.TemplateName.

  • tier (Union[IResolvable, TierProperty, None]) – AWS::ElasticBeanstalk::Environment.Tier.

  • version_label (Optional[str]) – AWS::ElasticBeanstalk::Environment.VersionLabel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

cfn_environment_props = elasticbeanstalk.CfnEnvironmentProps(
    application_name="applicationName",

    # the properties below are optional
    cname_prefix="cnamePrefix",
    description="description",
    environment_name="environmentName",
    operations_role="operationsRole",
    option_settings=[elasticbeanstalk.CfnEnvironment.OptionSettingProperty(
        namespace="namespace",
        option_name="optionName",

        # the properties below are optional
        resource_name="resourceName",
        value="value"
    )],
    platform_arn="platformArn",
    solution_stack_name="solutionStackName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    template_name="templateName",
    tier=elasticbeanstalk.CfnEnvironment.TierProperty(
        name="name",
        type="type",
        version="version"
    ),
    version_label="versionLabel"
)

Attributes

application_name

AWS::ElasticBeanstalk::Environment.ApplicationName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-applicationname

Return type

str

cname_prefix

AWS::ElasticBeanstalk::Environment.CNAMEPrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-cnameprefix

Return type

Optional[str]

description

AWS::ElasticBeanstalk::Environment.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-description

Return type

Optional[str]

environment_name

AWS::ElasticBeanstalk::Environment.EnvironmentName.

Link

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

Return type

Optional[str]

operations_role

AWS::ElasticBeanstalk::Environment.OperationsRole.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-operations-role

Return type

Optional[str]

option_settings

AWS::ElasticBeanstalk::Environment.OptionSettings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-optionsettings

Return type

Union[IResolvable, List[Union[IResolvable, OptionSettingProperty]], None]

platform_arn

AWS::ElasticBeanstalk::Environment.PlatformArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn

Return type

Optional[str]

solution_stack_name

AWS::ElasticBeanstalk::Environment.SolutionStackName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-solutionstackname

Return type

Optional[str]

tags

AWS::ElasticBeanstalk::Environment.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-elasticbeanstalk-environment-tags

Return type

Optional[List[CfnTag]]

template_name

AWS::ElasticBeanstalk::Environment.TemplateName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-templatename

Return type

Optional[str]

tier

AWS::ElasticBeanstalk::Environment.Tier.

Link

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

Return type

Union[IResolvable, TierProperty, None]

version_label

AWS::ElasticBeanstalk::Environment.VersionLabel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-versionlabel

Return type

Optional[str]