UserPoolClient L2 construct
Define a UserPool App Client.
Example
const pool = new cognito.UserPool(this, 'Pool');
const provider = new cognito.UserPoolIdentityProviderAmazon(this, 'Amazon', {
userPool: pool,
clientId: 'amzn-client-id',
clientSecret: 'amzn-client-secret',
});
const client = pool.addClient('app-client', {
// ...
supportedIdentityProviders: [
cognito.UserPoolClientIdentityProvider.AMAZON,
],
});
client.node.addDependency(provider);
pool = cognito.UserPool(self, "Pool")
provider = cognito.UserPoolIdentityProviderAmazon(self, "Amazon",
user_pool=pool,
client_id="amzn-client-id",
client_secret="amzn-client-secret"
)
client = pool.add_client("app-client",
# ...
supported_identity_providers=[cognito.UserPoolClientIdentityProvider.AMAZON
]
)
client.node.add_dependency(provider)
UserPool pool = new UserPool(this, "Pool");
UserPoolIdentityProviderAmazon provider = UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
.userPool(pool)
.clientId("amzn-client-id")
.clientSecret("amzn-client-secret")
.build();
UserPoolClient client = pool.addClient("app-client", UserPoolClientOptions.builder()
// ...
.supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON))
.build());
client.node.addDependency(provider);
// Install: dotnet add package Amazon.CDK.Lib
var pool = new UserPool(this, "Pool");
var provider = new UserPoolIdentityProviderAmazon(this, "Amazon", new UserPoolIdentityProviderAmazonProps {
UserPool = pool,
ClientId = "amzn-client-id",
ClientSecret = "amzn-client-secret"
});
var client = pool.AddClient("app-client", new UserPoolClientOptions {
// ...
SupportedIdentityProviders = new [] { UserPoolClientIdentityProvider.AMAZON }
});
client.Node.AddDependency(provider);
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
pool := cognito.NewUserPool(this, jsii.String("Pool"))
provider := cognito.NewUserPoolIdentityProviderAmazon(this, jsii.String("Amazon"), &UserPoolIdentityProviderAmazonProps{
UserPool: pool,
ClientId: jsii.String("amzn-client-id"),
ClientSecret: jsii.String("amzn-client-secret"),
})
client := pool.addClient(jsii.String("app-client"), &UserPoolClientOptions{
// ...
SupportedIdentityProviders: []UserPoolClientIdentityProvider{
cognito.UserPoolClientIdentityProvider_AMAZON(),
},
})
client.Node.AddDependency(provider)
Initializer
new UserPoolClient(scope: Construct, id: string, props: UserPoolClientProps)
UserPoolClient(scope: Construct, id: str, props: UserPoolClientProps)
new UserPoolClient(Construct scope, String id, UserPoolClientProps props)
new UserPoolClient(Construct scope, string id, UserPoolClientProps props)
NewUserPoolClient(Scope Construct, Id *string, Props UserPoolClientProps)
Construct Props
accessTokenValidityDurationaccess_token_validityDurationaccessTokenValidityDurationAccessTokenValidityDurationAccessTokenValidityDuration= Duration.minutes(60)#Values between 5 minutes and 1 day are valid. The duration cannot be longer than the refresh token validity.
analyticsAnalyticsConfigurationanalyticsAnalyticsConfigurationanalyticsAnalyticsConfigurationAnalyticsAnalyticsConfigurationAnalyticsAnalyticsConfiguration= no analytics configuration#authFlowsAuthFlowauth_flowsAuthFlowauthFlowsAuthFlowAuthFlowsAuthFlowAuthFlowsAuthFlow= If you don't specify a value, yo…#default
Default: If you don't specify a value, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
authSessionValidityDurationauth_session_validityDurationauthSessionValidityDurationAuthSessionValidityDurationAuthSessionValidityDuration= Duration.minutes(3)#AuthSessionValidity is the duration, in minutes, of that session token. see defaults in AuthSessionValidity. Valid duration is from 3 to 15 minutes.
enablePropagateAdditionalUserContextDatabooleanenable_propagate_additional_user_context_databoolenablePropagateAdditionalUserContextDataBooleanEnablePropagateAdditionalUserContextDataboolEnablePropagateAdditionalUserContextData*bool= false for new user pool clients#You can only activate enablePropagateAdditionalUserContextData in an app client that has a client secret.
enableTokenRevocationbooleanenable_token_revocationboolenableTokenRevocationBooleanEnableTokenRevocationboolEnableTokenRevocation*bool= true for new user pool clients#generateSecretbooleangenerate_secretboolgenerateSecretBooleanGenerateSecretboolGenerateSecret*bool= false#idTokenValidityDurationid_token_validityDurationidTokenValidityDurationIdTokenValidityDurationIdTokenValidityDuration= Duration.minutes(60)#Values between 5 minutes and 1 day are valid. The duration cannot be longer than the refresh token validity.
oAuthOAuthSettingso_authOAuthSettingsoAuthOAuthSettingsOAuthOAuthSettingsOAuthOAuthSettings= see defaults in `OAuthSettings`.…#An error is thrown when this is specified and disableOAuth is set.
default
Default: see defaults in OAuthSettings. meaningless if disableOAuth is set.
preventUserExistenceErrorsbooleanprevent_user_existence_errorsboolpreventUserExistenceErrorsBooleanPreventUserExistenceErrorsboolPreventUserExistenceErrors*bool= false#readAttributesClientAttributesread_attributesClientAttributesreadAttributesClientAttributesReadAttributesClientAttributesReadAttributesClientAttributes= all standard and custom attribut…#default
Default: all standard and custom attributes
refreshTokenRotationGracePeriodDurationrefresh_token_rotation_grace_periodDurationrefreshTokenRotationGracePeriodDurationRefreshTokenRotationGracePeriodDurationRefreshTokenRotationGracePeriodDuration= undefined (refresh token rotatio…#Defines the grace period for the original refresh token (0-60 seconds).
default
Default: undefined (refresh token rotation is disabled)
refreshTokenValidityDurationrefresh_token_validityDurationrefreshTokenValidityDurationRefreshTokenValidityDurationRefreshTokenValidityDuration= Duration.days(30)#Values between 60 minutes and 10 years are valid.
supportedIdentityProvidersUserPoolClientIdentityProvider[]supported_identity_providerstyping.List[UserPoolClientIdentityProvider]supportedIdentityProvidersList<UserPoolClientIdentityProvider>SupportedIdentityProvidersUserPoolClientIdentityProvider[]SupportedIdentityProviders*[]UserPoolClientIdentityProvider= supports all identity providers …#default
Default: supports all identity providers that are registered with the user pool. If the user pool and/or identity providers are imported, either specify this option explicitly or ensure that the identity providers are registered with the user pool using the UserPool.registerIdentityProvider() API.
userPoolIUserPoolRefuser_poolIUserPoolRefuserPoolIUserPoolRefUserPoolIUserPoolRefUserPoolIUserPoolRefrequired#userPoolClientNamestringuser_pool_client_namestruserPoolClientNameStringUserPoolClientNamestringUserPoolClientName*string= cloudformation generated name#writeAttributesClientAttributeswrite_attributesClientAttributeswriteAttributesClientAttributesWriteAttributesClientAttributesWriteAttributesClientAttributes= all standard and custom attribut…#default
Default: all standard and custom attributes
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
oAuthFlowsOAuthFlowso_auth_flowsOAuthFlowsoAuthFlowsOAuthFlowsOAuthFlowsOAuthFlowsOAuthFlowsOAuthFlowsrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#userPoolClientIdstringuser_pool_client_idstruserPoolClientIdStringUserPoolClientIdstringUserPoolClientId*stringrequired#userPoolClientNamestringuser_pool_client_namestruserPoolClientNameStringUserPoolClientNamestringUserPoolClientName*stringrequired#userPoolClientRefUserPoolClientReferenceuser_pool_client_refUserPoolClientReferenceuserPoolClientRefUserPoolClientReferenceUserPoolClientRefUserPoolClientReferenceUserPoolClientRefUserPoolClientReferencerequired#userPoolClientSecretSecretValueuser_pool_client_secretSecretValueuserPoolClientSecretSecretValueUserPoolClientSecretSecretValueUserPoolClientSecretSecretValuerequired#Only available if the "generateSecret" props is set to true
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromUserPoolClientId(scope: Construct, id: string, userPoolClientId: string): IUserPoolClient@staticmethod def from_user_pool_client_id(scope: Construct, id: str, user_pool_client_id: str) -> IUserPoolClientpublic static IUserPoolClient fromUserPoolClientId(Construct scope, String id, String userPoolClientId)public static IUserPoolClient FromUserPoolClientId(Construct scope, string id, string userPoolClientId)func FromUserPoolClientId(Scope Construct, Id *string, UserPoolClientId *string) IUserPoolClientstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.