Package software.amazon.awscdk.services.elasticbeanstalk

Class CfnEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.elasticbeanstalk.CfnEnvironment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.530Z") @Stability(Stable) public class CfnEnvironment extends CfnResource implements IInspectable
A CloudFormation AWS::ElasticBeanstalk::Environment.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticbeanstalk.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .applicationName("applicationName")
         // the properties below are optional
         .cnamePrefix("cnamePrefix")
         .description("description")
         .environmentName("environmentName")
         .operationsRole("operationsRole")
         .optionSettings(List.of(OptionSettingProperty.builder()
                 .namespace("namespace")
                 .optionName("optionName")
                 // the properties below are optional
                 .resourceName("resourceName")
                 .value("value")
                 .build()))
         .platformArn("platformArn")
         .solutionStackName("solutionStackName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateName("templateName")
         .tier(TierProperty.builder()
                 .name("name")
                 .type("type")
                 .version("version")
                 .build())
         .versionLabel("versionLabel")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironment

      @Stability(Stable) public CfnEnvironment(@NotNull Construct scope, @NotNull String id, @NotNull CfnEnvironmentProps props)
      Create a new AWS::ElasticBeanstalk::Environment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrEndpointUrl

      @Stability(Stable) @NotNull public String getAttrEndpointUrl()
      For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

      Example load balancer URL:

      Example instance IP address:

      192.0.2.0

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Specifies the tags applied to resources in the environment.

    • getApplicationName

      @Stability(Stable) @NotNull public String getApplicationName()
      The name of the application that is associated with this environment.

    • setApplicationName

      @Stability(Stable) public void setApplicationName(@NotNull String value)
      The name of the application that is associated with this environment.

    • getCnamePrefix

      @Stability(Stable) @Nullable public String getCnamePrefix()
      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.

    • setCnamePrefix

      @Stability(Stable) public void setCnamePrefix(@Nullable String value)
      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Your description for this environment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Your description for this environment.

    • getEnvironmentName

      @Stability(Stable) @Nullable public String getEnvironmentName()
      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 .

      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.

    • setEnvironmentName

      @Stability(Stable) public void setEnvironmentName(@Nullable String value)
      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 .

      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.

    • getOperationsRole

      @Stability(Stable) @Nullable public String getOperationsRole()

      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.

    • setOperationsRole

      @Stability(Stable) public void setOperationsRole(@Nullable String value)

      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.

    • getOptionSettings

      @Stability(Stable) @Nullable public Object getOptionSettings()
      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.

    • setOptionSettings

      @Stability(Stable) public void setOptionSettings(@Nullable IResolvable value)
      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.

    • setOptionSettings

      @Stability(Stable) public void setOptionSettings(@Nullable List<Object> value)
      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.

    • getPlatformArn

      @Stability(Stable) @Nullable public String getPlatformArn()
      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 .

      If you specify PlatformArn , don't specify SolutionStackName .

    • setPlatformArn

      @Stability(Stable) public void setPlatformArn(@Nullable String value)
      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 .

      If you specify PlatformArn , don't specify SolutionStackName .

    • getSolutionStackName

      @Stability(Stable) @Nullable public String getSolutionStackName()
      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.

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

    • setSolutionStackName

      @Stability(Stable) public void setSolutionStackName(@Nullable String value)
      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.

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

    • getTemplateName

      @Stability(Stable) @Nullable public String getTemplateName()
      The name of the Elastic Beanstalk configuration template to use with the environment.

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

    • setTemplateName

      @Stability(Stable) public void setTemplateName(@Nullable String value)
      The name of the Elastic Beanstalk configuration template to use with the environment.

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

    • getTier

      @Stability(Stable) @Nullable public Object getTier()
      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.

    • setTier

      @Stability(Stable) public void setTier(@Nullable IResolvable value)
      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.

    • setTier

      @Stability(Stable) public void setTier(@Nullable CfnEnvironment.TierProperty value)
      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.

    • getVersionLabel

      @Stability(Stable) @Nullable public String getVersionLabel()
      The name of the application version to deploy.

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

    • setVersionLabel

      @Stability(Stable) public void setVersionLabel(@Nullable String value)
      The name of the application version to deploy.

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