Interface GatewayResponseProps
- All Superinterfaces:
GatewayResponseOptions,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
GatewayResponseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:30.297Z")
@Stability(Stable)
public interface GatewayResponseProps
extends software.amazon.jsii.JsiiSerializable, GatewayResponseOptions
Properties for a new gateway response.
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;
GatewayResponseProps gatewayResponseProps = GatewayResponseProps.builder()
.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 ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forGatewayResponsePropsstatic final classAn implementation forGatewayResponseProps -
Method Summary
Modifier and TypeMethodDescriptionstatic GatewayResponseProps.Builderbuilder()Rest api resource to target.Methods inherited from interface software.amazon.awscdk.services.apigateway.GatewayResponseOptions
getResponseHeaders, getStatusCode, getTemplates, getTypeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRestApi
Rest api resource to target. -
builder
- Returns:
- a
GatewayResponseProps.BuilderofGatewayResponseProps
-