public static final class CfnAuthorizer.Builder
extends java.lang.Object
CfnAuthorizer
.Modifier and Type | Method and Description |
---|---|
CfnAuthorizer.Builder |
apiId(java.lang.String apiId)
The API identifier.
|
CfnAuthorizer.Builder |
authorizerCredentialsArn(java.lang.String authorizerCredentialsArn)
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
CfnAuthorizer.Builder |
authorizerPayloadFormatVersion(java.lang.String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer.
|
CfnAuthorizer.Builder |
authorizerResultTtlInSeconds(java.lang.Number authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds.
|
CfnAuthorizer.Builder |
authorizerType(java.lang.String authorizerType)
The authorizer type.
|
CfnAuthorizer.Builder |
authorizerUri(java.lang.String authorizerUri)
The authorizer's Uniform Resource Identifier (URI).
|
CfnAuthorizer |
build() |
static CfnAuthorizer.Builder |
create(Construct scope,
java.lang.String id) |
CfnAuthorizer.Builder |
enableSimpleResponses(java.lang.Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format.
|
CfnAuthorizer.Builder |
enableSimpleResponses(IResolvable enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format.
|
CfnAuthorizer.Builder |
identitySource(java.util.List<java.lang.String> identitySource)
The identity source for which authorization is requested.
|
CfnAuthorizer.Builder |
identityValidationExpression(java.lang.String identityValidationExpression)
This parameter is not used.
|
CfnAuthorizer.Builder |
jwtConfiguration(CfnAuthorizer.JWTConfigurationProperty jwtConfiguration)
The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
|
CfnAuthorizer.Builder |
jwtConfiguration(IResolvable jwtConfiguration)
The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
|
CfnAuthorizer.Builder |
name(java.lang.String name)
The name of the authorizer.
|
public static CfnAuthorizer.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnAuthorizer.JWTConfigurationProperty.Builder
.public CfnAuthorizer.Builder apiId(java.lang.String apiId)
apiId
- The API identifier. This parameter is required.this
public CfnAuthorizer.Builder authorizerType(java.lang.String authorizerType)
Specify REQUEST
for a Lambda function using incoming request parameters. Specify JWT
to use JSON Web Tokens (supported only for HTTP APIs).
authorizerType
- The authorizer type. This parameter is required.this
public CfnAuthorizer.Builder name(java.lang.String name)
name
- The name of the authorizer. This parameter is required.this
public CfnAuthorizer.Builder authorizerCredentialsArn(java.lang.String authorizerCredentialsArn)
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.
authorizerCredentialsArn
- Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. This parameter is required.this
public CfnAuthorizer.Builder authorizerPayloadFormatVersion(java.lang.String authorizerPayloadFormatVersion)
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 .
authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. This parameter is required.this
public CfnAuthorizer.Builder authorizerResultTtlInSeconds(java.lang.Number authorizerResultTtlInSeconds)
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.
authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. This parameter is required.this
public CfnAuthorizer.Builder authorizerUri(java.lang.String authorizerUri)
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
.
authorizerUri
- The authorizer's Uniform Resource Identifier (URI). This parameter is required.this
public CfnAuthorizer.Builder enableSimpleResponses(java.lang.Boolean enableSimpleResponses)
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 .
enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple format. This parameter is required.this
public CfnAuthorizer.Builder enableSimpleResponses(IResolvable enableSimpleResponses)
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 .
enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple format. This parameter is required.this
public CfnAuthorizer.Builder identitySource(java.util.List<java.lang.String> identitySource)
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
.
identitySource
- The identity source for which authorization is requested. This parameter is required.this
public CfnAuthorizer.Builder identityValidationExpression(java.lang.String identityValidationExpression)
identityValidationExpression
- This parameter is not used. This parameter is required.this
public CfnAuthorizer.Builder jwtConfiguration(IResolvable jwtConfiguration)
Required for the JWT
authorizer type. Supported only for HTTP APIs.
jwtConfiguration
- The `JWTConfiguration` property specifies the configuration of a JWT authorizer. This parameter is required.this
public CfnAuthorizer.Builder jwtConfiguration(CfnAuthorizer.JWTConfigurationProperty jwtConfiguration)
Required for the JWT
authorizer type. Supported only for HTTP APIs.
jwtConfiguration
- The `JWTConfiguration` property specifies the configuration of a JWT authorizer. This parameter is required.this
public CfnAuthorizer build()