Package software.amazon.awscdk.services.apigatewayv2

Class CfnRouteResponse

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnRouteResponse
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IRouteResponseRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:57.534Z") @Stability(Stable) public class CfnRouteResponse extends CfnResource implements IInspectable, IRouteResponseRef
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.services.apigatewayv2.*;
 Object responseModels;
 CfnRouteResponse cfnRouteResponse = CfnRouteResponse.Builder.create(this, "MyCfnRouteResponse")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRouteResponse

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

    • CfnRouteResponse

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

    • CfnRouteResponse

      @Stability(Stable) public CfnRouteResponse(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRouteResponseProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrRouteResponseId

      @Stability(Stable) @NotNull public String getAttrRouteResponseId()
      The route response ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRouteResponseRef

      @Stability(Stable) @NotNull public RouteResponseReference getRouteResponseRef()
      A reference to a RouteResponse resource.
      Specified by:
      getRouteResponseRef in interface IRouteResponseRef

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getRouteId

      @Stability(Stable) @NotNull public String getRouteId()
      The route ID.

    • setRouteId

      @Stability(Stable) public void setRouteId(@NotNull String value)
      The route ID.

    • getRouteResponseKey

      @Stability(Stable) @NotNull public String getRouteResponseKey()
      The route response key.

    • setRouteResponseKey

      @Stability(Stable) public void setRouteResponseKey(@NotNull String value)
      The route response key.

    • getModelSelectionExpression

      @Stability(Stable) @Nullable public String getModelSelectionExpression()
      The model selection expression for the route response.

    • setModelSelectionExpression

      @Stability(Stable) public void setModelSelectionExpression(@Nullable String value)
      The model selection expression for the route response.

    • getResponseModels

      @Stability(Stable) @Nullable public Object getResponseModels()
      The response models for the route response.

    • setResponseModels

      @Stability(Stable) public void setResponseModels(@Nullable Object value)
      The response models for the route response.

    • getResponseParameters

      @Stability(Stable) @Nullable public Object getResponseParameters()
      The route response parameters.

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

    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@Nullable IResolvable value)
      The route response parameters.

    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@Nullable Map<String,Object> value)
      The route response parameters.