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.

Describes the properties of an environment.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse

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

Syntax

C#
public class CreateEnvironmentResponse : AmazonWebServiceResponse

The CreateEnvironmentResponse type exposes the following members

Constructors

NameDescription
Public Method CreateEnvironmentResponse()

Properties

NameTypeDescription
Public Property AbortableOperationInProgress System.Boolean

Gets and sets the property AbortableOperationInProgress.

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

Public Property ApplicationName System.String

Gets and sets the property ApplicationName.

The name of the application associated with this environment.

Public Property CNAME System.String

Gets and sets the property CNAME.

The URL to the CNAME for this environment.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DateCreated System.DateTime

Gets and sets the property DateCreated.

The creation date for this environment.

Public Property DateUpdated System.DateTime

Gets and sets the property DateUpdated.

The last modified date for this environment.

Public Property Description System.String

Gets and sets the property Description.

Describes this environment.

Public Property EndpointURL System.String

Gets and sets the property EndpointURL.

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

Public Property EnvironmentArn System.String

Gets and sets the property EnvironmentArn.

The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.

Public Property EnvironmentId System.String

Gets and sets the property EnvironmentId.

The ID of this environment.

Public Property EnvironmentLinks System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.EnvironmentLink>

Gets and sets the property EnvironmentLinks.

A list of links to other environments in the same group.

Public Property EnvironmentName System.String

Gets and sets the property EnvironmentName.

The name of this environment.

Public Property Health Amazon.ElasticBeanstalk.EnvironmentHealth

Gets and sets the property Health.

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

  • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

  • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

  • Green: Indicates the environment is healthy and fully functional.

  • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

Public Property HealthStatus Amazon.ElasticBeanstalk.EnvironmentHealthStatus

Gets and sets the property HealthStatus.

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property PlatformArn System.String

Gets and sets the property PlatformArn.

The ARN of the platform.

Public Property Resources Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription

Gets and sets the property Resources.

The description of the AWS resources used by this environment.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SolutionStackName System.String

Gets and sets the property SolutionStackName.

The name of the SolutionStack deployed with this environment.

Public Property Status Amazon.ElasticBeanstalk.EnvironmentStatus

Gets and sets the property Status.

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • Updating: Environment is in the process of updating its configuration settings or application version.

  • Ready: Environment is available to have an action performed on it, such as update or terminate.

  • Terminating: Environment is in the shut-down process.

  • Terminated: Environment is not running.

Public Property TemplateName System.String

Gets and sets the property TemplateName.

The name of the configuration template used to originally launch this environment.

Public Property Tier Amazon.ElasticBeanstalk.Model.EnvironmentTier

Gets and sets the property Tier.

Describes the current tier of this environment.

Public Property VersionLabel System.String

Gets and sets the property VersionLabel.

The application version deployed in this environment.

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