#[non_exhaustive]pub struct UserBuilder { /* private fields */ }
Expand description
A builder for User
.
Implementations§
Source§impl UserBuilder
impl UserBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the user.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the user.
Sourcepub fn user_name(self, input: impl Into<String>) -> Self
pub fn user_name(self, input: impl Into<String>) -> Self
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName
is N/A
when the value for IdentityType
is IAM
and the corresponding IAM user is deleted.
Sourcepub fn set_user_name(self, input: Option<String>) -> Self
pub fn set_user_name(self, input: Option<String>) -> Self
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName
is N/A
when the value for IdentityType
is IAM
and the corresponding IAM user is deleted.
Sourcepub fn get_user_name(&self) -> &Option<String>
pub fn get_user_name(&self) -> &Option<String>
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName
is N/A
when the value for IdentityType
is IAM
and the corresponding IAM user is deleted.
Sourcepub fn role(self, input: UserRole) -> Self
pub fn role(self, input: UserRole) -> Self
The Amazon QuickSight role for the user. The user role can be one of the following:.
-
READER
: A user who has read-only access to dashboards. -
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards. -
ADMIN
: A user who is an author, who can also manage Amazon Amazon QuickSight settings. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. -
RESTRICTED_READER
: This role isn't currently available for use. -
RESTRICTED_AUTHOR
: This role isn't currently available for use.
Sourcepub fn set_role(self, input: Option<UserRole>) -> Self
pub fn set_role(self, input: Option<UserRole>) -> Self
The Amazon QuickSight role for the user. The user role can be one of the following:.
-
READER
: A user who has read-only access to dashboards. -
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards. -
ADMIN
: A user who is an author, who can also manage Amazon Amazon QuickSight settings. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. -
RESTRICTED_READER
: This role isn't currently available for use. -
RESTRICTED_AUTHOR
: This role isn't currently available for use.
Sourcepub fn get_role(&self) -> &Option<UserRole>
pub fn get_role(&self) -> &Option<UserRole>
The Amazon QuickSight role for the user. The user role can be one of the following:.
-
READER
: A user who has read-only access to dashboards. -
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards. -
ADMIN
: A user who is an author, who can also manage Amazon Amazon QuickSight settings. -
READER_PRO
: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards. -
AUTHOR_PRO
: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards. -
ADMIN_PRO
: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. -
RESTRICTED_READER
: This role isn't currently available for use. -
RESTRICTED_AUTHOR
: This role isn't currently available for use.
Sourcepub fn identity_type(self, input: IdentityType) -> Self
pub fn identity_type(self, input: IdentityType) -> Self
The type of identity authentication used by the user.
Sourcepub fn set_identity_type(self, input: Option<IdentityType>) -> Self
pub fn set_identity_type(self, input: Option<IdentityType>) -> Self
The type of identity authentication used by the user.
Sourcepub fn get_identity_type(&self) -> &Option<IdentityType>
pub fn get_identity_type(&self) -> &Option<IdentityType>
The type of identity authentication used by the user.
Sourcepub fn active(self, input: bool) -> Self
pub fn active(self, input: bool) -> Self
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
Sourcepub fn set_active(self, input: Option<bool>) -> Self
pub fn set_active(self, input: Option<bool>) -> Self
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
Sourcepub fn get_active(&self) -> &Option<bool>
pub fn get_active(&self) -> &Option<bool>
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
Sourcepub fn principal_id(self, input: impl Into<String>) -> Self
pub fn principal_id(self, input: impl Into<String>) -> Self
The principal ID of the user.
Sourcepub fn set_principal_id(self, input: Option<String>) -> Self
pub fn set_principal_id(self, input: Option<String>) -> Self
The principal ID of the user.
Sourcepub fn get_principal_id(&self) -> &Option<String>
pub fn get_principal_id(&self) -> &Option<String>
The principal ID of the user.
Sourcepub fn custom_permissions_name(self, input: impl Into<String>) -> Self
pub fn custom_permissions_name(self, input: impl Into<String>) -> Self
The custom permissions profile associated with this user.
Sourcepub fn set_custom_permissions_name(self, input: Option<String>) -> Self
pub fn set_custom_permissions_name(self, input: Option<String>) -> Self
The custom permissions profile associated with this user.
Sourcepub fn get_custom_permissions_name(&self) -> &Option<String>
pub fn get_custom_permissions_name(&self) -> &Option<String>
The custom permissions profile associated with this user.
Sourcepub fn external_login_federation_provider_type(
self,
input: impl Into<String>,
) -> Self
pub fn external_login_federation_provider_type( self, input: impl Into<String>, ) -> Self
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
-
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. -
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider.
Sourcepub fn set_external_login_federation_provider_type(
self,
input: Option<String>,
) -> Self
pub fn set_external_login_federation_provider_type( self, input: Option<String>, ) -> Self
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
-
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. -
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider.
Sourcepub fn get_external_login_federation_provider_type(&self) -> &Option<String>
pub fn get_external_login_federation_provider_type(&self) -> &Option<String>
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
-
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. -
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider.
Sourcepub fn external_login_federation_provider_url(
self,
input: impl Into<String>,
) -> Self
pub fn external_login_federation_provider_url( self, input: impl Into<String>, ) -> Self
The URL of the external login provider.
Sourcepub fn set_external_login_federation_provider_url(
self,
input: Option<String>,
) -> Self
pub fn set_external_login_federation_provider_url( self, input: Option<String>, ) -> Self
The URL of the external login provider.
Sourcepub fn get_external_login_federation_provider_url(&self) -> &Option<String>
pub fn get_external_login_federation_provider_url(&self) -> &Option<String>
The URL of the external login provider.
Sourcepub fn external_login_id(self, input: impl Into<String>) -> Self
pub fn external_login_id(self, input: impl Into<String>) -> Self
The identity ID for the user in the external login provider.
Sourcepub fn set_external_login_id(self, input: Option<String>) -> Self
pub fn set_external_login_id(self, input: Option<String>) -> Self
The identity ID for the user in the external login provider.
Sourcepub fn get_external_login_id(&self) -> &Option<String>
pub fn get_external_login_id(&self) -> &Option<String>
The identity ID for the user in the external login provider.
Trait Implementations§
Source§impl Clone for UserBuilder
impl Clone for UserBuilder
Source§fn clone(&self) -> UserBuilder
fn clone(&self) -> UserBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UserBuilder
impl Debug for UserBuilder
Source§impl Default for UserBuilder
impl Default for UserBuilder
Source§fn default() -> UserBuilder
fn default() -> UserBuilder
Source§impl PartialEq for UserBuilder
impl PartialEq for UserBuilder
impl StructuralPartialEq for UserBuilder
Auto Trait Implementations§
impl Freeze for UserBuilder
impl RefUnwindSafe for UserBuilder
impl Send for UserBuilder
impl Sync for UserBuilder
impl Unpin for UserBuilder
impl UnwindSafe for UserBuilder
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);