pub struct UpdateComputeEnvironmentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateComputeEnvironment
.
Updates an Batch compute environment.
Implementations§
Source§impl UpdateComputeEnvironmentFluentBuilder
impl UpdateComputeEnvironmentFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateComputeEnvironmentInputBuilder
pub fn as_input(&self) -> &UpdateComputeEnvironmentInputBuilder
Access the UpdateComputeEnvironment as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateComputeEnvironmentOutput, SdkError<UpdateComputeEnvironmentError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateComputeEnvironmentOutput, SdkError<UpdateComputeEnvironmentError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateComputeEnvironmentOutput, UpdateComputeEnvironmentError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateComputeEnvironmentOutput, UpdateComputeEnvironmentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn compute_environment(self, input: impl Into<String>) -> Self
pub fn compute_environment(self, input: impl Into<String>) -> Self
The name or full Amazon Resource Name (ARN) of the compute environment to update.
Sourcepub fn set_compute_environment(self, input: Option<String>) -> Self
pub fn set_compute_environment(self, input: Option<String>) -> Self
The name or full Amazon Resource Name (ARN) of the compute environment to update.
Sourcepub fn get_compute_environment(&self) -> &Option<String>
pub fn get_compute_environment(&self) -> &Option<String>
The name or full Amazon Resource Name (ARN) of the compute environment to update.
Sourcepub fn state(self, input: CeState) -> Self
pub fn state(self, input: CeState) -> Self
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 set_state(self, input: Option<CeState>) -> Self
pub fn set_state(self, input: Option<CeState>) -> Self
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 get_state(&self) -> &Option<CeState>
pub fn get_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, input: i32) -> Self
pub fn unmanagedv_cpus(self, input: i32) -> Self
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 set_unmanagedv_cpus(self, input: Option<i32>) -> Self
pub fn set_unmanagedv_cpus(self, input: Option<i32>) -> Self
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 get_unmanagedv_cpus(&self) -> &Option<i32>
pub fn get_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, input: ComputeResourceUpdate) -> Self
pub fn compute_resources(self, input: ComputeResourceUpdate) -> Self
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 set_compute_resources(self, input: Option<ComputeResourceUpdate>) -> Self
pub fn set_compute_resources(self, input: Option<ComputeResourceUpdate>) -> Self
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 get_compute_resources(&self) -> &Option<ComputeResourceUpdate>
pub fn get_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, input: impl Into<String>) -> Self
pub fn service_role(self, input: impl Into<String>) -> Self
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 set_service_role(self, input: Option<String>) -> Self
pub fn set_service_role(self, input: Option<String>) -> Self
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 get_service_role(&self) -> &Option<String>
pub fn get_service_role(&self) -> &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.
Sourcepub fn update_policy(self, input: UpdatePolicy) -> Self
pub fn update_policy(self, input: UpdatePolicy) -> Self
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.
Sourcepub fn set_update_policy(self, input: Option<UpdatePolicy>) -> Self
pub fn set_update_policy(self, input: Option<UpdatePolicy>) -> Self
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.
Sourcepub fn get_update_policy(&self) -> &Option<UpdatePolicy>
pub fn get_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.
Sourcepub fn set_context(self, input: Option<String>) -> Self
pub fn set_context(self, input: Option<String>) -> Self
Reserved.
Sourcepub fn get_context(&self) -> &Option<String>
pub fn get_context(&self) -> &Option<String>
Reserved.
Trait Implementations§
Source§impl Clone for UpdateComputeEnvironmentFluentBuilder
impl Clone for UpdateComputeEnvironmentFluentBuilder
Source§fn clone(&self) -> UpdateComputeEnvironmentFluentBuilder
fn clone(&self) -> UpdateComputeEnvironmentFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateComputeEnvironmentFluentBuilder
impl !RefUnwindSafe for UpdateComputeEnvironmentFluentBuilder
impl Send for UpdateComputeEnvironmentFluentBuilder
impl Sync for UpdateComputeEnvironmentFluentBuilder
impl Unpin for UpdateComputeEnvironmentFluentBuilder
impl !UnwindSafe for UpdateComputeEnvironmentFluentBuilder
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);