Class: Aws::CognitoIdentity::Types::RoleMapping

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

Overview

A role mapping.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ambiguous_role_resolution ⇒ String

If you specify Token or Rules as the ‘Type`, `AmbiguousRoleResolution` is required.

Specifies the action to be taken if either no rules match the claim value for the ‘Rules` type, or there is no `cognito:preferred_role` claim and there are multiple `cognito:roles` matches for the `Token` type.

Returns:

  • (String) 


1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 1123

class RoleMapping < Struct.new(
  :type,
  :ambiguous_role_resolution,
  :rules_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#rules_configuration ⇒ Types::RulesConfigurationType

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, ‘RulesConfiguration` is required.

Returns:



1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 1123

class RoleMapping < Struct.new(
  :type,
  :ambiguous_role_resolution,
  :rules_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The role mapping type. Token will use ‘cognito:roles` and `cognito:preferred_role` claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Returns:

  • (String) 


1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 1123

class RoleMapping < Struct.new(
  :type,
  :ambiguous_role_resolution,
  :rules_configuration)
  SENSITIVE = []
  include Aws::Structure
end