You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentity::Types::MappingRule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb

Overview

Note:

When making an API call, you may pass MappingRule data as a 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

Instance Attribute Details

#claimString

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

Returns:

  • (String)


877
878
879
880
881
882
883
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 877

class MappingRule < Struct.new(
  :claim,
  :match_type,
  :value,
  :role_arn)
  include Aws::Structure
end

#match_typeString

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

Returns:

  • (String)


877
878
879
880
881
882
883
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 877

class MappingRule < Struct.new(
  :claim,
  :match_type,
  :value,
  :role_arn)
  include Aws::Structure
end

#role_arnString

The role ARN.

Returns:

  • (String)


877
878
879
880
881
882
883
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 877

class MappingRule < Struct.new(
  :claim,
  :match_type,
  :value,
  :role_arn)
  include Aws::Structure
end

#valueString

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

Returns:

  • (String)


877
878
879
880
881
882
883
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 877

class MappingRule < Struct.new(
  :claim,
  :match_type,
  :value,
  :role_arn)
  include Aws::Structure
end