Interface ICfnEnvironmentProps
Properties for defining a CfnEnvironment.
Namespace: Amazon.CDK.AWS.ElasticBeanstalk
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnEnvironmentPropsSyntax (vb)
Public Interface ICfnEnvironmentPropsRemarks
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 cfnEnvironmentProps = new CfnEnvironmentProps {
ApplicationName = "applicationName",
// the properties below are optional
CnamePrefix = "cnamePrefix",
Description = "description",
EnvironmentName = "environmentName",
OperationsRole = "operationsRole",
OptionSettings = new [] { new OptionSettingProperty {
Namespace = "namespace",
OptionName = "optionName",
// the properties below are optional
ResourceName = "resourceName",
Value = "value"
} },
PlatformArn = "platformArn",
SolutionStackName = "solutionStackName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TemplateName = "templateName",
Tier = new TierProperty {
Name = "name",
Type = "type",
Version = "version"
},
VersionLabel = "versionLabel"
};Synopsis
Properties
| Application |
The name of the application that is associated with this environment. |
| Cname |
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. |
| Description | Your description for this environment. |
| Environment |
A unique name for the environment. |
| Operations |
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change. |
| Option |
Key-value pairs defining configuration options for this environment, such as the instance type. |
| Platform |
The Amazon Resource Name (ARN) of the custom platform to use with the environment. |
| Solution |
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. |
| Tags | Specifies the tags applied to resources in the environment. |
| Template |
The name of the Elastic Beanstalk configuration template to use with the environment. |
| Tier | Specifies the tier to use in creating this environment. |
| Version |
The name of the application version to deploy. |
Properties
ApplicationName
The name of the application that is associated with this environment.
string ApplicationName { get; }Property Value
System.
Remarks
CnamePrefix
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.
virtual string CnamePrefix { get; }Property Value
System.
Remarks
If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
Description
Your description for this environment.
virtual string Description { get; }Property Value
System.
Remarks
EnvironmentName
A unique name for the environment.
virtual string EnvironmentName { get; }Property Value
System.
Remarks
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account.
If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
If you don't specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see Name Type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
OperationsRole
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
virtual string OperationsRole { get; }Property Value
System.
Remarks
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role.
OptionSettings
Key-value pairs defining configuration options for this environment, such as the instance type.
virtual object OptionSettings { get; }Property Value
System.
Remarks
These options override the values that are defined in the solution stack or the configuration template . If you remove any options during a stack update, the removed options retain their current values.
PlatformArn
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
virtual string PlatformArn { get; }Property Value
System.
Remarks
For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .
If you specify PlatformArn , don't specify SolutionStackName .
SolutionStackName
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
virtual string SolutionStackName { get; }Property Value
System.
Remarks
If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify SolutionStackName , don't specify PlatformArn or TemplateName .
Tags
Specifies the tags applied to resources in the environment.
virtual ICfnTag[] Tags { get; }Property Value
ICfn
Remarks
TemplateName
The name of the Elastic Beanstalk configuration template to use with the environment.
virtual string TemplateName { get; }Property Value
System.
Remarks
If you specify TemplateName , then don't specify SolutionStackName .
Tier
Specifies the tier to use in creating this environment.
virtual object Tier { get; }Property Value
System.
Remarks
The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
VersionLabel
The name of the application version to deploy.
virtual string VersionLabel { get; }Property Value
System.
Remarks
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.