Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Class CfnUserPoolClientPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolClientPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.385Z")
@Stability(Stable)
public class CfnUserPoolClientPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::Cognito::UserPoolClient resource specifies an Amazon Cognito user pool client.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cognito.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnUserPoolClientPropsMixin cfnUserPoolClientPropsMixin = CfnUserPoolClientPropsMixin.Builder.create(CfnUserPoolClientMixinProps.builder()
         .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"))
         .refreshTokenRotation(RefreshTokenRotationProperty.builder()
                 .feature("feature")
                 .retryGracePeriodSeconds(123)
                 .build())
         .refreshTokenValidity(123)
         .supportedIdentityProviders(List.of("supportedIdentityProviders"))
         .tokenValidityUnits(TokenValidityUnitsProperty.builder()
                 .accessToken("accessToken")
                 .idToken("idToken")
                 .refreshToken("refreshToken")
                 .build())
         .userPoolId("userPoolId")
         .writeAttributes(List.of("writeAttributes"))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnUserPoolClientPropsMixin.AnalyticsConfigurationProperty	The settings for Amazon Pinpoint analytics configuration.
static final class	CfnUserPoolClientPropsMixin.Builder	A fluent builder for CfnUserPoolClientPropsMixin.
static interface	CfnUserPoolClientPropsMixin.RefreshTokenRotationProperty	The configuration of your app client for refresh token rotation.
static interface	CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty	The units that validity times are represented in.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnUserPoolClientPropsMixin(CfnUserPoolClientMixinProps props)	Create a mixin to apply properties to AWS::Cognito::UserPoolClient.
	CfnUserPoolClientPropsMixin(CfnUserPoolClientMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Cognito::UserPoolClient.
protected	CfnUserPoolClientPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolClientPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnUserPoolClientMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnUserPoolClientPropsMixin

protected CfnUserPoolClientPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolClientPropsMixin

protected CfnUserPoolClientPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolClientPropsMixin

@Stability(Stable)
public CfnUserPoolClientPropsMixin(@NotNull
 CfnUserPoolClientMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Cognito::UserPoolClient.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnUserPoolClientPropsMixin

@Stability(Stable)
public CfnUserPoolClientPropsMixin(@NotNull
 CfnUserPoolClientMixinProps props)

Create a mixin to apply properties to AWS::Cognito::UserPoolClient.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnUserPoolClientMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()