MappingRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidentity.model.MappingRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MappingRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A rule that maps a claim name, a claim value, and a match type to a role ARN.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MappingRule()

Constructors
Constructor and Description
`MappingRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MappingRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getClaim()` The claim name that must be present in the token, for example, "isAdmin" or "paid".
`String`	`getMatchType()` The match condition that specifies how closely the claim value in the IdP token must match `Value`.
`String`	`getRoleARN()` The role ARN.
`String`	`getValue()` A brief string that the claim must match, for example, "paid" or "yes".
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClaim(String claim)` The claim name that must be present in the token, for example, "isAdmin" or "paid".
`void`	`setMatchType(MappingRuleMatchType matchType)` The match condition that specifies how closely the claim value in the IdP token must match `Value`.
`void`	`setMatchType(String matchType)` The match condition that specifies how closely the claim value in the IdP token must match `Value`.
`void`	`setRoleARN(String roleARN)` The role ARN.
`void`	`setValue(String value)` A brief string that the claim must match, for example, "paid" or "yes".
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`MappingRule`	`withClaim(String claim)` The claim name that must be present in the token, for example, "isAdmin" or "paid".
`MappingRule`	`withMatchType(MappingRuleMatchType matchType)` The match condition that specifies how closely the claim value in the IdP token must match `Value`.
`MappingRule`	`withMatchType(String matchType)` The match condition that specifies how closely the claim value in the IdP token must match `Value`.
`MappingRule`	`withRoleARN(String roleARN)` The role ARN.
`MappingRule`	`withValue(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

- Constructor Detail
  - MappingRule
```
public MappingRule()
```
- Method Detail
  - setClaim
```
public void setClaim(String claim)
```
    The claim name that must be present in the token, for example, "isAdmin" or "paid".
    
    Parameters:
    
    claim - The claim name that must be present in the token, for example, "isAdmin" or "paid".
  - getClaim
```
public String getClaim()
```
    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".
  - withClaim
```
public MappingRule withClaim(String claim)
```
    The claim name that must be present in the token, for example, "isAdmin" or "paid".
    
    Parameters:
    
    claim - The claim name that must be present in the token, for example, "isAdmin" or "paid".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMatchType
```
public void setMatchType(String matchType)
```
    The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    Parameters:
    
    matchType - The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    See Also:
    
    MappingRuleMatchType
  - getMatchType
```
public String getMatchType()
```
    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
  - withMatchType
```
public MappingRule withMatchType(String matchType)
```
    The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    Parameters:
    
    matchType - The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MappingRuleMatchType
  - setMatchType
```
public void setMatchType(MappingRuleMatchType matchType)
```
    The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    Parameters:
    
    matchType - The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    See Also:
    
    MappingRuleMatchType
  - withMatchType
```
public MappingRule withMatchType(MappingRuleMatchType matchType)
```
    The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    Parameters:
    
    matchType - The match condition that specifies how closely the claim value in the IdP token must match Value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MappingRuleMatchType
  - setValue
```
public void setValue(String value)
```
    A brief string that the claim must match, for example, "paid" or "yes".
    
    Parameters:
    
    value - A brief string that the claim must match, for example, "paid" or "yes".
  - getValue
```
public String getValue()
```
    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".
  - withValue
```
public MappingRule withValue(String value)
```
    A brief string that the claim must match, for example, "paid" or "yes".
    
    Parameters:
    
    value - A brief string that the claim must match, for example, "paid" or "yes".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The role ARN.
    
    Parameters:
    
    roleARN - The role ARN.
  - getRoleARN
```
public String getRoleARN()
```
    The role ARN.
    
    Returns:
    
    The role ARN.
  - withRoleARN
```
public MappingRule withRoleARN(String roleARN)
```
    The role ARN.
    
    Parameters:
    
    roleARN - The role ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MappingRule clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class MappingRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappingRule

Method Detail

setClaim

getClaim

withClaim

setMatchType

getMatchType

withMatchType

setMatchType

withMatchType

setValue

getValue

withValue

setRoleARN

getRoleARN

withRoleARN

toString

equals

hashCode

clone

marshall