CfnUserPoolClientProps (software.amazon.awscdk:monocdk 1.138.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnUserPoolClientProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:05.031Z")
 @Stability(value=Stable)
public interface CfnUserPoolClientProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnUserPoolClient`.

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())
         .callbackUrLs(List.of("callbackUrLs"))
         .clientName("clientName")
         .defaultRedirectUri("defaultRedirectUri")
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnUserPoolClientProps.Builder` A builder for `CfnUserPoolClientProps`
`static class`	`CfnUserPoolClientProps.Jsii$Proxy` An implementation for `CfnUserPoolClientProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnUserPoolClientProps.Builder`	`builder()`
`default Number`	`getAccessTokenValidity()` The time limit, after which the access token is no longer valid and cannot be used.
`default List<String>`	`getAllowedOAuthFlows()` The allowed OAuth flows.
`default Object`	`getAllowedOAuthFlowsUserPoolClient()` Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`default List<String>`	`getAllowedOAuthScopes()` The allowed OAuth scopes.
`default Object`	`getAnalyticsConfiguration()` The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
`default List<String>`	`getCallbackUrLs()` A list of allowed redirect (callback) URLs for the identity providers.
`default String`	`getClientName()` The client name for the user pool client you would like to create.
`default String`	`getDefaultRedirectUri()` The default redirect URI.
`default Object`	`getEnableTokenRevocation()` Enables or disables token revocation.
`default List<String>`	`getExplicitAuthFlows()` The authentication flows that are supported by the user pool clients.
`default Object`	`getGenerateSecret()` Boolean to specify whether you want to generate a secret for the user pool client being created.
`default Number`	`getIdTokenValidity()` The time limit, after which the ID token is no longer valid and cannot be used.
`default List<String>`	`getLogoutUrLs()` A list of allowed logout URLs for the identity providers.
`default 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 List<String>`	`getReadAttributes()` The read attributes.
`default Number`	`getRefreshTokenValidity()` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`default List<String>`	`getSupportedIdentityProviders()` A list of provider names for the identity providers that are supported on this client.
`default Object`	`getTokenValidityUnits()` The units in which the validity times are represented in.
`String`	`getUserPoolId()` The user pool ID for the user pool where you want to create a user pool client.
`default List<String>`	`getWriteAttributes()` The user pool attributes that the app client can write to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getUserPoolId
```
@Stability(value=Stable)
 @NotNull
String getUserPoolId()
```
    The user pool ID for the user pool where you want to create a user pool client.
  - getAccessTokenValidity
```
@Stability(value=Stable)
 @Nullable
default Number getAccessTokenValidity()
```
    The time limit, after which the access token is no longer valid and cannot be used.
  - getAllowedOAuthFlows
```
@Stability(value=Stable)
 @Nullable
default List<String> getAllowedOAuthFlows()
```
    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.
  - getAllowedOAuthFlowsUserPoolClient
```
@Stability(value=Stable)
 @Nullable
default Object getAllowedOAuthFlowsUserPoolClient()
```
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - getAllowedOAuthScopes
```
@Stability(value=Stable)
 @Nullable
default List<String> getAllowedOAuthScopes()
```
    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.
  - getAnalyticsConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getAnalyticsConfiguration()
```
    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.
  - getCallbackUrLs
```
@Stability(value=Stable)
 @Nullable
default List<String> getCallbackUrLs()
```
    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.
  - getClientName
```
@Stability(value=Stable)
 @Nullable
default String getClientName()
```
    The client name for the user pool client you would like to create.
  - getDefaultRedirectUri
```
@Stability(value=Stable)
 @Nullable
default String getDefaultRedirectUri()
```
    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.
  - getEnableTokenRevocation
```
@Stability(value=Stable)
 @Nullable
default Object getEnableTokenRevocation()
```
    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.
  - getExplicitAuthFlows
```
@Stability(value=Stable)
 @Nullable
default List<String> getExplicitAuthFlows()
```
    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.
  - getGenerateSecret
```
@Stability(value=Stable)
 @Nullable
default Object getGenerateSecret()
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
  - getIdTokenValidity
```
@Stability(value=Stable)
 @Nullable
default Number getIdTokenValidity()
```
    The time limit, after which the ID token is no longer valid and cannot be used.
  - getLogoutUrLs
```
@Stability(value=Stable)
 @Nullable
default List<String> getLogoutUrLs()
```
    A list of allowed logout URLs for the identity providers.
  - getPreventUserExistenceErrors
```
@Stability(value=Stable)
 @Nullable
default 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.
    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.
  - getReadAttributes
```
@Stability(value=Stable)
 @Nullable
default List<String> getReadAttributes()
```
    The read attributes.
  - getRefreshTokenValidity
```
@Stability(value=Stable)
 @Nullable
default Number getRefreshTokenValidity()
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - getSupportedIdentityProviders
```
@Stability(value=Stable)
 @Nullable
default List<String> getSupportedIdentityProviders()
```
    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 .
  - getTokenValidityUnits
```
@Stability(value=Stable)
 @Nullable
default Object getTokenValidityUnits()
```
    The units in which the validity times are represented in.
    Default for RefreshToken is days, and default for ID and access tokens are hours.
  - getWriteAttributes
```
@Stability(value=Stable)
 @Nullable
default List<String> getWriteAttributes()
```
    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 .
  - builder
```
@Stability(value=Stable)
static CfnUserPoolClientProps.Builder builder()
```
    Returns:
    
    a CfnUserPoolClientProps.Builder of CfnUserPoolClientProps

Interface CfnUserPoolClientProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getUserPoolId

getAccessTokenValidity

getAllowedOAuthFlows

getAllowedOAuthFlowsUserPoolClient

getAllowedOAuthScopes

getAnalyticsConfiguration

getCallbackUrLs

getClientName

getDefaultRedirectUri

getEnableTokenRevocation

getExplicitAuthFlows

getGenerateSecret

getIdTokenValidity

getLogoutUrLs

getPreventUserExistenceErrors

getReadAttributes

getRefreshTokenValidity

getSupportedIdentityProviders

getTokenValidityUnits

getWriteAttributes

builder