@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-20T22:19:54.222Z") public class CfnConfigurationTemplate extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnConfigurationTemplate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnConfigurationTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnConfigurationTemplate(Construct scope, java.lang.String id, CfnConfigurationTemplateProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApplicationName()
public void setApplicationName(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getEnvironmentId()
You must specify EnvironmentId
if you don't specify PlatformArn
, SolutionStackName
, or SourceConfiguration
.
public void setEnvironmentId(java.lang.String value)
You must specify EnvironmentId
if you don't specify PlatformArn
, SolutionStackName
, or SourceConfiguration
.
public java.lang.Object getOptionSettings()
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 .
public void setOptionSettings(IResolvable value)
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 .
public void setOptionSettings(java.util.List<java.lang.Object> value)
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 .
public java.lang.String getPlatformArn()
For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .
If you specify
PlatformArn
, then don't specifySolutionStackName
.
public void setPlatformArn(java.lang.String value)
For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .
If you specify
PlatformArn
, then don't specifySolutionStackName
.
public java.lang.String getSolutionStackName()
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.
public void setSolutionStackName(java.lang.String value)
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.
public java.lang.Object getSourceConfiguration()
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.
public void setSourceConfiguration(IResolvable value)
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.
public void setSourceConfiguration(CfnConfigurationTemplate.SourceConfigurationProperty value)
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.