Class HttpAuthorizer

An authorizer for Http Apis.

Inheritance
object
Resource
HttpAuthorizer
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HttpAuthorizer : Resource, IHttpAuthorizer, IAuthorizer, IResource, IConstruct, IDependable
Syntax (vb)
Public Class HttpAuthorizer Inherits Resource Implements IHttpAuthorizer, IAuthorizer, IResource, IConstruct, IDependable
Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.Apigatewayv2;

             HttpApi httpApi;

             var httpAuthorizer = new HttpAuthorizer(this, "MyHttpAuthorizer", new HttpAuthorizerProps {
                 HttpApi = httpApi,
                 IdentitySource = new [] { "identitySource" },
                 Type = HttpAuthorizerType.IAM,

                 // the properties below are optional
                 AuthorizerName = "authorizerName",
                 AuthorizerUri = "authorizerUri",
                 EnableSimpleResponses = false,
                 JwtAudience = new [] { "jwtAudience" },
                 JwtIssuer = "jwtIssuer",
                 PayloadFormatVersion = AuthorizerPayloadVersion.VERSION_1_0,
                 ResultsCacheTtl = Duration.Minutes(30)
             });

Synopsis

Constructors

HttpAuthorizer(Construct, string, IHttpAuthorizerProps)

An authorizer for Http Apis.

Properties

AuthorizerId

Id of the Authorizer.
PROPERTY_INJECTION_ID

Uniquely identifies this class.

Methods

FromHttpAuthorizerAttributes(Construct, string, IHttpAuthorizerAttributes)

Import an existing HTTP Authorizer into this CDK app.

Constructors

HttpAuthorizer(Construct, string, IHttpAuthorizerProps)

An authorizer for Http Apis.

public HttpAuthorizer(Construct scope, string id, IHttpAuthorizerProps props)
Parameters
scope Construct
id string
props IHttpAuthorizerProps
Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.Apigatewayv2;

             HttpApi httpApi;

             var httpAuthorizer = new HttpAuthorizer(this, "MyHttpAuthorizer", new HttpAuthorizerProps {
                 HttpApi = httpApi,
                 IdentitySource = new [] { "identitySource" },
                 Type = HttpAuthorizerType.IAM,

                 // the properties below are optional
                 AuthorizerName = "authorizerName",
                 AuthorizerUri = "authorizerUri",
                 EnableSimpleResponses = false,
                 JwtAudience = new [] { "jwtAudience" },
                 JwtIssuer = "jwtIssuer",
                 PayloadFormatVersion = AuthorizerPayloadVersion.VERSION_1_0,
                 ResultsCacheTtl = Duration.Minutes(30)
             });

Properties

AuthorizerId

Id of the Authorizer.

public virtual string AuthorizerId { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

Methods

FromHttpAuthorizerAttributes(Construct, string, IHttpAuthorizerAttributes)

Import an existing HTTP Authorizer into this CDK app.

public static IHttpRouteAuthorizer FromHttpAuthorizerAttributes(Construct scope, string id, IHttpAuthorizerAttributes attrs)
Parameters
scope Construct
id string
attrs IHttpAuthorizerAttributes
Returns

IHttpRouteAuthorizer

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable