Interface CfnAuthorizerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAuthorizerProps.Jsii$Proxy
CfnAuthorizer
.
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.*; CfnAuthorizerProps cfnAuthorizerProps = CfnAuthorizerProps.builder() .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAuthorizerProps
static final class
An implementation forCfnAuthorizerProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAuthorizerProps.Builder
builder()
getApiId()
The API identifier.default String
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.default String
Specifies the format of the payload sent to an HTTP API Lambda authorizer.default Number
The time to live (TTL) for cached authorizer results, in seconds.The authorizer type.default String
The authorizer's Uniform Resource Identifier (URI).default Object
Specifies whether a Lambda authorizer returns a response in a simple format.The identity source for which authorization is requested.default String
This parameter is not used.default Object
TheJWTConfiguration
property specifies the configuration of a JWT authorizer.getName()
The name of the authorizer.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiId
The API identifier.- See Also:
-
getAuthorizerType
The authorizer type.Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs).- See Also:
-
getName
The name of the authorizer.- See Also:
-
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.- See Also:
-
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
and2.0
. To learn more, see Working with AWS Lambda authorizers for HTTP APIs .- See Also:
-
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.
- See Also:
-
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
.- See Also:
-
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 .
- See Also:
-
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
.- See Also:
-
getIdentityValidationExpression
This parameter is not used.- See Also:
-
getJwtConfiguration
TheJWTConfiguration
property specifies the configuration of a JWT authorizer.Required for the
JWT
authorizer type. Supported only for HTTP APIs.- See Also:
-
builder
- Returns:
- a
CfnAuthorizerProps.Builder
ofCfnAuthorizerProps
-