@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:46.786Z")
public interface CfnUserPoolClientProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cognito.*; CfnUserPoolClientProps cfnUserPoolClientProps = CfnUserPoolClientProps.builder() .userPoolId("userPoolId") // the properties below are optional .accessTokenValidity(123) .allowedOAuthFlows(List.of("allowedOAuthFlows")) .allowedOAuthFlowsUserPoolClient(false) .allowedOAuthScopes(List.of("allowedOAuthScopes")) .analyticsConfiguration(AnalyticsConfigurationProperty.builder() .applicationArn("applicationArn") .applicationId("applicationId") .externalId("externalId") .roleArn("roleArn") .userDataShared(false) .build()) .authSessionValidity(123) .callbackUrLs(List.of("callbackUrLs")) .clientName("clientName") .defaultRedirectUri("defaultRedirectUri") .enablePropagateAdditionalUserContextData(false) .enableTokenRevocation(false) .explicitAuthFlows(List.of("explicitAuthFlows")) .generateSecret(false) .idTokenValidity(123) .logoutUrLs(List.of("logoutUrLs")) .preventUserExistenceErrors("preventUserExistenceErrors") .readAttributes(List.of("readAttributes")) .refreshTokenValidity(123) .supportedIdentityProviders(List.of("supportedIdentityProviders")) .tokenValidityUnits(TokenValidityUnitsProperty.builder() .accessToken("accessToken") .idToken("idToken") .refreshToken("refreshToken") .build()) .writeAttributes(List.of("writeAttributes")) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnUserPoolClientProps.Builder
A builder for
CfnUserPoolClientProps |
static class |
CfnUserPoolClientProps.Jsii$Proxy
An implementation for
CfnUserPoolClientProps |
Modifier and Type | Method and Description |
---|---|
static CfnUserPoolClientProps.Builder |
builder() |
default java.lang.Number |
getAccessTokenValidity()
The access token time limit.
|
default java.util.List<java.lang.String> |
getAllowedOAuthFlows()
The allowed OAuth flows.
|
default java.lang.Object |
getAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
|
default java.util.List<java.lang.String> |
getAllowedOAuthScopes()
The allowed OAuth scopes.
|
default java.lang.Object |
getAnalyticsConfiguration()
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
|
default java.lang.Number |
getAuthSessionValidity()
Amazon Cognito creates a session token for each API request in an authentication flow.
|
default java.util.List<java.lang.String> |
getCallbackUrLs()
A list of allowed redirect (callback) URLs for the IdPs.
|
default java.lang.String |
getClientName()
The client name for the user pool client you would like to create.
|
default java.lang.String |
getDefaultRedirectUri()
The default redirect URI.
|
default java.lang.Object |
getEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
default java.lang.Object |
getEnableTokenRevocation()
Activates or deactivates token revocation.
|
default java.util.List<java.lang.String> |
getExplicitAuthFlows()
The authentication flows that you want your user pool client to support.
|
default java.lang.Object |
getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
default java.lang.Number |
getIdTokenValidity()
The ID token time limit.
|
default java.util.List<java.lang.String> |
getLogoutUrLs()
A list of allowed logout URLs for the IdPs.
|
default java.lang.String |
getPreventUserExistenceErrors()
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.
|
default java.util.List<java.lang.String> |
getReadAttributes()
The read attributes.
|
default java.lang.Number |
getRefreshTokenValidity()
The refresh token time limit.
|
default java.util.List<java.lang.String> |
getSupportedIdentityProviders()
A list of provider names for the identity providers (IdPs) that are supported on this client.
|
default java.lang.Object |
getTokenValidityUnits()
The units in which the validity times are represented.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool where you want to create a user pool client.
|
default java.util.List<java.lang.String> |
getWriteAttributes()
The user pool attributes that the app client can write to.
|
java.lang.String getUserPoolId()
default java.lang.Number getAccessTokenValidity()
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.
default java.util.List<java.lang.String> getAllowedOAuthFlows()
/oauth2/token
endpoint./oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.default java.lang.Object getAllowedOAuthFlowsUserPoolClient()
default java.util.List<java.lang.String> getAllowedOAuthScopes()
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.
default java.lang.Object getAnalyticsConfiguration()
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.
default java.lang.Number getAuthSessionValidity()
AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
default java.util.List<java.lang.String> getCallbackUrLs()
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.
default java.lang.String getClientName()
default java.lang.String getDefaultRedirectUri()
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.
default java.lang.Object getEnablePropagateAdditionalUserContextData()
For more information about propagation of user context data, see Adding advanced security to a user pool . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
default java.lang.Object getEnableTokenRevocation()
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
default java.util.List<java.lang.String> getExplicitAuthFlows()
For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows
, your user client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.
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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.ALLOW_CUSTOM_AUTH
: Enable 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.
In some environments, you will see the values ADMIN_NO_SRP_AUTH
, CUSTOM_AUTH_FLOW_ONLY
, or USER_PASSWORD_AUTH
. You can't assign these legacy ExplicitAuthFlows
values to user pool clients at the same time as values that begin with ALLOW_
,
like ALLOW_USER_SRP_AUTH
.
default java.lang.Object getGenerateSecret()
default java.lang.Number getIdTokenValidity()
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 IdTokenValidity
in an API request is hours.
default java.util.List<java.lang.String> getLogoutUrLs()
default java.lang.String getPreventUserExistenceErrors()
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.
default java.util.List<java.lang.String> getReadAttributes()
default java.lang.Number getRefreshTokenValidity()
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.
default java.util.List<java.lang.String> getSupportedIdentityProviders()
The following are supported: COGNITO
, Facebook
, Google
, SignInWithApple
, and LoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
or MyOIDCIdP
.
default java.lang.Object getTokenValidityUnits()
The default unit for RefreshToken is days, and default for ID and access tokens are hours.
default java.util.List<java.lang.String> getWriteAttributes()
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 .
static CfnUserPoolClientProps.Builder builder()
CfnUserPoolClientProps.Builder
of CfnUserPoolClientProps