class Aws::CognitoIdentity::Types::IdentityPool
An object representing an Amazon Cognito identity pool.
@note When making an API call, you may pass IdentityPool
data as a hash: { identity_pool_id: "IdentityPoolId", # required identity_pool_name: "IdentityPoolName", # required allow_unauthenticated_identities: false, # required allow_classic_flow: false, supported_login_providers: { "IdentityProviderName" => "IdentityProviderId", }, developer_provider_name: "DeveloperProviderName", open_id_connect_provider_arns: ["ARNString"], cognito_identity_providers: [ { provider_name: "CognitoIdentityProviderName", client_id: "CognitoIdentityProviderClientId", server_side_token_check: false, }, ], saml_provider_arns: ["ARNString"], identity_pool_tags: { "TagKeysType" => "TagValueType", }, }
@!attribute [rw] identity_pool_id
An identity pool ID in the format REGION:GUID. @return [String]
@!attribute [rw] identity_pool_name
A string that you provide. @return [String]
@!attribute [rw] allow_unauthenticated_identities
TRUE if the identity pool supports unauthenticated logins. @return [Boolean]
@!attribute [rw] allow_classic_flow
Enables or disables the Basic (Classic) authentication flow. For more information, see [Identity Pools (Federated Identities) Authentication Flow][1] in the *Amazon Cognito Developer Guide*. [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html @return [Boolean]
@!attribute [rw] supported_login_providers
Optional key:value pairs mapping provider names to provider app IDs. @return [Hash<String,String>]
@!attribute [rw] developer_provider_name
The "domain" by which Cognito will refer to your users. @return [String]
@!attribute [rw] open_id_connect_provider_arns
The ARNs of the OpenID Connect providers. @return [Array<String>]
@!attribute [rw] cognito_identity_providers
A list representing an Amazon Cognito user pool and its client ID. @return [Array<Types::CognitoIdentityProvider>]
@!attribute [rw] saml_provider_arns
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. @return [Array<String>]
@!attribute [rw] identity_pool_tags
The tags that are assigned 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. @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityPool AWS API Documentation
Constants
- SENSITIVE