Interface CfnRouteProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRouteProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:10.645Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRouteProps
static final class
An implementation forCfnRouteProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnRouteProps.Builder
builder()
getApiId()
The API identifier.default Object
Specifies whether an API key is required for the route.The authorization scopes supported by this route.default String
The authorization type for the route.default String
The identifier of theAuthorizer
resource to be associated with this route.default String
The model selection expression for the route.default String
The operation name for the route.default Object
The request models for the route.default Object
The request parameters for the route.The route key for the route.default String
The route response selection expression for the route.default String
The target for the route.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiId
The API identifier.- See Also:
-
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:
-
getApiKeyRequired
Specifies whether an API key is required for the route.Supported only for WebSocket APIs.
- See Also:
-
getAuthorizationScopes
The authorization scopes supported by this route.- See Also:
-
getAuthorizationType
The authorization type for the route.For WebSocket APIs, valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions, andCUSTOM
for using a Lambda authorizer. For HTTP APIs, valid values areNONE
for open access,JWT
for using JSON Web Tokens,AWS_IAM
for using AWS IAM permissions, andCUSTOM
for using a Lambda authorizer.- See Also:
-
getAuthorizerId
The identifier of theAuthorizer
resource to be associated with this route.The authorizer identifier is generated by API Gateway when you created the authorizer.
- See Also:
-
getModelSelectionExpression
The model selection expression for the route.Supported only for WebSocket APIs.
- See Also:
-
getOperationName
The operation name for the route.- See Also:
-
getRequestModels
The request models for the route.Supported only for WebSocket APIs.
- See Also:
-
getRequestParameters
The request parameters for the route.Supported only for WebSocket APIs.
- See Also:
-
getRouteResponseSelectionExpression
The route response selection expression for the route.Supported only for WebSocket APIs.
- See Also:
-
getTarget
The target for the route.- See Also:
-
builder
- Returns:
- a
CfnRouteProps.Builder
ofCfnRouteProps
-