pub struct UpdateWorkforceFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateWorkforce.
Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
The worker portal is now supported in VPC and public internet.
Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.
To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".
Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.
Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.
After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.
This operation only applies to private workforces.
Implementations§
Source§impl UpdateWorkforceFluentBuilder
impl UpdateWorkforceFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateWorkforceInputBuilder
pub fn as_input(&self) -> &UpdateWorkforceInputBuilder
Access the UpdateWorkforce as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateWorkforceOutput, SdkError<UpdateWorkforceError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateWorkforceOutput, SdkError<UpdateWorkforceError, 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<UpdateWorkforceOutput, UpdateWorkforceError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateWorkforceOutput, UpdateWorkforceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn workforce_name(self, input: impl Into<String>) -> Self
pub fn workforce_name(self, input: impl Into<String>) -> Self
The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
Sourcepub fn set_workforce_name(self, input: Option<String>) -> Self
pub fn set_workforce_name(self, input: Option<String>) -> Self
The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
Sourcepub fn get_workforce_name(&self) -> &Option<String>
pub fn get_workforce_name(&self) -> &Option<String>
The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
Sourcepub fn source_ip_config(self, input: SourceIpConfig) -> Self
pub fn source_ip_config(self, input: SourceIpConfig) -> Self
A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
Sourcepub fn set_source_ip_config(self, input: Option<SourceIpConfig>) -> Self
pub fn set_source_ip_config(self, input: Option<SourceIpConfig>) -> Self
A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
Sourcepub fn get_source_ip_config(&self) -> &Option<SourceIpConfig>
pub fn get_source_ip_config(&self) -> &Option<SourceIpConfig>
A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
Sourcepub fn oidc_config(self, input: OidcConfig) -> Self
pub fn oidc_config(self, input: OidcConfig) -> Self
Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
Sourcepub fn set_oidc_config(self, input: Option<OidcConfig>) -> Self
pub fn set_oidc_config(self, input: Option<OidcConfig>) -> Self
Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
Sourcepub fn get_oidc_config(&self) -> &Option<OidcConfig>
pub fn get_oidc_config(&self) -> &Option<OidcConfig>
Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
Sourcepub fn workforce_vpc_config(self, input: WorkforceVpcConfigRequest) -> Self
pub fn workforce_vpc_config(self, input: WorkforceVpcConfigRequest) -> Self
Use this parameter to update your VPC configuration for a workforce.
Sourcepub fn set_workforce_vpc_config(
self,
input: Option<WorkforceVpcConfigRequest>,
) -> Self
pub fn set_workforce_vpc_config( self, input: Option<WorkforceVpcConfigRequest>, ) -> Self
Use this parameter to update your VPC configuration for a workforce.
Sourcepub fn get_workforce_vpc_config(&self) -> &Option<WorkforceVpcConfigRequest>
pub fn get_workforce_vpc_config(&self) -> &Option<WorkforceVpcConfigRequest>
Use this parameter to update your VPC configuration for a workforce.
Trait Implementations§
Source§impl Clone for UpdateWorkforceFluentBuilder
impl Clone for UpdateWorkforceFluentBuilder
Source§fn clone(&self) -> UpdateWorkforceFluentBuilder
fn clone(&self) -> UpdateWorkforceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for UpdateWorkforceFluentBuilder
impl !RefUnwindSafe for UpdateWorkforceFluentBuilder
impl Send for UpdateWorkforceFluentBuilder
impl Sync for UpdateWorkforceFluentBuilder
impl Unpin for UpdateWorkforceFluentBuilder
impl !UnwindSafe for UpdateWorkforceFluentBuilder
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);