Class TerminateEnvironmentRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class TerminateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Request to terminate an environment.

See Also:
  • Constructor Details

    • TerminateEnvironmentRequest

      public TerminateEnvironmentRequest()
  • Method Details

    • setEnvironmentId

      public void setEnvironmentId(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.

      Parameters:
      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.

    • getEnvironmentId

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

      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.

    • withEnvironmentId

      public TerminateEnvironmentRequest withEnvironmentId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setEnvironmentName

      public void setEnvironmentName(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.

      Parameters:
      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.

    • getEnvironmentName

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

      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.

    • withEnvironmentName

      public TerminateEnvironmentRequest withEnvironmentName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setTerminateResources

      public void setTerminateResources(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

      Parameters:
      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

    • getTerminateResources

      public 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

      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

    • withTerminateResources

      public TerminateEnvironmentRequest withTerminateResources(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • isTerminateResources

      public 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

      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

    • setForceTerminate

      public void setForceTerminate(Boolean forceTerminate)

      Terminates the target environment even if another environment in the same group is dependent on it.

      Parameters:
      forceTerminate - Terminates the target environment even if another environment in the same group is dependent on it.
    • getForceTerminate

      public Boolean getForceTerminate()

      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.
    • withForceTerminate

      public TerminateEnvironmentRequest withForceTerminate(Boolean forceTerminate)

      Terminates the target environment even if another environment in the same group is dependent on it.

      Parameters:
      forceTerminate - Terminates the target environment even if another environment in the same group is dependent on it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isForceTerminate

      public Boolean isForceTerminate()

      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.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: