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

Class CfnRouteResponsePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnRouteResponsePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.537Z")
@Stability(Stable)
public class CfnRouteResponsePropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API.

For more information, see Set up Route Responses for a WebSocket API in API Gateway in the API Gateway Developer Guide .

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object responseModels;
 CfnRouteResponsePropsMixin cfnRouteResponsePropsMixin = CfnRouteResponsePropsMixin.Builder.create(CfnRouteResponseMixinProps.builder()
         .apiId("apiId")
         .modelSelectionExpression("modelSelectionExpression")
         .responseModels(responseModels)
         .responseParameters(Map.of(
                 "responseParametersKey", ParameterConstraintsProperty.builder()
                         .required(false)
                         .build()))
         .routeId("routeId")
         .routeResponseKey("routeResponseKey")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRouteResponsePropsMixin.Builder	A fluent builder for CfnRouteResponsePropsMixin.
static interface	CfnRouteResponsePropsMixin.ParameterConstraintsProperty	Specifies whether the parameter is required.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnRouteResponsePropsMixin(CfnRouteResponseMixinProps props)	Create a mixin to apply properties to AWS::ApiGatewayV2::RouteResponse.
	CfnRouteResponsePropsMixin(CfnRouteResponseMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGatewayV2::RouteResponse.
protected	CfnRouteResponsePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRouteResponsePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnRouteResponseMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnRouteResponsePropsMixin

protected CfnRouteResponsePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnRouteResponsePropsMixin

protected CfnRouteResponsePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRouteResponsePropsMixin

@Stability(Stable)
public CfnRouteResponsePropsMixin(@NotNull
 CfnRouteResponseMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGatewayV2::RouteResponse.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnRouteResponsePropsMixin

@Stability(Stable)
public CfnRouteResponsePropsMixin(@NotNull
 CfnRouteResponseMixinProps props)

Create a mixin to apply properties to AWS::ApiGatewayV2::RouteResponse.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnRouteResponseMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()