Struct aws_sdk_quicksight :: types :: builders :: UserBuilder Copy item path

impl UserBuilder

pub fn arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the user.

pub fn set_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the user.

pub fn get_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the user.

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.

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.

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.

pub fn email(self, input: impl Into<String>) -> Self

The user's email address.

pub fn set_email(self, input: Option<String>) -> Self

The user's email address.

pub fn get_email(&self) -> &Option<String>

The user's email address.

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 Business, 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.

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 Business, 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.

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 Business, 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.

pub fn identity_type(self, input: IdentityType) -> Self

The type of identity authentication used by the user.

pub fn set_identity_type(self, input: Option<IdentityType>) -> Self

The type of identity authentication used by the user.

pub fn get_identity_type(&self) -> &Option<IdentityType>

The type of identity authentication used by the user.

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.

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.

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.

pub fn principal_id(self, input: impl Into<String>) -> Self

The principal ID of the user.

pub fn set_principal_id(self, input: Option<String>) -> Self

The principal ID of the user.

pub fn get_principal_id(&self) -> &Option<String>

The principal ID of the user.

pub fn custom_permissions_name(self, input: impl Into<String>) -> Self

The custom permissions profile associated with this user.

pub fn set_custom_permissions_name(self, input: Option<String>) -> Self

The custom permissions profile associated with this user.

pub fn get_custom_permissions_name(&self) -> &Option<String>

The custom permissions profile associated with this user.

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.

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.

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.

pub fn external_login_federation_provider_url( self, input: impl Into<String> ) -> Self

The URL of the external login provider.

pub fn set_external_login_federation_provider_url( self, input: Option<String> ) -> Self

The URL of the external login provider.

pub fn get_external_login_federation_provider_url(&self) -> &Option<String>

The URL of the external login provider.

pub fn external_login_id(self, input: impl Into<String>) -> Self

The identity ID for the user in the external login provider.

pub fn set_external_login_id(self, input: Option<String>) -> Self

The identity ID for the user in the external login provider.

pub fn get_external_login_id(&self) -> &Option<String>

The identity ID for the user in the external login provider.

pub fn build(self) -> User

Consumes the builder and constructs a User.

Trait Implementations§

impl Clone for UserBuilder

fn clone(&self) -> UserBuilder

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for UserBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for UserBuilder

fn default() -> UserBuilder

Returns the “default value” for a type. Read more

impl PartialEq for UserBuilder

fn eq(&self, other: &UserBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserBuilder

Auto Trait Implementations§

impl UnwindSafe for UserBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more