class Aws::ElasticBeanstalk::Types::EnvironmentDescription

Describes the properties of an environment.

@!attribute [rw] environment_name

The name of this environment.
@return [String]

@!attribute [rw] environment_id

The ID of this environment.
@return [String]

@!attribute [rw] application_name

The name of the application associated with this environment.
@return [String]

@!attribute [rw] version_label

The application version deployed in this environment.
@return [String]

@!attribute [rw] solution_stack_name

The name of the `SolutionStack` deployed with this environment.
@return [String]

@!attribute [rw] platform_arn

The ARN of the platform version.
@return [String]

@!attribute [rw] template_name

The name of the configuration template used to originally launch
this environment.
@return [String]

@!attribute [rw] description

Describes this environment.
@return [String]

@!attribute [rw] endpoint_url

For load-balanced, autoscaling environments, the URL to the
LoadBalancer. For single-instance environments, the IP address of
the instance.
@return [String]

@!attribute [rw] cname

The URL to the CNAME for this environment.
@return [String]

@!attribute [rw] date_created

The creation date for this environment.
@return [Time]

@!attribute [rw] date_updated

The last modified date for this environment.
@return [Time]

@!attribute [rw] 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.
@return [String]

@!attribute [rw] abortable_operation_in_progress

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.
@return [Boolean]

@!attribute [rw] 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`
@return [String]

@!attribute [rw] health_status

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

[1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
@return [String]

@!attribute [rw] resources

The description of the AWS resources used by this environment.
@return [Types::EnvironmentResourcesDescription]

@!attribute [rw] tier

Describes the current tier of this environment.
@return [Types::EnvironmentTier]

@!attribute [rw] environment_links

A list of links to other environments in the same group.
@return [Array<Types::EnvironmentLink>]

@!attribute [rw] environment_arn

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

@!attribute [rw] operations_role

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

[1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/EnvironmentDescription AWS API Documentation

Constants

SENSITIVE