Interface User.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<User.Builder,
,User> SdkBuilder<User.Builder,
,User> SdkPojo
- Enclosing class:
User
-
Method Summary
Modifier and TypeMethodDescriptionThe active status of user.The Amazon Resource Name (ARN) for the user.customPermissionsName
(String customPermissionsName) The custom permissions profile associated with this user.The user's email address.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.externalLoginFederationProviderUrl
(String externalLoginFederationProviderUrl) The URL of the external login provider.externalLoginId
(String externalLoginId) The identity ID for the user in the external login provider.identityType
(String identityType) The type of identity authentication used by the user.identityType
(IdentityType identityType) The type of identity authentication used by the user.principalId
(String principalId) The principal ID of the user.The Amazon QuickSight role for the user.The Amazon QuickSight role for the user.The user's user name.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
isN/A
when the value forIdentityType
isIAM
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 forUserName
isN/A
when the value forIdentityType
isIAM
and the corresponding IAM user is deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
- 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. -
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:
-
-
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. -
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. -
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:
-
-
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
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:
-
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
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
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
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
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
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.
-