Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolClient.TokenValidityUnitsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolClient.TokenValidityUnitsProperty.Jsii$Proxy

Enclosing class:

CfnUserPoolClient

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

The time units you use when you set the duration of ID, access, and refresh tokens.

The default unit for RefreshToken is days, and the default for ID and access tokens is hours.

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.*;
 TokenValidityUnitsProperty tokenValidityUnitsProperty = TokenValidityUnitsProperty.builder()
         .accessToken("accessToken")
         .idToken("idToken")
         .refreshToken("refreshToken")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolClient.TokenValidityUnitsProperty.Builder	builder()
default String	getAccessToken()	A time unit of seconds , minutes , hours , or days for the value that you set in the AccessTokenValidity parameter.
default String	getIdToken()	A time unit of seconds , minutes , hours , or days for the value that you set in the IdTokenValidity parameter.
default String	getRefreshToken()	A time unit of seconds , minutes , hours , or days for the value that you set in the RefreshTokenValidity parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessToken

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

A time unit of seconds , minutes , hours , or days for the value that you set in the AccessTokenValidity parameter.

The default AccessTokenValidity time unit is hours. AccessTokenValidity duration can range from five minutes to one day.

See Also:

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

getIdToken

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

A time unit of seconds , minutes , hours , or days for the value that you set in the IdTokenValidity parameter.

The default IdTokenValidity time unit is hours. IdTokenValidity duration can range from five minutes to one day.

See Also:

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

getRefreshToken

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

A time unit of seconds , minutes , hours , or days for the value that you set in the RefreshTokenValidity parameter.

The default RefreshTokenValidity time unit is days. RefreshTokenValidity duration can range from 60 minutes to 10 years.

See Also:

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

builder

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

Returns:

a CfnUserPoolClient.TokenValidityUnitsProperty.Builder of CfnUserPoolClient.TokenValidityUnitsProperty