@Generated(value="software.amazon.awssdk:codegen") public final class EnvironmentDescription extends Object implements ToCopyableBuilder<EnvironmentDescription.Builder,EnvironmentDescription>
Describes the properties of an environment.
Modifier and Type | Class and Description |
---|---|
static interface |
EnvironmentDescription.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
abortableOperationInProgress()
Indicates if there is an in-progress environment configuration update or application version deployment that you
can cancel.
|
String |
applicationName()
The name of the application associated with this environment.
|
static EnvironmentDescription.Builder |
builder() |
String |
cname()
The URL to the CNAME for this environment.
|
Instant |
dateCreated()
The creation date for this environment.
|
Instant |
dateUpdated()
The last modified date for this environment.
|
String |
description()
Describes this environment.
|
String |
endpointURL()
For load-balanced, autoscaling environments, the URL to the LoadBalancer.
|
String |
environmentArn()
The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
|
String |
environmentId()
The ID of this environment.
|
List<EnvironmentLink> |
environmentLinks()
A list of links to other environments in the same group.
|
String |
environmentName()
The name of this environment.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
EnvironmentHealth |
health()
Describes the health status of the environment.
|
String |
healthAsString()
Describes the health status of the environment.
|
EnvironmentHealthStatus |
healthStatus()
Returns the health status of the application running in your environment.
|
String |
healthStatusAsString()
Returns the health status of the application running in your environment.
|
String |
platformArn()
The ARN of the platform.
|
EnvironmentResourcesDescription |
resources()
The description of the AWS resources used by this environment.
|
static Class<? extends EnvironmentDescription.Builder> |
serializableBuilderClass() |
String |
solutionStackName()
The name of the
SolutionStack deployed with this environment. |
EnvironmentStatus |
status()
The current operational status of the environment:
|
String |
statusAsString()
The current operational status of the environment:
|
String |
templateName()
The name of the configuration template used to originally launch this environment.
|
EnvironmentTier |
tier()
Describes the current tier of this environment.
|
EnvironmentDescription.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
versionLabel()
The application version deployed in this environment.
|
copy
public String environmentName()
The name of this environment.
public String environmentId()
The ID of this environment.
public String applicationName()
The name of the application associated with this environment.
public String versionLabel()
The application version deployed in this environment.
public String solutionStackName()
The name of the SolutionStack
deployed with this environment.
SolutionStack
deployed with this environment.public String platformArn()
The ARN of the platform.
public String templateName()
The name of the configuration template used to originally launch this environment.
public String description()
Describes this environment.
public String endpointURL()
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
public String cname()
The URL to the CNAME for this environment.
public Instant dateCreated()
The creation date for this environment.
public Instant dateUpdated()
The last modified date for this environment.
public EnvironmentStatus status()
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.
If the service returns an enum value that is not available in the current SDK version, status
will
return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
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.
EnvironmentStatus
public String statusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, status
will
return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
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.
EnvironmentStatus
public Boolean abortableOperationInProgress()
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.
true:
There is an update in progress.
false:
There are no updates currently in progress.
public EnvironmentHealth health()
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
If the service returns an enum value that is not available in the current SDK version, health
will
return EnvironmentHealth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
healthAsString()
.
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
EnvironmentHealth
public String healthAsString()
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
If the service returns an enum value that is not available in the current SDK version, health
will
return EnvironmentHealth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
healthAsString()
.
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
EnvironmentHealth
public EnvironmentHealthStatus healthStatus()
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
If the service returns an enum value that is not available in the current SDK version, healthStatus
will
return EnvironmentHealthStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from healthStatusAsString()
.
EnvironmentHealthStatus
public String healthStatusAsString()
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
If the service returns an enum value that is not available in the current SDK version, healthStatus
will
return EnvironmentHealthStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from healthStatusAsString()
.
EnvironmentHealthStatus
public EnvironmentResourcesDescription resources()
The description of the AWS resources used by this environment.
public EnvironmentTier tier()
Describes the current tier of this environment.
public List<EnvironmentLink> environmentLinks()
A list of links to other environments in the same group.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String environmentArn()
The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
public EnvironmentDescription.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<EnvironmentDescription.Builder,EnvironmentDescription>
public static EnvironmentDescription.Builder builder()
public static Class<? extends EnvironmentDescription.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.