Class RoleMapping

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

A role mapping.

See Also:

  • Method Details

    • type

      public final RoleMappingType type()

      The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

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

      Returns:
      The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
      See Also:

    • typeAsString

      public final String typeAsString()

      The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

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

      Returns:
      The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
      See Also:

    • ambiguousRoleResolution

      public final AmbiguousRoleResolutionType ambiguousRoleResolution()

      If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

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

      Returns:
      If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

      See Also:

    • ambiguousRoleResolutionAsString

      public final String ambiguousRoleResolutionAsString()

      If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

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

      Returns:
      If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

      See Also:

    • rulesConfiguration

      public final RulesConfigurationType rulesConfiguration()

      The rules to be used for mapping users to roles.

      If you specify Rules as the role mapping type, RulesConfiguration is required.

      Returns:
      The rules to be used for mapping users to roles.

      If you specify Rules as the role mapping type, RulesConfiguration is required.

    • toBuilder

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

    • builder

      public static RoleMapping.Builder builder()

    • serializableBuilderClass

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