interface IUserPoolClient
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Cognito.IUserPoolClient |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#IUserPoolClient |
 Java | software.amazon.awscdk.services.cognito.IUserPoolClient |
 Python | aws_cdk.aws_cognito.IUserPoolClient |
 TypeScript (source) | aws-cdk-lib » aws_cognito » IUserPoolClient |
Implemented by
User
Obtainable from
User.fromUserPoolClientId()
Represents a Cognito user pool client.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| user | string | Name of the application client. |
| user | Secret | The generated client secret. |
env
Type:
Resource
The environment this resource belongs to.
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.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
userPoolClientId
Type:
string
Name of the application client.
userPoolClientSecret
Type:
Secret
The generated client secret.
Only available if the "generateSecret" props is set to true
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
Apply the given removal policy to this resource.
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).