software.amazon.awscdk.services.cognito

Class CfnUserPoolClientProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolClientProps.Builder

Enclosing interface:

CfnUserPoolClientProps

public static final class CfnUserPoolClientProps.Builder
extends java.lang.Object

A builder for CfnUserPoolClientProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnUserPoolClientProps.Builder	accessTokenValidity(java.lang.Number accessTokenValidity) Sets the value of CfnUserPoolClientProps.getAccessTokenValidity()
CfnUserPoolClientProps.Builder	allowedOAuthFlows(java.util.List<java.lang.String> allowedOAuthFlows) Sets the value of CfnUserPoolClientProps.getAllowedOAuthFlows()
CfnUserPoolClientProps.Builder	allowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient) Sets the value of CfnUserPoolClientProps.getAllowedOAuthFlowsUserPoolClient()
CfnUserPoolClientProps.Builder	allowedOAuthFlowsUserPoolClient(IResolvable allowedOAuthFlowsUserPoolClient) Sets the value of CfnUserPoolClientProps.getAllowedOAuthFlowsUserPoolClient()
CfnUserPoolClientProps.Builder	allowedOAuthScopes(java.util.List<java.lang.String> allowedOAuthScopes) Sets the value of CfnUserPoolClientProps.getAllowedOAuthScopes()
CfnUserPoolClientProps.Builder	analyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty analyticsConfiguration) Sets the value of CfnUserPoolClientProps.getAnalyticsConfiguration()
CfnUserPoolClientProps.Builder	analyticsConfiguration(IResolvable analyticsConfiguration) Sets the value of CfnUserPoolClientProps.getAnalyticsConfiguration()
CfnUserPoolClientProps	build() Builds the configured instance.
CfnUserPoolClientProps.Builder	callbackUrLs(java.util.List<java.lang.String> callbackUrLs) Sets the value of CfnUserPoolClientProps.getCallbackUrLs()
CfnUserPoolClientProps.Builder	clientName(java.lang.String clientName) Sets the value of CfnUserPoolClientProps.getClientName()
CfnUserPoolClientProps.Builder	defaultRedirectUri(java.lang.String defaultRedirectUri) Sets the value of CfnUserPoolClientProps.getDefaultRedirectUri()
CfnUserPoolClientProps.Builder	enablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData) Sets the value of CfnUserPoolClientProps.getEnablePropagateAdditionalUserContextData()
CfnUserPoolClientProps.Builder	enablePropagateAdditionalUserContextData(IResolvable enablePropagateAdditionalUserContextData) Sets the value of CfnUserPoolClientProps.getEnablePropagateAdditionalUserContextData()
CfnUserPoolClientProps.Builder	enableTokenRevocation(java.lang.Boolean enableTokenRevocation) Sets the value of CfnUserPoolClientProps.getEnableTokenRevocation()
CfnUserPoolClientProps.Builder	enableTokenRevocation(IResolvable enableTokenRevocation) Sets the value of CfnUserPoolClientProps.getEnableTokenRevocation()
CfnUserPoolClientProps.Builder	explicitAuthFlows(java.util.List<java.lang.String> explicitAuthFlows) Sets the value of CfnUserPoolClientProps.getExplicitAuthFlows()
CfnUserPoolClientProps.Builder	generateSecret(java.lang.Boolean generateSecret) Sets the value of CfnUserPoolClientProps.getGenerateSecret()
CfnUserPoolClientProps.Builder	generateSecret(IResolvable generateSecret) Sets the value of CfnUserPoolClientProps.getGenerateSecret()
CfnUserPoolClientProps.Builder	idTokenValidity(java.lang.Number idTokenValidity) Sets the value of CfnUserPoolClientProps.getIdTokenValidity()
CfnUserPoolClientProps.Builder	logoutUrLs(java.util.List<java.lang.String> logoutUrLs) Sets the value of CfnUserPoolClientProps.getLogoutUrLs()
CfnUserPoolClientProps.Builder	preventUserExistenceErrors(java.lang.String preventUserExistenceErrors) Sets the value of CfnUserPoolClientProps.getPreventUserExistenceErrors()
CfnUserPoolClientProps.Builder	readAttributes(java.util.List<java.lang.String> readAttributes) Sets the value of CfnUserPoolClientProps.getReadAttributes()
CfnUserPoolClientProps.Builder	refreshTokenValidity(java.lang.Number refreshTokenValidity) Sets the value of CfnUserPoolClientProps.getRefreshTokenValidity()
CfnUserPoolClientProps.Builder	supportedIdentityProviders(java.util.List<java.lang.String> supportedIdentityProviders) Sets the value of CfnUserPoolClientProps.getSupportedIdentityProviders()
CfnUserPoolClientProps.Builder	tokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty tokenValidityUnits) Sets the value of CfnUserPoolClientProps.getTokenValidityUnits()
CfnUserPoolClientProps.Builder	tokenValidityUnits(IResolvable tokenValidityUnits) Sets the value of CfnUserPoolClientProps.getTokenValidityUnits()
CfnUserPoolClientProps.Builder	userPoolId(java.lang.String userPoolId) Sets the value of CfnUserPoolClientProps.getUserPoolId()
CfnUserPoolClientProps.Builder	writeAttributes(java.util.List<java.lang.String> writeAttributes) Sets the value of CfnUserPoolClientProps.getWriteAttributes()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

