Package software.amazon.awssdk.services.quicksight.model

Interface User.Builder

    • Method Detail

      • arn

        User.Builder arn​(String arn)

        The Amazon Resource Name (ARN) for the user.

        Parameters:
        arn - The Amazon Resource Name (ARN) for the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userName

        User.Builder userName​(String userName)

        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.

        Parameters:
        userName - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • email

        User.Builder email​(String email)

        The user's email address.

        Parameters:
        email - The user's email address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • role

        User.Builder role​(String role)

        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.

        Parameters:
        role - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserRole, UserRole

      • role

        User.Builder role​(UserRole role)

        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.

        Parameters:
        role - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserRole, UserRole

      • identityType

        User.Builder identityType​(String identityType)

        The type of identity authentication used by the user.

        Parameters:
        identityType - The type of identity authentication used by the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IdentityType, IdentityType

      • identityType

        User.Builder identityType​(IdentityType identityType)

        The type of identity authentication used by the user.

        Parameters:
        identityType - The type of identity authentication used by the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IdentityType, IdentityType

      • active

        User.Builder active​(Boolean active)

        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.

        Parameters:
        active - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • principalId

        User.Builder principalId​(String principalId)

        The principal ID of the user.

        Parameters:
        principalId - The principal ID of the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customPermissionsName

        User.Builder customPermissionsName​(String customPermissionsName)

        The custom permissions profile associated with this user.

        Parameters:
        customPermissionsName - The custom permissions profile associated with this user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalLoginFederationProviderType

        User.Builder externalLoginFederationProviderType​(String externalLoginFederationProviderType)

        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.

        Parameters:
        externalLoginFederationProviderType - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalLoginFederationProviderUrl

        User.Builder externalLoginFederationProviderUrl​(String externalLoginFederationProviderUrl)

        The URL of the external login provider.

        Parameters:
        externalLoginFederationProviderUrl - The URL of the external login provider.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalLoginId

        User.Builder externalLoginId​(String externalLoginId)

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

        Parameters:
        externalLoginId - The identity ID for the user in the external login provider.
        Returns:
        Returns a reference to this object so that method calls can be chained together.