Class MappingRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MappingRule.Builder,
MappingRule>
A rule that maps a claim name, a claim value, and a match type to a role ARN.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MappingRule.Builder
builder()
final String
claim()
The claim name that must be present in the token, for example, "isAdmin" or "paid".final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final MappingRuleMatchType
The match condition that specifies how closely the claim value in the IdP token must matchValue
.final String
The match condition that specifies how closely the claim value in the IdP token must matchValue
.final String
roleARN()
The role ARN.static Class
<? extends MappingRule.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
A brief string that the claim must match, for example, "paid" or "yes".Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnMappingRuleMatchType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommatchTypeAsString()
.- Returns:
- The match condition that specifies how closely the claim value in the IdP token must match
Value
. - See Also:
-
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 returnMappingRuleMatchType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommatchTypeAsString()
.- Returns:
- The match condition that specifies how closely the claim value in the IdP token must match
Value
. - See Also:
-
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
The role ARN.
- Returns:
- The role ARN.
-
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 interfaceToCopyableBuilder<MappingRule.Builder,
MappingRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-