Package software.amazon.awssdk.services.elasticbeanstalk.model

Class TerminateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.TerminateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class TerminateEnvironmentRequest
extends ElasticBeanstalkRequest
implements ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>

Request to terminate an environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TerminateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method	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	equalsBySdkFields(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)
int	hashCode()
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

environmentId

public final 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.

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.

environmentName

public final 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.

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.

terminateResources

public final 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

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

forceTerminate

public final Boolean forceTerminate()

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.

toBuilder

public TerminateEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static TerminateEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TerminateEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo