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.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.491Z")
 @Stability(value=Stable)
public interface CfnRouteProps
extends software.amazon.jsii.JsiiSerializable

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

See Also:

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

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

See Also:

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

getRouteKey

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

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

See Also:

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

getApiKeyRequired

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

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

See Also:

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

getAuthorizationScopes

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

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

See Also:

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

getAuthorizationType

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

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

See Also:

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

getAuthorizerId

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

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

See Also:

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

getModelSelectionExpression

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

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

See Also:

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

getOperationName

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

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

See Also:

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

getRequestModels

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

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

See Also:

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

getRequestParameters

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

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

See Also:

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

getRouteResponseSelectionExpression

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

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

See Also:

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

getTarget

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

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

See Also:

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

builder

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

Returns:

a CfnRouteProps.Builder of CfnRouteProps