Documentation

Describes the properties of an environment.

See: newEnvironmentDescription smart constructor.

Create a value of EnvironmentDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:EnvironmentDescription', environmentDescription_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.

$sel:cname:EnvironmentDescription', environmentDescription_cname - The URL to the CNAME for this environment.

$sel:templateName:EnvironmentDescription', environmentDescription_templateName - The name of the configuration template used to originally launch this environment.

$sel:abortableOperationInProgress:EnvironmentDescription', environmentDescription_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.

$sel:endpointURL:EnvironmentDescription', environmentDescription_endpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

$sel:resources:EnvironmentDescription', environmentDescription_resources - The description of the AWS resources used by this environment.

$sel:dateUpdated:EnvironmentDescription', environmentDescription_dateUpdated - The last modified date for this environment.

$sel:dateCreated:EnvironmentDescription', environmentDescription_dateCreated - The creation date for this environment.

$sel:health:EnvironmentDescription', environmentDescription_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 RestartEnvironment request.

Default: Grey

$sel:versionLabel:EnvironmentDescription', environmentDescription_versionLabel - The application version deployed in this environment.

$sel:operationsRole:EnvironmentDescription', environmentDescription_operationsRole - The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

$sel:platformArn:EnvironmentDescription', environmentDescription_platformArn - The ARN of the platform version.

$sel:tier:EnvironmentDescription', environmentDescription_tier - Describes the current tier of this environment.

$sel:environmentName:EnvironmentDescription', environmentDescription_environmentName - The name of this environment.

$sel:applicationName:EnvironmentDescription', environmentDescription_applicationName - The name of the application associated with this environment.

$sel:environmentArn:EnvironmentDescription', environmentDescription_environmentArn - The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

$sel:solutionStackName:EnvironmentDescription', environmentDescription_solutionStackName - The name of the SolutionStack deployed with this environment.

$sel:environmentId:EnvironmentDescription', environmentDescription_environmentId - The ID of this environment.

$sel:healthStatus:EnvironmentDescription', environmentDescription_healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

$sel:environmentLinks:EnvironmentDescription', environmentDescription_environmentLinks - A list of links to other environments in the same group.

$sel:description:EnvironmentDescription', environmentDescription_description - Describes this environment.

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.

The URL to the CNAME for this environment.

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

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.

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

The description of the AWS resources used by this environment.

The last modified date for this environment.

The creation date for this environment.

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 RestartEnvironment request.

Default: Grey

The application version deployed in this environment.

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

The ARN of the platform version.

Describes the current tier of this environment.

The name of this environment.

The name of the application associated with this environment.

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

The name of the SolutionStack deployed with this environment.

The ID of this environment.

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

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

Describes this environment.