#[non_exhaustive]pub struct UpdateComputeEnvironmentInput {
pub compute_environment: Option<String>,
pub state: Option<CeState>,
pub unmanagedv_cpus: Option<i32>,
pub compute_resources: Option<ComputeResourceUpdate>,
pub service_role: Option<String>,
pub update_policy: Option<UpdatePolicy>,
}
Expand description
Contains the parameters for UpdateComputeEnvironment
.
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: Option<String>
The name or full Amazon Resource Name (ARN) of the compute environment to update.
state: Option<CeState>
The state of the compute environment. Compute environments in the ENABLED
state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.
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.
unmanagedv_cpus: Option<i32>
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
compute_resources: Option<ComputeResourceUpdate>
Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.
service_role: Option<String>
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role
path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
update_policy: Option<UpdatePolicy>
Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
Implementations§
source§impl UpdateComputeEnvironmentInput
impl UpdateComputeEnvironmentInput
sourcepub fn compute_environment(&self) -> Option<&str>
pub fn compute_environment(&self) -> Option<&str>
The name or full Amazon Resource Name (ARN) of the compute environment to update.
sourcepub fn state(&self) -> Option<&CeState>
pub fn state(&self) -> Option<&CeState>
The state of the compute environment. Compute environments in the ENABLED
state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.
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 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. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
sourcepub fn compute_resources(&self) -> Option<&ComputeResourceUpdate>
pub fn compute_resources(&self) -> Option<&ComputeResourceUpdate>
Details of the compute resources managed by the compute environment. Required for a managed 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 full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role
path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
sourcepub fn update_policy(&self) -> Option<&UpdatePolicy>
pub fn update_policy(&self) -> Option<&UpdatePolicy>
Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
source§impl UpdateComputeEnvironmentInput
impl UpdateComputeEnvironmentInput
sourcepub fn builder() -> UpdateComputeEnvironmentInputBuilder
pub fn builder() -> UpdateComputeEnvironmentInputBuilder
Creates a new builder-style object to manufacture UpdateComputeEnvironmentInput
.
Trait Implementations§
source§impl Clone for UpdateComputeEnvironmentInput
impl Clone for UpdateComputeEnvironmentInput
source§fn clone(&self) -> UpdateComputeEnvironmentInput
fn clone(&self) -> UpdateComputeEnvironmentInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq<UpdateComputeEnvironmentInput> for UpdateComputeEnvironmentInput
impl PartialEq<UpdateComputeEnvironmentInput> for UpdateComputeEnvironmentInput
source§fn eq(&self, other: &UpdateComputeEnvironmentInput) -> bool
fn eq(&self, other: &UpdateComputeEnvironmentInput) -> bool
self
and other
values to be equal, and is used
by ==
.