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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

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)


982
983
984
985
986
987
988
989
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 982

class MappingRule < Struct.new(
  :claim,
  :match_type,
  :value,
  :role_arn)
  SENSITIVE = []
  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)


982
983
984
985
986
987
988
989
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 982

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

#role_arnString

The role ARN.

Returns:

  • (String)


982
983
984
985
986
987
988
989
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 982

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

#valueString

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

Returns:

  • (String)


982
983
984
985
986
987
988
989
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 982

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