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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentity::Types::MappingRule

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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”.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentity/types.rb', line 982

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

#match_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentity/types.rb', line 982

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

#role_arn ⇒ String

The role ARN.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentity/types.rb', line 982

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

#value ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentity/types.rb', line 982

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