Class MappingRule

java.lang.Object
software.amazon.awssdk.services.cognitoidentity.model.MappingRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MappingRule.Builder,MappingRule>
@Generated("software.amazon.awssdk:codegen") public final class MappingRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MappingRule.Builder,MappingRule>

A rule that maps a claim name, a claim value, and a match type to a role ARN.

See Also:

  • Method Details

    • claim

      public final String claim()

      The claim name that must be present in the token, for example, "isAdmin" or "paid".

      Returns:
      The claim name that must be present in the token, for example, "isAdmin" or "paid".

    • matchType

      public final MappingRuleMatchType matchType()

      The match condition that specifies how closely the claim value in the IdP token must match Value.

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

      Returns:
      The match condition that specifies how closely the claim value in the IdP token must match Value.
      See Also:

    • matchTypeAsString

      public final String matchTypeAsString()

      The match condition that specifies how closely the claim value in the IdP token must match Value.

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

      Returns:
      The match condition that specifies how closely the claim value in the IdP token must match Value.
      See Also:

    • value

      public final String value()

      A brief string that the claim must match, for example, "paid" or "yes".

      Returns:
      A brief string that the claim must match, for example, "paid" or "yes".

    • roleARN

      public final String roleARN()

      The role ARN.

      Returns:
      The role ARN.

    • toBuilder

      public MappingRule.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<MappingRule.Builder,MappingRule>
      Returns:
      a builder for type T

    • builder

      public static MappingRule.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.