Class UpdateEnvironmentResult
- All Implemented Interfaces:
Serializable
,Cloneable
Describes the properties of an environment.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.The name of the application associated with this environment.getCNAME()
The URL to the CNAME for this environment.The creation date for this environment.The last modified date for this environment.Describes this environment.For load-balanced, autoscaling environments, the URL to the LoadBalancer.The ID of this environment.A list of links to other environments in the same group.The name of this environment.Describes the health status of the environment.Returns the health status of the application running in your environment.The description of the AWS resources used by this environment.The name of theSolutionStack
deployed with this environment.The current operational status of the environment:The name of the configuration template used to originally launch this environment.getTier()
Describes the current tier of this environment.The application version deployed in this environment.int
hashCode()
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.void
setAbortableOperationInProgress
(Boolean abortableOperationInProgress) Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.void
setApplicationName
(String applicationName) The name of the application associated with this environment.void
The URL to the CNAME for this environment.void
setDateCreated
(Date dateCreated) The creation date for this environment.void
setDateUpdated
(Date dateUpdated) The last modified date for this environment.void
setDescription
(String description) Describes this environment.void
setEndpointURL
(String endpointURL) For load-balanced, autoscaling environments, the URL to the LoadBalancer.void
setEnvironmentId
(String environmentId) The ID of this environment.void
setEnvironmentLinks
(Collection<EnvironmentLink> environmentLinks) A list of links to other environments in the same group.void
setEnvironmentName
(String environmentName) The name of this environment.void
setHealth
(EnvironmentHealth health) Describes the health status of the environment.void
Describes the health status of the environment.void
setHealthStatus
(EnvironmentHealthStatus healthStatus) Returns the health status of the application running in your environment.void
setHealthStatus
(String healthStatus) Returns the health status of the application running in your environment.void
setResources
(EnvironmentResourcesDescription resources) The description of the AWS resources used by this environment.void
setSolutionStackName
(String solutionStackName) The name of theSolutionStack
deployed with this environment.void
setStatus
(EnvironmentStatus status) The current operational status of the environment:void
The current operational status of the environment:void
setTemplateName
(String templateName) The name of the configuration template used to originally launch this environment.void
setTier
(EnvironmentTier tier) Describes the current tier of this environment.void
setVersionLabel
(String versionLabel) The application version deployed in this environment.toString()
Returns a string representation of this object; useful for testing and debugging.withAbortableOperationInProgress
(Boolean abortableOperationInProgress) Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.withApplicationName
(String applicationName) The name of the application associated with this environment.The URL to the CNAME for this environment.withDateCreated
(Date dateCreated) The creation date for this environment.withDateUpdated
(Date dateUpdated) The last modified date for this environment.withDescription
(String description) Describes this environment.withEndpointURL
(String endpointURL) For load-balanced, autoscaling environments, the URL to the LoadBalancer.withEnvironmentId
(String environmentId) The ID of this environment.withEnvironmentLinks
(EnvironmentLink... environmentLinks) A list of links to other environments in the same group.withEnvironmentLinks
(Collection<EnvironmentLink> environmentLinks) A list of links to other environments in the same group.withEnvironmentName
(String environmentName) The name of this environment.withHealth
(EnvironmentHealth health) Describes the health status of the environment.withHealth
(String health) Describes the health status of the environment.withHealthStatus
(EnvironmentHealthStatus healthStatus) Returns the health status of the application running in your environment.withHealthStatus
(String healthStatus) Returns the health status of the application running in your environment.withResources
(EnvironmentResourcesDescription resources) The description of the AWS resources used by this environment.withSolutionStackName
(String solutionStackName) The name of theSolutionStack
deployed with this environment.withStatus
(EnvironmentStatus status) The current operational status of the environment:withStatus
(String status) The current operational status of the environment:withTemplateName
(String templateName) The name of the configuration template used to originally launch this environment.withTier
(EnvironmentTier tier) Describes the current tier of this environment.withVersionLabel
(String versionLabel) The application version deployed in this environment.
-
Constructor Details
-
UpdateEnvironmentResult
public UpdateEnvironmentResult()
-
-
Method Details
-
setEnvironmentName
The name of this environment.
- Parameters:
environmentName
- The name of this environment.
-
getEnvironmentName
The name of this environment.
- Returns:
- The name of this environment.
-
withEnvironmentName
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.
-
setEnvironmentId
The ID of this environment.
- Parameters:
environmentId
- The ID of this environment.
-
getEnvironmentId
The ID of this environment.
- Returns:
- The ID of this environment.
-
withEnvironmentId
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.
-
setApplicationName
The name of the application associated with this environment.
- Parameters:
applicationName
- The name of the application associated with this environment.
-
getApplicationName
The name of the application associated with this environment.
- Returns:
- The name of the application associated with this environment.
-
withApplicationName
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.
-
setVersionLabel
The application version deployed in this environment.
- Parameters:
versionLabel
- The application version deployed in this environment.
-
getVersionLabel
The application version deployed in this environment.
- Returns:
- The application version deployed in this environment.
-
withVersionLabel
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.
-
setSolutionStackName
The name of the
SolutionStack
deployed with this environment.- Parameters:
solutionStackName
- The name of theSolutionStack
deployed with this environment.
-
getSolutionStackName
The name of the
SolutionStack
deployed with this environment.- Returns:
- The name of the
SolutionStack
deployed with this environment.
-
withSolutionStackName
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.
-
setTemplateName
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.
-
getTemplateName
The name of the configuration template used to originally launch this environment.
- Returns:
- The name of the configuration template used to originally launch this environment.
-
withTemplateName
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.
-
setDescription
Describes this environment.
- Parameters:
description
- Describes this environment.
-
getDescription
Describes this environment.
- Returns:
- Describes this environment.
-
withDescription
Describes this environment.
- Parameters:
description
- Describes this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEndpointURL
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.
-
getEndpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
- Returns:
- For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
-
withEndpointURL
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.
-
setCNAME
The URL to the CNAME for this environment.
- Parameters:
cNAME
- The URL to the CNAME for this environment.
-
getCNAME
The URL to the CNAME for this environment.
- Returns:
- The URL to the CNAME for this environment.
-
withCNAME
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.
-
setDateCreated
The creation date for this environment.
- Parameters:
dateCreated
- The creation date for this environment.
-
getDateCreated
The creation date for this environment.
- Returns:
- The creation date for this environment.
-
withDateCreated
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.
-
setDateUpdated
The last modified date for this environment.
- Parameters:
dateUpdated
- The last modified date for this environment.
-
getDateUpdated
The last modified date for this environment.
- Returns:
- The last modified date for this environment.
-
withDateUpdated
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.
-
setStatus
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.
-
- See Also:
-
-
getStatus
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:
- 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.
-
- See Also:
-
-
withStatus
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:
-
-
setStatus
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.
-
- See Also:
-
-
withStatus
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:
-
-
setAbortableOperationInProgress
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.
-
getAbortableOperationInProgress
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:
- 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.
-
withAbortableOperationInProgress
public UpdateEnvironmentResult withAbortableOperationInProgress(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.
-
isAbortableOperationInProgress
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:
- 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.
-
setHealth
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
orRestartEnvironement
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
orRestartEnvironement
request.
Default:
Grey
-
- See Also:
-
-
getHealth
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
orRestartEnvironement
request.
Default:
Grey
- Returns:
- 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
orRestartEnvironement
request.
Default:
Grey
-
- See Also:
-
-
withHealth
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
orRestartEnvironement
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
orRestartEnvironement
request.
Default:
Grey
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setHealth
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
orRestartEnvironement
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
orRestartEnvironement
request.
Default:
Grey
-
- See Also:
-
-
withHealth
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
orRestartEnvironement
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
orRestartEnvironement
request.
Default:
Grey
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setHealthStatus
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.- See Also:
-
getHealthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
- Returns:
- Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
- See Also:
-
withHealthStatus
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:
-
setHealthStatus
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.- See Also:
-
withHealthStatus
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:
-
setResources
The description of the AWS resources used by this environment.
- Parameters:
resources
- The description of the AWS resources used by this environment.
-
getResources
The description of the AWS resources used by this environment.
- Returns:
- The description of the AWS resources used by this environment.
-
withResources
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.
-
setTier
Describes the current tier of this environment.
- Parameters:
tier
- Describes the current tier of this environment.
-
getTier
Describes the current tier of this environment.
- Returns:
- Describes the current tier of this environment.
-
withTier
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.
-
getEnvironmentLinks
A list of links to other environments in the same group.
- Returns:
- A list of links to other environments in the same group.
-
setEnvironmentLinks
A list of links to other environments in the same group.
- Parameters:
environmentLinks
- A list of links to other environments in the same group.
-
withEnvironmentLinks
A list of links to other environments in the same group.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironmentLinks(java.util.Collection)
orwithEnvironmentLinks(java.util.Collection)
if you want to override the existing values.- 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.
-
withEnvironmentLinks
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-