Struct TerminateEnvironmentInput

#[non_exhaustive]
pub struct TerminateEnvironmentInput {
    pub environment_id: Option<String>,
    pub environment_name: Option<String>,
    pub terminate_resources: Option<bool>,
    pub force_terminate: Option<bool>,
}

Request to terminate an environment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

environment_id: Option<String>

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.

environment_name: Option<String>

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.

terminate_resources: Option<bool>

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

force_terminate: Option<bool>

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

Implementations

impl TerminateEnvironmentInput

pub fn environment_id(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<bool>

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) -> Option<bool>

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

impl TerminateEnvironmentInput

pub fn builder() -> TerminateEnvironmentInputBuilder

Creates a new builder-style object to manufacture TerminateEnvironmentInput.

Trait Implementations

impl Clone for TerminateEnvironmentInput

fn clone(&self) -> TerminateEnvironmentInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminateEnvironmentInput

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

Formats the value using the given formatter.

impl PartialEq for TerminateEnvironmentInput

fn eq(&self, other: &TerminateEnvironmentInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TerminateEnvironmentInput