@Generated(value="software.amazon.awssdk:codegen") public final class TerminateEnvironmentRequest extends ElasticBeanstalkRequest implements ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>
Request to terminate an environment.
Modifier and Type | Class and Description |
---|---|
static interface |
TerminateEnvironmentRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static TerminateEnvironmentRequest.Builder |
builder() |
String |
environmentId()
The ID of the environment to terminate.
|
String |
environmentName()
The name of the environment to terminate.
|
boolean |
equals(Object obj) |
Boolean |
forceTerminate()
Terminates the target environment even if another environment in the same group is dependent on it.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
static Class<? extends TerminateEnvironmentRequest.Builder> |
serializableBuilderClass() |
Boolean |
terminateResources()
Indicates whether the associated AWS resources should shut down when the environment is terminated:
|
TerminateEnvironmentRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS
Elastic Beanstalk returns MissingRequiredParameter
error.
public 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.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS
Elastic Beanstalk returns MissingRequiredParameter
error.
public 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
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 Boolean forceTerminate()
Terminates the target environment even if another environment in the same group is dependent on it.
public TerminateEnvironmentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>
toBuilder
in class ElasticBeanstalkRequest
public static TerminateEnvironmentRequest.Builder builder()
public static Class<? extends TerminateEnvironmentRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.