#[non_exhaustive]
pub struct ComputeEnvironmentDetail {
Show 15 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>,
}
Expand description

An object that represents an Batch compute environment.

Fields (Non-exhaustive)§

This struct is marked as 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.
§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.

§tags: Option<HashMap<String, String>>

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.

Implementations§

source§

impl ComputeEnvironmentDetail

source

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 (_).

source

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

The Amazon Resource Name (ARN) of the compute environment.

source

pub fn unmanagedv_cpus(&self) -> Option<i32>

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

source

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

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

source

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags applied to the compute environment.

source

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.

source

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.

source

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

The current status of the compute environment (for example, CREATING or VALID).

source

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

A short, human-readable string to provide additional details for the current status of the compute environment.

source

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.

source

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.

source

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.

source

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.

source

pub fn container_orchestration_type(&self) -> Option<&OrchestrationType>

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

source

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

Unique identifier for the compute environment.

source§

impl ComputeEnvironmentDetail

source

pub fn builder() -> ComputeEnvironmentDetailBuilder

Creates a new builder-style object to manufacture ComputeEnvironmentDetail.

Trait Implementations§

source§

impl Clone for ComputeEnvironmentDetail

source§

fn clone(&self) -> ComputeEnvironmentDetail

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ComputeEnvironmentDetail

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq<ComputeEnvironmentDetail> for ComputeEnvironmentDetail

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for ComputeEnvironmentDetail

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more