software.amazon.awscdk.services.apigatewayv2

Interface CfnRouteResponseProps

All Known Implementing Classes:

CfnRouteResponseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.966Z")
public interface CfnRouteResponseProps

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;
 Object responseParameters;
 CfnRouteResponseProps cfnRouteResponseProps = CfnRouteResponseProps.builder()
         .apiId("apiId")
         .routeId("routeId")
         .routeResponseKey("routeResponseKey")
         // the properties below are optional
         .modelSelectionExpression("modelSelectionExpression")
         .responseModels(responseModels)
         .responseParameters(responseParameters)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getApiId

java.lang.String getApiId()

The API identifier.

getRouteId

java.lang.String getRouteId()

The route ID.

getRouteResponseKey

java.lang.String getRouteResponseKey()

The route response key.

getModelSelectionExpression

default java.lang.String getModelSelectionExpression()

The model selection expression for the route response.

Supported only for WebSocket APIs.

getResponseModels

default java.lang.Object getResponseModels()

The response models for the route response.

getResponseParameters

default java.lang.Object getResponseParameters()

The route response parameters.

builder

static CfnRouteResponseProps.Builder builder()

Returns:

a CfnRouteResponseProps.Builder of CfnRouteResponseProps