public static interface EnvironmentDescription.Builder extends CopyableBuilder<EnvironmentDescription.Builder,EnvironmentDescription>
Modifier and Type | Method and Description |
---|---|
EnvironmentDescription.Builder |
abortableOperationInProgress(Boolean abortableOperationInProgress)
Indicates if there is an in-progress environment configuration update or application version deployment that
you can cancel.
|
EnvironmentDescription.Builder |
applicationName(String applicationName)
The name of the application associated with this environment.
|
EnvironmentDescription.Builder |
cname(String cname)
The URL to the CNAME for this environment.
|
EnvironmentDescription.Builder |
dateCreated(Instant dateCreated)
The creation date for this environment.
|
EnvironmentDescription.Builder |
dateUpdated(Instant dateUpdated)
The last modified date for this environment.
|
EnvironmentDescription.Builder |
description(String description)
Describes this environment.
|
EnvironmentDescription.Builder |
endpointURL(String endpointURL)
For load-balanced, autoscaling environments, the URL to the LoadBalancer.
|
EnvironmentDescription.Builder |
environmentArn(String environmentArn)
The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
|
EnvironmentDescription.Builder |
environmentId(String environmentId)
The ID of this environment.
|
EnvironmentDescription.Builder |
environmentLinks(Collection<EnvironmentLink> environmentLinks)
A list of links to other environments in the same group.
|
EnvironmentDescription.Builder |
environmentLinks(Consumer<EnvironmentLink.Builder>... environmentLinks)
A list of links to other environments in the same group.
|
EnvironmentDescription.Builder |
environmentLinks(EnvironmentLink... environmentLinks)
A list of links to other environments in the same group.
|
EnvironmentDescription.Builder |
environmentName(String environmentName)
The name of this environment.
|
EnvironmentDescription.Builder |
health(EnvironmentHealth health)
Describes the health status of the environment.
|
EnvironmentDescription.Builder |
health(String health)
Describes the health status of the environment.
|
EnvironmentDescription.Builder |
healthStatus(EnvironmentHealthStatus healthStatus)
Returns the health status of the application running in your environment.
|
EnvironmentDescription.Builder |
healthStatus(String healthStatus)
Returns the health status of the application running in your environment.
|
EnvironmentDescription.Builder |
platformArn(String platformArn)
The ARN of the platform.
|
default EnvironmentDescription.Builder |
resources(Consumer<EnvironmentResourcesDescription.Builder> resources)
The description of the AWS resources used by this environment.
|
EnvironmentDescription.Builder |
resources(EnvironmentResourcesDescription resources)
The description of the AWS resources used by this environment.
|
EnvironmentDescription.Builder |
solutionStackName(String solutionStackName)
The name of the
SolutionStack deployed with this environment. |
EnvironmentDescription.Builder |
status(EnvironmentStatus status)
The current operational status of the environment:
|
EnvironmentDescription.Builder |
status(String status)
The current operational status of the environment:
|
EnvironmentDescription.Builder |
templateName(String templateName)
The name of the configuration template used to originally launch this environment.
|
default EnvironmentDescription.Builder |
tier(Consumer<EnvironmentTier.Builder> tier)
Describes the current tier of this environment.
|
EnvironmentDescription.Builder |
tier(EnvironmentTier tier)
Describes the current tier of this environment.
|
EnvironmentDescription.Builder |
versionLabel(String versionLabel)
The application version deployed in this environment.
|
copy
applyMutation, build
EnvironmentDescription.Builder environmentName(String environmentName)
The name of this environment.
environmentName
- The name of this environment.EnvironmentDescription.Builder environmentId(String environmentId)
The ID of this environment.
environmentId
- The ID of this environment.EnvironmentDescription.Builder applicationName(String applicationName)
The name of the application associated with this environment.
applicationName
- The name of the application associated with this environment.EnvironmentDescription.Builder versionLabel(String versionLabel)
The application version deployed in this environment.
versionLabel
- The application version deployed in this environment.EnvironmentDescription.Builder solutionStackName(String solutionStackName)
The name of the SolutionStack
deployed with this environment.
solutionStackName
- The name of the SolutionStack
deployed with this environment.EnvironmentDescription.Builder platformArn(String platformArn)
The ARN of the platform.
platformArn
- The ARN of the platform.EnvironmentDescription.Builder templateName(String templateName)
The name of the configuration template used to originally launch this environment.
templateName
- The name of the configuration template used to originally launch this environment.EnvironmentDescription.Builder description(String description)
Describes this environment.
description
- Describes this environment.EnvironmentDescription.Builder endpointURL(String endpointURL)
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
endpointURL
- For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance
environments, the IP address of the instance.EnvironmentDescription.Builder cname(String cname)
The URL to the CNAME for this environment.
cname
- The URL to the CNAME for this environment.EnvironmentDescription.Builder dateCreated(Instant dateCreated)
The creation date for this environment.
dateCreated
- The creation date for this environment.EnvironmentDescription.Builder dateUpdated(Instant dateUpdated)
The last modified date for this environment.
dateUpdated
- The last modified date for this environment.EnvironmentDescription.Builder status(String 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.
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.
EnvironmentStatus
,
EnvironmentStatus
EnvironmentDescription.Builder status(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.
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.
EnvironmentStatus
,
EnvironmentStatus
EnvironmentDescription.Builder abortableOperationInProgress(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.
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.
EnvironmentDescription.Builder health(String 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
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
EnvironmentHealth
,
EnvironmentHealth
EnvironmentDescription.Builder health(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
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
EnvironmentHealth
,
EnvironmentHealth
EnvironmentDescription.Builder healthStatus(String healthStatus)
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
healthStatus
- Returns the health status of the application running in your environment. For more information, see Health Colors
and Statuses.EnvironmentHealthStatus
,
EnvironmentHealthStatus
EnvironmentDescription.Builder healthStatus(EnvironmentHealthStatus healthStatus)
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
healthStatus
- Returns the health status of the application running in your environment. For more information, see Health Colors
and Statuses.EnvironmentHealthStatus
,
EnvironmentHealthStatus
EnvironmentDescription.Builder resources(EnvironmentResourcesDescription resources)
The description of the AWS resources used by this environment.
resources
- The description of the AWS resources used by this environment.default EnvironmentDescription.Builder resources(Consumer<EnvironmentResourcesDescription.Builder> resources)
The description of the AWS resources used by this environment.
This is a convenience that creates an instance of theEnvironmentResourcesDescription.Builder
avoiding the need to create one manually via EnvironmentResourcesDescription.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to resources(EnvironmentResourcesDescription)
.resources
- a consumer that will call methods on EnvironmentResourcesDescription.Builder
resources(EnvironmentResourcesDescription)
EnvironmentDescription.Builder tier(EnvironmentTier tier)
Describes the current tier of this environment.
tier
- Describes the current tier of this environment.default EnvironmentDescription.Builder tier(Consumer<EnvironmentTier.Builder> tier)
Describes the current tier of this environment.
This is a convenience that creates an instance of theEnvironmentTier.Builder
avoiding the need to
create one manually via EnvironmentTier.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to tier(EnvironmentTier)
.tier
- a consumer that will call methods on EnvironmentTier.Builder
tier(EnvironmentTier)
EnvironmentDescription.Builder environmentLinks(Collection<EnvironmentLink> environmentLinks)
A list of links to other environments in the same group.
environmentLinks
- A list of links to other environments in the same group.EnvironmentDescription.Builder environmentLinks(EnvironmentLink... environmentLinks)
A list of links to other environments in the same group.
environmentLinks
- A list of links to other environments in the same group.EnvironmentDescription.Builder environmentLinks(Consumer<EnvironmentLink.Builder>... environmentLinks)
A list of links to other environments in the same group.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #environmentLinks(List)
.environmentLinks
- a consumer that will call methods on List.Builder
#environmentLinks(List)
EnvironmentDescription.Builder environmentArn(String environmentArn)
The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
environmentArn
- The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an
ARN.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.