Interface ICfnConfigurationTemplateProps
Properties for defining a CfnConfigurationTemplate
.
Namespace: Amazon.CDK.AWS.ElasticBeanstalk
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnConfigurationTemplateProps
Syntax (vb)
Public Interface ICfnConfigurationTemplateProps
Remarks
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 cfnConfigurationTemplateProps = 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
Properties
ApplicationName | The name of the Elastic Beanstalk application to associate with this configuration template. |
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. |
Properties
ApplicationName
The name of the Elastic Beanstalk application to associate with this configuration template.
string ApplicationName { get; }
Property Value
System.String
Remarks
Description
An optional description for this configuration.
virtual string Description { get; }
Property Value
System.String
Remarks
EnvironmentId
The ID of an environment whose settings you want to use to create the configuration template.
virtual string EnvironmentId { get; }
Property Value
System.String
Remarks
You must specify EnvironmentId
if you don't specify PlatformArn
, SolutionStackName
, or SourceConfiguration
.
OptionSettings
Option values for the Elastic Beanstalk configuration, such as the instance type.
virtual object OptionSettings { get; }
Property Value
System.Object
Remarks
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 .
PlatformArn
The Amazon Resource Name (ARN) of the custom platform.
virtual string PlatformArn { get; }
Property Value
System.String
Remarks
For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .
If you specify PlatformArn
, then don't specify SolutionStackName
.
SolutionStackName
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
virtual string SolutionStackName { get; }
Property Value
System.String
Remarks
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.
SourceConfiguration
An Elastic Beanstalk configuration template to base this one on.
virtual object SourceConfiguration { get; }
Property Value
System.Object
Remarks
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.