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

Interface TerminateEnvironmentRequest.Builder

    • Method Detail

      • environmentId

        TerminateEnvironmentRequest.Builder environmentId​(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.

      • environmentName

        TerminateEnvironmentRequest.Builder environmentName​(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.

      • terminateResources

        TerminateEnvironmentRequest.Builder terminateResources​(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.

      • forceTerminate

        TerminateEnvironmentRequest.Builder forceTerminate​(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.