Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UpdateUserPoolClientRequest.Builder

All Superinterfaces:

CopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>, SdkBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>

Enclosing class:

UpdateUserPoolClientRequest

public static interface UpdateUserPoolClientRequest.Builder
extends CopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>

Method Summary

Modifier and Type	Method	Description
UpdateUserPoolClientRequest.Builder	allowedOAuthFlows(String... allowedOAuthFlows)	Set to code to initiate a code grant flow, which provides an authorization code as the response.
UpdateUserPoolClientRequest.Builder	allowedOAuthFlows(Collection<String> allowedOAuthFlows)	Set to code to initiate a code grant flow, which provides an authorization code as the response.
UpdateUserPoolClientRequest.Builder	allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)	Set to code to initiate a code grant flow, which provides an authorization code as the response.
UpdateUserPoolClientRequest.Builder	allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)	Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
UpdateUserPoolClientRequest.Builder	allowedOAuthScopes(String... allowedOAuthScopes)	A list of allowed OAuth scopes.
UpdateUserPoolClientRequest.Builder	allowedOAuthScopes(Collection<String> allowedOAuthScopes)	A list of allowed OAuth scopes.
UpdateUserPoolClientRequest.Builder	callbackURLs(String... callbackURLs)	A list of allowed callback URLs for the identity providers.
UpdateUserPoolClientRequest.Builder	callbackURLs(Collection<String> callbackURLs)	A list of allowed callback URLs for the identity providers.
UpdateUserPoolClientRequest.Builder	clientId(String clientId)	The ID of the client associated with the user pool.
UpdateUserPoolClientRequest.Builder	clientName(String clientName)	The client name from the update user pool client request.
UpdateUserPoolClientRequest.Builder	defaultRedirectURI(String defaultRedirectURI)	The default redirect URI.
UpdateUserPoolClientRequest.Builder	explicitAuthFlows(String... explicitAuthFlows)	Explicit authentication flows.
UpdateUserPoolClientRequest.Builder	explicitAuthFlows(Collection<String> explicitAuthFlows)	Explicit authentication flows.
UpdateUserPoolClientRequest.Builder	explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)	Explicit authentication flows.
UpdateUserPoolClientRequest.Builder	logoutURLs(String... logoutURLs)	A list ofallowed logout URLs for the identity providers.
UpdateUserPoolClientRequest.Builder	logoutURLs(Collection<String> logoutURLs)	A list ofallowed logout URLs for the identity providers.
UpdateUserPoolClientRequest.Builder	readAttributes(String... readAttributes)	The read-only attributes of the user pool.
UpdateUserPoolClientRequest.Builder	readAttributes(Collection<String> readAttributes)	The read-only attributes of the user pool.
UpdateUserPoolClientRequest.Builder	refreshTokenValidity(Integer refreshTokenValidity)	The time limit, in days, after which the refresh token is no longer valid and cannot be used.
UpdateUserPoolClientRequest.Builder	supportedIdentityProviders(String... supportedIdentityProviders)	A list of provider names for the identity providers that are supported on this client.
UpdateUserPoolClientRequest.Builder	supportedIdentityProviders(Collection<String> supportedIdentityProviders)	A list of provider names for the identity providers that are supported on this client.
UpdateUserPoolClientRequest.Builder	userPoolId(String userPoolId)	The user pool ID for the user pool where you want to update the user pool client.
UpdateUserPoolClientRequest.Builder	writeAttributes(String... writeAttributes)	The writeable attributes of the user pool.
UpdateUserPoolClientRequest.Builder	writeAttributes(Collection<String> writeAttributes)	The writeable attributes of the user pool.

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

copy

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

apply, build

Method Detail

userPoolId

UpdateUserPoolClientRequest.Builder userPoolId(String userPoolId)

The user pool ID for the user pool where you want to update the user pool client.

Parameters:

userPoolId - The user pool ID for the user pool where you want to update the user pool client.

Returns:

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

clientId

UpdateUserPoolClientRequest.Builder clientId(String clientId)

The ID of the client associated with the user pool.

Parameters:

clientId - The ID of the client associated with the user pool.

Returns:

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

clientName

UpdateUserPoolClientRequest.Builder clientName(String clientName)

The client name from the update user pool client request.

Parameters:

clientName - The client name from the update user pool client request.

Returns:

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

refreshTokenValidity

UpdateUserPoolClientRequest.Builder refreshTokenValidity(Integer refreshTokenValidity)

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Parameters:

refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Returns:

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

readAttributes

UpdateUserPoolClientRequest.Builder readAttributes(Collection<String> readAttributes)

The read-only attributes of the user pool.

Parameters:

readAttributes - The read-only attributes of the user pool.

Returns:

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

readAttributes

UpdateUserPoolClientRequest.Builder readAttributes(String... readAttributes)

The read-only attributes of the user pool.

NOTE: This method appends the values to the existing list (if any). Use #setReadAttributes(java.util.Collection) or #withReadAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

readAttributes - The read-only attributes of the user pool.

Returns:

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

writeAttributes

UpdateUserPoolClientRequest.Builder writeAttributes(Collection<String> writeAttributes)

The writeable attributes of the user pool.

Parameters:

writeAttributes - The writeable attributes of the user pool.

Returns:

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

writeAttributes

UpdateUserPoolClientRequest.Builder writeAttributes(String... writeAttributes)

The writeable attributes of the user pool.

