Package software.amazon.awscdk.services.elasticbeanstalk

Class CfnEnvironmentProps.Builder

java.lang.Object
software.amazon.awscdk.services.elasticbeanstalk.CfnEnvironmentProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEnvironmentProps>
Enclosing interface:
CfnEnvironmentProps
@Stability(Stable) public static final class CfnEnvironmentProps.Builder extends Object implements software.amazon.jsii.Builder<CfnEnvironmentProps>
A builder for CfnEnvironmentProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • applicationName

      @Stability(Stable) public CfnEnvironmentProps.Builder applicationName(String applicationName)
      Sets the value of CfnEnvironmentProps.getApplicationName()
      Parameters:
      applicationName - The name of the application that is associated with this environment. This parameter is required.
      Returns:
      this

    • cnamePrefix

      @Stability(Stable) public CfnEnvironmentProps.Builder cnamePrefix(String cnamePrefix)
      Sets the value of CfnEnvironmentProps.getCnamePrefix()
      Parameters:
      cnamePrefix - 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.
      Returns:
      this

    • description

      @Stability(Stable) public CfnEnvironmentProps.Builder description(String description)
      Sets the value of CfnEnvironmentProps.getDescription()
      Parameters:
      description - Your description for this environment.
      Returns:
      this

    • environmentName

      @Stability(Stable) public CfnEnvironmentProps.Builder environmentName(String environmentName)
      Sets the value of CfnEnvironmentProps.getEnvironmentName()
      Parameters:
      environmentName - 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.

      Returns:
      this

    • operationsRole

      @Stability(Stable) public CfnEnvironmentProps.Builder operationsRole(String operationsRole)
      Sets the value of CfnEnvironmentProps.getOperationsRole()
      Parameters:
      operationsRole -

      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.
      Returns:
      this

    • optionSettings

      @Stability(Stable) public CfnEnvironmentProps.Builder optionSettings(IResolvable optionSettings)
      Sets the value of CfnEnvironmentProps.getOptionSettings()
      Parameters:
      optionSettings - 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.
      Returns:
      this

    • optionSettings

      @Stability(Stable) public CfnEnvironmentProps.Builder optionSettings(List<? extends Object> optionSettings)
      Sets the value of CfnEnvironmentProps.getOptionSettings()
      Parameters:
      optionSettings - 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.
      Returns:
      this

    • platformArn

      @Stability(Stable) public CfnEnvironmentProps.Builder platformArn(String platformArn)
      Sets the value of CfnEnvironmentProps.getPlatformArn()
      Parameters:
      platformArn - 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 .

      Returns:
      this

    • solutionStackName

      @Stability(Stable) public CfnEnvironmentProps.Builder solutionStackName(String solutionStackName)
      Sets the value of CfnEnvironmentProps.getSolutionStackName()
      Parameters:
      solutionStackName - 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 .

      Returns:
      this

    • tags

      @Stability(Stable) public CfnEnvironmentProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnEnvironmentProps.getTags()
      Parameters:
      tags - Specifies the tags applied to resources in the environment.
      Returns:
      this

    • templateName

      @Stability(Stable) public CfnEnvironmentProps.Builder templateName(String templateName)
      Sets the value of CfnEnvironmentProps.getTemplateName()
      Parameters:
      templateName - The name of the Elastic Beanstalk configuration template to use with the environment.

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

      Returns:
      this

    • tier

      @Stability(Stable) public CfnEnvironmentProps.Builder tier(IResolvable tier)
      Sets the value of CfnEnvironmentProps.getTier()
      Parameters:
      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.
      Returns:
      this

    • tier

      @Stability(Stable) public CfnEnvironmentProps.Builder tier(CfnEnvironment.TierProperty tier)
      Sets the value of CfnEnvironmentProps.getTier()
      Parameters:
      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.
      Returns:
      this

    • versionLabel

      @Stability(Stable) public CfnEnvironmentProps.Builder versionLabel(String versionLabel)
      Sets the value of CfnEnvironmentProps.getVersionLabel()
      Parameters:
      versionLabel - The name of the application version to deploy. Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
      Returns:
      this

    • build

      @Stability(Stable) public CfnEnvironmentProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnEnvironmentProps>
      Returns:
      a new instance of CfnEnvironmentProps
      Throws:
      NullPointerException - if any required attribute was not provided