com.amazonaws.services.cognitoidentity.model

Class MappingRule

java.lang.Object

com.amazonaws.services.cognitoidentity.model.MappingRule

All Implemented Interfaces:

Serializable

public class MappingRule
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MappingRule()

Method Summary

Modifier and Type	Method and Description
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	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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MappingRule

public MappingRule()

Method Detail

getClaim

public String getClaim()

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

Constraints:
Length: 1 - 64
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

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

setClaim

public void setClaim(String claim)

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

Constraints:
Length: 1 - 64
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

claim -

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".

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

claim -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMatchType

public String getMatchType()

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

Constraints:
Allowed Values: Equals, Contains, StartsWith, NotEqual

Returns:

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

See Also:

MappingRuleMatchType

setMatchType

public void setMatchType(String matchType)

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

Constraints:
Allowed Values: Equals, Contains, StartsWith, NotEqual

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

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Equals, Contains, StartsWith, NotEqual

Parameters:

matchType -

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

Returns:

A reference to this updated 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.

Constraints:
Allowed Values: Equals, Contains, StartsWith, NotEqual

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Equals, Contains, StartsWith, NotEqual

Parameters:

matchType -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MappingRuleMatchType

getValue

public String getValue()

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

Constraints:
Length: 1 - 128

Returns:

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

setValue

public void setValue(String value)

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

Constraints:
Length: 1 - 128

Parameters:

value -

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".

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128

Parameters:

value -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleARN

public String getRoleARN()

The role ARN.

Constraints:
Length: 20 - 2048

Returns:

The role ARN.

setRoleARN

public void setRoleARN(String roleARN)

The role ARN.

Constraints:
Length: 20 - 2048

Parameters:

roleARN -

The role ARN.

withRoleARN

public MappingRule withRoleARN(String roleARN)

The role ARN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:

roleARN -

The role ARN.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object