Package software.amazon.awscdk.services.apigateway

Class CfnGatewayResponse

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.apigateway.CfnGatewayResponse
All Implemented Interfaces:
IInspectable, IGatewayResponseRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:04.112Z") @Stability(Stable) public class CfnGatewayResponse extends CfnResource implements IInspectable, IGatewayResponseRef
The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses 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.apigateway.*;
 CfnGatewayResponse cfnGatewayResponse = CfnGatewayResponse.Builder.create(this, "MyCfnGatewayResponse")
         .responseType("responseType")
         .restApiId("restApiId")
         // the properties below are optional
         .responseParameters(Map.of(
                 "responseParametersKey", "responseParameters"))
         .responseTemplates(Map.of(
                 "responseTemplatesKey", "responseTemplates"))
         .statusCode("statusCode")
         .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

    • CfnGatewayResponse

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

    • CfnGatewayResponse

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

    • CfnGatewayResponse

      @Stability(Stable) public CfnGatewayResponse(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGatewayResponseProps props)
      Create a new AWS::ApiGateway::GatewayResponse.

      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

    • isCfnGatewayResponse

      @Stability(Stable) @NotNull public static Boolean isCfnGatewayResponse(@NotNull Object x)
      Checks whether the given object is a CfnGatewayResponse.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID for the gateway response.

      For example: abc123 .

    • getCfnProperties

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

    • getGatewayResponseRef

      @Stability(Stable) @NotNull public GatewayResponseReference getGatewayResponseRef()
      A reference to a GatewayResponse resource.
      Specified by:
      getGatewayResponseRef in interface IGatewayResponseRef

    • getResponseType

      @Stability(Stable) @NotNull public String getResponseType()
      The response type of the associated GatewayResponse.

    • setResponseType

      @Stability(Stable) public void setResponseType(@NotNull String value)
      The response type of the associated GatewayResponse.

    • getRestApiId

      @Stability(Stable) @NotNull public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@NotNull String value)
      The string identifier of the associated RestApi.

    • getResponseParameters

      @Stability(Stable) @Nullable public Object getResponseParameters()
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@Nullable Map<String,String> value)
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@Nullable IResolvable value)
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

    • getResponseTemplates

      @Stability(Stable) @Nullable public Object getResponseTemplates()
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

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

    • setResponseTemplates

      @Stability(Stable) public void setResponseTemplates(@Nullable Map<String,String> value)
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

    • setResponseTemplates

      @Stability(Stable) public void setResponseTemplates(@Nullable IResolvable value)
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

    • getStatusCode

      @Stability(Stable) @Nullable public String getStatusCode()
      The HTTP status code for this GatewayResponse.

    • setStatusCode

      @Stability(Stable) public void setStatusCode(@Nullable String value)
      The HTTP status code for this GatewayResponse.