Interface IUserPool
Represents a Cognito UserPool.
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface IUserPool : IResource, IConstruct, IDependable
Syntax (vb)
Public Interface IUserPool
Inherits IResource, IConstruct, 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. |
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. |
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
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
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
Remarks
AddDomain(String, IUserPoolDomainOptions)
Associate a domain to this user pool.
UserPoolDomain AddDomain(string id, IUserPoolDomainOptions options)
Parameters
- id System.String
- options IUserPoolDomainOptions
Returns
Remarks
AddResourceServer(String, IUserPoolResourceServerOptions)
Add a new resource server to this user pool.
UserPoolResourceServer AddResourceServer(string id, IUserPoolResourceServerOptions options)
Parameters
- id System.String
- options IUserPoolResourceServerOptions
Returns
Remarks
RegisterIdentityProvider(IUserPoolIdentityProvider)
Register an identity provider with this user pool.
void RegisterIdentityProvider(IUserPoolIdentityProvider provider)
Parameters
- provider IUserPoolIdentityProvider