software.amazon.awscdk.services.cognito

Class CfnUserPoolClient.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolClient.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolClient>

Enclosing class:

CfnUserPoolClient

@Stability(value=Stable)
public static final class CfnUserPoolClient.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolClient>

A fluent builder for CfnUserPoolClient.

Method Summary

Modifier and Type	Method and Description
CfnUserPoolClient.Builder	accessTokenValidity(Number accessTokenValidity) The time limit, after which the access token is no longer valid and cannot be used.
CfnUserPoolClient.Builder	allowedOAuthFlows(List<String> allowedOAuthFlows) The allowed OAuth flows.
CfnUserPoolClient.Builder	allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient) Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
CfnUserPoolClient.Builder	allowedOAuthFlowsUserPoolClient(IResolvable allowedOAuthFlowsUserPoolClient) Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
CfnUserPoolClient.Builder	allowedOAuthScopes(List<String> allowedOAuthScopes) The allowed OAuth scopes.
CfnUserPoolClient.Builder	analyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty analyticsConfiguration) The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
CfnUserPoolClient.Builder	analyticsConfiguration(IResolvable analyticsConfiguration) The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
CfnUserPoolClient	build()
CfnUserPoolClient.Builder	callbackUrLs(List<String> callbackUrLs) A list of allowed redirect (callback) URLs for the identity providers.
CfnUserPoolClient.Builder	clientName(String clientName) The client name for the user pool client you would like to create.
static CfnUserPoolClient.Builder	create(Construct scope, String id)
CfnUserPoolClient.Builder	defaultRedirectUri(String defaultRedirectUri) The default redirect URI.
CfnUserPoolClient.Builder	enableTokenRevocation(Boolean enableTokenRevocation) Enables or disables token revocation.
CfnUserPoolClient.Builder	enableTokenRevocation(IResolvable enableTokenRevocation) Enables or disables token revocation.
CfnUserPoolClient.Builder	explicitAuthFlows(List<String> explicitAuthFlows) The authentication flows that are supported by the user pool clients.
CfnUserPoolClient.Builder	generateSecret(Boolean generateSecret) Boolean to specify whether you want to generate a secret for the user pool client being created.
CfnUserPoolClient.Builder	generateSecret(IResolvable generateSecret) Boolean to specify whether you want to generate a secret for the user pool client being created.
CfnUserPoolClient.Builder	idTokenValidity(Number idTokenValidity) The time limit, after which the ID token is no longer valid and cannot be used.
CfnUserPoolClient.Builder	logoutUrLs(List<String> logoutUrLs) A list of allowed logout URLs for the identity providers.
CfnUserPoolClient.Builder	preventUserExistenceErrors(String preventUserExistenceErrors) Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
CfnUserPoolClient.Builder	readAttributes(List<String> readAttributes) The read attributes.
CfnUserPoolClient.Builder	refreshTokenValidity(Number refreshTokenValidity) The time limit, in days, after which the refresh token is no longer valid and cannot be used.
CfnUserPoolClient.Builder	supportedIdentityProviders(List<String> supportedIdentityProviders) A list of provider names for the identity providers that are supported on this client.
CfnUserPoolClient.Builder	tokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty tokenValidityUnits) The units in which the validity times are represented in.
CfnUserPoolClient.Builder	tokenValidityUnits(IResolvable tokenValidityUnits) The units in which the validity times are represented in.
CfnUserPoolClient.Builder	userPoolId(String userPoolId) The user pool ID for the user pool where you want to create a user pool client.
CfnUserPoolClient.Builder	writeAttributes(List<String> writeAttributes) The user pool attributes that the app client can write to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnUserPoolClient.Builder create(Construct scope,
                                                                        String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnUserPoolClient.AnalyticsConfigurationProperty.Builder.

userPoolId

@Stability(value=Stable)
public CfnUserPoolClient.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. This parameter is required.

Returns:

this

accessTokenValidity

@Stability(value=Stable)
public CfnUserPoolClient.Builder accessTokenValidity(Number accessTokenValidity)

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

Parameters:

accessTokenValidity - The time limit, after which the access token is no longer valid and cannot be used. This parameter is required.

Returns:

this

allowedOAuthFlows

@Stability(value=Stable)
public CfnUserPoolClient.Builder allowedOAuthFlows(List<String> allowedOAuthFlows)

The allowed OAuth flows.

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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Parameters:

allowedOAuthFlows - The allowed OAuth flows. This parameter is required.

Returns:

this

allowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
public CfnUserPoolClient.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. This parameter is required.

Returns:

this

allowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
public CfnUserPoolClient.Builder allowedOAuthFlowsUserPoolClient(IResolvable 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. This parameter is required.

Returns:

this

allowedOAuthScopes

@Stability(value=Stable)
public CfnUserPoolClient.Builder allowedOAuthScopes(List<String> allowedOAuthScopes)

The allowed OAuth scopes.

Possible values provided by OAuth are: phone , email , openid , and profile . Possible values provided by AWS are: aws.cognito.signin.user.admin . Custom scopes created in Resource Servers are also supported.

Parameters:

allowedOAuthScopes - The allowed OAuth scopes. This parameter is required.

Returns:

this

analyticsConfiguration

@Stability(value=Stable)
public CfnUserPoolClient.Builder analyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty analyticsConfiguration)

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Parameters:

analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. This parameter is required.

Returns:

this

analyticsConfiguration

@Stability(value=Stable)
public CfnUserPoolClient.Builder analyticsConfiguration(IResolvable analyticsConfiguration)

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Parameters:

analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. This parameter is required.

Returns:

this

callbackUrLs

@Stability(value=Stable)
public CfnUserPoolClient.Builder callbackUrLs(List<String> callbackUrLs)

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

• Be an absolute URI.
• Be registered with the authorization server.
• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint .

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Parameters:

callbackUrLs - A list of allowed redirect (callback) URLs for the identity providers. This parameter is required.

Returns:

this

clientName

@Stability(value=Stable)
public CfnUserPoolClient.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. This parameter is required.

Returns:

this

defaultRedirectUri

@Stability(value=Stable)
public CfnUserPoolClient.Builder defaultRedirectUri(String defaultRedirectUri)

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

A redirect URI must:

• Be an absolute URI.
• Be registered with the authorization server.
• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint .

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Parameters:

defaultRedirectUri - The default redirect URI. Must be in the `CallbackURLs` list. This parameter is required.

Returns:

this

enableTokenRevocation

@Stability(value=Stable)
public CfnUserPoolClient.Builder enableTokenRevocation(Boolean enableTokenRevocation)

Enables or disables token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .

If you don't include this parameter, token revocation is automatically enabled for the new user pool client.

Parameters:

enableTokenRevocation - Enables or disables token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) . This parameter is required.

