Class UserPoolClient

Define a UserPool App Client.

Inheritance
System.Object
Resource
UserPoolClient
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserPoolClient : Resource, IUserPoolClient, IResource
Syntax (vb)
Public Class UserPoolClient
    Inherits Resource
    Implements IUserPoolClient, IResource
Remarks

ExampleMetadata: infused

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);

Synopsis

Constructors

UserPoolClient(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
UserPoolClient(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
UserPoolClient(Construct, String, IUserPoolClientProps)

Properties

OAuthFlows

The OAuth flows enabled for this client.
UserPoolClientId

Name of the application client.
UserPoolClientName

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

The generated client secret.

Methods

FromUserPoolClientId(Construct, String, String)

Import a user pool client given its id.

Constructors

UserPoolClient(ByRefValue)

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

protected UserPoolClient(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

UserPoolClient(DeputyBase.DeputyProps)

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

protected UserPoolClient(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

UserPoolClient(Construct, String, IUserPoolClientProps)

public UserPoolClient(Construct scope, string id, IUserPoolClientProps props)
Parameters
scope Constructs.Construct
id System.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

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

System.String

UserPoolClientSecret

The generated client secret.

public virtual SecretValue UserPoolClientSecret { get; }
Property Value

SecretValue

Remarks

Only available if the "generateSecret" props is set to true

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 Constructs.Construct
id System.String
userPoolClientId System.String
Returns

IUserPoolClient

Implements

Constructs.IConstruct
Constructs.IDependable