Class CfnRouteResponse

All Implemented Interfaces:
IInspectable,, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.934Z") @Stability(Stable) public class CfnRouteResponse extends CfnResource implements IInspectable
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object responseModels;
 CfnRouteResponse cfnRouteResponse = CfnRouteResponse.Builder.create(this, "MyCfnRouteResponse")
         // the properties below are optional
                 "responseParametersKey", ParameterConstraintsProperty.builder()

See Also:
  • Field Details


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

    • CfnRouteResponse

      protected CfnRouteResponse( objRef)
    • CfnRouteResponse

      protected CfnRouteResponse( initializationMode)
    • CfnRouteResponse

      @Stability(Stable) public CfnRouteResponse(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRouteResponseProps props)
      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
      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)
      renderProperties in class CfnResource
      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()
      getCfnProperties in class CfnResource
    • 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.
    • 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.