@Stability(value=Stable) public static final class CfnUserPoolClientProps.Builder extends Object implements software.amazon.jsii.Builder<CfnUserPoolClientProps>
CfnUserPoolClientProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnUserPoolClientProps.Builder userPoolId(String userPoolId)
CfnUserPoolClientProps.getUserPoolId()userPoolId - The user pool ID for the user pool where you want to create a user pool client. This parameter is required.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder accessTokenValidity(Number accessTokenValidity)
CfnUserPoolClientProps.getAccessTokenValidity()accessTokenValidity - The time limit after which the access token is no longer valid and can't be used.
If you supply a TokenValidityUnits value, you override the default time unit of hours . The default time unit for AccessTokenValidity in an API request is hours.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder allowedOAuthFlows(List<String> allowedOAuthFlows)
CfnUserPoolClientProps.getAllowedOAuthFlows()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.
this@Stability(value=Stable) public CfnUserPoolClientProps.Builder allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
CfnUserPoolClientProps.getAllowedOAuthFlowsUserPoolClient()allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder allowedOAuthFlowsUserPoolClient(IResolvable allowedOAuthFlowsUserPoolClient)
CfnUserPoolClientProps.getAllowedOAuthFlowsUserPoolClient()allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder allowedOAuthScopes(List<String> allowedOAuthScopes)
CfnUserPoolClientProps.getAllowedOAuthScopes()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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder analyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty analyticsConfiguration)
CfnUserPoolClientProps.getAnalyticsConfiguration()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.
this@Stability(value=Stable) public CfnUserPoolClientProps.Builder analyticsConfiguration(IResolvable analyticsConfiguration)
CfnUserPoolClientProps.getAnalyticsConfiguration()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.
this@Stability(value=Stable) public CfnUserPoolClientProps.Builder callbackUrLs(List<String> callbackUrLs)
CfnUserPoolClientProps.getCallbackUrLs()callbackUrLs - A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
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.
this@Stability(value=Stable) public CfnUserPoolClientProps.Builder clientName(String clientName)
CfnUserPoolClientProps.getClientName()clientName - The client name for the user pool client you would like to create.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder defaultRedirectUri(String defaultRedirectUri)
CfnUserPoolClientProps.getDefaultRedirectUri()defaultRedirectUri - The default redirect URI. Must be in the `CallbackURLs` list.
A redirect URI must:
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.
this@Stability(value=Stable) public CfnUserPoolClientProps.Builder enableTokenRevocation(Boolean enableTokenRevocation)
CfnUserPoolClientProps.getEnableTokenRevocation()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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder enableTokenRevocation(IResolvable enableTokenRevocation)
CfnUserPoolClientProps.getEnableTokenRevocation()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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder explicitAuthFlows(List<String> explicitAuthFlows)
CfnUserPoolClientProps.getExplicitAuthFlows()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 theALLOW_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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder generateSecret(Boolean generateSecret)
CfnUserPoolClientProps.getGenerateSecret()generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder generateSecret(IResolvable generateSecret)
CfnUserPoolClientProps.getGenerateSecret()generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder idTokenValidity(Number idTokenValidity)
CfnUserPoolClientProps.getIdTokenValidity()idTokenValidity - The time limit after which the access token is no longer valid and can't be used.
If you supply a TokenValidityUnits value, you override the default time unit of hours . The default time unit for AccessTokenValidity in an API request is hours.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder logoutUrLs(List<String> logoutUrLs)
CfnUserPoolClientProps.getLogoutUrLs()logoutUrLs - A list of allowed logout URLs for the identity providers.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder preventUserExistenceErrors(String preventUserExistenceErrors)
CfnUserPoolClientProps.getPreventUserExistenceErrors()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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder readAttributes(List<String> readAttributes)
CfnUserPoolClientProps.getReadAttributes()readAttributes - The read attributes.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder refreshTokenValidity(Number refreshTokenValidity)
CfnUserPoolClientProps.getRefreshTokenValidity()refreshTokenValidity - The time limit after which the refresh token is no longer valid and can't be used.
The default time unit for RefreshTokenValidity in an API request is days.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder supportedIdentityProviders(List<String> supportedIdentityProviders)
CfnUserPoolClientProps.getSupportedIdentityProviders()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 .this@Stability(value=Stable) public CfnUserPoolClientProps.Builder tokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty tokenValidityUnits)
CfnUserPoolClientProps.getTokenValidityUnits()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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder tokenValidityUnits(IResolvable tokenValidityUnits)
CfnUserPoolClientProps.getTokenValidityUnits()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.this@Stability(value=Stable) public CfnUserPoolClientProps.Builder writeAttributes(List<String> writeAttributes)
CfnUserPoolClientProps.getWriteAttributes()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 you have 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 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 Identity Provider Attribute Mappings for Your user pool .this@Stability(value=Stable) public CfnUserPoolClientProps build()
build in interface software.amazon.jsii.Builder<CfnUserPoolClientProps>CfnUserPoolClientPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.