Class CfnEnvironment

A CloudFormation AWS::ElasticBeanstalk::Environment.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnEnvironment
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticBeanstalk
Assembly: Amazon.CDK.AWS.ElasticBeanstalk.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEnvironment
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

Specify an AWS Elastic Beanstalk environment by using the AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment.

CloudformationResource: AWS::ElasticBeanstalk::Environment

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html

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;

CfnEnvironment 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(Construct, String, ICfnEnvironmentProps)

Create a new AWS::ElasticBeanstalk::Environment.
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

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

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(Construct, String, ICfnEnvironmentProps)

Create a new AWS::ElasticBeanstalk::Environment.

public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnEnvironmentProps
  • resource properties.

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

Properties

ApplicationName

The name of the application that is associated with this environment.

public virtual string ApplicationName { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-applicationname

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

Remarks

If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-cnameprefix

Description

Your description for this environment.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-description

EnvironmentName

A unique name for the environment.

public virtual string EnvironmentName { get; set; }
Property Value

System.String

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-name

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-operations-role

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-optionsettings

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

Remarks

For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .

If you specify PlatformArn , don't specify SolutionStackName .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn

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

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-solutionstackname

Tags

Specifies the tags applied to resources in the environment.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-elasticbeanstalk-environment-tags

TemplateName

The name of the Elastic Beanstalk configuration template to use with the environment.

public virtual string TemplateName { get; set; }
Property Value

System.String

Remarks

If you specify TemplateName , then don't specify SolutionStackName .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-templatename

Tier

Specifies the tier to use in creating this environment.

public virtual object Tier { get; set; }
Property Value

System.Object

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-tier

VersionLabel

The name of the application version to deploy.

public virtual string VersionLabel { get; set; }
Property Value

System.String

Remarks

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-versionlabel

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>

Overrides

Implements

Constructs.IConstruct