software.amazon.awssdk.services.quicksight.model

Interface User.Builder

All Superinterfaces:

Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo

Enclosing class:

User

public static interface User.Builder
extends SdkPojo, CopyableBuilder<User.Builder,User>

Method Summary

Modifier and Type	Method and Description
User.Builder	active(Boolean active) The active status of user.
User.Builder	arn(String arn) The Amazon Resource Name (ARN) for the user.
User.Builder	customPermissionsName(String customPermissionsName) The custom permissions profile associated with this user.
User.Builder	email(String email) The user's email address.
User.Builder	identityType(IdentityType identityType) The type of identity authentication used by the user.
User.Builder	identityType(String identityType) The type of identity authentication used by the user.
User.Builder	principalId(String principalId) The principal ID of the user.
User.Builder	role(String role) The Amazon QuickSight role for the user.
User.Builder	role(UserRole role) The Amazon QuickSight role for the user.
User.Builder	userName(String userName) The user's user name.

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

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.

Parameters:

userName - The user's user name.

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

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

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

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

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.