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

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

Overview

Describes the properties of an environment.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#application_name ⇒ String

The name of the application associated with this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#cname ⇒ String

The URL to the CNAME for this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#date_created ⇒ Time

The creation date for this environment.

Returns:

  • (Time) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#date_updated ⇒ Time

The last modified date for this environment.

Returns:

  • (Time) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Describes this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#environment_arn ⇒ String

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

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The ID of this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#environment_links ⇒ Array<Types::EnvironmentLink>

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

Returns:



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ String

The name of this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#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`

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#health_status ⇒ String

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

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

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#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*.

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

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#platform_arn ⇒ String

The ARN of the platform version.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Types::EnvironmentResourcesDescription

The description of the AWS resources used by this environment.

Returns:



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#solution_stack_name ⇒ String

The name of the ‘SolutionStack` deployed with this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

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

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ Types::EnvironmentTier

Describes the current tier of this environment.

Returns:



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#version_label ⇒ String

The application version deployed in this environment.

Returns:

  • (String) 


2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 2305

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,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end