software.amazon.awscdk.services.cognito

Interface CfnUserPoolClientProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolClientProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.624Z")
 @Stability(value=Stable)
public interface CfnUserPoolClientProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Cognito::UserPoolClient`.

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

Modifier and Type	Method and Description
static CfnUserPoolClientProps.Builder	builder()
default Number	getAccessTokenValidity() `AWS::Cognito::UserPoolClient.AccessTokenValidity`.
default List<String>	getAllowedOAuthFlows() `AWS::Cognito::UserPoolClient.AllowedOAuthFlows`.
default Object	getAllowedOAuthFlowsUserPoolClient() `AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.
default List<String>	getAllowedOAuthScopes() `AWS::Cognito::UserPoolClient.AllowedOAuthScopes`.
default Object	getAnalyticsConfiguration() `AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.
default List<String>	getCallbackUrLs() `AWS::Cognito::UserPoolClient.CallbackURLs`.
default String	getClientName() `AWS::Cognito::UserPoolClient.ClientName`.
default String	getDefaultRedirectUri() `AWS::Cognito::UserPoolClient.DefaultRedirectURI`.
default Object	getEnableTokenRevocation() `AWS::Cognito::UserPoolClient.EnableTokenRevocation`.
default List<String>	getExplicitAuthFlows() `AWS::Cognito::UserPoolClient.ExplicitAuthFlows`.
default Object	getGenerateSecret() `AWS::Cognito::UserPoolClient.GenerateSecret`.
default Number	getIdTokenValidity() `AWS::Cognito::UserPoolClient.IdTokenValidity`.
default List<String>	getLogoutUrLs() `AWS::Cognito::UserPoolClient.LogoutURLs`.
default String	getPreventUserExistenceErrors() `AWS::Cognito::UserPoolClient.PreventUserExistenceErrors`.
default List<String>	getReadAttributes() `AWS::Cognito::UserPoolClient.ReadAttributes`.
default Number	getRefreshTokenValidity() `AWS::Cognito::UserPoolClient.RefreshTokenValidity`.
default List<String>	getSupportedIdentityProviders() `AWS::Cognito::UserPoolClient.SupportedIdentityProviders`.
default Object	getTokenValidityUnits() `AWS::Cognito::UserPoolClient.TokenValidityUnits`.
String	getUserPoolId() `AWS::Cognito::UserPoolClient.UserPoolId`.
default List<String>	getWriteAttributes() `AWS::Cognito::UserPoolClient.WriteAttributes`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessTokenValidity

@Stability(value=Stable)
 @Nullable
default Number getAccessTokenValidity()

`AWS::Cognito::UserPoolClient.AccessTokenValidity`.

getAllowedOAuthFlows

@Stability(value=Stable)
 @Nullable
default List<String> getAllowedOAuthFlows()

`AWS::Cognito::UserPoolClient.AllowedOAuthFlows`.

getAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
 @Nullable
default Object getAllowedOAuthFlowsUserPoolClient()

`AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.

getAllowedOAuthScopes

@Stability(value=Stable)
 @Nullable
default List<String> getAllowedOAuthScopes()

`AWS::Cognito::UserPoolClient.AllowedOAuthScopes`.

getAnalyticsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getAnalyticsConfiguration()

`AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.

getCallbackUrLs

@Stability(value=Stable)
 @Nullable
default List<String> getCallbackUrLs()

`AWS::Cognito::UserPoolClient.CallbackURLs`.

getClientName

@Stability(value=Stable)
 @Nullable
default String getClientName()

`AWS::Cognito::UserPoolClient.ClientName`.

getDefaultRedirectUri

@Stability(value=Stable)
 @Nullable
default String getDefaultRedirectUri()

`AWS::Cognito::UserPoolClient.DefaultRedirectURI`.

getEnableTokenRevocation

@Stability(value=Stable)
 @Nullable
default Object getEnableTokenRevocation()

`AWS::Cognito::UserPoolClient.EnableTokenRevocation`.

getExplicitAuthFlows

@Stability(value=Stable)
 @Nullable
default List<String> getExplicitAuthFlows()

`AWS::Cognito::UserPoolClient.ExplicitAuthFlows`.

getGenerateSecret

@Stability(value=Stable)
 @Nullable
default Object getGenerateSecret()

`AWS::Cognito::UserPoolClient.GenerateSecret`.

getIdTokenValidity

@Stability(value=Stable)
 @Nullable
default Number getIdTokenValidity()

`AWS::Cognito::UserPoolClient.IdTokenValidity`.

getLogoutUrLs

@Stability(value=Stable)
 @Nullable
default List<String> getLogoutUrLs()

`AWS::Cognito::UserPoolClient.LogoutURLs`.

getPreventUserExistenceErrors

@Stability(value=Stable)
 @Nullable
default String getPreventUserExistenceErrors()

`AWS::Cognito::UserPoolClient.PreventUserExistenceErrors`.

getReadAttributes

@Stability(value=Stable)
 @Nullable
default List<String> getReadAttributes()

`AWS::Cognito::UserPoolClient.ReadAttributes`.

getRefreshTokenValidity

@Stability(value=Stable)
 @Nullable
default Number getRefreshTokenValidity()

`AWS::Cognito::UserPoolClient.RefreshTokenValidity`.

getSupportedIdentityProviders

@Stability(value=Stable)
 @Nullable
default List<String> getSupportedIdentityProviders()

`AWS::Cognito::UserPoolClient.SupportedIdentityProviders`.

getTokenValidityUnits

@Stability(value=Stable)
 @Nullable
default Object getTokenValidityUnits()

`AWS::Cognito::UserPoolClient.TokenValidityUnits`.

getUserPoolId

@Stability(value=Stable)
 @NotNull
String getUserPoolId()

`AWS::Cognito::UserPoolClient.UserPoolId`.

getWriteAttributes

@Stability(value=Stable)
 @Nullable
default List<String> getWriteAttributes()

`AWS::Cognito::UserPoolClient.WriteAttributes`.

builder

@Stability(value=Stable)
static CfnUserPoolClientProps.Builder builder()

Returns:

a CfnUserPoolClientProps.Builder of CfnUserPoolClientProps