You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::EnvironmentDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes the properties of an environment.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#abortable_operation_in_progress ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#application_name ⇒ String

The name of the application associated with this environment.

Returns:

  • (String) —

    The name of the application associated with this environment.

#cname ⇒ String

The URL to the CNAME for this environment.

Returns:

  • (String) —

    The URL to the CNAME for this environment.

#date_created ⇒ Time

The creation date for this environment.

Returns:

  • (Time) —

    The creation date for this environment.

#date_updated ⇒ Time

The last modified date for this environment.

Returns:

  • (Time) —

    The last modified date for this environment.

#description ⇒ String

Describes this environment.

Returns:

  • (String) —

    Describes this environment.

#endpoint_url ⇒ String

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

Returns:

  • (String) —

    For load-balanced, autoscaling environments, the URL to the LoadBalancer.

#environment_arn ⇒ String

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

Returns:

  • (String) —

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

#environment_id ⇒ String

The ID of this environment.

Returns:

  • (String) —

    The ID of this environment.

#environment_links ⇒ Array<Types::EnvironmentLink>

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

Returns:

#environment_name ⇒ String

The name of this environment.

Returns:

  • (String) —

    The name of this environment.

#health ⇒ String

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

Possible values:

  • Green
  • Yellow
  • Red
  • Grey

Returns:

  • (String) —

    Describes the health status of the environment.

#health_status ⇒ String

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

Returns:

  • (String) —

    Returns the health status of the application running in your environment.

#operations_role ⇒ String

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the environment\'s operations role.

#platform_arn ⇒ String

The ARN of the platform version.

Returns:

  • (String) —

    The ARN of the platform version.

#resources ⇒ Types::EnvironmentResourcesDescription

The description of the AWS resources used by this environment.

Returns:

#solution_stack_name ⇒ String

The name of the SolutionStack deployed with this environment.

Returns:

  • (String) —

    The name of the SolutionStack deployed with this environment.

#status ⇒ String

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.

    Possible values:

    • Aborting
    • Launching
    • Updating
    • LinkingFrom
    • LinkingTo
    • Ready
    • Terminating
    • Terminated

Returns:

  • (String) —

    The current operational status of the environment:.

#template_name ⇒ String

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

Returns:

  • (String) —

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

#tier ⇒ Types::EnvironmentTier

Describes the current tier of this environment.

Returns:

#version_label ⇒ String

The application version deployed in this environment.

Returns:

  • (String) —

    The application version deployed in this environment.