interface RefreshTokenRotationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Cognito.CfnUserPoolClient.RefreshTokenRotationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPoolClient_RefreshTokenRotationProperty |
 Java | software.amazon.awscdk.services.cognito.CfnUserPoolClient.RefreshTokenRotationProperty |
 Python | aws_cdk.aws_cognito.CfnUserPoolClient.RefreshTokenRotationProperty |
 TypeScript | aws-cdk-lib » aws_cognito » CfnUserPoolClient » RefreshTokenRotationProperty |
The configuration of your app client for refresh token rotation.
When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const refreshTokenRotationProperty: cognito.CfnUserPoolClient.RefreshTokenRotationProperty = {
feature: 'feature',
retryGracePeriodSeconds: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| feature? | string | The state of refresh token rotation for the current app client. |
| retry | number | When you request a token refresh with GetTokensFromRefreshToken , the original refresh token that you're rotating out can remain valid for a period of time of up to 60 seconds. |
feature?
Type:
string
(optional)
The state of refresh token rotation for the current app client.
retryGracePeriodSeconds?
Type:
number
(optional)
When you request a token refresh with GetTokensFromRefreshToken , the original refresh token that you're rotating out can remain valid for a period of time of up to 60 seconds.
This allows for client-side retries. When RetryGracePeriodSeconds is 0 , the grace period is disabled and a successful request immediately invalidates the submitted refresh token.