IdentityPool Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    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.

Declaration

Swift

public let allowClassicFlow: Bool?


                    
                    
                    allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

Declaration

Swift

public let allowUnauthenticatedIdentities: Bool


                    
                    
                    cognitoIdentityProviders

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

Declaration

Swift

public let cognitoIdentityProviders: [CognitoIdentityProvider]?


                    
                    
                    developerProviderName

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

Declaration

Swift

public let developerProviderName: String?


                    
                    
                    identityPoolId

An identity pool ID in the format REGION:GUID.

Declaration

Swift

public let identityPoolId: String


                    
                    
                    identityPoolName

A string that you provide.

Declaration

Swift

public let identityPoolName: String


                    
                    
                    identityPoolTags

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

Swift

public let identityPoolTags: [String : String]?


                    
                    
                    openIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

Declaration

Swift

public let openIdConnectProviderARNs: [String]?


                    
                    
                    samlProviderARNs

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

Declaration

Swift

public let samlProviderARNs: [String]?


                    
                    
                    supportedLoginProviders

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

Declaration

Swift

public let supportedLoginProviders: [String : String]?


                    
                    
                    init(allowClassicFlow:allowUnauthenticatedIdentities:cognitoIdentityProviders:developerProviderName:identityPoolId:identityPoolName:identityPoolTags:openIdConnectProviderARNs:samlProviderARNs:supportedLoginProviders:)

Undocumented

Declaration

Swift

public init(allowClassicFlow: Bool? = nil, allowUnauthenticatedIdentities: Bool, cognitoIdentityProviders: [CognitoIdentityProvider]? = nil, developerProviderName: String? = nil, identityPoolId: String, identityPoolName: String, identityPoolTags: [String : String]? = nil, openIdConnectProviderARNs: [String]? = nil, samlProviderARNs: [String]? = nil, supportedLoginProviders: [String : String]? = nil)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws