Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Interface CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty.Jsii$Proxy

Enclosing class:

CfnUserPoolClientPropsMixin

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

The units that validity times are represented in.

The default unit for refresh tokens is days, and the default for ID and access tokens are 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.cfnpropertymixins.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	CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty.Builder	A builder for CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty
static final class	CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty.Jsii$Proxy	An implementation for CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty.Builder	builder()
default String	getAccessToken()	A time unit for the value that you set in the AccessTokenValidity parameter.
default String	getIdToken()	A time unit for the value that you set in the IdTokenValidity parameter.
default String	getRefreshToken()	A time unit 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 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 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 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 CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty.Builder builder()

Returns:

a CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty.Builder of CfnUserPoolClientPropsMixin.TokenValidityUnitsProperty