Class TerminateEnvironmentRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Request to terminate an environment.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The ID of the environment to terminate.The name of the environment to terminate.Terminates the target environment even if another environment in the same group is dependent on it.Indicates whether the associated AWS resources should shut down when the environment is terminated:int
hashCode()
Terminates the target environment even if another environment in the same group is dependent on it.Indicates whether the associated AWS resources should shut down when the environment is terminated:void
setEnvironmentId
(String environmentId) The ID of the environment to terminate.void
setEnvironmentName
(String environmentName) The name of the environment to terminate.void
setForceTerminate
(Boolean forceTerminate) Terminates the target environment even if another environment in the same group is dependent on it.void
setTerminateResources
(Boolean terminateResources) Indicates whether the associated AWS resources should shut down when the environment is terminated:toString()
Returns a string representation of this object; useful for testing and debugging.withEnvironmentId
(String environmentId) The ID of the environment to terminate.withEnvironmentName
(String environmentName) The name of the environment to terminate.withForceTerminate
(Boolean forceTerminate) Terminates the target environment even if another environment in the same group is dependent on it.withTerminateResources
(Boolean terminateResources) Indicates whether the associated AWS resources should shut down when the environment is terminated:Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
TerminateEnvironmentRequest
public TerminateEnvironmentRequest()
-
-
Method Details
-
setEnvironmentId
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Parameters:
environmentId
- The ID of the environment to terminate.Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
-
getEnvironmentId
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Returns:
- The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
-
withEnvironmentId
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Parameters:
environmentId
- The ID of the environment to terminate.Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnvironmentName
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Parameters:
environmentName
- The name of the environment to terminate.Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
-
getEnvironmentName
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Returns:
- The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
-
withEnvironmentName
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Parameters:
environmentName
- The name of the environment to terminate.Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTerminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
- Parameters:
terminateResources
- Indicates whether the associated AWS resources should shut down when the environment is terminated:-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
-
-
-
getTerminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
- Returns:
- Indicates whether the associated AWS resources should shut down
when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
-
-
-
withTerminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
- Parameters:
terminateResources
- Indicates whether the associated AWS resources should shut down when the environment is terminated:-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
isTerminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
- Returns:
- Indicates whether the associated AWS resources should shut down
when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
-
-
-
setForceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
- Parameters:
forceTerminate
- Terminates the target environment even if another environment in the same group is dependent on it.
-
getForceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
- Returns:
- Terminates the target environment even if another environment in the same group is dependent on it.
-
withForceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
- Parameters:
forceTerminate
- Terminates the target environment even if another environment in the same group is dependent on it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isForceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
- Returns:
- Terminates the target environment even if another environment in the same group is dependent on it.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-