NOTE: This method appends the values to the existing list (if any). Use #setWriteAttributes(java.util.Collection) or #withWriteAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

writeAttributes - The writeable attributes of the user pool.

Returns:

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

explicitAuthFlows

UpdateUserPoolClientRequest.Builder explicitAuthFlows(Collection<String> explicitAuthFlows)

Explicit authentication flows.

Parameters:

explicitAuthFlows - Explicit authentication flows.

Returns:

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

See Also:

ExplicitAuthFlowsType

explicitAuthFlows

UpdateUserPoolClientRequest.Builder explicitAuthFlows(String... explicitAuthFlows)

Explicit authentication flows.

NOTE: This method appends the values to the existing list (if any). Use #setExplicitAuthFlows(java.util.Collection) or #withExplicitAuthFlows(java.util.Collection) if you want to override the existing values.

Parameters:

explicitAuthFlows - Explicit authentication flows.

Returns:

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

See Also:

ExplicitAuthFlowsType

explicitAuthFlows

UpdateUserPoolClientRequest.Builder explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)

Explicit authentication flows.

NOTE: This method appends the values to the existing list (if any). Use #setExplicitAuthFlows(java.util.Collection) or #withExplicitAuthFlows(java.util.Collection) if you want to override the existing values.

Parameters:

explicitAuthFlows - Explicit authentication flows.

Returns:

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

See Also:

ExplicitAuthFlowsType

supportedIdentityProviders

UpdateUserPoolClientRequest.Builder supportedIdentityProviders(Collection<String> supportedIdentityProviders)

A list of provider names for the identity providers that are supported on this client.

Parameters:

supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.

Returns:

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

supportedIdentityProviders

UpdateUserPoolClientRequest.Builder supportedIdentityProviders(String... supportedIdentityProviders)

A list of provider names for the identity providers that are supported on this client.

NOTE: This method appends the values to the existing list (if any). Use #setSupportedIdentityProviders(java.util.Collection) or #withSupportedIdentityProviders(java.util.Collection) if you want to override the existing values.

Parameters:

supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.

Returns:

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

callbackURLs

UpdateUserPoolClientRequest.Builder callbackURLs(Collection<String> callbackURLs)

A list of allowed callback URLs for the identity providers.

Parameters:

callbackURLs - A list of allowed callback URLs for the identity providers.

Returns:

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

callbackURLs

UpdateUserPoolClientRequest.Builder callbackURLs(String... callbackURLs)

A list of allowed callback URLs for the identity providers.

NOTE: This method appends the values to the existing list (if any). Use #setCallbackURLs(java.util.Collection) or #withCallbackURLs(java.util.Collection) if you want to override the existing values.

Parameters:

callbackURLs - A list of allowed callback URLs for the identity providers.

Returns:

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

logoutURLs

UpdateUserPoolClientRequest.Builder logoutURLs(Collection<String> logoutURLs)

A list ofallowed logout URLs for the identity providers.

Parameters:

logoutURLs - A list ofallowed logout URLs for the identity providers.

Returns:

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

logoutURLs

UpdateUserPoolClientRequest.Builder logoutURLs(String... logoutURLs)

A list ofallowed logout URLs for the identity providers.

NOTE: This method appends the values to the existing list (if any). Use #setLogoutURLs(java.util.Collection) or #withLogoutURLs(java.util.Collection) if you want to override the existing values.

Parameters:

logoutURLs - A list ofallowed logout URLs for the identity providers.

Returns:

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

defaultRedirectURI

UpdateUserPoolClientRequest.Builder defaultRedirectURI(String defaultRedirectURI)

The default redirect URI. Must be in the CallbackURLs list.

Parameters:

defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.

Returns:

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

allowedOAuthFlows

UpdateUserPoolClientRequest.Builder allowedOAuthFlows(Collection<String> allowedOAuthFlows)

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Parameters:

allowedOAuthFlows - Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Returns:

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

See Also:

OAuthFlowType

allowedOAuthFlows

UpdateUserPoolClientRequest.Builder allowedOAuthFlows(String... allowedOAuthFlows)

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

NOTE: This method appends the values to the existing list (if any). Use #setAllowedOAuthFlows(java.util.Collection) or #withAllowedOAuthFlows(java.util.Collection) if you want to override the existing values.

Parameters:

allowedOAuthFlows - Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Returns:

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

See Also:

OAuthFlowType

allowedOAuthFlows

UpdateUserPoolClientRequest.Builder allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

NOTE: This method appends the values to the existing list (if any). Use #setAllowedOAuthFlows(java.util.Collection) or #withAllowedOAuthFlows(java.util.Collection) if you want to override the existing values.

Parameters:

allowedOAuthFlows - Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Returns:

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

See Also:

OAuthFlowType

allowedOAuthScopes

UpdateUserPoolClientRequest.Builder allowedOAuthScopes(Collection<String> allowedOAuthScopes)

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

Parameters:

allowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

Returns:

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

allowedOAuthScopes

UpdateUserPoolClientRequest.Builder allowedOAuthScopes(String... allowedOAuthScopes)

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

NOTE: This method appends the values to the existing list (if any). Use #setAllowedOAuthScopes(java.util.Collection) or #withAllowedOAuthScopes(java.util.Collection) if you want to override the existing values.

Parameters:

allowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

Returns:

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

allowedOAuthFlowsUserPoolClient

UpdateUserPoolClientRequest.Builder allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)

Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Parameters:

allowedOAuthFlowsUserPoolClient - Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Returns:

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