You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentity::Types::MappingRule
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentity::Types::MappingRule
- Defined in:
- (unknown)
Overview
When passing MappingRule as input to an Aws::Client method, you can use a vanilla Hash:
{
claim: "ClaimName", # required
match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
value: "ClaimValue", # required
role_arn: "ARNString", # required
}
A rule that maps a claim name, a claim value, and a match type to a role ARN.
Instance Attribute Summary collapse
-
#claim ⇒ String
The claim name that must be present in the token, for example, \"isAdmin\" or \"paid\".
-
#match_type ⇒ String
The match condition that specifies how closely the claim value in the IdP token must match
Value
. -
#role_arn ⇒ String
The role ARN.
-
#value ⇒ String
A brief string that the claim must match, for example, \"paid\" or \"yes\".
Instance Attribute Details
#claim ⇒ String
The claim name that must be present in the token, for example, \"isAdmin\" or \"paid\".
#match_type ⇒ String
The match condition that specifies how closely the claim value in the
IdP token must match Value
.
Possible values:
- Equals
- Contains
- StartsWith
- NotEqual
#role_arn ⇒ String
The role ARN.
#value ⇒ String
A brief string that the claim must match, for example, \"paid\" or \"yes\".