AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateEnvironment operation. Launches an environment for the specified application using the specified configuration.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
      Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z

Syntax

C#
public class CreateEnvironmentRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The CreateEnvironmentRequest type exposes the following members

Constructors

NameDescription
Public Method CreateEnvironmentRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateEnvironmentRequest(string, string)

Instantiates CreateEnvironmentRequest with the parameterized properties

Properties

NameTypeDescription
Public Property ApplicationName System.String

Gets and sets the property ApplicationName.

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Public Property CNAMEPrefix System.String

Gets and sets the property CNAMEPrefix.

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Public Property Description System.String

Gets and sets the property Description.

Describes this environment.

Public Property EnvironmentName System.String

Gets and sets the property EnvironmentName.

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Public Property GroupName System.String

Gets and sets the property GroupName.

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

Public Property OptionSettings System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting>

Gets and sets the property OptionSettings.

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

Public Property OptionsToRemove System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.OptionSpecification>

Gets and sets the property OptionsToRemove.

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Public Property PlatformArn System.String

Gets and sets the property PlatformArn.

The ARN of the platform.

Public Property SolutionStackName System.String

Gets and sets the property SolutionStackName.

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Public Property Tags System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.Tag>

Gets and sets the property Tags.

This specifies the tags applied to resources in the environment.

Public Property TemplateName System.String

Gets and sets the property TemplateName.

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Public Property Tier Amazon.ElasticBeanstalk.Model.EnvironmentTier

Gets and sets the property Tier.

This specifies the tier to use for creating this environment.

Public Property VersionLabel System.String

Gets and sets the property VersionLabel.

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

Examples

The following operation creates a new environment for version v1 of a java application named my-app:

To create a new environment for an application


var response = client.CreateEnvironment(new CreateEnvironmentRequest 
{
    ApplicationName = "my-app",
    CNAMEPrefix = "my-app",
    EnvironmentName = "my-env",
    SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
    VersionLabel = "v1"
});

string applicationName = response.ApplicationName;
string cname = response.CNAME;
DateTime dateCreated = response.DateCreated;
DateTime dateUpdated = response.DateUpdated;
string environmentId = response.EnvironmentId;
string environmentName = response.EnvironmentName;
string health = response.Health;
string solutionStackName = response.SolutionStackName;
string status = response.Status;
EnvironmentTier tier = response.Tier;
string versionLabel = response.VersionLabel;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms