Struct aws_sdk_elasticbeanstalk::model::EnvironmentDescription

#[non_exhaustive]
pub struct EnvironmentDescription {

    pub environment_name: Option<String>,
    pub environment_id: Option<String>,
    pub application_name: Option<String>,
    pub version_label: Option<String>,
    pub solution_stack_name: Option<String>,
    pub platform_arn: Option<String>,
    pub template_name: Option<String>,
    pub description: Option<String>,
    pub endpoint_url: Option<String>,
    pub cname: Option<String>,
    pub date_created: Option<DateTime>,
    pub date_updated: Option<DateTime>,
    pub status: Option<EnvironmentStatus>,
    pub abortable_operation_in_progress: Option<bool>,
    pub health: Option<EnvironmentHealth>,
    pub health_status: Option<EnvironmentHealthStatus>,
    pub resources: Option<EnvironmentResourcesDescription>,
    pub tier: Option<EnvironmentTier>,
    pub environment_links: Option<Vec<EnvironmentLink>>,
    pub environment_arn: Option<String>,
    pub operations_role: Option<String>,
}

Describes the properties of 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_name: Option<String>

The name of this environment.

environment_id: Option<String>

The ID of this environment.

application_name: Option<String>

The name of the application associated with this environment.

version_label: Option<String>

The application version deployed in this environment.

solution_stack_name: Option<String>

The name of the SolutionStack deployed with this environment.

platform_arn: Option<String>

The ARN of the platform version.

template_name: Option<String>

The name of the configuration template used to originally launch this environment.

description: Option<String>

Describes this environment.

endpoint_url: Option<String>

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

cname: Option<String>

The URL to the CNAME for this environment.

date_created: Option<DateTime>

The creation date for this environment.

date_updated: Option<DateTime>

The last modified date for this environment.

status: Option<EnvironmentStatus>

The current operational status of the environment:

• Launching: Environment is in the process of initial deployment.

• Updating: Environment is in the process of updating its configuration settings or application version.

• Ready: Environment is available to have an action performed on it, such as update or terminate.

• Terminating: Environment is in the shut-down process.

• Terminated: Environment is not running.

abortable_operation_in_progress: Option<bool>

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

health: Option<EnvironmentHealth>

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

• Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

• Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

• Green: Indicates the environment is healthy and fully functional.

• Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

Default: Grey

health_status: Option<EnvironmentHealthStatus>

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

resources: Option<EnvironmentResourcesDescription>

The description of the AWS resources used by this environment.

tier: Option<EnvironmentTier>

Describes the current tier of this environment.

environment_links: Option<Vec<EnvironmentLink>>

A list of links to other environments in the same group.

environment_arn: Option<String>

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

operations_role: Option<String>

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Implementations

impl EnvironmentDescription

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

The name of this environment.

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

The ID of this environment.

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

The name of the application associated with this environment.

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

The application version deployed in this environment.

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

The name of the SolutionStack deployed with this environment.

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

The ARN of the platform version.

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

The name of the configuration template used to originally launch this environment.

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

Describes this environment.

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

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

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

The URL to the CNAME for this environment.

pub fn date_created(&self) -> Option<&DateTime>

The creation date for this environment.

pub fn date_updated(&self) -> Option<&DateTime>

The last modified date for this environment.

pub fn status(&self) -> Option<&EnvironmentStatus>

The current operational status of the environment:

• Launching: Environment is in the process of initial deployment.

• Updating: Environment is in the process of updating its configuration settings or application version.

• Ready: Environment is available to have an action performed on it, such as update or terminate.

• Terminating: Environment is in the shut-down process.

• Terminated: Environment is not running.

pub fn abortable_operation_in_progress(&self) -> Option<bool>

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

pub fn health(&self) -> Option<&EnvironmentHealth>

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

• Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

• Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

• Green: Indicates the environment is healthy and fully functional.

• Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

Default: Grey

pub fn health_status(&self) -> Option<&EnvironmentHealthStatus>

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

pub fn resources(&self) -> Option<&EnvironmentResourcesDescription>

The description of the AWS resources used by this environment.

pub fn tier(&self) -> Option<&EnvironmentTier>

Describes the current tier of this environment.

pub fn environment_links(&self) -> Option<&[EnvironmentLink]>

A list of links to other environments in the same group.

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

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

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

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

impl EnvironmentDescription

pub fn builder() -> Builder

Creates a new builder-style object to manufacture EnvironmentDescription

Trait Implementations

impl Clone for EnvironmentDescription

fn clone(&self) -> EnvironmentDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentDescription

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

Formats the value using the given formatter.

impl PartialEq<EnvironmentDescription> for EnvironmentDescription

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for EnvironmentDescription