Class: Aws::CognitoIdentityProvider::Types::TokenValidityUnitsType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The time units that, with IdTokenValidity, AccessTokenValidity, and RefreshTokenValidity, set and display the duration of ID, access, and refresh tokens for an app client. You can assign a separate token validity unit to each type of token.

This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of DescribeUserPoolClient.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

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.

Returns:

  • (String) 


10245
10246
10247
10248
10249
10250
10251
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10245

class TokenValidityUnitsType < Struct.new(
  :access_token,
  :id_token,
  :refresh_token)
  SENSITIVE = []
  include Aws::Structure
end

#id_token ⇒ String

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.

Returns:

  • (String) 


10245
10246
10247
10248
10249
10250
10251
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10245

class TokenValidityUnitsType < Struct.new(
  :access_token,
  :id_token,
  :refresh_token)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_token ⇒ String

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.

Returns:

  • (String) 


10245
10246
10247
10248
10249
10250
10251
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10245

class TokenValidityUnitsType < Struct.new(
  :access_token,
  :id_token,
  :refresh_token)
  SENSITIVE = []
  include Aws::Structure
end