Class CognitoUserPoolsAuthorizer
Cognito user pools based custom authorizer.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class CognitoUserPoolsAuthorizer : Authorizer, IResource, IConstruct, IDependable, IAuthorizer
Syntax (vb)
Public Class CognitoUserPoolsAuthorizer
Inherits Authorizer
Implements IResource, IConstruct, IDependable, 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
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
Remarks
Attribute: true