Package software.amazon.awscdk.services.apigateway

Class GatewayResponse

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.GatewayResponse

All Implemented Interfaces:

IResource, IGatewayResponse, IGatewayResponseRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:04.115Z")
@Stability(Stable)
public class GatewayResponse
extends Resource
implements IGatewayResponse

Configure the response received by clients, produced from the API Gateway backend.

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.*;
 ResponseType responseType;
 RestApi restApi;
 GatewayResponse gatewayResponse = GatewayResponse.Builder.create(this, "MyGatewayResponse")
         .restApi(restApi)
         .type(responseType)
         // the properties below are optional
         .responseHeaders(Map.of(
                 "responseHeadersKey", "responseHeaders"))
         .statusCode("statusCode")
         .templates(Map.of(
                 "templatesKey", "templates"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GatewayResponse.Builder	A fluent builder for GatewayResponse.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IGatewayResponse

IGatewayResponse.Jsii$Default, IGatewayResponse.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GatewayResponse(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GatewayResponse(software.amazon.jsii.JsiiObjectRef objRef)
	GatewayResponse(software.constructs.Construct scope, String id, GatewayResponseProps props)

Method Summary

Modifier and Type	Method	Description
static IGatewayResponse	fromGatewayResponseId(software.constructs.Construct scope, String id, String gatewayResponseId)	Reference an existing GatewayResponse given a gateway response ID.
GatewayResponseReference	getGatewayResponseRef()	A reference to a GatewayResponse resource.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.apigateway.IGatewayResponse

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

GatewayResponse

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

GatewayResponse

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

GatewayResponse

@Stability(Stable)
public GatewayResponse(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 GatewayResponseProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromGatewayResponseId

@Stability(Stable)
@NotNull
public static IGatewayResponse fromGatewayResponseId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String gatewayResponseId)

Reference an existing GatewayResponse given a gateway response ID.

Parameters:

scope - This parameter is required.

id - This parameter is required.

gatewayResponseId - This parameter is required.

getGatewayResponseRef

@Stability(Stable)
@NotNull
public GatewayResponseReference getGatewayResponseRef()

A reference to a GatewayResponse resource.

Specified by:

getGatewayResponseRef in interface IGatewayResponseRef