Package software.amazon.awscdk.services.apigatewayv2

Interface CfnRouteResponseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteResponseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.227Z")
@Stability(Stable)
public interface CfnRouteResponseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRouteResponse.

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 responseModels;
 CfnRouteResponseProps cfnRouteResponseProps = CfnRouteResponseProps.builder()
         .apiId("apiId")
         .routeId("routeId")
         .routeResponseKey("routeResponseKey")
         // the properties below are optional
         .modelSelectionExpression("modelSelectionExpression")
         .responseModels(responseModels)
         .responseParameters(Map.of(
                 "responseParametersKey", ParameterConstraintsProperty.builder()
                         .required(false)
                         .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRouteResponseProps.Builder	builder()
String	getApiId()	The API identifier.
default String	getModelSelectionExpression()	The model selection expression for the route response.
default Object	getResponseModels()	The response models for the route response.
default Object	getResponseParameters()	The route response parameters.
String	getRouteId()	The route ID.
String	getRouteResponseKey()	The route response key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

getRouteId

@Stability(Stable)
@NotNull
String getRouteId()

The route ID.

getRouteResponseKey

@Stability(Stable)
@NotNull
String getRouteResponseKey()

The route response key.

getModelSelectionExpression

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

The model selection expression for the route response.

Supported only for WebSocket APIs.

getResponseModels

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

The response models for the route response.

getResponseParameters

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

The route response parameters.

builder

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

Returns:

a CfnRouteResponseProps.Builder of CfnRouteResponseProps