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

Class: Aws::ElasticBeanstalk::Types::DescribeEnvironmentHealthResult

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Health details for an AWS Elastic Beanstalk environment.

Instance Attribute Summary collapse

Instance Attribute Details

#application_metricsTypes::ApplicationMetrics

Application request metrics for the environment.



1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#causesArray<String>

Descriptions of the data that contributed to the environment's current health status.

Returns:

  • (Array<String>)


1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#colorString

The health color of the environment.

Returns:

  • (String)


1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#environment_nameString

The environment's name.

Returns:

  • (String)


1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#health_statusString

The health status of the environment. For example, Ok.

Returns:

  • (String)


1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#instances_healthTypes::InstanceHealthSummary

Summary health information for the instances in the environment.



1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#refreshed_atTime

The date and time that the health information was retrieved.

Returns:

  • (Time)


1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end

#statusString

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

Returns:

  • (String)


1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1848

class DescribeEnvironmentHealthResult < Struct.new(
  :environment_name,
  :health_status,
  :status,
  :color,
  :causes,
  :application_metrics,
  :instances_health,
  :refreshed_at)
  include Aws::Structure
end