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

Class TerminateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>

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

Request to terminate an environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TerminateEnvironmentRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

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	forceTerminate()	Terminates the target environment even if another environment in the same group is dependent on it.
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

environmentId

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.

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 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 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>

Returns:

a builder for type T

builder

public static TerminateEnvironmentRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object