Struct aws_sdk_batch::types::builders::ComputeEnvironmentDetailBuilder

#[non_exhaustive]
pub struct ComputeEnvironmentDetailBuilder { /* private fields */ }

A builder for ComputeEnvironmentDetail.

Implementations

impl ComputeEnvironmentDetailBuilder

pub fn compute_environment_name(self, input: impl Into<String>) -> Self

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

pub fn set_compute_environment_name(self, input: Option<String>) -> Self

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

pub fn compute_environment_arn(self, input: impl Into<String>) -> Self

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

pub fn set_compute_environment_arn(self, input: Option<String>) -> Self

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

pub fn unmanagedv_cpus(self, input: i32) -> Self

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

pub fn set_unmanagedv_cpus(self, input: Option<i32>) -> Self

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

pub fn ecs_cluster_arn(self, input: impl Into<String>) -> Self

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

pub fn set_ecs_cluster_arn(self, input: Option<String>) -> Self

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags applied to the compute environment.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags applied to the compute environment.

pub fn type(self, input: CeType) -> Self

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

pub fn set_type(self, input: Option<CeType>) -> Self

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

pub fn state(self, input: CeState) -> Self

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.

pub fn set_state(self, input: Option<CeState>) -> Self

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.

pub fn status(self, input: CeStatus) -> Self

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

pub fn set_status(self, input: Option<CeStatus>) -> Self

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

pub fn status_reason(self, input: impl Into<String>) -> Self

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

pub fn set_status_reason(self, input: Option<String>) -> Self

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

pub fn compute_resources(self, input: ComputeResource) -> Self

The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

pub fn set_compute_resources(self, input: Option<ComputeResource>) -> Self

The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

pub fn service_role(self, input: impl Into<String>) -> Self

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.

pub fn set_service_role(self, input: Option<String>) -> Self

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.

pub fn update_policy(self, input: UpdatePolicy) -> Self

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

pub fn set_update_policy(self, input: Option<UpdatePolicy>) -> Self

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

pub fn eks_configuration(self, input: EksConfiguration) -> Self

The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

pub fn set_eks_configuration(self, input: Option<EksConfiguration>) -> Self

The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

pub fn container_orchestration_type(self, input: OrchestrationType) -> Self

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

pub fn set_container_orchestration_type( self, input: Option<OrchestrationType> ) -> Self

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

pub fn uuid(self, input: impl Into<String>) -> Self

Unique identifier for the compute environment.

pub fn set_uuid(self, input: Option<String>) -> Self

Unique identifier for the compute environment.

pub fn build(self) -> ComputeEnvironmentDetail

Consumes the builder and constructs a ComputeEnvironmentDetail.

Trait Implementations

impl Clone for ComputeEnvironmentDetailBuilder

fn clone(&self) -> ComputeEnvironmentDetailBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComputeEnvironmentDetailBuilder

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

Formats the value using the given formatter.

impl Default for ComputeEnvironmentDetailBuilder

fn default() -> ComputeEnvironmentDetailBuilder

Returns the “default value” for a type.

impl PartialEq<ComputeEnvironmentDetailBuilder> for ComputeEnvironmentDetailBuilder

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

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

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.

impl StructuralPartialEq for ComputeEnvironmentDetailBuilder