Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

EnvironmentDescription

import type { EnvironmentDescription } from "https://aws-api.deno.dev/v0.4/services/elasticbeanstalk.ts?docs=full";

Describes the properties of an environment.

interface EnvironmentDescription {
AbortableOperationInProgress?: boolean | null;
ApplicationName?: string | null;
CNAME?: string | null;
DateCreated?: Date | number | null;
DateUpdated?: Date | number | null;
Description?: string | null;
EndpointURL?: string | null;
EnvironmentArn?: string | null;
EnvironmentId?: string | null;
EnvironmentLinks: EnvironmentLink[];
EnvironmentName?: string | null;
Health?: EnvironmentHealth | null;
HealthStatus?: EnvironmentHealthStatus | null;
OperationsRole?: string | null;
PlatformArn?: string | null;
Resources?: EnvironmentResourcesDescription | null;
SolutionStackName?: string | null;
Status?: EnvironmentStatus | null;
TemplateName?: string | null;
Tier?: EnvironmentTier | null;
VersionLabel?: string | null;
}

§Properties

§
AbortableOperationInProgress?: boolean | null
[src]

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.

§
ApplicationName?: string | null
[src]

The name of the application associated with this environment.

§
CNAME?: string | null
[src]

The URL to the CNAME for this environment.

§
DateCreated?: Date | number | null
[src]

The creation date for this environment.

§
DateUpdated?: Date | number | null
[src]

The last modified date for this environment.

§
Description?: string | null
[src]

Describes this environment.

§
EndpointURL?: string | null
[src]

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

§
EnvironmentArn?: string | null
[src]

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

§
EnvironmentId?: string | null
[src]

The ID of this environment.

§
EnvironmentName?: string | null
[src]

The name of this environment.

§
Health?: EnvironmentHealth | null
[src]

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

§
HealthStatus?: EnvironmentHealthStatus | null
[src]

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

§
OperationsRole?: string | null
[src]

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

§
PlatformArn?: string | null
[src]

The ARN of the platform version.

§
Resources?: EnvironmentResourcesDescription | null
[src]

The description of the AWS resources used by this environment.

§
SolutionStackName?: string | null
[src]

The name of the SolutionStack deployed with this environment.

§
Status?: EnvironmentStatus | null
[src]

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.
§
TemplateName?: string | null
[src]

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

§
Tier?: EnvironmentTier | null
[src]

Describes the current tier of this environment.

§
VersionLabel?: string | null
[src]

The application version deployed in this environment.