Skip to content

Creates a new identity pool

Description

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your Amazon Web Services account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com
  • Google: accounts.google.com
  • Sign in With Apple: appleid.apple.com
  • Amazon: www.amazon.com
  • Twitter: api.twitter.com
  • Digits: www.digits.com

If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.

You must use Amazon Web Services developer credentials to call this operation.

Usage

cognitoidentity_create_identity_pool(IdentityPoolName,
  AllowUnauthenticatedIdentities, AllowClassicFlow,
  SupportedLoginProviders, DeveloperProviderName,
  OpenIdConnectProviderARNs, CognitoIdentityProviders, SamlProviderARNs,
  IdentityPoolTags)

Arguments

  • IdentityPoolName

    [required] A string that you provide.

  • AllowUnauthenticatedIdentities

    [required] TRUE if the identity pool supports unauthenticated logins.

  • AllowClassicFlow

    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

  • SupportedLoginProviders

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

  • DeveloperProviderName

    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.

  • OpenIdConnectProviderARNs

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

  • CognitoIdentityProviders

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

  • SamlProviderARNs

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

  • IdentityPoolTags

    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.

Value

A list with the following syntax:

list(
  IdentityPoolId = "string",
  IdentityPoolName = "string",
  AllowUnauthenticatedIdentities = TRUE|FALSE,
  AllowClassicFlow = TRUE|FALSE,
  SupportedLoginProviders = list(
    "string"
  ),
  DeveloperProviderName = "string",
  OpenIdConnectProviderARNs = list(
    "string"
  ),
  CognitoIdentityProviders = list(
    list(
      ProviderName = "string",
      ClientId = "string",
      ServerSideTokenCheck = TRUE|FALSE
    )
  ),
  SamlProviderARNs = list(
    "string"
  ),
  IdentityPoolTags = list(
    "string"
  )
)

Request syntax

svc$create_identity_pool(
  IdentityPoolName = "string",
  AllowUnauthenticatedIdentities = TRUE|FALSE,
  AllowClassicFlow = TRUE|FALSE,
  SupportedLoginProviders = list(
    "string"
  ),
  DeveloperProviderName = "string",
  OpenIdConnectProviderARNs = list(
    "string"
  ),
  CognitoIdentityProviders = list(
    list(
      ProviderName = "string",
      ClientId = "string",
      ServerSideTokenCheck = TRUE|FALSE
    )
  ),
  SamlProviderARNs = list(
    "string"
  ),
  IdentityPoolTags = list(
    "string"
  )
)