Interface UserPoolClientProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,UserPoolClientOptions
- All Known Implementing Classes:
UserPoolClientProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T22:26:33.372Z")
@Stability(Stable)
public interface UserPoolClientProps
extends software.amazon.jsii.JsiiSerializable, UserPoolClientOptions
Properties for the UserPoolClient construct.
Example:
import software.amazon.awscdk.services.pinpoint.*;
UserPool userPool;
CfnApp pinpointApp;
Role pinpointRole;
UserPoolClient.Builder.create(this, "Client")
.userPool(userPool)
.analytics(AnalyticsConfiguration.builder()
// Your Pinpoint project ID
.applicationId(pinpointApp.getRef())
// External ID for the IAM role
.externalId("sample-external-id")
// IAM role that Cognito can assume to publish to Pinpoint
.role(pinpointRole)
// Whether to include user data in analytics events
.shareUserData(true)
.build())
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forUserPoolClientPropsstatic final classAn implementation forUserPoolClientProps -
Method Summary
Modifier and TypeMethodDescriptionstatic UserPoolClientProps.Builderbuilder()The UserPool resource this client will have access to.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.cognito.UserPoolClientOptions
getAccessTokenValidity, getAnalytics, getAuthFlows, getAuthSessionValidity, getDisableOAuth, getEnablePropagateAdditionalUserContextData, getEnableTokenRevocation, getGenerateSecret, getIdTokenValidity, getOAuth, getPreventUserExistenceErrors, getReadAttributes, getRefreshTokenRotationGracePeriod, getRefreshTokenValidity, getSupportedIdentityProviders, getUserPoolClientName, getWriteAttributes
-
Method Details
-
getUserPool
The UserPool resource this client will have access to. -
builder
- Returns:
- a
UserPoolClientProps.BuilderofUserPoolClientProps
-