Describes the properties of an environment.

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class EnvironmentDescription
Public Class EnvironmentDescription
public ref class EnvironmentDescription

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
EnvironmentDescription()()()()
Initializes a new instance of the EnvironmentDescription class
ApplicationName
The name of the application associated with this environment.

Constraints:

Length
1 - 100

CNAME
The URL to the CNAME for this environment.

Constraints:

Length
1 - 255

DateCreated
The creation date for this environment.
DateUpdated
The last modified date for this environment.
Description
Describes this environment.

Constraints:

Length
0 - 200

EndpointURL
The URL to the LoadBalancer for this environment.
EnvironmentId
The ID of this environment.
EnvironmentName
The name of this environment.

Constraints:

Length
4 - 23

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

Field Value

Red : Indicates the environment is not working.

Field Value

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Field Value

Green: Indicates the environment is healthy and fully functional.
  • 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

Constraints:

Allowed Values
Green, Yellow, Red, Grey

Resources
The description of the AWS resources used by this environment.
SolutionStackName
The name of the SolutionStack deployed with this environment.

Constraints:

Length
0 - 100

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.

Constraints:

Allowed Values
Launching, Updating, Ready, Terminating, Terminated

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

Constraints:

Length
1 - 100

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
VersionLabel
The application version deployed in this environment.

Constraints:

Length
1 - 100

WithApplicationName(String)
Sets the ApplicationName property
WithCNAME(String)
Sets the CNAME property
WithDateCreated(DateTime)
Sets the DateCreated property
WithDateUpdated(DateTime)
Sets the DateUpdated property
WithDescription(String)
Sets the Description property
WithEndpointURL(String)
Sets the EndpointURL property
WithEnvironmentId(String)
Sets the EnvironmentId property
WithEnvironmentName(String)
Sets the EnvironmentName property
WithHealth(String)
Sets the Health property
WithResources(EnvironmentResourcesDescription)
Sets the Resources property
WithSolutionStackName(String)
Sets the SolutionStackName property
WithStatus(String)
Sets the Status property
WithTemplateName(String)
Sets the TemplateName property
WithVersionLabel(String)
Sets the VersionLabel property

Inheritance Hierarchy

System..::..Object
  Amazon.ElasticBeanstalk.Model..::..EnvironmentDescription

See Also