Class IdentityPool

Provides an AWS Cognito Identity Pool.

Example Usage

using System.IO;
using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Aws.Iam.SamlProvider("default", new Aws.Iam.SamlProviderArgs
    {
        SamlMetadataDocument = File.ReadAllText("saml-metadata.xml"),
    });
    var main = new Aws.Cognito.IdentityPool("main", new Aws.Cognito.IdentityPoolArgs
    {
        AllowUnauthenticatedIdentities = false,
        CognitoIdentityProviders = 
        {
            new Aws.Cognito.Inputs.IdentityPoolCognitoIdentityProviderArgs
            {
                ClientId = "6lhlkkfbfb4q5kpp90urffae",
                ProviderName = "cognito-idp.us-east-1.amazonaws.com/us-east-1_Tv0493apJ",
                ServerSideTokenCheck = false,
            },
            new Aws.Cognito.Inputs.IdentityPoolCognitoIdentityProviderArgs
            {
                ClientId = "7kodkvfqfb4qfkp39eurffae",
                ProviderName = "cognito-idp.us-east-1.amazonaws.com/eu-west-1_Zr231apJu",
                ServerSideTokenCheck = false,
            },
        },
        IdentityPoolName = "identity pool",
        OpenidConnectProviderArns = 
        {
            "arn:aws:iam::123456789012:oidc-provider/foo.example.com",
        },
        SamlProviderArns = 
        {
            @default.Arn,
        },
        SupportedLoginProviders = 
        {
            { "accounts.google.com", "123456789012.apps.googleusercontent.com" },
            { "graph.facebook.com", "7346241598935552" },
        },
    });
}

}
Inheritance
System.Object
Resource
CustomResource
IdentityPool
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Cognito
Assembly: Pulumi.Aws.dll
Syntax
public class IdentityPool : CustomResource

Constructors

View Source

IdentityPool(String, IdentityPoolArgs, CustomResourceOptions)

Create a IdentityPool resource with the given unique name, arguments, and options.

Declaration
public IdentityPool(string name, IdentityPoolArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
IdentityPoolArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AllowUnauthenticatedIdentities

Whether the identity pool supports unauthenticated logins or not.

Declaration
public Output<bool?> AllowUnauthenticatedIdentities { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Arn

The ARN of the identity pool.

Declaration
public Output<string> Arn { get; }
Property Value
Type Description
Output<System.String>
View Source

CognitoIdentityProviders

An array of Amazon Cognito Identity user pools and their client IDs.

Declaration
public Output<ImmutableArray<IdentityPoolCognitoIdentityProvider>> CognitoIdentityProviders { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<IdentityPoolCognitoIdentityProvider>>
View Source

DeveloperProviderName

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider.

Declaration
public Output<string> DeveloperProviderName { get; }
Property Value
Type Description
Output<System.String>
View Source

IdentityPoolName

The Cognito Identity Pool name.

Declaration
public Output<string> IdentityPoolName { get; }
Property Value
Type Description
Output<System.String>
View Source

OpenidConnectProviderArns

A list of OpendID Connect provider ARNs.

Declaration
public Output<ImmutableArray<string>> OpenidConnectProviderArns { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

SamlProviderArns

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

Declaration
public Output<ImmutableArray<string>> SamlProviderArns { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

SupportedLoginProviders

Key-Value pairs mapping provider names to provider app IDs.

Declaration
public Output<ImmutableDictionary<string, string>> SupportedLoginProviders { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>
View Source

Tags

A map of tags to assign to the Identity Pool.

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

View Source

Get(String, Input<String>, IdentityPoolState, CustomResourceOptions)

Get an existing IdentityPool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static IdentityPool Get(string name, Input<string> id, IdentityPoolState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
IdentityPoolState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
IdentityPool