You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass SetIdentityPoolRolesInput data as a 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

Instance Attribute Details

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


1077
1078
1079
1080
1081
1082
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1077

class SetIdentityPoolRolesInput < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  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-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

Returns:



1077
1078
1079
1080
1081
1082
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1077

class SetIdentityPoolRolesInput < Struct.new(
  :identity_pool_id,
  :roles,
  :role_mappings)
  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>)


1077
1078
1079
1080
1081
1082
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1077

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