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 CfnEnvironment.

Parameters
  • application_name (str) – The name of the application that is associated with this environment.

  • cname_prefix (Optional[str]) – If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

  • description (Optional[str]) – Your description for this environment.

  • environment_name (Optional[str]) – A unique name for the environment. Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can’t start or end with a hyphen. This name must be unique within a region in your account. If you don’t specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application. If you don’t specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see Name Type . .. epigraph:: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

  • operations_role (Optional[str]) –

    The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change. The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment’s operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role.

  • option_settings (Union[IResolvable, Sequence[Union[IResolvable, OptionSettingProperty, Dict[str, Any]]], None]) – Key-value pairs defining configuration options for this environment, such as the instance type. These options override the values that are defined in the solution stack or the configuration template . If you remove any options during a stack update, the removed options retain their current values.

  • platform_arn (Optional[str]) – The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide . .. epigraph:: If you specify PlatformArn , don’t specify SolutionStackName .

  • solution_stack_name (Optional[str]) – The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide. .. epigraph:: If you specify SolutionStackName , don’t specify PlatformArn or TemplateName .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies the tags applied to resources in the environment.

  • template_name (Optional[str]) – The name of the Elastic Beanstalk configuration template to use with the environment. .. epigraph:: If you specify TemplateName , then don’t specify SolutionStackName .

  • tier (Union[IResolvable, TierProperty, Dict[str, Any], None]) – Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

  • version_label (Optional[str]) – The name of the application version to deploy. Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

Link

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

ExampleMetadata

fixture=_generated

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

The name of the application that is associated with this environment.

Link

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

Return type

str

cname_prefix

If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.

If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Link

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

Return type

Optional[str]

description

Your description for this environment.

Link

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

Return type

Optional[str]

environment_name

A unique name for the environment.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can’t start or end with a hyphen. This name must be unique within a region in your account.

If you don’t specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

If you don’t specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see Name Type . .. epigraph:

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
Link

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

Return type

Optional[str]

operations_role

The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.

The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment’s operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role.

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

Key-value pairs defining configuration options for this environment, such as the instance type.

These options override the values that are defined in the solution stack or the configuration template . If you remove any options during a stack update, the removed options retain their current values.

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

The Amazon Resource Name (ARN) of the custom platform to use with the environment.

For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide . .. epigraph:

If you specify ``PlatformArn`` , don't specify ``SolutionStackName`` .
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

The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide. .. epigraph:

If you specify ``SolutionStackName`` , don't specify ``PlatformArn`` or ``TemplateName`` .
Link

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

Return type

Optional[str]

tags

Specifies the tags applied to resources in the environment.

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

The name of the Elastic Beanstalk configuration template to use with the environment.

If you specify TemplateName , then don’t specify SolutionStackName .

Link

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

Return type

Optional[str]

tier

Specifies the tier to use in creating this environment.

The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

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

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

Link

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

Return type

Optional[str]