Interface IUserPool

Represents a Cognito UserPool.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IUserPool : IResource

Syntax (vb)

Public Interface IUserPool
    Inherits IResource, IConstruct, IDependable

Synopsis

Properties

IdentityProviders	Get all identity providers registered with this user pool.
UserPoolArn	The ARN of this user pool resource.
UserPoolId	The physical ID of this user pool resource.
UserPoolProviderName	The provider name of this user pool resource.

Methods

AddClient(String, IUserPoolClientOptions)	Add a new app client to this user pool.
AddDomain(String, IUserPoolDomainOptions)	Associate a domain to this user pool.
AddResourceServer(String, IUserPoolResourceServerOptions)	Add a new resource server to this user pool.
Grant(IGrantable, String[])	Adds an IAM policy statement associated with this user pool to an IAM principal's policy.
RegisterIdentityProvider(IUserPoolIdentityProvider)	Register an identity provider with this user pool.

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

System.String

Remarks

Attribute: true

UserPoolId

The physical ID of this user pool resource.

string UserPoolId { get; }

Property Value

System.String

Remarks

Attribute: true

UserPoolProviderName

The provider name of this user pool resource.

string UserPoolProviderName { get; }

Property Value

System.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 System.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 System.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)

Grant(IGrantable, String[])

Adds an IAM policy statement associated with this user pool to an IAM principal's policy.

Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable
actions System.String[]

Returns

Grant

RegisterIdentityProvider(IUserPoolIdentityProvider)

void RegisterIdentityProvider(IUserPoolIdentityProvider provider)

Parameters

provider IUserPoolIdentityProvider