Package software.amazon.awscdk.services.apigatewayv2

Class CfnAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.CfnAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAuthorizer>

Enclosing class:

CfnAuthorizer

@Stability(Stable)
public static final class CfnAuthorizer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAuthorizer>

A fluent builder for CfnAuthorizer.

Method Summary

Modifier and Type	Method	Description
CfnAuthorizer.Builder	apiId(String apiId)	The API identifier.
CfnAuthorizer.Builder	authorizerCredentialsArn(String authorizerCredentialsArn)	Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
CfnAuthorizer.Builder	authorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)	Specifies the format of the payload sent to an HTTP API Lambda authorizer.
CfnAuthorizer.Builder	authorizerResultTtlInSeconds(Number authorizerResultTtlInSeconds)	The time to live (TTL) for cached authorizer results, in seconds.
CfnAuthorizer.Builder	authorizerType(String authorizerType)	The authorizer type.
CfnAuthorizer.Builder	authorizerUri(String authorizerUri)	The authorizer's Uniform Resource Identifier (URI).
CfnAuthorizer	build()
static CfnAuthorizer.Builder	create(software.constructs.Construct scope, String id)
CfnAuthorizer.Builder	enableSimpleResponses(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(List<String> identitySource)	The identity source for which authorization is requested.
CfnAuthorizer.Builder	identityValidationExpression(String identityValidationExpression)	This parameter is not used.
CfnAuthorizer.Builder	jwtConfiguration(IResolvable jwtConfiguration)	The JWTConfiguration property specifies the configuration of a JWT authorizer.
CfnAuthorizer.Builder	jwtConfiguration(CfnAuthorizer.JWTConfigurationProperty jwtConfiguration)	The JWTConfiguration property specifies the configuration of a JWT authorizer.
CfnAuthorizer.Builder	name(String name)	The name of the authorizer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAuthorizer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAuthorizer.Builder.

apiId

@Stability(Stable)
public CfnAuthorizer.Builder apiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid

authorizerType

@Stability(Stable)
public CfnAuthorizer.Builder authorizerType(String authorizerType)

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).

Parameters:

authorizerType - The authorizer type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype

name

@Stability(Stable)
public CfnAuthorizer.Builder name(String name)

The name of the authorizer.

Parameters:

name - The name of the authorizer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name

authorizerCredentialsArn

@Stability(Stable)
public CfnAuthorizer.Builder authorizerCredentialsArn(String authorizerCredentialsArn)

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.

Parameters:

authorizerCredentialsArn - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn

authorizerPayloadFormatVersion

@Stability(Stable)
public CfnAuthorizer.Builder authorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)

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 .

Parameters:

authorizerPayloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda authorizer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerpayloadformatversion

authorizerResultTtlInSeconds

@Stability(Stable)
public CfnAuthorizer.Builder authorizerResultTtlInSeconds(Number authorizerResultTtlInSeconds)

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.

Parameters:

authorizerResultTtlInSeconds - The time to live (TTL) for cached authorizer results, in seconds. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds

authorizerUri

@Stability(Stable)
public CfnAuthorizer.Builder authorizerUri(String authorizerUri)

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 .

Parameters:

authorizerUri - The authorizer's Uniform Resource Identifier (URI). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri

enableSimpleResponses

@Stability(Stable)
public CfnAuthorizer.Builder enableSimpleResponses(Boolean enableSimpleResponses)

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 .

Parameters:

enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-enablesimpleresponses

enableSimpleResponses

@Stability(Stable)
public CfnAuthorizer.Builder enableSimpleResponses(IResolvable enableSimpleResponses)

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 .

Parameters:

enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-enablesimpleresponses

identitySource

@Stability(Stable)
public CfnAuthorizer.Builder identitySource(List<String> identitySource)

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 .

Parameters:

identitySource - The identity source for which authorization is requested. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

identityValidationExpression

@Stability(Stable)
public CfnAuthorizer.Builder identityValidationExpression(String identityValidationExpression)

This parameter is not used.

Parameters:

identityValidationExpression - This parameter is not used. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression

jwtConfiguration

@Stability(Stable)
public CfnAuthorizer.Builder jwtConfiguration(IResolvable jwtConfiguration)

The JWTConfiguration property specifies the configuration of a JWT authorizer.

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

Parameters:

jwtConfiguration - The JWTConfiguration property specifies the configuration of a JWT authorizer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration

jwtConfiguration

@Stability(Stable)
public CfnAuthorizer.Builder jwtConfiguration(CfnAuthorizer.JWTConfigurationProperty jwtConfiguration)

The JWTConfiguration property specifies the configuration of a JWT authorizer.

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

Parameters:

jwtConfiguration - The JWTConfiguration property specifies the configuration of a JWT authorizer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration

build

@Stability(Stable)
public CfnAuthorizer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAuthorizer>

Returns:

a newly built instance of CfnAuthorizer.