Returns:

this

enableTokenRevocation

@Stability(value=Stable)
public CfnUserPoolClient.Builder enableTokenRevocation(IResolvable enableTokenRevocation)

Enables or disables token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .

If you don't include this parameter, token revocation is automatically enabled for the new user pool client.

Parameters:

enableTokenRevocation - Enables or disables token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) . This parameter is required.

Returns:

this

explicitAuthFlows

@Stability(value=Stable)
public CfnUserPoolClient.Builder explicitAuthFlows(List<String> explicitAuthFlows)

The authentication flows that are supported by the user pool clients.

Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

• ALLOW_ADMIN_USER_PASSWORD_AUTH : Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH . This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
• ALLOW_CUSTOM_AUTH : Enable Lambda trigger based authentication.
• ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
• ALLOW_USER_SRP_AUTH : Enable SRP based authentication.
• ALLOW_REFRESH_TOKEN_AUTH : Enable authflow to refresh tokens.

Parameters:

explicitAuthFlows - The authentication flows that are supported by the user pool clients. This parameter is required.

Returns:

this

generateSecret

@Stability(value=Stable)
public CfnUserPoolClient.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. This parameter is required.

Returns:

this

generateSecret

@Stability(value=Stable)
public CfnUserPoolClient.Builder generateSecret(IResolvable 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. This parameter is required.

Returns:

this

idTokenValidity

@Stability(value=Stable)
public CfnUserPoolClient.Builder idTokenValidity(Number idTokenValidity)

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

Parameters:

idTokenValidity - The time limit, after which the ID token is no longer valid and cannot be used. This parameter is required.

Returns:

this

logoutUrLs

@Stability(value=Stable)
public CfnUserPoolClient.Builder logoutUrLs(List<String> logoutUrLs)

A list of allowed logout URLs for the identity providers.

Parameters:

logoutUrLs - A list of allowed logout URLs for the identity providers. This parameter is required.

Returns:

this

preventUserExistenceErrors

@Stability(value=Stable)
public CfnUserPoolClient.Builder preventUserExistenceErrors(String preventUserExistenceErrors)

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.

When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY , those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Parameters:

preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. This parameter is required.

Returns:

this

readAttributes

@Stability(value=Stable)
public CfnUserPoolClient.Builder readAttributes(List<String> readAttributes)

The read attributes.

Parameters:

readAttributes - The read attributes. This parameter is required.

Returns:

this

refreshTokenValidity

@Stability(value=Stable)
public CfnUserPoolClient.Builder refreshTokenValidity(Number 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. This parameter is required.

Returns:

this

supportedIdentityProviders

@Stability(value=Stable)
public CfnUserPoolClient.Builder supportedIdentityProviders(List<String> supportedIdentityProviders)

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

The following are supported: COGNITO , Facebook , SignInWithApple , Google and LoginWithAmazon .

Parameters:

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

Returns:

this

tokenValidityUnits

@Stability(value=Stable)
public CfnUserPoolClient.Builder tokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty tokenValidityUnits)

The units in which the validity times are represented in.

Default for RefreshToken is days, and default for ID and access tokens are hours.

Parameters:

tokenValidityUnits - The units in which the validity times are represented in. This parameter is required.

Returns:

this

tokenValidityUnits

@Stability(value=Stable)
public CfnUserPoolClient.Builder tokenValidityUnits(IResolvable tokenValidityUnits)

The units in which the validity times are represented in.

Default for RefreshToken is days, and default for ID and access tokens are hours.

Parameters:

tokenValidityUnits - The units in which the validity times are represented in. This parameter is required.

Returns:

this

writeAttributes

@Stability(value=Stable)
public CfnUserPoolClient.Builder writeAttributes(List<String> writeAttributes)

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .

Parameters:

writeAttributes - The user pool attributes that the app client can write to. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnUserPoolClient build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPoolClient>