You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentity::Types::SetIdentityPoolRolesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentity::Types::SetIdentityPoolRolesInput
- Defined in:
- (unknown)
Overview
When passing SetIdentityPoolRolesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
identity_pool_id: "IdentityPoolId", # required
roles: { # required
"RoleType" => "ARNString",
},
role_mappings: {
"IdentityProviderName" => {
type: "Token", # required, accepts Token, Rules
ambiguous_role_resolution: "AuthenticatedRole", # accepts AuthenticatedRole, Deny
rules_configuration: {
rules: [ # required
{
claim: "ClaimName", # required
match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
value: "ClaimValue", # required
role_arn: "ARNString", # required
},
],
},
},
},
}
Input to the SetIdentityPoolRoles
action.
Instance Attribute Summary collapse
-
#identity_pool_id ⇒ String
An identity pool ID in the format REGION:GUID.
-
#role_mappings ⇒ Hash<String,Types::RoleMapping>
How users for a specific identity provider are to mapped to roles.
-
#roles ⇒ Hash<String,String>
The map of roles associated with this pool.
Instance Attribute Details
#identity_pool_id ⇒ String
An identity pool ID in the format REGION:GUID.
#role_mappings ⇒ Hash<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-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".
Up to 25 rules can be specified per identity provider.
#roles ⇒ Hash<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.