AWSCognitoIdentityMappingRule

Objective-C

@interface AWSCognitoIdentityMappingRule : AWSModel

Swift

class AWSCognitoIdentityMappingRule : AWSModel

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

Required parameters: [Claim, MatchType, Value, RoleARN]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable claim;

    Swift

    var claim: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityMappingRuleMatchType matchType;

    Swift

    var matchType: AWSCognitoIdentityMappingRuleMatchType { get set }

  • The role ARN.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable roleARN;

    Swift

    var roleARN: String? { get set }

  • A brief string that the claim must match, for example, “paid” or “yes”.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable value;

    Swift

    var value: String? { get set }