#[non_exhaustive]pub struct ComputeEnvironmentDetail {Show 16 fields
pub compute_environment_name: Option<String>,
pub compute_environment_arn: Option<String>,
pub unmanagedv_cpus: Option<i32>,
pub ecs_cluster_arn: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub type: Option<CeType>,
pub state: Option<CeState>,
pub status: Option<CeStatus>,
pub status_reason: Option<String>,
pub compute_resources: Option<ComputeResource>,
pub service_role: Option<String>,
pub update_policy: Option<UpdatePolicy>,
pub eks_configuration: Option<EksConfiguration>,
pub container_orchestration_type: Option<OrchestrationType>,
pub uuid: Option<String>,
pub context: Option<String>,
}
Expand description
An object that represents an Batch compute 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.compute_environment_name: Option<String>
The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
compute_environment_arn: Option<String>
The Amazon Resource Name (ARN) of the compute environment.
unmanagedv_cpus: Option<i32>
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
ecs_cluster_arn: Option<String>
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
The tags applied to the compute environment.
type: Option<CeType>
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute environments in the Batch User Guide.
state: Option<CeState>
The state of the compute environment. The valid values are ENABLED
or DISABLED
.
If the state is ENABLED
, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.
If the state is DISABLED
, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING
or RUNNING
state continue to progress normally. Managed compute environments in the DISABLED
state don't scale out.
Compute environments in a DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus
value. However, the instance size doesn't change. For example, consider a c5.8xlarge
instance with a minvCpus
value of 4
and a desiredvCpus
value of 36
. This instance doesn't scale down to a c5.large
instance.
status: Option<CeStatus>
The current status of the compute environment (for example, CREATING
or VALID
).
status_reason: Option<String>
A short, human-readable string to provide additional details for the current status of the compute environment.
compute_resources: Option<ComputeResource>
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
service_role: Option<String>
The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
update_policy: Option<UpdatePolicy>
Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
eks_configuration: Option<EksConfiguration>
The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType
is EKS
.
container_orchestration_type: Option<OrchestrationType>
The orchestration type of the compute environment. The valid values are ECS
(default) or EKS
.
uuid: Option<String>
Unique identifier for the compute environment.
context: Option<String>
Reserved.
Implementations§
Source§impl ComputeEnvironmentDetail
impl ComputeEnvironmentDetail
Sourcepub fn compute_environment_name(&self) -> Option<&str>
pub fn compute_environment_name(&self) -> Option<&str>
The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn compute_environment_arn(&self) -> Option<&str>
pub fn compute_environment_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the compute environment.
Sourcepub fn unmanagedv_cpus(&self) -> Option<i32>
pub fn unmanagedv_cpus(&self) -> Option<i32>
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
Sourcepub fn ecs_cluster_arn(&self) -> Option<&str>
pub fn ecs_cluster_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
The tags applied to the compute environment.
Sourcepub fn type(&self) -> Option<&CeType>
pub fn type(&self) -> Option<&CeType>
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute environments in the Batch User Guide.
Sourcepub fn state(&self) -> Option<&CeState>
pub fn state(&self) -> Option<&CeState>
The state of the compute environment. The valid values are ENABLED
or DISABLED
.
If the state is ENABLED
, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.
If the state is DISABLED
, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING
or RUNNING
state continue to progress normally. Managed compute environments in the DISABLED
state don't scale out.
Compute environments in a DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus
value. However, the instance size doesn't change. For example, consider a c5.8xlarge
instance with a minvCpus
value of 4
and a desiredvCpus
value of 36
. This instance doesn't scale down to a c5.large
instance.
Sourcepub fn status(&self) -> Option<&CeStatus>
pub fn status(&self) -> Option<&CeStatus>
The current status of the compute environment (for example, CREATING
or VALID
).
Sourcepub fn status_reason(&self) -> Option<&str>
pub fn status_reason(&self) -> Option<&str>
A short, human-readable string to provide additional details for the current status of the compute environment.
Sourcepub fn compute_resources(&self) -> Option<&ComputeResource>
pub fn compute_resources(&self) -> Option<&ComputeResource>
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
Sourcepub fn service_role(&self) -> Option<&str>
pub fn service_role(&self) -> Option<&str>
The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
Sourcepub fn update_policy(&self) -> Option<&UpdatePolicy>
pub fn update_policy(&self) -> Option<&UpdatePolicy>
Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
Sourcepub fn eks_configuration(&self) -> Option<&EksConfiguration>
pub fn eks_configuration(&self) -> Option<&EksConfiguration>
The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType
is EKS
.
Sourcepub fn container_orchestration_type(&self) -> Option<&OrchestrationType>
pub fn container_orchestration_type(&self) -> Option<&OrchestrationType>
The orchestration type of the compute environment. The valid values are ECS
(default) or EKS
.
Source§impl ComputeEnvironmentDetail
impl ComputeEnvironmentDetail
Sourcepub fn builder() -> ComputeEnvironmentDetailBuilder
pub fn builder() -> ComputeEnvironmentDetailBuilder
Creates a new builder-style object to manufacture ComputeEnvironmentDetail
.
Trait Implementations§
Source§impl Clone for ComputeEnvironmentDetail
impl Clone for ComputeEnvironmentDetail
Source§fn clone(&self) -> ComputeEnvironmentDetail
fn clone(&self) -> ComputeEnvironmentDetail
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComputeEnvironmentDetail
impl Debug for ComputeEnvironmentDetail
Source§impl PartialEq for ComputeEnvironmentDetail
impl PartialEq for ComputeEnvironmentDetail
impl StructuralPartialEq for ComputeEnvironmentDetail
Auto Trait Implementations§
impl Freeze for ComputeEnvironmentDetail
impl RefUnwindSafe for ComputeEnvironmentDetail
impl Send for ComputeEnvironmentDetail
impl Sync for ComputeEnvironmentDetail
impl Unpin for ComputeEnvironmentDetail
impl UnwindSafe for ComputeEnvironmentDetail
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);