Class CfnEnvironmentProps

Properties for defining a CfnEnvironment.

Inheritance

object

CfnEnvironmentProps

Implements

ICfnEnvironmentProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ElasticBeanstalk

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEnvironmentProps : ICfnEnvironmentProps

Syntax (vb)

Public Class CfnEnvironmentProps Implements ICfnEnvironmentProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-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;

             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

Constructors

CfnEnvironmentProps()

Properties for defining a CfnEnvironment.

Properties

ApplicationName	The name of the application that is associated with this environment.
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.

Constructors

CfnEnvironmentProps()

Properties for defining a CfnEnvironment.

public CfnEnvironmentProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-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;

             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"
             };

Properties

ApplicationName

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

public string ApplicationName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-applicationname

CnamePrefix

If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.

public string? CnamePrefix { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-cnameprefix

Description

Your description for this environment.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-description

EnvironmentName

A unique name for the environment.

public string? EnvironmentName { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-environmentname

OperationsRole

The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.

public string? OperationsRole { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-operationsrole

OptionSettings

Key-value pairs defining configuration options for this environment, such as the instance type.

public object? OptionSettings { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-optionsettings

PlatformArn

The Amazon Resource Name (ARN) of the custom platform to use with the environment.

public string? PlatformArn { get; set; }

Property Value

string

Remarks

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

If you specify <code>PlatformArn</code> , don't specify <code>SolutionStackName</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-platformarn

SolutionStackName

The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

public string? SolutionStackName { get; set; }

Property Value

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 <code>SolutionStackName</code> , don't specify <code>PlatformArn</code> or <code>TemplateName</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-solutionstackname

Tags

Specifies the tags applied to resources in the environment.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-tags

TemplateName

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

public string? TemplateName { get; set; }

Property Value

string

Remarks

If you specify <code>TemplateName</code> , then don't specify <code>SolutionStackName</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-templatename

Tier

Specifies the tier to use in creating this environment.

public object? Tier { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-tier

VersionLabel

The name of the application version to deploy.

public string? VersionLabel { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-environment.html#cfn-elasticbeanstalk-environment-versionlabel

Implements

ICfnEnvironmentProps