Interface IUserPool

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Represents a Cognito UserPool.

public interface IUserPool : IResource, IConstruct, IConstruct, IDependable

Properties

IdentityProviders

Get all identity providers registered with this user pool.

IUserPoolIdentityProvider[] IdentityProviders { get; }

Property Value

IUserPoolIdentityProvider[]

UserPoolArn

The ARN of this user pool resource.

string UserPoolArn { get; }

Property Value

string

Remarks

Attribute: true

UserPoolId

The physical ID of this user pool resource.

string UserPoolId { get; }

Property Value

string

Remarks

Attribute: true

Methods

AddClient(string, IUserPoolClientOptions?)

Add a new app client to this user pool.

UserPoolClient AddClient(string id, IUserPoolClientOptions? options = null)

Parameters

id string

options IUserPoolClientOptions

Returns

UserPoolClient

Remarks

See: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html

AddDomain(string, IUserPoolDomainOptions)

Associate a domain to this user pool.

UserPoolDomain AddDomain(string id, IUserPoolDomainOptions options)

Parameters

id string

options IUserPoolDomainOptions

Returns

UserPoolDomain

Remarks

See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html

AddResourceServer(string, IUserPoolResourceServerOptions)

Add a new resource server to this user pool.

UserPoolResourceServer AddResourceServer(string id, IUserPoolResourceServerOptions options)

Parameters

id string

options IUserPoolResourceServerOptions

Returns

UserPoolResourceServer

Remarks

See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-resource-servers.html

RegisterIdentityProvider(IUserPoolIdentityProvider)

Register an identity provider with this user pool.

void RegisterIdentityProvider(IUserPoolIdentityProvider provider)

Parameters

provider IUserPoolIdentityProvider