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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CognitoIdentityProvider.Builder,CognitoIdentityProvider>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.