userPoolId

public CfnUserPoolClientProps.Builder userPoolId(java.lang.String userPoolId)

Sets the value of CfnUserPoolClientProps.getUserPoolId()

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

public CfnUserPoolClientProps.Builder accessTokenValidity(java.lang.Number accessTokenValidity)

Sets the value of CfnUserPoolClientProps.getAccessTokenValidity()

Parameters:

accessTokenValidity - The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours.

Returns:

this

allowedOAuthFlows

public CfnUserPoolClientProps.Builder allowedOAuthFlows(java.util.List<java.lang.String> allowedOAuthFlows)

Sets the value of CfnUserPoolClientProps.getAllowedOAuthFlows()

Parameters:

allowedOAuthFlows - The allowed OAuth flows.

• code - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
• implicit - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
• client_credentials - Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

Returns:

this

allowedOAuthFlowsUserPoolClient

public CfnUserPoolClientProps.Builder allowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)

Sets the value of CfnUserPoolClientProps.getAllowedOAuthFlowsUserPoolClient()

Parameters:

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

Returns:

this

allowedOAuthFlowsUserPoolClient

public CfnUserPoolClientProps.Builder allowedOAuthFlowsUserPoolClient(IResolvable allowedOAuthFlowsUserPoolClient)

Sets the value of CfnUserPoolClientProps.getAllowedOAuthFlowsUserPoolClient()

Parameters:

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

Returns:

this

allowedOAuthScopes

public CfnUserPoolClientProps.Builder allowedOAuthScopes(java.util.List<java.lang.String> allowedOAuthScopes)

Sets the value of CfnUserPoolClientProps.getAllowedOAuthScopes()

Parameters:

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.

Returns:

this

analyticsConfiguration

public CfnUserPoolClientProps.Builder analyticsConfiguration(IResolvable analyticsConfiguration)

Sets the value of CfnUserPoolClientProps.getAnalyticsConfiguration()

Parameters:

analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

Returns:

this

analyticsConfiguration

public CfnUserPoolClientProps.Builder analyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty analyticsConfiguration)

Sets the value of CfnUserPoolClientProps.getAnalyticsConfiguration()

Parameters:

analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

Returns:

this

callbackUrLs

public CfnUserPoolClientProps.Builder callbackUrLs(java.util.List<java.lang.String> callbackUrLs)

Sets the value of CfnUserPoolClientProps.getCallbackUrLs()

Parameters:

callbackUrLs - A list of allowed redirect (callback) URLs for the IdPs. 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.

Returns:

this

clientName

public CfnUserPoolClientProps.Builder clientName(java.lang.String clientName)

Sets the value of CfnUserPoolClientProps.getClientName()

Parameters:

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

Returns:

this

defaultRedirectUri

public CfnUserPoolClientProps.Builder defaultRedirectUri(java.lang.String defaultRedirectUri)

Sets the value of CfnUserPoolClientProps.getDefaultRedirectUri()

Parameters:

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.

Returns:

this

enablePropagateAdditionalUserContextData

public CfnUserPoolClientProps.Builder enablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)

Sets the value of CfnUserPoolClientProps.getEnablePropagateAdditionalUserContextData()

Parameters:

enablePropagateAdditionalUserContextData - `AWS::Cognito::UserPoolClient.EnablePropagateAdditionalUserContextData`.

Returns:

this

enablePropagateAdditionalUserContextData

public CfnUserPoolClientProps.Builder enablePropagateAdditionalUserContextData(IResolvable enablePropagateAdditionalUserContextData)

Sets the value of CfnUserPoolClientProps.getEnablePropagateAdditionalUserContextData()

Parameters:

