#[non_exhaustive]pub struct EnvironmentDescription {Show 21 fields
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>,
}
Expand description
Describes the properties of an environment.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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 anUpdateEnvironment
orRestartEnvironment
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§
source§impl EnvironmentDescription
impl EnvironmentDescription
sourcepub fn environment_name(&self) -> Option<&str>
pub fn environment_name(&self) -> Option<&str>
The name of this environment.
sourcepub fn environment_id(&self) -> Option<&str>
pub fn environment_id(&self) -> Option<&str>
The ID of this environment.
sourcepub fn application_name(&self) -> Option<&str>
pub fn application_name(&self) -> Option<&str>
The name of the application associated with this environment.
sourcepub fn version_label(&self) -> Option<&str>
pub fn version_label(&self) -> Option<&str>
The application version deployed in this environment.
sourcepub fn solution_stack_name(&self) -> Option<&str>
pub fn solution_stack_name(&self) -> Option<&str>
The name of the SolutionStack
deployed with this environment.
sourcepub fn platform_arn(&self) -> Option<&str>
pub fn platform_arn(&self) -> Option<&str>
The ARN of the platform version.
sourcepub fn template_name(&self) -> Option<&str>
pub fn template_name(&self) -> Option<&str>
The name of the configuration template used to originally launch this environment.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
Describes this environment.
sourcepub fn endpoint_url(&self) -> Option<&str>
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.
sourcepub fn date_created(&self) -> Option<&DateTime>
pub fn date_created(&self) -> Option<&DateTime>
The creation date for this environment.
sourcepub fn date_updated(&self) -> Option<&DateTime>
pub fn date_updated(&self) -> Option<&DateTime>
The last modified date for this environment.
sourcepub fn status(&self) -> Option<&EnvironmentStatus>
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.
sourcepub fn abortable_operation_in_progress(&self) -> Option<bool>
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.
sourcepub fn health(&self) -> Option<&EnvironmentHealth>
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 anUpdateEnvironment
orRestartEnvironment
request.
Default: Grey
sourcepub fn health_status(&self) -> Option<&EnvironmentHealthStatus>
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.
sourcepub fn resources(&self) -> Option<&EnvironmentResourcesDescription>
pub fn resources(&self) -> Option<&EnvironmentResourcesDescription>
The description of the AWS resources used by this environment.
sourcepub fn tier(&self) -> Option<&EnvironmentTier>
pub fn tier(&self) -> Option<&EnvironmentTier>
Describes the current tier of this environment.
sourcepub fn environment_links(&self) -> &[EnvironmentLink]
pub fn environment_links(&self) -> &[EnvironmentLink]
A list of links to other environments in the same group.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment_links.is_none()
.
sourcepub fn environment_arn(&self) -> Option<&str>
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.
sourcepub fn operations_role(&self) -> Option<&str>
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.
source§impl EnvironmentDescription
impl EnvironmentDescription
sourcepub fn builder() -> EnvironmentDescriptionBuilder
pub fn builder() -> EnvironmentDescriptionBuilder
Creates a new builder-style object to manufacture EnvironmentDescription
.
Trait Implementations§
source§impl Clone for EnvironmentDescription
impl Clone for EnvironmentDescription
source§fn clone(&self) -> EnvironmentDescription
fn clone(&self) -> EnvironmentDescription
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for EnvironmentDescription
impl Debug for EnvironmentDescription
source§impl PartialEq for EnvironmentDescription
impl PartialEq for EnvironmentDescription
source§fn eq(&self, other: &EnvironmentDescription) -> bool
fn eq(&self, other: &EnvironmentDescription) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for EnvironmentDescription
Auto Trait Implementations§
impl Freeze for EnvironmentDescription
impl RefUnwindSafe for EnvironmentDescription
impl Send for EnvironmentDescription
impl Sync for EnvironmentDescription
impl Unpin for EnvironmentDescription
impl UnwindSafe for EnvironmentDescription
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more