Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolClient.RefreshTokenRotationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolClient.RefreshTokenRotationProperty.Jsii$Proxy

Enclosing class:

CfnUserPoolClient

@Stability(Stable)
public static interface CfnUserPoolClient.RefreshTokenRotationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cognito.*;
 RefreshTokenRotationProperty refreshTokenRotationProperty = RefreshTokenRotationProperty.builder()
         .feature("feature")
         .retryGracePeriodSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolClient.RefreshTokenRotationProperty.Builder	A builder for CfnUserPoolClient.RefreshTokenRotationProperty
static final class	CfnUserPoolClient.RefreshTokenRotationProperty.Jsii$Proxy	An implementation for CfnUserPoolClient.RefreshTokenRotationProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolClient.RefreshTokenRotationProperty.Builder	builder()
default String	getFeature()	The state of refresh token rotation for the current app client.
default Number	getRetryGracePeriodSeconds()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFeature

@Stability(Stable)
@Nullable
default String getFeature()

The state of refresh token rotation for the current app client.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-refreshtokenrotation.html#cfn-cognito-userpoolclient-refreshtokenrotation-feature

getRetryGracePeriodSeconds

@Stability(Stable)
@Nullable
default Number getRetryGracePeriodSeconds()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-refreshtokenrotation.html#cfn-cognito-userpoolclient-refreshtokenrotation-retrygraceperiodseconds

builder

@Stability(Stable)
static CfnUserPoolClient.RefreshTokenRotationProperty.Builder builder()

Returns:

a CfnUserPoolClient.RefreshTokenRotationProperty.Builder of CfnUserPoolClient.RefreshTokenRotationProperty