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

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

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

Overview

Describes the properties of an environment.

Instance Attribute Summary collapse

Instance Attribute Details

#abortable_operation_in_progressBoolean

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)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#application_nameString

The name of the application associated with this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#cnameString

The URL to the CNAME for this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#date_createdTime

The creation date for this environment.

Returns:

  • (Time)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#date_updatedTime

The last modified date for this environment.

Returns:

  • (Time)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#descriptionString

Describes this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#endpoint_urlString

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

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#environment_arnString

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

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#environment_idString

The ID of this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

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

Returns:



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#environment_nameString

The name of this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#healthString

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

Default: Grey

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#health_statusString

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

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#platform_arnString

The ARN of the platform.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#resourcesTypes::EnvironmentResourcesDescription

The description of the AWS resources used by this environment.



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#solution_stack_nameString

The name of the SolutionStack deployed with this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#template_nameString

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

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#tierTypes::EnvironmentTier

Describes the current tier of this environment.



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end

#version_labelString

The application version deployed in this environment.

Returns:

  • (String)


2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2401

class EnvironmentDescription < Struct.new(
  :environment_name,
  :environment_id,
  :application_name,
  :version_label,
  :solution_stack_name,
  :platform_arn,
  :template_name,
  :description,
  :endpoint_url,
  :cname,
  :date_created,
  :date_updated,
  :status,
  :abortable_operation_in_progress,
  :health,
  :health_status,
  :resources,
  :tier,
  :environment_links,
  :environment_arn)
  include Aws::Structure
end