Table of Contents

Class UserPoolClient

Namespace
Amazon.CDK.AWS.Cognito
Assembly
Amazon.CDK.AWS.Cognito.dll

Define a UserPool App Client.

public class UserPoolClient : Resource, IUserPoolClient, IResource, IConstruct, IConstruct, IDependable
Inheritance
UserPoolClient
Implements
IResource
IConstruct
IConstruct
IDependable

Examples

var pool = new UserPool(this, "Pool");
            var provider = new UserPoolIdentityProviderAmazon(this, "Amazon", new UserPoolIdentityProviderAmazonProps {
                UserPool = pool,
                ClientId = "amzn-client-id",
                ClientSecret = "amzn-client-secret"
            });

            var client = pool.AddClient("app-client", new UserPoolClientOptions {
                // ...
                SupportedIdentityProviders = new [] { UserPoolClientIdentityProvider.AMAZON }
            });

            client.Node.AddDependency(provider);

Remarks

ExampleMetadata: infused

Constructors

UserPoolClient(Construct, string, IUserPoolClientProps) 

public UserPoolClient(Construct scope, string id, IUserPoolClientProps props)

Parameters

scope Construct
id string
props IUserPoolClientProps

Properties

OAuthFlows

The OAuth flows enabled for this client.

public virtual IOAuthFlows OAuthFlows { get; }

Property Value

IOAuthFlows

UserPoolClientId

Name of the application client.

public virtual string UserPoolClientId { get; }

Property Value

string

UserPoolClientName

The client name that was specified via the userPoolClientName property during initialization, throws an error otherwise.

public virtual string UserPoolClientName { get; }

Property Value

string

Methods

FromUserPoolClientId(Construct, string, string)

Import a user pool client given its id.

public static IUserPoolClient FromUserPoolClientId(Construct scope, string id, string userPoolClientId)

Parameters

scope Construct
id string
userPoolClientId string

Returns

IUserPoolClient