/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CognitoIdentity::CreateIdentityPool

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $cognito-identity = Paws->service('CognitoIdentity');
my $IdentityPool = $cognito -identity->CreateIdentityPool(
  AllowUnauthenticatedIdentities => 1,
  IdentityPoolName               => 'MyIdentityPoolName',
  AllowClassicFlow               => 1,                      # OPTIONAL
  CognitoIdentityProviders       => [
    {
      ClientId =>
        'MyCognitoIdentityProviderClientId',    # min: 1, max: 128; OPTIONAL
      ProviderName =>
        'MyCognitoIdentityProviderName',        # min: 1, max: 128; OPTIONAL
      ServerSideTokenCheck => 1,                # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  DeveloperProviderName => 'MyDeveloperProviderName',    # OPTIONAL
  IdentityPoolTags      => {
    'MyTagKeysType' =>
      'MyTagValueType',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
  OpenIdConnectProviderARNs => [
    'MyARNString', ...    # min: 20, max: 2048
  ],    # OPTIONAL
  SamlProviderARNs => [
    'MyARNString', ...    # min: 20, max: 2048
  ],    # OPTIONAL
  SupportedLoginProviders => {
    'MyIdentityProviderName' => 'MyIdentityProviderId'
    ,    # key: min: 1, max: 128, value: min: 1, max: 128
  },    # OPTIONAL
);

# Results:
my $AllowClassicFlow = $IdentityPool->AllowClassicFlow;
my $AllowUnauthenticatedIdentities =
  $IdentityPool->AllowUnauthenticatedIdentities;
my $CognitoIdentityProviders  = $IdentityPool->CognitoIdentityProviders;
my $DeveloperProviderName     = $IdentityPool->DeveloperProviderName;
my $IdentityPoolId            = $IdentityPool->IdentityPoolId;
my $IdentityPoolName          = $IdentityPool->IdentityPoolName;
my $IdentityPoolTags          = $IdentityPool->IdentityPoolTags;
my $OpenIdConnectProviderARNs = $IdentityPool->OpenIdConnectProviderARNs;
my $SamlProviderARNs          = $IdentityPool->SamlProviderARNs;
my $SupportedLoginProviders   = $IdentityPool->SupportedLoginProviders;

# Returns a L<Paws::CognitoIdentity::IdentityPool> object.

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/CreateIdentityPool

ATTRIBUTES

AllowClassicFlow => Bool

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) in the Amazon Cognito Developer Guide.

REQUIRED AllowUnauthenticatedIdentities => Bool

TRUE if the identity pool supports unauthenticated logins.

CognitoIdentityProviders => ArrayRef[Paws::CognitoIdentity::CognitoIdentityProvider]

An array of Amazon Cognito user pools and their client IDs.

DeveloperProviderName => Str

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

REQUIRED IdentityPoolName => Str

A string that you provide.

IdentityPoolTags => Paws::CognitoIdentity::IdentityPoolTagsType

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

OpenIdConnectProviderARNs => ArrayRef[Str|Undef]

The Amazon Resource Names (ARN) of the OpenID Connect providers.

SamlProviderARNs => ArrayRef[Str|Undef]

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

SupportedLoginProviders => Paws::CognitoIdentity::IdentityProviders

Optional key:value pairs mapping provider names to provider app IDs.

SEE ALSO

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

BUGS and CONTRIBUTIONS

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