Interface CreateUserRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateUserRequest.Builder,
,CreateUserRequest> FinspaceDataRequest.Builder
,SdkBuilder<CreateUserRequest.Builder,
,CreateUserRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateUserRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe option to indicate whether the user can use theGetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.The option to indicate whether the user can use theGetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.apiAccessPrincipalArn
(String apiAccessPrincipalArn) The ARN identifier of an AWS user or role that is allowed to call theGetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user.clientToken
(String clientToken) A token that ensures idempotency.emailAddress
(String emailAddress) The email address of the user that you want to register.The first name of the user that you want to register.The last name of the user that you want to register.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The option to indicate the type of user.The option to indicate the type of user.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.finspacedata.model.FinspaceDataRequest.Builder
build
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
-
emailAddress
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
- Parameters:
emailAddress
- The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The option to indicate the type of user. Use one of the following options to specify this parameter:
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
- Parameters:
type
- The option to indicate the type of user. Use one of the following options to specify this parameter:-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
The option to indicate the type of user. Use one of the following options to specify this parameter:
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
- Parameters:
type
- The option to indicate the type of user. Use one of the following options to specify this parameter:-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
firstName
The first name of the user that you want to register.
- Parameters:
firstName
- The first name of the user that you want to register.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastName
The last name of the user that you want to register.
- Parameters:
lastName
- The last name of the user that you want to register.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiAccess
The option to indicate whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
- Parameters:
apiAccess
- The option to indicate whether the user can use theGetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
apiAccess
The option to indicate whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
- Parameters:
apiAccess
- The option to indicate whether the user can use theGetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
apiAccessPrincipalArn
The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.- Parameters:
apiAccessPrincipalArn
- The ARN identifier of an AWS user or role that is allowed to call theGetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A token that ensures idempotency. This token expires in 10 minutes.
- Parameters:
clientToken
- A token that ensures idempotency. This token expires in 10 minutes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-