Interface UpdateEnvironmentResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<UpdateEnvironmentResponse.Builder,
,UpdateEnvironmentResponse> ElasticBeanstalkResponse.Builder
,SdkBuilder<UpdateEnvironmentResponse.Builder,
,UpdateEnvironmentResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
UpdateEnvironmentResponse
-
Method Summary
Modifier and TypeMethodDescriptionabortableOperationInProgress
(Boolean abortableOperationInProgress) Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.applicationName
(String applicationName) The name of the application associated with this environment.The URL to the CNAME for this environment.dateCreated
(Instant dateCreated) The creation date for this environment.dateUpdated
(Instant dateUpdated) The last modified date for this environment.description
(String description) Describes this environment.endpointURL
(String endpointURL) For load-balanced, autoscaling environments, the URL to the LoadBalancer.environmentArn
(String environmentArn) The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.environmentId
(String environmentId) The ID of this environment.environmentLinks
(Collection<EnvironmentLink> environmentLinks) A list of links to other environments in the same group.environmentLinks
(Consumer<EnvironmentLink.Builder>... environmentLinks) A list of links to other environments in the same group.environmentLinks
(EnvironmentLink... environmentLinks) A list of links to other environments in the same group.environmentName
(String environmentName) The name of this environment.Describes the health status of the environment.health
(EnvironmentHealth health) Describes the health status of the environment.healthStatus
(String healthStatus) Returns the health status of the application running in your environment.healthStatus
(EnvironmentHealthStatus healthStatus) Returns the health status of the application running in your environment.operationsRole
(String operationsRole) The Amazon Resource Name (ARN) of the environment's operations role.platformArn
(String platformArn) The ARN of the platform version.resources
(Consumer<EnvironmentResourcesDescription.Builder> resources) The description of the AWS resources used by this environment.resources
(EnvironmentResourcesDescription resources) The description of the AWS resources used by this environment.solutionStackName
(String solutionStackName) The name of theSolutionStack
deployed with this environment.The current operational status of the environment:status
(EnvironmentStatus status) The current operational status of the environment:templateName
(String templateName) The name of the configuration template used to originally launch this environment.tier
(Consumer<EnvironmentTier.Builder> tier) Describes the current tier of this environment.tier
(EnvironmentTier tier) Describes the current tier of this environment.versionLabel
(String versionLabel) The application version deployed in this environment.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
environmentName
The name of this environment.
- Parameters:
environmentName
- The name of this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentId
The ID of this environment.
- Parameters:
environmentId
- The ID of this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applicationName
The name of the application associated with this environment.
- Parameters:
applicationName
- The name of the application associated with this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionLabel
The application version deployed in this environment.
- Parameters:
versionLabel
- The application version deployed in this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionStackName
The name of the
SolutionStack
deployed with this environment.- Parameters:
solutionStackName
- The name of theSolutionStack
deployed with this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformArn
The ARN of the platform version.
- Parameters:
platformArn
- The ARN of the platform version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateName
The name of the configuration template used to originally launch this environment.
- Parameters:
templateName
- The name of the configuration template used to originally launch this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
Describes this environment.
- Parameters:
description
- Describes this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
- Parameters:
endpointURL
- For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cname
The URL to the CNAME for this environment.
- Parameters:
cname
- The URL to the CNAME for this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateCreated
The creation date for this environment.
- Parameters:
dateCreated
- The creation date for this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateUpdated
The last modified date for this environment.
- Parameters:
dateUpdated
- The last modified date for this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
abortableOperationInProgress
UpdateEnvironmentResponse.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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
- Parameters:
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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
- Parameters:
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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
- Parameters:
healthStatus
- Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
- Parameters:
healthStatus
- Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resources
The description of the AWS resources used by this environment.
- Parameters:
resources
- The description of the AWS resources used by this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resources
default UpdateEnvironmentResponse.Builder resources(Consumer<EnvironmentResourcesDescription.Builder> resources) The description of the AWS resources used by this environment.
This is a convenience method that creates an instance of theEnvironmentResourcesDescription.Builder
avoiding the need to create one manually viaEnvironmentResourcesDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresources(EnvironmentResourcesDescription)
.- Parameters:
resources
- a consumer that will call methods onEnvironmentResourcesDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tier
Describes the current tier of this environment.
- Parameters:
tier
- Describes the current tier of this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tier
Describes the current tier of this environment.
This is a convenience method that creates an instance of theEnvironmentTier.Builder
avoiding the need to create one manually viaEnvironmentTier.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totier(EnvironmentTier)
.- Parameters:
tier
- a consumer that will call methods onEnvironmentTier.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentLinks
A list of links to other environments in the same group.
- Parameters:
environmentLinks
- A list of links to other environments in the same group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentLinks
A list of links to other environments in the same group.
- Parameters:
environmentLinks
- A list of links to other environments in the same group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentLinks
UpdateEnvironmentResponse.Builder environmentLinks(Consumer<EnvironmentLink.Builder>... environmentLinks) A list of links to other environments in the same group.
This is a convenience method that creates an instance of theEnvironmentLink.Builder
avoiding the need to create one manually viaEnvironmentLink.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironmentLinks(List<EnvironmentLink>)
.- Parameters:
environmentLinks
- a consumer that will call methods onEnvironmentLink.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentArn
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
- Parameters:
environmentArn
- The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationsRole
The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
- Parameters:
operationsRole
- The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-