software.amazon.awssdk.services.quicksight.model

Interface RegisterUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>, QuickSightRequest.Builder, SdkBuilder<RegisterUserRequest.Builder,RegisterUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RegisterUserRequest

public static interface RegisterUserRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

Method Summary

Modifier and Type	Method and Description
RegisterUserRequest.Builder	awsAccountId(String awsAccountId) The ID for the Amazon Web Services account that the user is in.
RegisterUserRequest.Builder	customFederationProviderUrl(String customFederationProviderUrl) The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role.
RegisterUserRequest.Builder	customPermissionsName(String customPermissionsName) (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.
RegisterUserRequest.Builder	email(String email) The email address of the user that you want to register.
RegisterUserRequest.Builder	externalLoginFederationProviderType(String externalLoginFederationProviderType) The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role.
RegisterUserRequest.Builder	externalLoginId(String externalLoginId) The identity ID for a user in the external login provider.
RegisterUserRequest.Builder	iamArn(String iamArn) The ARN of the IAM user or role that you are registering with Amazon QuickSight.
RegisterUserRequest.Builder	identityType(IdentityType identityType) Amazon QuickSight supports several ways of managing the identity of users.
RegisterUserRequest.Builder	identityType(String identityType) Amazon QuickSight supports several ways of managing the identity of users.
RegisterUserRequest.Builder	namespace(String namespace) The namespace.
RegisterUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
RegisterUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RegisterUserRequest.Builder	sessionName(String sessionName) You need to use this parameter only when you register one or more users using an assumed IAM role.
RegisterUserRequest.Builder	userName(String userName) The Amazon QuickSight user name that you want to create for the user you are registering.
RegisterUserRequest.Builder	userRole(String userRole) The Amazon QuickSight role for the user.
RegisterUserRequest.Builder	userRole(UserRole userRole) The Amazon QuickSight role for the user.

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

identityType

RegisterUserRequest.Builder identityType(String identityType)

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

• IAM: A user whose identity maps to an existing IAM user or role.

• QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Parameters:

identityType - Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

• IAM: A user whose identity maps to an existing IAM user or role.

• QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Returns:

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

See Also:

IdentityType, IdentityType

identityType

RegisterUserRequest.Builder identityType(IdentityType identityType)

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

• IAM: A user whose identity maps to an existing IAM user or role.

• QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Parameters:

identityType - Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

• IAM: A user whose identity maps to an existing IAM user or role.

• QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Returns:

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

See Also:

IdentityType, IdentityType

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 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 QuickSight settings.

• RESTRICTED_READER: This role isn't currently available for use.

• RESTRICTED_AUTHOR: This role isn't currently available for use.

Parameters:

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 QuickSight settings.

• 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

userRole

RegisterUserRequest.Builder userRole(UserRole 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 QuickSight settings.

• RESTRICTED_READER: This role isn't currently available for use.

• RESTRICTED_AUTHOR: This role isn't currently available for use.

Parameters:

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 QuickSight settings.

• 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

iamArn

RegisterUserRequest.Builder iamArn(String iamArn)

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

Parameters:

iamArn - The ARN of the IAM user or role that you are registering with Amazon QuickSight.

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 QuickSight 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 QuickSight 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 QuickSight 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 QuickSight 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 QuickSight user name that you want to create for the user you are registering.

Parameters:

userName - The Amazon QuickSight 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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight 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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

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

This feature is available only to Amazon QuickSight 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 QuickSight 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 QuickSight 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 Amazon QuickSight 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 Amazon QuickSight 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.

overrideConfiguration

RegisterUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

RegisterUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder