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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MappingRule.Builder

Method Summary

Modifier and Type	Method	Description
static MappingRule.Builder	builder()
String	claim()	The claim name that must be present in the token, for example, "isAdmin" or "paid".
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MappingRuleMatchType	matchType()	The match condition that specifies how closely the claim value in the IdP token must match Value.
String	matchTypeAsString()	The match condition that specifies how closely the claim value in the IdP token must match Value.
String	roleARN()	The role ARN.
List<SdkField<?>>	sdkFields()
static Class<? extends MappingRule.Builder>	serializableBuilderClass()
MappingRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	A brief string that the claim must match, for example, "paid" or "yes".

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

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:

MappingRuleMatchType

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:

MappingRuleMatchType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<MappingRule.Builder,MappingRule>

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)

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