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

Interface UserPoolClientType.Builder

All Superinterfaces:

CopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>, SdkBuilder<UserPoolClientType.Builder,UserPoolClientType>

Enclosing class:

UserPoolClientType

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

Method Summary

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

UserPoolClientType.Builder userPoolId(String userPoolId)

The user pool ID for the user pool client.

Parameters:

userPoolId - The user pool ID for the user pool client.

Returns:

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

clientName

UserPoolClientType.Builder clientName(String clientName)

The client name from the user pool request of the client type.

Parameters:

clientName - The client name from the user pool request of the client type.

Returns:

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

clientId

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

clientSecret

UserPoolClientType.Builder clientSecret(String clientSecret)

The client secret from the user pool request of the client type.

Parameters:

clientSecret - The client secret from the user pool request of the client type.

Returns:

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

lastModifiedDate

UserPoolClientType.Builder lastModifiedDate(Date lastModifiedDate)

The date the user pool client was last modified.

Parameters:

lastModifiedDate - The date the user pool client was last modified.

Returns:

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

creationDate

UserPoolClientType.Builder creationDate(Date creationDate)

The date the user pool client was created.

Parameters:

creationDate - The date the user pool client was created.

Returns:

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

refreshTokenValidity

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

UserPoolClientType.Builder readAttributes(Collection<String> readAttributes)

The Read-only attributes.

Parameters:

readAttributes - The Read-only attributes.

Returns:

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

readAttributes

UserPoolClientType.Builder readAttributes(String... readAttributes)

The Read-only 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-only attributes.

Returns:

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

writeAttributes

UserPoolClientType.Builder writeAttributes(Collection<String> writeAttributes)

The writeable attributes.

Parameters:

writeAttributes - The writeable attributes.

Returns:

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

writeAttributes

UserPoolClientType.Builder writeAttributes(String... writeAttributes)

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

Returns:

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

explicitAuthFlows

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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