Class IdentityPool

(experimental) Define a Cognito Identity Pool.

Inheritance

System.Object

Resource

IdentityPool

Implements

IIdentityPool

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Cognito.IdentityPool.Alpha

Assembly: Amazon.CDK.AWS.Cognito.IdentityPool.Alpha.dll

Syntax (csharp)

public class IdentityPool : Resource, IIdentityPool, IResource

Syntax (vb)

Public Class IdentityPool
    Inherits Resource
    Implements IIdentityPool, IResource

Remarks

Stability: Experimental

Resource: AWS::Cognito::IdentityPool

ExampleMetadata: infused

Examples

OpenIdConnectProvider openIdConnectProvider;

new IdentityPool(this, "myidentitypool", new IdentityPoolProps {
    IdentityPoolName = "myidentitypool",
    AuthenticationProviders = new IdentityPoolAuthenticationProviders {
        Google = new IdentityPoolGoogleLoginProvider {
            ClientId = "12345678012.apps.googleusercontent.com"
        },
        OpenIdConnectProviders = new [] { openIdConnectProvider },
        CustomProvider = "my-custom-provider.example.com"
    }
});

Synopsis

Constructors

IdentityPool(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
IdentityPool(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
IdentityPool(Construct, String, IIdentityPoolProps)

Properties

AuthenticatedRole	(experimental) Default role for authenticated users.
IdentityPoolArn	(experimental) The ARN of the Identity Pool.
IdentityPoolId	(experimental) The id of the Identity Pool in the format REGION:GUID.
IdentityPoolName	(experimental) The name of the Identity Pool.
UnauthenticatedRole	(experimental) Default role for unauthenticated users.

Methods

AddRoleMappings(IIdentityPoolRoleMapping[])	(experimental) Adds Role Mappings to Identity Pool.
AddUserPoolAuthentication(IUserPoolAuthenticationProvider)	(experimental) Add a User Pool to the IdentityPool and configure User Pool Client to handle identities.
FromIdentityPoolArn(Construct, String, String)	(experimental) Import an existing Identity Pool from its Arn.
FromIdentityPoolId(Construct, String, String)	(experimental) Import an existing Identity Pool from its id.

Constructors

IdentityPool(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected IdentityPool(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

IdentityPool(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected IdentityPool(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

IdentityPool(Construct, String, IIdentityPoolProps)

public IdentityPool(Construct scope, string id, IIdentityPoolProps props = null)

Parameters

scope Constructs.Construct
id System.String
props IIdentityPoolProps

Remarks

Stability: Experimental

Properties

AuthenticatedRole

(experimental) Default role for authenticated users.

public virtual IRole AuthenticatedRole { get; }

Property Value

IRole

Remarks

Stability: Experimental

IdentityPoolArn

(experimental) The ARN of the Identity Pool.

public virtual string IdentityPoolArn { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

IdentityPoolId

(experimental) The id of the Identity Pool in the format REGION:GUID.

public virtual string IdentityPoolId { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

IdentityPoolName

(experimental) The name of the Identity Pool.

public virtual string IdentityPoolName { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

UnauthenticatedRole

(experimental) Default role for unauthenticated users.

public virtual IRole UnauthenticatedRole { get; }

Property Value

IRole

Remarks

Stability: Experimental

Methods

AddRoleMappings(IIdentityPoolRoleMapping[])

(experimental) Adds Role Mappings to Identity Pool.

public virtual void AddRoleMappings(params IIdentityPoolRoleMapping[] roleMappings)

Parameters

roleMappings IIdentityPoolRoleMapping[]

Remarks

Stability: Experimental

AddUserPoolAuthentication(IUserPoolAuthenticationProvider)

(experimental) Add a User Pool to the IdentityPool and configure User Pool Client to handle identities.

public virtual void AddUserPoolAuthentication(IUserPoolAuthenticationProvider userPool)

Parameters

userPool IUserPoolAuthenticationProvider

Remarks

Stability: Experimental

FromIdentityPoolArn(Construct, String, String)

(experimental) Import an existing Identity Pool from its Arn.

public static IIdentityPool FromIdentityPoolArn(Construct scope, string id, string identityPoolArn)

Parameters

scope Constructs.Construct
id System.String
identityPoolArn System.String

Returns

IIdentityPool

Remarks

Stability: Experimental

FromIdentityPoolId(Construct, String, String)

(experimental) Import an existing Identity Pool from its id.

public static IIdentityPool FromIdentityPoolId(Construct scope, string id, string identityPoolId)

Parameters

scope Constructs.Construct
id System.String
identityPoolId System.String

Returns

IIdentityPool

Remarks

Stability: Experimental

Implements

IIdentityPool

IResource

Constructs.IConstruct

Constructs.IDependable