Package software.amazon.awscdk.services.elasticbeanstalk

Class CfnConfigurationTemplate

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.CfnConfigurationTemplate
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.524Z") @Stability(Stable) public class CfnConfigurationTemplate extends CfnResource implements IInspectable
A CloudFormation AWS::ElasticBeanstalk::ConfigurationTemplate.

Specify an AWS Elastic Beanstalk configuration template by using the AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::ConfigurationTemplate resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

The Elastic Beanstalk console and documentation often refer to configuration templates as saved configurations . When you set configuration options in a saved configuration (configuration template), Elastic Beanstalk applies them with a particular precedence as part of applying options from multiple sources. For more information, see Configuration Options in the AWS Elastic Beanstalk Developer Guide .

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.*;
 CfnConfigurationTemplate cfnConfigurationTemplate = CfnConfigurationTemplate.Builder.create(this, "MyCfnConfigurationTemplate")
         .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();

  • 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

    • CfnConfigurationTemplate

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

    • CfnConfigurationTemplate

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

    • CfnConfigurationTemplate

      @Stability(Stable) public CfnConfigurationTemplate(@NotNull Construct scope, @NotNull String id, @NotNull CfnConfigurationTemplateProps props)
      Create a new AWS::ElasticBeanstalk::ConfigurationTemplate.

      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.

    • getAttrTemplateName

      @Stability(Stable) @NotNull public String getAttrTemplateName()

    • getCfnProperties

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

    • getApplicationName

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

    • setApplicationName

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

    • getDescription

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

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description for this configuration.

    • getEnvironmentId

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

    • setEnvironmentId

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

    • setOptionSettings

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

    • setOptionSettings

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

    • setPlatformArn

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

    • setSolutionStackName

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

    • setSourceConfiguration

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

    • setSourceConfiguration

      @Stability(Stable) public void setSourceConfiguration(@Nullable CfnConfigurationTemplate.SourceConfigurationProperty value)
      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.