Package software.amazon.awscdk.services.apigatewayv2

Class CfnAuthorizer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnAuthorizer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.174Z") @Stability(Stable) public class CfnAuthorizer extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::Authorizer.

The AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see Controlling and managing access to a WebSocket API in API Gateway and Controlling and managing access to an HTTP API in API Gateway in the API Gateway Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 CfnAuthorizer cfnAuthorizer = CfnAuthorizer.Builder.create(this, "MyCfnAuthorizer")
         .apiId("apiId")
         .authorizerType("authorizerType")
         .name("name")
         // the properties below are optional
         .authorizerCredentialsArn("authorizerCredentialsArn")
         .authorizerPayloadFormatVersion("authorizerPayloadFormatVersion")
         .authorizerResultTtlInSeconds(123)
         .authorizerUri("authorizerUri")
         .enableSimpleResponses(false)
         .identitySource(List.of("identitySource"))
         .identityValidationExpression("identityValidationExpression")
         .jwtConfiguration(JWTConfigurationProperty.builder()
                 .audience(List.of("audience"))
                 .issuer("issuer")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAuthorizer

      protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAuthorizer

      protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAuthorizer

      @Stability(Stable) public CfnAuthorizer(@NotNull Construct scope, @NotNull String id, @NotNull CfnAuthorizerProps props)
      Create a new AWS::ApiGatewayV2::Authorizer.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAuthorizerId

      @Stability(Stable) @NotNull public String getAttrAuthorizerId()
      The authorizer ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getAuthorizerType

      @Stability(Stable) @NotNull public String getAuthorizerType()
      The authorizer type.

      Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

    • setAuthorizerType

      @Stability(Stable) public void setAuthorizerType(@NotNull String value)
      The authorizer type.

      Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the authorizer.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the authorizer.

    • getAuthorizerCredentialsArn

      @Stability(Stable) @Nullable public String getAuthorizerCredentialsArn()
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

      To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

    • setAuthorizerCredentialsArn

      @Stability(Stable) public void setAuthorizerCredentialsArn(@Nullable String value)
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

      To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

    • getAuthorizerPayloadFormatVersion

      @Stability(Stable) @Nullable public String getAuthorizerPayloadFormatVersion()
      Specifies the format of the payload sent to an HTTP API Lambda authorizer.

      Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0 . To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

    • setAuthorizerPayloadFormatVersion

      @Stability(Stable) public void setAuthorizerPayloadFormatVersion(@Nullable String value)
      Specifies the format of the payload sent to an HTTP API Lambda authorizer.

      Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0 . To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

    • getAuthorizerResultTtlInSeconds

      @Stability(Stable) @Nullable public Number getAuthorizerResultTtlInSeconds()
      The time to live (TTL) for cached authorizer results, in seconds.

      If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • setAuthorizerResultTtlInSeconds

      @Stability(Stable) public void setAuthorizerResultTtlInSeconds(@Nullable Number value)
      The time to live (TTL) for cached authorizer results, in seconds.

      If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • getAuthorizerUri

      @Stability(Stable) @Nullable public String getAuthorizerUri()
      The authorizer's Uniform Resource Identifier (URI).

      For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: *{account_id}* :function: *{lambda_function_name}* /invocations . In general, the URI has this form: arn:aws:apigateway: *{region}* :lambda:path/ *{service_api}* , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations .

    • setAuthorizerUri

      @Stability(Stable) public void setAuthorizerUri(@Nullable String value)
      The authorizer's Uniform Resource Identifier (URI).

      For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: *{account_id}* :function: *{lambda_function_name}* /invocations . In general, the URI has this form: arn:aws:apigateway: *{region}* :lambda:path/ *{service_api}* , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations .

    • getEnableSimpleResponses

      @Stability(Stable) @Nullable public Object getEnableSimpleResponses()
      Specifies whether a Lambda authorizer returns a response in a simple format.

      By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

    • setEnableSimpleResponses

      @Stability(Stable) public void setEnableSimpleResponses(@Nullable Boolean value)
      Specifies whether a Lambda authorizer returns a response in a simple format.

      By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

    • setEnableSimpleResponses

      @Stability(Stable) public void setEnableSimpleResponses(@Nullable IResolvable value)
      Specifies whether a Lambda authorizer returns a response in a simple format.

      By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

    • getIdentitySource

      @Stability(Stable) @Nullable public List<String> getIdentitySource()
      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $ , for example, $request.header.Auth , $request.querystring.Name . These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

      For JWT , a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization .

    • setIdentitySource

      @Stability(Stable) public void setIdentitySource(@Nullable List<String> value)
      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $ , for example, $request.header.Auth , $request.querystring.Name . These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

      For JWT , a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization .

    • getIdentityValidationExpression

      @Stability(Stable) @Nullable public String getIdentityValidationExpression()
      This parameter is not used.

    • setIdentityValidationExpression

      @Stability(Stable) public void setIdentityValidationExpression(@Nullable String value)
      This parameter is not used.

    • getJwtConfiguration

      @Stability(Stable) @Nullable public Object getJwtConfiguration()
      The JWTConfiguration property specifies the configuration of a JWT authorizer.

      Required for the JWT authorizer type. Supported only for HTTP APIs.

    • setJwtConfiguration

      @Stability(Stable) public void setJwtConfiguration(@Nullable IResolvable value)
      The JWTConfiguration property specifies the configuration of a JWT authorizer.

      Required for the JWT authorizer type. Supported only for HTTP APIs.

    • setJwtConfiguration

      @Stability(Stable) public void setJwtConfiguration(@Nullable CfnAuthorizer.JWTConfigurationProperty value)
      The JWTConfiguration property specifies the configuration of a JWT authorizer.

      Required for the JWT authorizer type. Supported only for HTTP APIs.