Class CognitoUserPoolsAuthorizer

Cognito user pools based custom authorizer.

Inheritance

System.Object

Resource

Authorizer

CognitoUserPoolsAuthorizer

Implements

IResource

Constructs.IConstruct

Constructs.IDependable

IAuthorizer

Inherited Members

Authorizer.IsAuthorizer(Object)

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CognitoUserPoolsAuthorizer : Authorizer, IResource, IAuthorizer

Syntax (vb)

Public Class CognitoUserPoolsAuthorizer
    Inherits Authorizer
    Implements IResource, IAuthorizer

Remarks

Resource: AWS::ApiGateway::Authorizer

ExampleMetadata: infused

Examples

Resource books;
var userPool = new UserPool(this, "UserPool");

var auth = new CognitoUserPoolsAuthorizer(this, "booksAuthorizer", new CognitoUserPoolsAuthorizerProps {
    CognitoUserPools = new [] { userPool }
});
books.AddMethod("GET", new HttpIntegration("http://amazon.com"), new MethodOptions {
    Authorizer = auth,
    AuthorizationType = AuthorizationType.COGNITO
});

Synopsis

Constructors

CognitoUserPoolsAuthorizer(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CognitoUserPoolsAuthorizer(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CognitoUserPoolsAuthorizer(Construct, String, ICognitoUserPoolsAuthorizerProps)

Properties

AuthorizationType	The authorization type of this authorizer.
AuthorizerArn	The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.
AuthorizerId	The id of the authorizer.

Constructors

CognitoUserPoolsAuthorizer(ByRefValue)

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

protected CognitoUserPoolsAuthorizer(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CognitoUserPoolsAuthorizer(DeputyBase.DeputyProps)

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

protected CognitoUserPoolsAuthorizer(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CognitoUserPoolsAuthorizer(Construct, String, ICognitoUserPoolsAuthorizerProps)

public CognitoUserPoolsAuthorizer(Construct scope, string id, ICognitoUserPoolsAuthorizerProps props)

Parameters

scope Constructs.Construct

id System.String

props ICognitoUserPoolsAuthorizerProps

Properties

AuthorizationType

The authorization type of this authorizer.

public override Nullable<AuthorizationType> AuthorizationType { get; }

Property Value

System.Nullable<AuthorizationType>

Overrides

Authorizer.AuthorizationType

AuthorizerArn

The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.

public virtual string AuthorizerArn { get; }

Property Value

System.String

Remarks

Attribute: true

AuthorizerId

The id of the authorizer.

public override string AuthorizerId { get; }

Property Value

System.String

Overrides

Authorizer.AuthorizerId

Remarks

Attribute: true

Implements

IResource

Constructs.IConstruct

Constructs.IDependable

IAuthorizer