Class UserPoolClient

Define a UserPool App Client.

Inheritance

System.Object

Construct

Resource

UserPoolClient

Implements

IUserPoolClient

IResource

IConstruct

Constructs.IConstruct

IDependable

Inherited Members

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.AWS.Cognito.dll

Syntax (csharp)

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

Syntax (vb)

Public Class UserPoolClient
    Inherits Resource
    Implements IUserPoolClient, IResource, IConstruct, IConstruct, IDependable

Remarks

Stability: Experimental

Synopsis

Constructors

UserPoolClient(Construct, String, IUserPoolClientProps)
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

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.

Methods

FromUserPoolClientId(Construct, String, String)

Import a user pool client given its id.

Constructors

UserPoolClient(Construct, String, IUserPoolClientProps)

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

Parameters

scope Construct

id System.String

props IUserPoolClientProps

Remarks

Stability: Experimental

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

Properties

OAuthFlows

The OAuth flows enabled for this client.

public virtual IOAuthFlows OAuthFlows { get; }

Property Value

IOAuthFlows

Remarks

Stability: Experimental

UserPoolClientId

Name of the application client.

public virtual string UserPoolClientId { get; }

Property Value

System.String

Remarks

Stability: Experimental

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

Remarks

Stability: Experimental

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

userPoolClientId System.String

Returns

IUserPoolClient

Remarks

Stability: Experimental

Implements

IUserPoolClient

IResource

IConstruct

Constructs.IConstruct

IDependable