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.

  • Method Details

    • 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()
      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>
      Specified by:
      toBuilder in class ElasticBeanstalkRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.