software.amazon.awssdk.services.finspacedata.model

Interface UpdateUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>, FinspaceDataRequest.Builder, SdkBuilder<UpdateUserRequest.Builder,UpdateUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateUserRequest

public static interface UpdateUserRequest.Builder
extends FinspaceDataRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Method Summary

Modifier and Type	Method and Description
UpdateUserRequest.Builder	apiAccess(ApiAccess 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.
UpdateUserRequest.Builder	apiAccess(String 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.
UpdateUserRequest.Builder	apiAccessPrincipalArn(String 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.
UpdateUserRequest.Builder	clientToken(String clientToken) A token that ensures idempotency.
UpdateUserRequest.Builder	firstName(String firstName) The first name of the user.
UpdateUserRequest.Builder	lastName(String lastName) The last name of the user.
UpdateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateUserRequest.Builder	type(String type) The option to indicate the type of user.
UpdateUserRequest.Builder	type(UserType type) The option to indicate the type of user.
UpdateUserRequest.Builder	userId(String userId) The unique identifier for the user that you want to update.

Methods inherited from interface software.amazon.awssdk.services.finspacedata.model.FinspaceDataRequest.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

userId

UpdateUserRequest.Builder userId(String userId)

The unique identifier for the user that you want to update.

Parameters:

userId - The unique identifier for the user that you want to update.

Returns:

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

type

UpdateUserRequest.Builder type(String type)

The option to indicate the type of user.

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

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

UserType, UserType

type

UpdateUserRequest.Builder type(UserType type)

The option to indicate the type of user.

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

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

UserType, UserType

firstName

UpdateUserRequest.Builder firstName(String firstName)

The first name of the user.

Parameters:

firstName - The first name of the user.

Returns:

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

lastName

UpdateUserRequest.Builder lastName(String lastName)

The last name of the user.

Parameters:

lastName - The last name of the user.

Returns:

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

apiAccess

UpdateUserRequest.Builder apiAccess(String 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 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.

Returns:

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

See Also:

ApiAccess, ApiAccess

apiAccess

UpdateUserRequest.Builder apiAccess(ApiAccess 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 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.

Returns:

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

See Also:

ApiAccess, ApiAccess

apiAccessPrincipalArn

UpdateUserRequest.Builder apiAccessPrincipalArn(String 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 the GetProgrammaticAccessCredentials 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

UpdateUserRequest.Builder clientToken(String 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

UpdateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder