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

Interface CreateUserPoolClientRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>, SdkBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

Enclosing class:

CreateUserPoolClientRequest

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

Method Summary

Modifier and Type	Method	Description
CreateUserPoolClientRequest.Builder	allowedOAuthFlows(String... allowedOAuthFlows)	Set to code to initiate a code grant flow, which provides an authorization code as the response.
CreateUserPoolClientRequest.Builder	allowedOAuthFlows(Collection<String> allowedOAuthFlows)	Set to code to initiate a code grant flow, which provides an authorization code as the response.
CreateUserPoolClientRequest.Builder	allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)	Set to code to initiate a code grant flow, which provides an authorization code as the response.
CreateUserPoolClientRequest.Builder	allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)	Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
CreateUserPoolClientRequest.Builder	allowedOAuthScopes(String... allowedOAuthScopes)	A list of allowed OAuth scopes.
CreateUserPoolClientRequest.Builder	allowedOAuthScopes(Collection<String> allowedOAuthScopes)	A list of allowed OAuth scopes.
CreateUserPoolClientRequest.Builder	callbackURLs(String... callbackURLs)	A list of allowed callback URLs for the identity providers.
CreateUserPoolClientRequest.Builder	callbackURLs(Collection<String> callbackURLs)	A list of allowed callback URLs for the identity providers.
CreateUserPoolClientRequest.Builder	clientName(String clientName)	The client name for the user pool client you would like to create.
CreateUserPoolClientRequest.Builder	defaultRedirectURI(String defaultRedirectURI)	The default redirect URI.
CreateUserPoolClientRequest.Builder	explicitAuthFlows(String... explicitAuthFlows)	The explicit authentication flows.
CreateUserPoolClientRequest.Builder	explicitAuthFlows(Collection<String> explicitAuthFlows)	The explicit authentication flows.
CreateUserPoolClientRequest.Builder	explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)	The explicit authentication flows.
CreateUserPoolClientRequest.Builder	generateSecret(Boolean generateSecret)	Boolean to specify whether you want to generate a secret for the user pool client being created.
CreateUserPoolClientRequest.Builder	logoutURLs(String... logoutURLs)	A list of allowed logout URLs for the identity providers.
CreateUserPoolClientRequest.Builder	logoutURLs(Collection<String> logoutURLs)	A list of allowed logout URLs for the identity providers.
CreateUserPoolClientRequest.Builder	readAttributes(String... readAttributes)	The read attributes.
CreateUserPoolClientRequest.Builder	readAttributes(Collection<String> readAttributes)	The read attributes.
CreateUserPoolClientRequest.Builder	refreshTokenValidity(Integer refreshTokenValidity)	The time limit, in days, after which the refresh token is no longer valid and cannot be used.
CreateUserPoolClientRequest.Builder	supportedIdentityProviders(String... supportedIdentityProviders)	A list of provider names for the identity providers that are supported on this client.
CreateUserPoolClientRequest.Builder	supportedIdentityProviders(Collection<String> supportedIdentityProviders)	A list of provider names for the identity providers that are supported on this client.
CreateUserPoolClientRequest.Builder	userPoolId(String userPoolId)	The user pool ID for the user pool where you want to create a user pool client.
CreateUserPoolClientRequest.Builder	writeAttributes(String... writeAttributes)	The write attributes.
CreateUserPoolClientRequest.Builder	writeAttributes(Collection<String> writeAttributes)	The write attributes.

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

CreateUserPoolClientRequest.Builder userPoolId(String userPoolId)

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

Parameters:

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

Returns:

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

clientName

CreateUserPoolClientRequest.Builder clientName(String clientName)

The client name for the user pool client you would like to create.

Parameters:

clientName - The client name for the user pool client you would like to create.

Returns:

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

generateSecret

CreateUserPoolClientRequest.Builder generateSecret(Boolean generateSecret)

Boolean to specify whether you want to generate a secret for the user pool client being created.

Parameters:

generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.

Returns:

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

refreshTokenValidity

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

CreateUserPoolClientRequest.Builder readAttributes(Collection<String> readAttributes)

The read attributes.

Parameters:

readAttributes - The read attributes.

Returns:

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

readAttributes

CreateUserPoolClientRequest.Builder readAttributes(String... readAttributes)

The read attributes.

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

Returns:

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

writeAttributes

CreateUserPoolClientRequest.Builder writeAttributes(Collection<String> writeAttributes)

The write attributes.

Parameters:

writeAttributes - The write attributes.

Returns:

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

writeAttributes

CreateUserPoolClientRequest.Builder writeAttributes(String... writeAttributes)

The write attributes.

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 write attributes.

Returns:

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

explicitAuthFlows

CreateUserPoolClientRequest.Builder explicitAuthFlows(Collection<String> explicitAuthFlows)

The explicit authentication flows.

Parameters:

explicitAuthFlows - The explicit authentication flows.

Returns:

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

See Also:

ExplicitAuthFlowsType

explicitAuthFlows

CreateUserPoolClientRequest.Builder explicitAuthFlows(String... explicitAuthFlows)

The 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 - The explicit authentication flows.

Returns:

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

See Also:

ExplicitAuthFlowsType

explicitAuthFlows

CreateUserPoolClientRequest.Builder explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)

The 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 - The explicit authentication flows.

Returns:

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

See Also:

ExplicitAuthFlowsType

supportedIdentityProviders

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

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

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

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

CreateUserPoolClientRequest.Builder logoutURLs(Collection<String> logoutURLs)

A list of allowed logout URLs for the identity providers.

Parameters:

logoutURLs - A list of allowed logout URLs for the identity providers.

Returns:

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

logoutURLs

CreateUserPoolClientRequest.Builder logoutURLs(String... logoutURLs)

A list of allowed 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 of allowed logout URLs for the identity providers.

Returns:

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

defaultRedirectURI

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

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

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

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

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

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

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