Interface RegisterUserRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>, QuickSightRequest.Builder, SdkBuilder<RegisterUserRequest.Builder,RegisterUserRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RegisterUserRequest
@Mutable @NotThreadSafe public static interface RegisterUserRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

  • Method Details

    • identityType

      RegisterUserRequest.Builder identityType(String identityType)

      The identity type that your Quick Sight account uses to manage the identity of users.

      Parameters:
      identityType - The identity type that your Quick Sight account uses to manage the identity of users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • identityType

      RegisterUserRequest.Builder identityType(IdentityType identityType)

      The identity type that your Quick Sight account uses to manage the identity of users.

      Parameters:
      identityType - The identity type that your Quick Sight account uses to manage the identity of users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • email

      RegisterUserRequest.Builder email(String email)

      The email address of the user that you want to register.

      Parameters:
      email - The email address of the user that you want to register.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userRole

      RegisterUserRequest.Builder userRole(String userRole)

      The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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:
      userRole - The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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

      RegisterUserRequest.Builder userRole(UserRole userRole)

      The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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:
      userRole - The Amazon Quick Sight 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 Quick Sight settings.

      • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, 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 Quick Sight 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:

    • iamArn

      RegisterUserRequest.Builder iamArn(String iamArn)

      The ARN of the IAM user or role that you are registering with Amazon Quick Sight.

      Parameters:
      iamArn - The ARN of the IAM user or role that you are registering with Amazon Quick Sight.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionName

      RegisterUserRequest.Builder sessionName(String sessionName)

      You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.

      Parameters:
      sessionName - You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsAccountId

      RegisterUserRequest.Builder awsAccountId(String awsAccountId)

      The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.

      Parameters:
      awsAccountId - The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      RegisterUserRequest.Builder namespace(String namespace)

      The namespace. Currently, you should set this to default.

      Parameters:
      namespace - The namespace. Currently, you should set this to default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userName

      RegisterUserRequest.Builder userName(String userName)

      The Amazon Quick Sight user name that you want to create for the user you are registering.

      Parameters:
      userName - The Amazon Quick Sight user name that you want to create for the user you are registering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPermissionsName

      RegisterUserRequest.Builder customPermissionsName(String customPermissionsName)

      (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

      • Create and update data sources

      • Create and update datasets

      • Create and update email reports

      • Subscribe to email reports

      To add custom permissions to an existing user, use UpdateUser instead.

      A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Quick Sight user.

      Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).

      This feature is available only to Quick Sight Enterprise edition subscriptions.

      Parameters:
      customPermissionsName - (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

      • Create and update data sources

      • Create and update datasets

      • Create and update email reports

      • Subscribe to email reports

      To add custom permissions to an existing user, use UpdateUser instead.

      A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Quick Sight user.

      Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).

      This feature is available only to Quick Sight Enterprise edition subscriptions.

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

    • externalLoginFederationProviderType

      RegisterUserRequest.Builder externalLoginFederationProviderType(String externalLoginFederationProviderType)

      The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

      • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

      • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

      Parameters:
      externalLoginFederationProviderType - The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

      • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

      • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

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

    • customFederationProviderUrl

      RegisterUserRequest.Builder customFederationProviderUrl(String customFederationProviderUrl)

      The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

      Parameters:
      customFederationProviderUrl - The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalLoginId

      RegisterUserRequest.Builder externalLoginId(String externalLoginId)

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

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

    • tags

      RegisterUserRequest.Builder tags(Collection<Tag> tags)

      The tags to associate with the user.

      Parameters:
      tags - The tags to associate with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterUserRequest.Builder tags(Tag... tags)

      The tags to associate with the user.

      Parameters:
      tags - The tags to associate with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterUserRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to associate with the user.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      RegisterUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.