Package software.amazon.awssdk.services.cognitoidentity.model

Class CognitoIdentityProvider

java.lang.Object

software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityProvider

All Implemented Interfaces:

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

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

A provider representing an Amazon Cognito user pool and its client ID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CognitoIdentityProvider.Builder

Method Summary

Modifier and Type	Method	Description
static CognitoIdentityProvider.Builder	builder()
String	clientId()	The client ID for the Amazon Cognito user pool.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	providerName()	The provider name for an Amazon Cognito user pool.
List<SdkField<?>>	sdkFields()
static Class<? extends CognitoIdentityProvider.Builder>	serializableBuilderClass()
Boolean	serverSideTokenCheck()	TRUE if server-side token validation is enabled for the identity provider’s token.
CognitoIdentityProvider.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

providerName

public final String providerName()

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Returns:

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

clientId

public final String clientId()

The client ID for the Amazon Cognito user pool.

Returns:

The client ID for the Amazon Cognito user pool.

serverSideTokenCheck

public final Boolean serverSideTokenCheck()

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Returns:

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

toBuilder

public CognitoIdentityProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CognitoIdentityProvider.Builder,CognitoIdentityProvider>

builder

public static CognitoIdentityProvider.Builder builder()

serializableBuilderClass

public static Class<? extends CognitoIdentityProvider.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