Class: Aws::CognitoIdentity::Types::SetIdentityPoolRolesInput

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

Overview

Input to the ‘SetIdentityPoolRoles` action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


1163
1164
1165
1166
1167
1168
1169
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 1163

class SetIdentityPoolRolesInput < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#role_mappingsHash<String,Types::RoleMapping>

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, “graph.facebook.com” or “cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id”.

Up to 25 rules can be specified per identity provider.

Returns:



1163
1164
1165
1166
1167
1168
1169
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 1163

class SetIdentityPoolRolesInput < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#rolesHash<String,String>

The map of roles associated with this pool. For a given role, the key will be either “authenticated” or “unauthenticated” and the value will be the Role ARN.

Returns:

  • (Hash<String,String>)


1163
1164
1165
1166
1167
1168
1169
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 1163

class SetIdentityPoolRolesInput < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  SENSITIVE = []
  include Aws::Structure
end