Class: Aws::CognitoIdentity::Types::IdentityPool

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentity/types.rb

Overview

An object representing an Amazon Cognito identity pool.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_classic_flow ⇒ Boolean

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html

Returns:

  • (Boolean) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#allow_unauthenticated_identities ⇒ Boolean

TRUE if the identity pool supports unauthenticated logins.

Returns:

  • (Boolean) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#cognito_identity_providers ⇒ Array<Types::CognitoIdentityProvider>

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

Returns:



672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#developer_provider_name ⇒ String

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

Returns:

  • (String) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_id ⇒ String

An identity pool ID in the format REGION:GUID.

Returns:

  • (String) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_name ⇒ String

A string that you provide.

Returns:

  • (String) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_connect_provider_arns ⇒ Array<String>

The ARNs of the OpenID Connect providers.

Returns:

  • (Array<String>) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#saml_provider_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end

#supported_login_providers ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 672

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :allow_classic_flow,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns,
  :identity_pool_tags)
  SENSITIVE = []
  include Aws::Structure
end