AWSCognitoIdentityIdentityPool

Objective-C

@interface AWSCognitoIdentityIdentityPool : AWSRequest

Swift

class AWSCognitoIdentityIdentityPool : AWSRequest

An object representing an Amazon Cognito identity pool.

Required parameters: [IdentityPoolId, IdentityPoolName, AllowUnauthenticatedIdentities]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable allowClassicFlow;

    Swift

    var allowClassicFlow: NSNumber? { get set }

  • TRUE if the identity pool supports unauthenticated logins.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable allowUnauthenticatedIdentities;

    Swift

    var allowUnauthenticatedIdentities: NSNumber? { get set }

  • A list representing an Amazon Cognito user pool and its client ID.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSCognitoIdentityCognitoIdentityProvider *> *_Nullable cognitoIdentityProviders;

    Swift

    var cognitoIdentityProviders: [AWSCognitoIdentityCognitoIdentityProvider]? { get set }

  • The “domain” by which Cognito will refer to your users.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable developerProviderName;

    Swift

    var developerProviderName: String? { get set }

  • An identity pool ID in the format REGION:GUID.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable identityPoolId;

    Swift

    var identityPoolId: String? { get set }

  • A string that you provide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable identityPoolName;

    Swift

    var identityPoolName: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable identityPoolTags;

    Swift

    var identityPoolTags: [String : String]? { get set }

  • The ARNs of the OpenID Connect providers.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable openIdConnectProviderARNs;

    Swift

    var openIdConnectProviderARNs: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable samlProviderARNs;

    Swift

    var samlProviderARNs: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable supportedLoginProviders;

    Swift

    var supportedLoginProviders: [String : String]? { get set }