Class: AWSCDK::Cognito::CfnUserPoolClient::RefreshTokenRotationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPoolClient::RefreshTokenRotationProperty

Defined in:

cognito/cfn_user_pool_client.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #feature ⇒ String^? readonly

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

• #retry_grace_period_seconds ⇒ Numeric^? readonly

  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.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(feature: nil, retry_grace_period_seconds: nil) ⇒ RefreshTokenRotationProperty constructor

  A new instance of RefreshTokenRotationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(feature: nil, retry_grace_period_seconds: nil) ⇒ RefreshTokenRotationProperty

Returns a new instance of RefreshTokenRotationProperty.

Parameters:

• feature (String, nil) (defaults to: nil) —

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

• retry_grace_period_seconds (Numeric, nil) (defaults to: nil) —

  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.

# File 'cognito/cfn_user_pool_client.rb', line 885

def initialize(feature: nil, retry_grace_period_seconds: nil)
  @feature = feature
  Jsii::Type.check_type(@feature, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "feature") unless @feature.nil?
  @retry_grace_period_seconds = retry_grace_period_seconds
  Jsii::Type.check_type(@retry_grace_period_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retryGracePeriodSeconds") unless @retry_grace_period_seconds.nil?
end

Instance Attribute Details

#feature ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

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

# File 'cognito/cfn_user_pool_client.rb', line 896

def feature
  @feature
end

#retry_grace_period_seconds ⇒ Numeric^? (readonly)

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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'cognito/cfn_user_pool_client.rb', line 903

def retry_grace_period_seconds
  @retry_grace_period_seconds
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool_client.rb', line 905

def self.jsii_properties
  {
    :feature => "feature",
    :retry_grace_period_seconds => "retryGracePeriodSeconds",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool_client.rb', line 912

def to_jsii
  result = {}
  result.merge!({
    "feature" => @feature,
    "retryGracePeriodSeconds" => @retry_grace_period_seconds,
  })
  result.compact
end