Package software.amazon.awscdk.services.apigatewayv2

Class CfnIntegrationResponse

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.CfnIntegrationResponse
All Implemented Interfaces:
IInspectable, IIntegrationResponseRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:31.676Z") @Stability(Stable) public class CfnIntegrationResponse extends CfnResource implements IInspectable, IIntegrationResponseRef
The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API.

For more information, see Set up WebSocket API Integration Responses 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 responseParameters;
 Object responseTemplates;
 CfnIntegrationResponse cfnIntegrationResponse = CfnIntegrationResponse.Builder.create(this, "MyCfnIntegrationResponse")
         .apiId("apiId")
         .integrationId("integrationId")
         .integrationResponseKey("integrationResponseKey")
         // the properties below are optional
         .contentHandlingStrategy("contentHandlingStrategy")
         .responseParameters(responseParameters)
         .responseTemplates(responseTemplates)
         .templateSelectionExpression("templateSelectionExpression")
         .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

    • CfnIntegrationResponse

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

    • CfnIntegrationResponse

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

    • CfnIntegrationResponse

      @Stability(Stable) public CfnIntegrationResponse(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIntegrationResponseProps 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.

    • getAttrIntegrationResponseId

      @Stability(Stable) @NotNull public String getAttrIntegrationResponseId()
      The integration response ID.

    • getCfnProperties

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

    • getIntegrationResponseRef

      @Stability(Stable) @NotNull public IntegrationResponseReference getIntegrationResponseRef()
      A reference to a IntegrationResponse resource.
      Specified by:
      getIntegrationResponseRef in interface IIntegrationResponseRef

    • getApiId

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

    • setApiId

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

    • getIntegrationId

      @Stability(Stable) @NotNull public String getIntegrationId()
      The integration ID.

    • setIntegrationId

      @Stability(Stable) public void setIntegrationId(@NotNull String value)
      The integration ID.

    • getIntegrationResponseKey

      @Stability(Stable) @NotNull public String getIntegrationResponseKey()
      The integration response key.

    • setIntegrationResponseKey

      @Stability(Stable) public void setIntegrationResponseKey(@NotNull String value)
      The integration response key.

    • getContentHandlingStrategy

      @Stability(Stable) @Nullable public String getContentHandlingStrategy()
      Supported only for WebSocket APIs.

    • setContentHandlingStrategy

      @Stability(Stable) public void setContentHandlingStrategy(@Nullable String value)
      Supported only for WebSocket APIs.

    • getResponseParameters

      @Stability(Stable) @Nullable public Object getResponseParameters()
      A key-value map specifying response parameters that are passed to the method response from the backend.

    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@Nullable Object value)
      A key-value map specifying response parameters that are passed to the method response from the backend.

    • getResponseTemplates

      @Stability(Stable) @Nullable public Object getResponseTemplates()
      The collection of response templates for the integration response as a string-to-string map of key-value pairs.

    • setResponseTemplates

      @Stability(Stable) public void setResponseTemplates(@Nullable Object value)
      The collection of response templates for the integration response as a string-to-string map of key-value pairs.

    • getTemplateSelectionExpression

      @Stability(Stable) @Nullable public String getTemplateSelectionExpression()
      The template selection expression for the integration response.

    • setTemplateSelectionExpression

      @Stability(Stable) public void setTemplateSelectionExpression(@Nullable String value)
      The template selection expression for the integration response.