public class TerminateEnvironmentRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Request to terminate an environment.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
environmentId
The ID of the environment to terminate.
|
private java.lang.String |
environmentName
The name of the environment to terminate.
|
private java.lang.Boolean |
forceTerminate
Terminates the target environment even if another environment in the same
group is dependent on it.
|
private java.lang.Boolean |
terminateResources
Indicates whether the associated AWS resources should shut down when the
environment is terminated:
|
NOOP
Constructor and Description |
---|
TerminateEnvironmentRequest() |
Modifier and Type | Method and Description |
---|---|
TerminateEnvironmentRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getEnvironmentId()
The ID of the environment to terminate.
|
java.lang.String |
getEnvironmentName()
The name of the environment to terminate.
|
java.lang.Boolean |
getForceTerminate()
Terminates the target environment even if another environment in the same
group is dependent on it.
|
java.lang.Boolean |
getTerminateResources()
Indicates whether the associated AWS resources should shut down when the
environment is terminated:
|
int |
hashCode() |
java.lang.Boolean |
isForceTerminate()
Terminates the target environment even if another environment in the same
group is dependent on it.
|
java.lang.Boolean |
isTerminateResources()
Indicates whether the associated AWS resources should shut down when the
environment is terminated:
|
void |
setEnvironmentId(java.lang.String environmentId)
The ID of the environment to terminate.
|
void |
setEnvironmentName(java.lang.String environmentName)
The name of the environment to terminate.
|
void |
setForceTerminate(java.lang.Boolean forceTerminate)
Terminates the target environment even if another environment in the same
group is dependent on it.
|
void |
setTerminateResources(java.lang.Boolean terminateResources)
Indicates whether the associated AWS resources should shut down when the
environment is terminated:
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TerminateEnvironmentRequest |
withEnvironmentId(java.lang.String environmentId)
The ID of the environment to terminate.
|
TerminateEnvironmentRequest |
withEnvironmentName(java.lang.String environmentName)
The name of the environment to terminate.
|
TerminateEnvironmentRequest |
withForceTerminate(java.lang.Boolean forceTerminate)
Terminates the target environment even if another environment in the same
group is dependent on it.
|
TerminateEnvironmentRequest |
withTerminateResources(java.lang.Boolean terminateResources)
Indicates whether the associated AWS resources should shut down when the
environment is terminated:
|
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
private java.lang.String 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.
private java.lang.String 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.
private java.lang.Boolean 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
private java.lang.Boolean forceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
public void setEnvironmentId(java.lang.String 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.
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.
public java.lang.String 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.
Condition: You must specify either this or an EnvironmentName, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
public TerminateEnvironmentRequest withEnvironmentId(java.lang.String 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.
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.
public void setEnvironmentName(java.lang.String 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.
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.
public java.lang.String 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.
Condition: You must specify either this or an EnvironmentId, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
public TerminateEnvironmentRequest withEnvironmentName(java.lang.String 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.
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.
public void setTerminateResources(java.lang.Boolean 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
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
public java.lang.Boolean 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
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
public TerminateEnvironmentRequest withTerminateResources(java.lang.Boolean 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
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
public java.lang.Boolean 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
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
public void setForceTerminate(java.lang.Boolean forceTerminate)
Terminates the target environment even if another environment in the same group is dependent on it.
forceTerminate
- Terminates the target environment even if another environment in
the same group is dependent on it.public java.lang.Boolean getForceTerminate()
Terminates the target environment even if another environment in the same group is dependent on it.
public TerminateEnvironmentRequest withForceTerminate(java.lang.Boolean forceTerminate)
Terminates the target environment even if another environment in the same group is dependent on it.
forceTerminate
- Terminates the target environment even if another environment in
the same group is dependent on it.public java.lang.Boolean isForceTerminate()
Terminates the target environment even if another environment in the same group is dependent on it.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public TerminateEnvironmentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()