software.amazon.awscdk.services.elasticbeanstalk

Class CfnConfigurationTemplate

java.lang.Object

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

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:54.222Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConfigurationTemplate.Builder A fluent builder for CfnConfigurationTemplate.
static interface	CfnConfigurationTemplate.ConfigurationOptionSettingProperty Use the `ConfigurationOptionSetting` property type to specify an option for an AWS Elastic Beanstalk configuration template when defining an AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.
static interface	CfnConfigurationTemplate.SourceConfigurationProperty Use the `SourceConfiguration` property type to specify another AWS Elastic Beanstalk configuration template as the base to creating a new AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfigurationTemplate(Construct scope, java.lang.String id, CfnConfigurationTemplateProps props) Create a new `AWS::ElasticBeanstalk::ConfigurationTemplate`.
protected	CfnConfigurationTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationName() The name of the Elastic Beanstalk application to associate with this configuration template.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() An optional description for this configuration.
java.lang.String	getEnvironmentId() The ID of an environment whose settings you want to use to create the configuration template.
java.lang.Object	getOptionSettings() Option values for the Elastic Beanstalk configuration, such as the instance type.
java.lang.String	getPlatformArn() The Amazon Resource Name (ARN) of the custom platform.
java.lang.String	getSolutionStackName() The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
java.lang.Object	getSourceConfiguration() An Elastic Beanstalk configuration template to base this one on.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApplicationName(java.lang.String value) The name of the Elastic Beanstalk application to associate with this configuration template.
void	setDescription(java.lang.String value) An optional description for this configuration.
void	setEnvironmentId(java.lang.String value) The ID of an environment whose settings you want to use to create the configuration template.
void	setOptionSettings(IResolvable value) Option values for the Elastic Beanstalk configuration, such as the instance type.
void	setOptionSettings(java.util.List<java.lang.Object> value) Option values for the Elastic Beanstalk configuration, such as the instance type.
void	setPlatformArn(java.lang.String value) The Amazon Resource Name (ARN) of the custom platform.
void	setSolutionStackName(java.lang.String value) The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
void	setSourceConfiguration(CfnConfigurationTemplate.SourceConfigurationProperty value) An Elastic Beanstalk configuration template to base this one on.
void	setSourceConfiguration(IResolvable value) An Elastic Beanstalk configuration template to base this one on.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConfigurationTemplate

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

CfnConfigurationTemplate

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

CfnConfigurationTemplate

public CfnConfigurationTemplate(Construct scope,
                                java.lang.String id,
                                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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationName

public java.lang.String getApplicationName()

The name of the Elastic Beanstalk application to associate with this configuration template.

setApplicationName

public void setApplicationName(java.lang.String value)

The name of the Elastic Beanstalk application to associate with this configuration template.

getDescription

public java.lang.String getDescription()

An optional description for this configuration.

setDescription

public void setDescription(java.lang.String value)

An optional description for this configuration.

getEnvironmentId

public java.lang.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

public void setEnvironmentId(java.lang.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

public java.lang.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

public void setOptionSettings(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

public void setOptionSettings(java.util.List<java.lang.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

public java.lang.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

public void setPlatformArn(java.lang.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

public java.lang.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

public void setSolutionStackName(java.lang.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

public java.lang.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

public void setSourceConfiguration(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

public void setSourceConfiguration(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.