Skip to content
v2.277.0

HttpAuthorizer L2 construct ​

An authorizer for Http Apis.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_iam as interfaces_iam } from 'aws-cdk-lib/interfaces';

declare const httpApiRef: apigatewayv2.IHttpApiRef;
declare const roleRef: interfaces_iam.IRoleRef;
const httpAuthorizer = new apigatewayv2.HttpAuthorizer(this, 'MyHttpAuthorizer', {
  httpApi: httpApiRef,
  identitySource: ['identitySource'],
  type: apigatewayv2.HttpAuthorizerType.IAM,

  // the properties below are optional
  authorizerName: 'authorizerName',
  authorizerUri: 'authorizerUri',
  enableSimpleResponses: false,
  jwtAudience: ['jwtAudience'],
  jwtIssuer: 'jwtIssuer',
  payloadFormatVersion: apigatewayv2.AuthorizerPayloadVersion.VERSION_1_0,
  resultsCacheTtl: cdk.Duration.minutes(30),
  role: roleRef,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_apigatewayv2 as apigatewayv2
from aws_cdk.interfaces import aws_iam as interfaces_iam

# http_api_ref: apigatewayv2.IHttpApiRef
# role_ref: interfaces_iam.IRoleRef

http_authorizer = apigatewayv2.HttpAuthorizer(self, "MyHttpAuthorizer",
    http_api=http_api_ref,
    identity_source=["identitySource"],
    type=apigatewayv2.HttpAuthorizerType.IAM,

    # the properties below are optional
    authorizer_name="authorizerName",
    authorizer_uri="authorizerUri",
    enable_simple_responses=False,
    jwt_audience=["jwtAudience"],
    jwt_issuer="jwtIssuer",
    payload_format_version=apigatewayv2.AuthorizerPayloadVersion.VERSION_1_0,
    results_cache_ttl=cdk.Duration.minutes(30),
    role=role_ref
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.apigatewayv2.*;
import software.amazon.awscdk.interfaces.iam.*;

IHttpApiRef httpApiRef;
IRoleRef roleRef;

HttpAuthorizer httpAuthorizer = HttpAuthorizer.Builder.create(this, "MyHttpAuthorizer")
        .httpApi(httpApiRef)
        .identitySource(List.of("identitySource"))
        .type(HttpAuthorizerType.IAM)

        // the properties below are optional
        .authorizerName("authorizerName")
        .authorizerUri("authorizerUri")
        .enableSimpleResponses(false)
        .jwtAudience(List.of("jwtAudience"))
        .jwtIssuer("jwtIssuer")
        .payloadFormatVersion(AuthorizerPayloadVersion.VERSION_1_0)
        .resultsCacheTtl(Duration.minutes(30))
        .role(roleRef)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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;
using Amazon.CDK.Interfaces.IAM;

IHttpApiRef httpApiRef;
IRoleRef roleRef;

var httpAuthorizer = new HttpAuthorizer(this, "MyHttpAuthorizer", new HttpAuthorizerProps {
    HttpApi = httpApiRef,
    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),
    Role = roleRef
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var httpApiRef IHttpApiRef
var roleRef IRoleRef

httpAuthorizer := awscdk.Aws_apigatewayv2.NewHttpAuthorizer(this, jsii.String("MyHttpAuthorizer"), &HttpAuthorizerProps{
	HttpApi: httpApiRef,
	IdentitySource: []*string{
		jsii.String("identitySource"),
	},
	Type: awscdk.*Aws_apigatewayv2.HttpAuthorizerType_IAM,

	// the properties below are optional
	AuthorizerName: jsii.String("authorizerName"),
	AuthorizerUri: jsii.String("authorizerUri"),
	EnableSimpleResponses: jsii.Boolean(false),
	JwtAudience: []*string{
		jsii.String("jwtAudience"),
	},
	JwtIssuer: jsii.String("jwtIssuer"),
	PayloadFormatVersion: awscdk.*Aws_apigatewayv2.AuthorizerPayloadVersion_VERSION_1_0,
	ResultsCacheTtl: cdk.Duration_Minutes(jsii.Number(30)),
	Role: roleRef,
})

Initializer ​

ts
new HttpAuthorizer(scope: Construct, id: string, props: HttpAuthorizerProps)
python
HttpAuthorizer(scope: Construct, id: str, props: HttpAuthorizerProps)
java
new HttpAuthorizer(Construct scope, String id, HttpAuthorizerProps props)
csharp
new HttpAuthorizer(Construct scope, string id, HttpAuthorizerProps props)
go
NewHttpAuthorizer(Scope Construct, Id *string, Props HttpAuthorizerProps)

Construct Props ​

authorizerNameoptionalstringauthorizer_nameoptionalstrauthorizerNameoptionalStringAuthorizerNameoptionalstringAuthorizerNameoptional*string#
Name of the authorizer.

Default: id of the HttpAuthorizer construct.

authorizerUrioptionalstringauthorizer_urioptionalstrauthorizerUrioptionalStringAuthorizerUrioptionalstringAuthorizerUrioptional*string#
The authorizer's Uniform Resource Identifier (URI).

Default: required for Request authorizer types

For REQUEST authorizers, this must be a well-formed Lambda function URI.

enableSimpleResponsesoptionalbooleanenable_simple_responsesoptionalboolenableSimpleResponsesoptionalBooleanEnableSimpleResponsesoptionalboolEnableSimpleResponsesoptional*bool#
Specifies whether a Lambda authorizer returns a response in a simple format.

Default: The lambda authorizer must return an IAM policy as its response

If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.

httpApiIHttpApiRefhttp_apiIHttpApiRefhttpApiIHttpApiRefHttpApiIHttpApiRefHttpApiIHttpApiRefrequired#
HTTP Api to attach the authorizer to.
identitySourcestring[]identity_sourcetyping.List[str]identitySourceList<String>IdentitySourcestring[]IdentitySource*[]*stringrequired#
The identity source for which authorization is requested.
jwtAudienceoptionalstring[]jwt_audienceoptionaltyping.List[str]jwtAudienceoptionalList<String>JwtAudienceoptionalstring[]JwtAudienceoptional*[]*string#
A list of the intended recipients of the JWT.

Default: required for JWT authorizer typess.

A valid JWT must provide an aud that matches at least one entry in this list.

jwtIssueroptionalstringjwt_issueroptionalstrjwtIssueroptionalStringJwtIssueroptionalstringJwtIssueroptional*string#
The base domain of the identity provider that issues JWT.

Default: required for JWT authorizer types.

payloadFormatVersionoptionalAuthorizerPayloadVersionpayload_format_versionoptionalAuthorizerPayloadVersionpayloadFormatVersionoptionalAuthorizerPayloadVersionPayloadFormatVersionoptionalAuthorizerPayloadVersionPayloadFormatVersionoptionalAuthorizerPayloadVersion#
Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Default: AuthorizerPayloadVersion.VERSION_2_0 if the authorizer type is HttpAuthorizerType.LAMBDA

resultsCacheTtloptionalDurationresults_cache_ttloptionalDurationresultsCacheTtloptionalDurationResultsCacheTtloptionalDurationResultsCacheTtloptionalDuration#
How long APIGateway should cache the results.

Default: API Gateway will not cache authorizer responses

Max 1 hour.

roleoptionalIRoleRefroleoptionalIRoleRefroleoptionalIRoleRefRoleoptionalIRoleRefRoleoptionalIRoleRef#
The IAM role that the API Gateway service assumes while invoking the authorizer.

Default: No role

Supported only for REQUEST authorizers.

Properties ​

authorizerIdstringauthorizer_idstrauthorizerIdStringAuthorizerIdstringAuthorizerId*string#
Id of the Authorizer.
authorizerRefAuthorizerReferenceauthorizer_refAuthorizerReferenceauthorizerRefAuthorizerReferenceAuthorizerRefAuthorizerReferenceAuthorizerRefAuthorizerReference#
A reference to a Authorizer resource.
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#
Uniquely identifies this class.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.

Methods ​

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromHttpAuthorizerAttributes(scope: Construct, id: string, attrs: HttpAuthorizerAttributes): IHttpRouteAuthorizer@staticmethod def from_http_authorizer_attributes(scope: Construct, id: str, attrs: HttpAuthorizerAttributes) -> IHttpRouteAuthorizerpublic static IHttpRouteAuthorizer fromHttpAuthorizerAttributes(Construct scope, String id, HttpAuthorizerAttributes attrs)public static IHttpRouteAuthorizer FromHttpAuthorizerAttributes(Construct scope, string id, HttpAuthorizerAttributes attrs)func FromHttpAuthorizerAttributes(Scope Construct, Id *string, Attrs HttpAuthorizerAttributes) IHttpRouteAuthorizerstatic#
Import an existing HTTP Authorizer into this CDK app.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.