Struct aws_sdk_quicksight::types::builders::UserBuilder

#[non_exhaustive]
pub struct UserBuilder { /* private fields */ }

A builder for User.

Implementations

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.

• 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.

• 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.

• 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.

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

Performs copy-assignment from source.

impl Debug for UserBuilder

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

Formats the value using the given formatter.

impl Default for UserBuilder

fn default() -> UserBuilder

Returns the “default value” for a type.

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 ==.

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