CfnAuthorizer

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.158Z")
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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnAuthorizer.Builder` A fluent builder for `CfnAuthorizer`.
`static interface`	`CfnAuthorizer.JWTConfigurationProperty` The `JWTConfiguration` property specifies the configuration of a JWT authorizer.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnAuthorizer(Construct scope, java.lang.String id, CfnAuthorizerProps props)` Create a new `AWS::ApiGatewayV2::Authorizer`.
`protected`	`CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApiId()` The API identifier.
`java.lang.String`	`getAttrAuthorizerId()`
`java.lang.String`	`getAuthorizerCredentialsArn()` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`java.lang.String`	`getAuthorizerPayloadFormatVersion()` Specifies the format of the payload sent to an HTTP API Lambda authorizer.
`java.lang.Number`	`getAuthorizerResultTtlInSeconds()` The time to live (TTL) for cached authorizer results, in seconds.
`java.lang.String`	`getAuthorizerType()` The authorizer type.
`java.lang.String`	`getAuthorizerUri()` The authorizer's Uniform Resource Identifier (URI).
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getEnableSimpleResponses()` Specifies whether a Lambda authorizer returns a response in a simple format.
`java.util.List<java.lang.String>`	`getIdentitySource()` The identity source for which authorization is requested.
`java.lang.String`	`getIdentityValidationExpression()` This parameter is not used.
`java.lang.Object`	`getJwtConfiguration()` The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
`java.lang.String`	`getName()` The name of the authorizer.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setApiId(java.lang.String value)` The API identifier.
`void`	`setAuthorizerCredentialsArn(java.lang.String value)` Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
`void`	`setAuthorizerPayloadFormatVersion(java.lang.String value)` Specifies the format of the payload sent to an HTTP API Lambda authorizer.
`void`	`setAuthorizerResultTtlInSeconds(java.lang.Number value)` The time to live (TTL) for cached authorizer results, in seconds.
`void`	`setAuthorizerType(java.lang.String value)` The authorizer type.
`void`	`setAuthorizerUri(java.lang.String value)` The authorizer's Uniform Resource Identifier (URI).
`void`	`setEnableSimpleResponses(java.lang.Boolean value)` Specifies whether a Lambda authorizer returns a response in a simple format.
`void`	`setEnableSimpleResponses(IResolvable value)` Specifies whether a Lambda authorizer returns a response in a simple format.
`void`	`setIdentitySource(java.util.List<java.lang.String> value)` The identity source for which authorization is requested.
`void`	`setIdentityValidationExpression(java.lang.String value)` This parameter is not used.
`void`	`setJwtConfiguration(CfnAuthorizer.JWTConfigurationProperty value)` The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
`void`	`setJwtConfiguration(IResolvable value)` The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
`void`	`setName(java.lang.String value)` The name of the authorizer.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnAuthorizer
```
protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnAuthorizer
```
protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnAuthorizer
```
public CfnAuthorizer(Construct scope,
                     java.lang.String id,
                     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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrAuthorizerId
```
public java.lang.String getAttrAuthorizerId()
```
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getApiId
```
public java.lang.String getApiId()
```
    The API identifier.
  - setApiId
```
public void setApiId(java.lang.String value)
```
    The API identifier.
  - getAuthorizerType
```
public java.lang.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
```
public void setAuthorizerType(java.lang.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
```
public java.lang.String getName()
```
    The name of the authorizer.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the authorizer.
  - getAuthorizerCredentialsArn
```
public java.lang.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
```
public void setAuthorizerCredentialsArn(java.lang.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
```
public java.lang.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
```
public void setAuthorizerPayloadFormatVersion(java.lang.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
```
public java.lang.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
```
public void setAuthorizerResultTtlInSeconds(java.lang.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
```
public java.lang.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
```
public void setAuthorizerUri(java.lang.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
```
public java.lang.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
```
public void setEnableSimpleResponses(java.lang.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
```
public void setEnableSimpleResponses(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
```
public java.util.List<java.lang.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
```
public void setIdentitySource(java.util.List<java.lang.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
```
public java.lang.String getIdentityValidationExpression()
```
    This parameter is not used.
  - setIdentityValidationExpression
```
public void setIdentityValidationExpression(java.lang.String value)
```
    This parameter is not used.
  - getJwtConfiguration
```
public java.lang.Object getJwtConfiguration()
```
    The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
    Required for the JWT authorizer type. Supported only for HTTP APIs.
  - setJwtConfiguration
```
public void setJwtConfiguration(IResolvable value)
```
    The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
    Required for the JWT authorizer type. Supported only for HTTP APIs.
  - setJwtConfiguration
```
public void setJwtConfiguration(CfnAuthorizer.JWTConfigurationProperty value)
```
    The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
    Required for the JWT authorizer type. Supported only for HTTP APIs.

Class CfnAuthorizer

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnAuthorizer

CfnAuthorizer

CfnAuthorizer

Method Detail

inspect

renderProperties

getAttrAuthorizerId

getCfnProperties

getApiId

setApiId

getAuthorizerType

setAuthorizerType

getName

setName

getAuthorizerCredentialsArn

setAuthorizerCredentialsArn

getAuthorizerPayloadFormatVersion

setAuthorizerPayloadFormatVersion

getAuthorizerResultTtlInSeconds

setAuthorizerResultTtlInSeconds

getAuthorizerUri

setAuthorizerUri

getEnableSimpleResponses

setEnableSimpleResponses

setEnableSimpleResponses

getIdentitySource

setIdentitySource

getIdentityValidationExpression

setIdentityValidationExpression

getJwtConfiguration

setJwtConfiguration

setJwtConfiguration