Class CfnConfigurationTemplate
Specify an AWS Elastic Beanstalk configuration template by using the AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticBeanstalk
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConfigurationTemplate : CfnResource, IInspectable
Syntax (vb)
Public Class CfnConfigurationTemplate
Inherits CfnResource
Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::ElasticBeanstalk::ConfigurationTemplate
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticBeanstalk;
var cfnConfigurationTemplate = new CfnConfigurationTemplate(this, "MyCfnConfigurationTemplate", new CfnConfigurationTemplateProps {
ApplicationName = "applicationName",
// the properties below are optional
Description = "description",
EnvironmentId = "environmentId",
OptionSettings = new [] { new ConfigurationOptionSettingProperty {
Namespace = "namespace",
OptionName = "optionName",
// the properties below are optional
ResourceName = "resourceName",
Value = "value"
} },
PlatformArn = "platformArn",
SolutionStackName = "solutionStackName",
SourceConfiguration = new SourceConfigurationProperty {
ApplicationName = "applicationName",
TemplateName = "templateName"
}
});
Synopsis
Constructors
CfnConfigurationTemplate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConfigurationTemplate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnConfigurationTemplate(Construct, String, ICfnConfigurationTemplateProps) |
Properties
ApplicationName | The name of the Elastic Beanstalk application to associate with this configuration template. |
AttrTemplateName | The name of the configuration template. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | An optional description for this configuration. |
EnvironmentId | The ID of an environment whose settings you want to use to create the configuration template. |
OptionSettings | Option values for the Elastic Beanstalk configuration, such as the instance type. |
PlatformArn | The Amazon Resource Name (ARN) of the custom platform. |
SolutionStackName | The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. |
SourceConfiguration | An Elastic Beanstalk configuration template to base this one on. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConfigurationTemplate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConfigurationTemplate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConfigurationTemplate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConfigurationTemplate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnConfigurationTemplate(Construct, String, ICfnConfigurationTemplateProps)
public CfnConfigurationTemplate(Construct scope, string id, ICfnConfigurationTemplateProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnConfigurationTemplateProps
Resource properties.
Properties
ApplicationName
The name of the Elastic Beanstalk application to associate with this configuration template.
public virtual string ApplicationName { get; set; }
Property Value
System.String
AttrTemplateName
The name of the configuration template.
public virtual string AttrTemplateName { get; }
Property Value
System.String
Remarks
Constraint: This name must be unique per application.
CloudformationAttribute: TemplateName
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
An optional description for this configuration.
public virtual string Description { get; set; }
Property Value
System.String
EnvironmentId
The ID of an environment whose settings you want to use to create the configuration template.
public virtual string EnvironmentId { get; set; }
Property Value
System.String
OptionSettings
Option values for the Elastic Beanstalk configuration, such as the instance type.
public virtual object OptionSettings { get; set; }
Property Value
System.Object
PlatformArn
The Amazon Resource Name (ARN) of the custom platform.
public virtual string PlatformArn { get; set; }
Property Value
System.String
SolutionStackName
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
public virtual string SolutionStackName { get; set; }
Property Value
System.String
SourceConfiguration
An Elastic Beanstalk configuration template to base this one on.
public virtual object SourceConfiguration { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>