GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::CognitoIdentity::SetIdentityPoolRoles(3) User Contributed Perl Documentation Paws::CognitoIdentity::SetIdentityPoolRoles(3)

Paws::CognitoIdentity::SetIdentityPoolRoles - Arguments for method SetIdentityPoolRoles on Paws::CognitoIdentity

This class represents the parameters used for calling the method SetIdentityPoolRoles on the Amazon Cognito Identity service. Use the attributes of this class as arguments to method SetIdentityPoolRoles.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetIdentityPoolRoles.

    my $cognito-identity = Paws->service('CognitoIdentity');
    $cognito -identity->SetIdentityPoolRoles(
      IdentityPoolId => 'MyIdentityPoolId',
      Roles          => {
        'MyRoleType' =>
          'MyARNString',    # key: min: 1, max: 128, value: min: 20, max: 2048
      },
      RoleMappings => {
        'MyIdentityProviderName' => {
          Type                    => 'Token',    # values: Token, Rules
          AmbiguousRoleResolution =>
            'AuthenticatedRole',    # values: AuthenticatedRole, Deny; OPTIONAL
          RulesConfiguration => {
            Rules => [
              {
                Claim     => 'MyClaimName',    # min: 1, max: 64
                MatchType =>
                  'Equals',    # values: Equals, Contains, StartsWith, NotEqual
                RoleARN => 'MyARNString',     # min: 20, max: 2048
                Value   => 'MyClaimValue',    # min: 1, max: 128
              },
              ...
            ],    # min: 1, max: 400
          },    # OPTIONAL
        },    # key: min: 1, max: 128
      },    # OPTIONAL
    );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/cognito-identity/SetIdentityPoolRoles>

REQUIRED IdentityPoolId => Str

An identity pool ID in the format REGION:GUID.

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.

REQUIRED Roles => Paws::CognitoIdentity::RolesMap

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.

This class forms part of Paws, documenting arguments for method SetIdentityPoolRoles in Paws::CognitoIdentity

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.