Package software.amazon.awscdk.services.elasticbeanstalk

Interface CfnConfigurationTemplateProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnConfigurationTemplateProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.528Z") @Stability(Stable) public interface CfnConfigurationTemplateProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnConfigurationTemplate.

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.*;
 CfnConfigurationTemplateProps cfnConfigurationTemplateProps = CfnConfigurationTemplateProps.builder()
         .applicationName("applicationName")
         // the properties below are optional
         .description("description")
         .environmentId("environmentId")
         .optionSettings(List.of(ConfigurationOptionSettingProperty.builder()
                 .namespace("namespace")
                 .optionName("optionName")
                 // the properties below are optional
                 .resourceName("resourceName")
                 .value("value")
                 .build()))
         .platformArn("platformArn")
         .solutionStackName("solutionStackName")
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .applicationName("applicationName")
                 .templateName("templateName")
                 .build())
         .build();

  • Method Details

    • getApplicationName

      @Stability(Stable) @NotNull String getApplicationName()
      The name of the Elastic Beanstalk application to associate with this configuration template.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      An optional description for this configuration.

    • getEnvironmentId

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

    • getOptionSettings

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

    • getPlatformArn

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

    • getSolutionStackName

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

    • getSourceConfiguration

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

    • builder

      @Stability(Stable) static CfnConfigurationTemplateProps.Builder builder()
      Returns:
      a CfnConfigurationTemplateProps.Builder of CfnConfigurationTemplateProps