Struct aws_sdk_elasticbeanstalk::client::fluent_builders::TerminateEnvironment

pub struct TerminateEnvironment { /* private fields */ }

Fluent builder constructing a request to TerminateEnvironment.

Terminates the specified environment.

Implementations

impl TerminateEnvironment

pub async fn send(
    self
) -> Result<TerminateEnvironmentOutput, SdkError<TerminateEnvironmentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn environment_id(self, input: impl Into<String>) -> Self

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.

pub fn set_environment_id(self, input: Option<String>) -> Self

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.

pub fn environment_name(self, input: impl Into<String>) -> Self

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.

pub fn set_environment_name(self, input: Option<String>) -> Self

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.

pub fn terminate_resources(self, input: bool) -> Self

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

pub fn set_terminate_resources(self, input: Option<bool>) -> Self

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

pub fn force_terminate(self, input: bool) -> Self

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

pub fn set_force_terminate(self, input: Option<bool>) -> Self

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

Trait Implementations

impl Clone for TerminateEnvironment

fn clone(&self) -> TerminateEnvironment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TerminateEnvironment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.