You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

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
  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"],
}

An object representing an Amazon Cognito identity pool.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_unauthenticated_identitiesBoolean

TRUE if the identity pool supports unauthenticated logins.

Returns:

  • (Boolean)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#cognito_identity_providersArray<Types::CognitoIdentityProvider>

A list representing an Amazon Cognito Identity User Pool and its client ID.

Returns:



623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#developer_provider_nameString

The "domain" by which Cognito will refer to your users.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#identity_pool_nameString

A string that you provide.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#open_id_connect_provider_arnsArray<String>

A list of OpendID Connect provider ARNs.

Returns:

  • (Array<String>)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#saml_provider_arnsArray<String>

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

Returns:

  • (Array<String>)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end

#supported_login_providersHash<String,String>

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

Returns:

  • (Hash<String,String>)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 623

class IdentityPool < Struct.new(
  :identity_pool_id,
  :identity_pool_name,
  :allow_unauthenticated_identities,
  :supported_login_providers,
  :developer_provider_name,
  :open_id_connect_provider_arns,
  :cognito_identity_providers,
  :saml_provider_arns)
  include Aws::Structure
end