Package software.amazon.awscdk.services.apigatewayv2

Interface CfnRouteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.333Z")
@Stability(Stable)
public interface CfnRouteProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRoute.

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.*;
 Object requestModels;
 Object requestParameters;
 CfnRouteProps cfnRouteProps = CfnRouteProps.builder()
         .apiId("apiId")
         .routeKey("routeKey")
         // the properties below are optional
         .apiKeyRequired(false)
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizationType("authorizationType")
         .authorizerId("authorizerId")
         .modelSelectionExpression("modelSelectionExpression")
         .operationName("operationName")
         .requestModels(requestModels)
         .requestParameters(requestParameters)
         .routeResponseSelectionExpression("routeResponseSelectionExpression")
         .target("target")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRouteProps.Builder	A builder for CfnRouteProps
static final class	CfnRouteProps.Jsii$Proxy	An implementation for CfnRouteProps

Method Summary

Modifier and Type	Method	Description
static CfnRouteProps.Builder	builder()
Object	getApiId()	The API identifier.
default Object	getApiKeyRequired()	Specifies whether an API key is required for the route.
default List<String>	getAuthorizationScopes()	The authorization scopes supported by this route.
default String	getAuthorizationType()	The authorization type for the route.
default Object	getAuthorizerId()	The identifier of the Authorizer resource to be associated with this route.
default String	getModelSelectionExpression()	The model selection expression for the route.
default String	getOperationName()	The operation name for the route.
default Object	getRequestModels()	The request models for the route.
default Object	getRequestParameters()	The request parameters for the route.
String	getRouteKey()	The route key for the route.
default String	getRouteResponseSelectionExpression()	The route response selection expression for the route.
default Object	getTarget()	The target for the route.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
Object getApiId()

The API identifier.

Returns union: either String or IApiRef

See Also:

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

getRouteKey

@Stability(Stable)
@NotNull
String getRouteKey()

The route key for the route.

For HTTP APIs, the route key can be either $default , or a combination of an HTTP method and resource path, for example, GET /pets .

See Also:

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

getApiKeyRequired

@Stability(Stable)
@Nullable
default Object getApiKeyRequired()

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

Returns union: either Boolean or IResolvable

See Also:

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

getAuthorizationScopes

@Stability(Stable)
@Nullable
default List<String> getAuthorizationScopes()

The authorization scopes supported by this route.

See Also:

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

getAuthorizationType

@Stability(Stable)
@Nullable
default String getAuthorizationType()

The authorization type for the route.

For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

See Also:

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

getAuthorizerId

@Stability(Stable)
@Nullable
default Object getAuthorizerId()

The identifier of the Authorizer resource to be associated with this route.

The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns union: either String or IAuthorizerRef

See Also:

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

getModelSelectionExpression

@Stability(Stable)
@Nullable
default String getModelSelectionExpression()

The model selection expression for the route.

Supported only for WebSocket APIs.

See Also:

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

getOperationName

@Stability(Stable)
@Nullable
default String getOperationName()

The operation name for the route.

See Also:

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

getRequestModels

@Stability(Stable)
@Nullable
default Object getRequestModels()

The request models for the route.

Supported only for WebSocket APIs.

See Also:

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

getRequestParameters

@Stability(Stable)
@Nullable
default Object getRequestParameters()

The request parameters for the route.

Supported only for WebSocket APIs.

See Also:

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

getRouteResponseSelectionExpression

@Stability(Stable)
@Nullable
default String getRouteResponseSelectionExpression()

The route response selection expression for the route.

Supported only for WebSocket APIs.

See Also:

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

getTarget

@Stability(Stable)
@Nullable
default Object getTarget()

The target for the route.

Returns union: either String or IIntegrationRef

See Also:

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

builder

@Stability(Stable)
static CfnRouteProps.Builder builder()

Returns:

a CfnRouteProps.Builder of CfnRouteProps