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

Class MappingRule

java.lang.Object

software.amazon.awssdk.services.cognitoidentity.model.MappingRule

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<MappingRule.Builder,MappingRule>

@Generated("software.amazon.awssdk:codegen")
public class MappingRule
extends Object
implements StructuredPojo, ToCopyableBuilder<MappingRule.Builder,MappingRule>

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

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)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	matchType()	The match condition that specifies how closely the claim value in the IdP token must match Value.
String	roleARN()	The role ARN.
static Class<? extends MappingRule.Builder>	serializableBuilderClass()
MappingRule.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	value()	A brief string that the claim must match, for example, "paid" or "yes".

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

claim

public 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 String matchType()

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

Returns:

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

See Also:

MappingRuleMatchType

value

public 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.