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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.865Z")
 @Stability(value=Stable)
public interface CfnRouteProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGatewayV2::Route`.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRouteProps.Builder	builder()
String	getApiId() `AWS::ApiGatewayV2::Route.ApiId`.
default Object	getApiKeyRequired() `AWS::ApiGatewayV2::Route.ApiKeyRequired`.
default List<String>	getAuthorizationScopes() `AWS::ApiGatewayV2::Route.AuthorizationScopes`.
default String	getAuthorizationType() `AWS::ApiGatewayV2::Route.AuthorizationType`.
default String	getAuthorizerId() `AWS::ApiGatewayV2::Route.AuthorizerId`.
default String	getModelSelectionExpression() `AWS::ApiGatewayV2::Route.ModelSelectionExpression`.
default String	getOperationName() `AWS::ApiGatewayV2::Route.OperationName`.
default Object	getRequestModels() `AWS::ApiGatewayV2::Route.RequestModels`.
default Object	getRequestParameters() `AWS::ApiGatewayV2::Route.RequestParameters`.
String	getRouteKey() `AWS::ApiGatewayV2::Route.RouteKey`.
default String	getRouteResponseSelectionExpression() `AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`.
default String	getTarget() `AWS::ApiGatewayV2::Route.Target`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiId

@Stability(value=Stable)
 @NotNull
String getApiId()

`AWS::ApiGatewayV2::Route.ApiId`.

getApiKeyRequired

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

`AWS::ApiGatewayV2::Route.ApiKeyRequired`.

getAuthorizationScopes

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

`AWS::ApiGatewayV2::Route.AuthorizationScopes`.

getAuthorizationType

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

`AWS::ApiGatewayV2::Route.AuthorizationType`.

getAuthorizerId

@Stability(value=Stable)
 @Nullable
default String getAuthorizerId()

`AWS::ApiGatewayV2::Route.AuthorizerId`.

getModelSelectionExpression

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

`AWS::ApiGatewayV2::Route.ModelSelectionExpression`.

getOperationName

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

`AWS::ApiGatewayV2::Route.OperationName`.

getRequestModels

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

`AWS::ApiGatewayV2::Route.RequestModels`.

getRequestParameters

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

`AWS::ApiGatewayV2::Route.RequestParameters`.

getRouteKey

@Stability(value=Stable)
 @NotNull
String getRouteKey()

`AWS::ApiGatewayV2::Route.RouteKey`.

getRouteResponseSelectionExpression

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

`AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`.

getTarget

@Stability(value=Stable)
 @Nullable
default String getTarget()

`AWS::ApiGatewayV2::Route.Target`.

builder

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

Returns:

a CfnRouteProps.Builder of CfnRouteProps