Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Interface CfnRouteResponseMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteResponseMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.536Z")
@Stability(Stable)
public interface CfnRouteResponseMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnRouteResponsePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.*;
 Object responseModels;
 CfnRouteResponseMixinProps cfnRouteResponseMixinProps = CfnRouteResponseMixinProps.builder()
         .apiId("apiId")
         .modelSelectionExpression("modelSelectionExpression")
         .responseModels(responseModels)
         .responseParameters(Map.of(
                 "responseParametersKey", ParameterConstraintsProperty.builder()
                         .required(false)
                         .build()))
         .routeId("routeId")
         .routeResponseKey("routeResponseKey")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRouteResponseMixinProps.Builder	builder()
default Object	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.
default Object	getRouteId()	The route ID.
default String	getRouteResponseKey()	The route response key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

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

The API identifier.

Returns union: either String or IApiRef

See Also:

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

getModelSelectionExpression

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

The model selection expression for the route response.

Supported only for WebSocket APIs.

See Also:

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

getResponseModels

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

The response models for the route response.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels

getResponseParameters

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

The route response parameters.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnRouteResponsePropsMixin.ParameterConstraintsProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters

getRouteId

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

The route ID.

Returns union: either String or IRouteRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid

getRouteResponseKey

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

The route response key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey

builder

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

Returns:

a CfnRouteResponseMixinProps.Builder of CfnRouteResponseMixinProps