pub struct UpdateWorkspaceAuthenticationFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateWorkspaceAuthentication
.
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin
and Editor
roles in the workspace.
Changes to the authentication method for a workspace may take a few minutes to take effect.
Implementations§
Source§impl UpdateWorkspaceAuthenticationFluentBuilder
impl UpdateWorkspaceAuthenticationFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateWorkspaceAuthenticationInputBuilder
pub fn as_input(&self) -> &UpdateWorkspaceAuthenticationInputBuilder
Access the UpdateWorkspaceAuthentication as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateWorkspaceAuthenticationOutput, SdkError<UpdateWorkspaceAuthenticationError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateWorkspaceAuthenticationOutput, SdkError<UpdateWorkspaceAuthenticationError, 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<UpdateWorkspaceAuthenticationOutput, UpdateWorkspaceAuthenticationError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateWorkspaceAuthenticationOutput, UpdateWorkspaceAuthenticationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn workspace_id(self, input: impl Into<String>) -> Self
pub fn workspace_id(self, input: impl Into<String>) -> Self
The ID of the workspace to update the authentication for.
Sourcepub fn set_workspace_id(self, input: Option<String>) -> Self
pub fn set_workspace_id(self, input: Option<String>) -> Self
The ID of the workspace to update the authentication for.
Sourcepub fn get_workspace_id(&self) -> &Option<String>
pub fn get_workspace_id(&self) -> &Option<String>
The ID of the workspace to update the authentication for.
Sourcepub fn authentication_providers(
self,
input: AuthenticationProviderTypes,
) -> Self
pub fn authentication_providers( self, input: AuthenticationProviderTypes, ) -> Self
Appends an item to authenticationProviders
.
To override the contents of this collection use set_authentication_providers
.
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
Sourcepub fn set_authentication_providers(
self,
input: Option<Vec<AuthenticationProviderTypes>>,
) -> Self
pub fn set_authentication_providers( self, input: Option<Vec<AuthenticationProviderTypes>>, ) -> Self
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
Sourcepub fn get_authentication_providers(
&self,
) -> &Option<Vec<AuthenticationProviderTypes>>
pub fn get_authentication_providers( &self, ) -> &Option<Vec<AuthenticationProviderTypes>>
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
Sourcepub fn saml_configuration(self, input: SamlConfiguration) -> Self
pub fn saml_configuration(self, input: SamlConfiguration) -> Self
If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin
and Editor
roles in the workspace.
Sourcepub fn set_saml_configuration(self, input: Option<SamlConfiguration>) -> Self
pub fn set_saml_configuration(self, input: Option<SamlConfiguration>) -> Self
If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin
and Editor
roles in the workspace.
Sourcepub fn get_saml_configuration(&self) -> &Option<SamlConfiguration>
pub fn get_saml_configuration(&self) -> &Option<SamlConfiguration>
If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin
and Editor
roles in the workspace.
Trait Implementations§
Source§impl Clone for UpdateWorkspaceAuthenticationFluentBuilder
impl Clone for UpdateWorkspaceAuthenticationFluentBuilder
Source§fn clone(&self) -> UpdateWorkspaceAuthenticationFluentBuilder
fn clone(&self) -> UpdateWorkspaceAuthenticationFluentBuilder
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 UpdateWorkspaceAuthenticationFluentBuilder
impl !RefUnwindSafe for UpdateWorkspaceAuthenticationFluentBuilder
impl Send for UpdateWorkspaceAuthenticationFluentBuilder
impl Sync for UpdateWorkspaceAuthenticationFluentBuilder
impl Unpin for UpdateWorkspaceAuthenticationFluentBuilder
impl !UnwindSafe for UpdateWorkspaceAuthenticationFluentBuilder
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);