enablePropagateAdditionalUserContextData - `AWS::Cognito::UserPoolClient.EnablePropagateAdditionalUserContextData`.

Returns:

this

enableTokenRevocation

public CfnUserPoolClientProps.Builder enableTokenRevocation(java.lang.Boolean enableTokenRevocation)

Sets the value of CfnUserPoolClientProps.getEnableTokenRevocation()

Parameters:

enableTokenRevocation - Activates or deactivates 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 activated for the new user pool client.

Returns:

this

enableTokenRevocation

public CfnUserPoolClientProps.Builder enableTokenRevocation(IResolvable enableTokenRevocation)

Sets the value of CfnUserPoolClientProps.getEnableTokenRevocation()

Parameters:

enableTokenRevocation - Activates or deactivates 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 activated for the new user pool client.

Returns:

this

explicitAuthFlows

public CfnUserPoolClientProps.Builder explicitAuthFlows(java.util.List<java.lang.String> explicitAuthFlows)

Sets the value of CfnUserPoolClientProps.getExplicitAuthFlows()

Parameters:

explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix.

Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
• ALLOW_CUSTOM_AUTH : Enable AWS Lambda trigger based authentication.
• ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In this flow, Amazon 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.

If you don't specify a value for ExplicitAuthFlows , your app client activates the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.

Returns:

this

generateSecret

public CfnUserPoolClientProps.Builder generateSecret(java.lang.Boolean generateSecret)

Sets the value of CfnUserPoolClientProps.getGenerateSecret()

Parameters:

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

Returns:

this

generateSecret

public CfnUserPoolClientProps.Builder generateSecret(IResolvable generateSecret)

Sets the value of CfnUserPoolClientProps.getGenerateSecret()

Parameters:

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

Returns:

this

idTokenValidity

public CfnUserPoolClientProps.Builder idTokenValidity(java.lang.Number idTokenValidity)

Sets the value of CfnUserPoolClientProps.getIdTokenValidity()

Parameters:

idTokenValidity - The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours , your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours.

Returns:

this

logoutUrLs

public CfnUserPoolClientProps.Builder logoutUrLs(java.util.List<java.lang.String> logoutUrLs)

Sets the value of CfnUserPoolClientProps.getLogoutUrLs()

Parameters:

logoutUrLs - A list of allowed logout URLs for the IdPs.

Returns:

this

preventUserExistenceErrors

public CfnUserPoolClientProps.Builder preventUserExistenceErrors(java.lang.String preventUserExistenceErrors)

Sets the value of CfnUserPoolClientProps.getPreventUserExistenceErrors()

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

Returns:

this

readAttributes

public CfnUserPoolClientProps.Builder readAttributes(java.util.List<java.lang.String> readAttributes)

Sets the value of CfnUserPoolClientProps.getReadAttributes()

Parameters:

readAttributes - The read attributes.

Returns:

this

refreshTokenValidity

public CfnUserPoolClientProps.Builder refreshTokenValidity(java.lang.Number refreshTokenValidity)

Sets the value of CfnUserPoolClientProps.getRefreshTokenValidity()

Parameters:

refreshTokenValidity - The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days , your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.

Returns:

this

supportedIdentityProviders

public CfnUserPoolClientProps.Builder supportedIdentityProviders(java.util.List<java.lang.String> supportedIdentityProviders)

Sets the value of CfnUserPoolClientProps.getSupportedIdentityProviders()

Parameters:

supportedIdentityProviders - A list of provider names for the IdPs that this client supports. The following are supported: COGNITO , Facebook , Google LoginWithAmazon , and the names of your own SAML and OIDC providers.

Returns:

this

tokenValidityUnits

public CfnUserPoolClientProps.Builder tokenValidityUnits(IResolvable tokenValidityUnits)

Sets the value of CfnUserPoolClientProps.getTokenValidityUnits()

Parameters:

tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.

Returns:

this

tokenValidityUnits

public CfnUserPoolClientProps.Builder tokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty tokenValidityUnits)

Sets the value of CfnUserPoolClientProps.getTokenValidityUnits()

Parameters:

tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.

Returns:

this

writeAttributes

public CfnUserPoolClientProps.Builder writeAttributes(java.util.List<java.lang.String> writeAttributes)

Sets the value of CfnUserPoolClientProps.getWriteAttributes()

Parameters:

writeAttributes - The user pool attributes that the app client can write to. If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .

Returns:

this

build

public CfnUserPoolClientProps build()

Builds the configured instance.

Returns:

a new instance of CfnUserPoolClientProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided