Class CfnEnvironment
Specify an AWS Elastic Beanstalk environment by using the AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticBeanstalk
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEnvironment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment.
CloudformationResource: AWS::ElasticBeanstalk::Environment
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 cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", 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
Constructors
CfnEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEnvironment(Construct, String, ICfnEnvironmentProps) |
Properties
ApplicationName | The name of the application that is associated with this environment. |
AttrEndpointUrl | For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CnamePrefix | 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. |
EnvironmentName | A unique name for the environment. |
OperationsRole | The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change. |
OptionSettings | Key-value pairs defining configuration options for this environment, such as the instance type. |
PlatformArn | The Amazon Resource Name (ARN) of the custom platform to use with the environment. |
SolutionStackName | The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Specifies the tags applied to resources in the environment. |
TemplateName | The name of the Elastic Beanstalk configuration template to use with the environment. |
Tier | Specifies the tier to use in creating this environment. |
VersionLabel | The name of the application version to deploy. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEnvironment(Construct, String, ICfnEnvironmentProps)
public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps 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 ICfnEnvironmentProps
Resource properties.
Properties
ApplicationName
The name of the application that is associated with this environment.
public virtual string ApplicationName { get; set; }
Property Value
System.String
AttrEndpointUrl
For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.
public virtual string AttrEndpointUrl { get; }
Property Value
System.String
Remarks
Example load balancer URL:
Example instance IP address:
192.0.2.0
CloudformationAttribute: EndpointURL
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
CnamePrefix
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.
public virtual string CnamePrefix { get; set; }
Property Value
System.String
Description
Your description for this environment.
public virtual string Description { get; set; }
Property Value
System.String
EnvironmentName
A unique name for the environment.
public virtual string EnvironmentName { get; set; }
Property Value
System.String
OperationsRole
The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
public virtual string OperationsRole { get; set; }
Property Value
System.String
OptionSettings
Key-value pairs defining configuration options for this environment, 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 to use with the environment.
public virtual string PlatformArn { get; set; }
Property Value
System.String
SolutionStackName
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
public virtual string SolutionStackName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Specifies the tags applied to resources in the environment.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TemplateName
The name of the Elastic Beanstalk configuration template to use with the environment.
public virtual string TemplateName { get; set; }
Property Value
System.String
Tier
Specifies the tier to use in creating this environment.
public virtual object Tier { get; set; }
Property Value
System.Object
VersionLabel
The name of the application version to deploy.
public virtual string VersionLabel { get; set; }
Property Value
System.String
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>