Package software.amazon.awscdk.services.elasticbeanstalk

Class CfnConfigurationTemplateProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • applicationName

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder applicationName(String applicationName)
      Sets the value of CfnConfigurationTemplateProps.getApplicationName()
      Parameters:
      applicationName - The name of the Elastic Beanstalk application to associate with this configuration template. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder description(String description)
      Sets the value of CfnConfigurationTemplateProps.getDescription()
      Parameters:
      description - An optional description for this configuration.
      Returns:
      this

    • environmentId

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder environmentId(String environmentId)
      Sets the value of CfnConfigurationTemplateProps.getEnvironmentId()
      Parameters:
      environmentId - The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn , SolutionStackName , or SourceConfiguration .
      Returns:
      this

    • optionSettings

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder optionSettings(IResolvable optionSettings)
      Sets the value of CfnConfigurationTemplateProps.getOptionSettings()
      Parameters:
      optionSettings - Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide .
      Returns:
      this

    • optionSettings

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder optionSettings(List<? extends Object> optionSettings)
      Sets the value of CfnConfigurationTemplateProps.getOptionSettings()
      Parameters:
      optionSettings - Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide .
      Returns:
      this

    • platformArn

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder platformArn(String platformArn)
      Sets the value of CfnConfigurationTemplateProps.getPlatformArn()
      Parameters:
      platformArn - The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .

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

      Returns:
      this

    • solutionStackName

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder solutionStackName(String solutionStackName)
      Sets the value of CfnConfigurationTemplateProps.getSolutionStackName()
      Parameters:
      solutionStackName - The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7 . A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide .

      You must specify SolutionStackName if you don't specify PlatformArn , EnvironmentId , or SourceConfiguration .

      Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

      Returns:
      this

    • sourceConfiguration

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder sourceConfiguration(IResolvable sourceConfiguration)
      Sets the value of CfnConfigurationTemplateProps.getSourceConfiguration()
      Parameters:
      sourceConfiguration - An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

      Values specified in OptionSettings override any values obtained from the SourceConfiguration .

      You must specify SourceConfiguration if you don't specify PlatformArn , EnvironmentId , or SolutionStackName .

      Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

      Returns:
      this

    • sourceConfiguration

      @Stability(Stable) public CfnConfigurationTemplateProps.Builder sourceConfiguration(CfnConfigurationTemplate.SourceConfigurationProperty sourceConfiguration)
      Sets the value of CfnConfigurationTemplateProps.getSourceConfiguration()
      Parameters:
      sourceConfiguration - An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

      Values specified in OptionSettings override any values obtained from the SourceConfiguration .

      You must specify SourceConfiguration if you don't specify PlatformArn , EnvironmentId , or SolutionStackName .

      Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

      Returns:
      this

    • build

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