ICognitoIdentityUpdateIdentityPoolRequest

Interface in AWS.CognitoIdentity

Interface for UpdateIdentityPool requests.

Ancestors

• ICognitoIdentityRequest

Properties

AllowClassicFlow

property AllowClassicFlow: TOptional<Boolean>

Specify whether to enable or disable the Basic (Classic) authentication flow.

AllowUnauthenticatedIdentities

property AllowUnauthenticatedIdentities: Boolean

Specify True to support unauthenticated logins.

CognitoIdentityProviders

property CognitoIdentityProviders: TList<ICognitoIdentityCognitoIdentityProvider>

Type: ICognitoIdentityCognitoIdentityProvider

A list of Amazon Cognito user pools and their client IDs.

DeveloperProviderName

property DeveloperProviderName: string

Specify the "domain" by which Cognito will refer to your users.

This is a pseudo-domain name that you provide. This will act as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. You can use letters, as well as period (.), underscore (_), and dash (-). NOTE: Once set, you cannot change the DeveloperProviderName. Take care when setting this parameter.

IdentityPoolId

property IdentityPoolId: string

Specify the ID of the identity pool in the format REGION:GUID.

IdentityPoolName

property IdentityPoolName: string

Specify a name for the identity pool.

IdentityPoolTags

property IdentityPoolTags: TDictionary<string, string>

Specify tags to assign to the identity pool.

OpenIdConnectProviderARNs

property OpenIdConnectProviderARNs: TList<TARN>

Specify a list of Amazon Resource Names (ARN) of OpenID Connect providers.

SamlProviderARNs

property SamlProviderARNs: TList<TARN>

Specify a list of Amazon Resource Names (ARN) of SAML providers for your user pool.

SupportedLoginProviders

property SupportedLoginProviders: TDictionary<string, string>

Specify a key-value mapping from provider names to provider app IDs.

Valid keys:

Methods

AddCognitoIdentityProvider

function AddCognitoIdentityProvider( const ACognitoIdentityProvider: ICognitoIdentityCognitoIdentityProvider): Integer;

ICognitoIdentityCognitoIdentityProvider

Add a Cognito Identity Provider to CognitoIdentityProviders.

Parameters

Name	Description
ACognitoIdentityProvider	A Cognito Identity Provider.

Returns

Returns the index of the Cognito Identity Provider added to CognitoIdentityProviders.

AddIdentityPoolTag

procedure AddIdentityPoolTag(const AKey, AValue: string);

Add a key-value pair to IdentityPoolTags.

Parameters

Name	Description
AKey	Specify a Tag key.
AValue	Specify a Tag value.

AddOpenIdConnectProviderARN

function AddOpenIdConnectProviderARN(const AOpenIdConnectProviderARN: TARN): Integer;

Add an Amazon Resource Name (ARN) to OpenIdConnectProviderARNs.

Parameters

Name	Description
AOpenIdConnectProviderARN	Specify the Amazon Resource Names (ARN) of an OpenID Connect provider.

Returns

Returns the index of the ARN added to OpenIdConnectProviderARNs.

AddSamlProviderARN

function AddSamlProviderARN(const ASamlProviderARN: TARN): Integer;

Add an Amazon Resource Name (ARN) to SamlProviderARNs.

Parameters

Name	Description
ASamlProviderARN	Specify the Amazon Resource Names (ARN) of a SAML provider for your user pool.

Returns

Returns the index of the ARN added to SamlProviderARNs.

AddSupportedLoginProvider

procedure AddSupportedLoginProvider(const AProviderName, AProviderAppID: string);

Add a key-value pair to SupportedLoginProviders.

Parameters

Name	Description
AProviderName	Specify a provider name to add to SupportedLoginProviders.
AProviderAppID	Specify a provider app ID to add to SupportedLoginProviders.