Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class RefreshTokenRotationType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.RefreshTokenRotationType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RefreshTokenRotationType.Builder,RefreshTokenRotationType>

@Generated("software.amazon.awssdk:codegen")
public final class RefreshTokenRotationType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RefreshTokenRotationType.Builder,RefreshTokenRotationType>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RefreshTokenRotationType.Builder

Method Summary

Modifier and Type	Method	Description
static RefreshTokenRotationType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FeatureType	feature()	The state of refresh token rotation for the current app client.
String	featureAsString()	The state of refresh token rotation for the current app client.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	retryGracePeriodSeconds()	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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshTokenRotationType.Builder>	serializableBuilderClass()
RefreshTokenRotationType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

feature

public final FeatureType feature()

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

If the service returns an enum value that is not available in the current SDK version, feature will return FeatureType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureAsString().

Returns:

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

See Also:

FeatureType

featureAsString

public final String featureAsString()

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

If the service returns an enum value that is not available in the current SDK version, feature will return FeatureType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureAsString().

Returns:

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

See Also:

FeatureType

retryGracePeriodSeconds

public final Integer retryGracePeriodSeconds()

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:

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.

toBuilder

public RefreshTokenRotationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RefreshTokenRotationType.Builder,RefreshTokenRotationType>

builder

public static RefreshTokenRotationType.Builder builder()

serializableBuilderClass

public static Class<? extends RefreshTokenRotationType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo