software.amazon.awscdk.services.apigateway

Interface GatewayResponseProps

All Superinterfaces:

GatewayResponseOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GatewayResponseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.162Z")
 @Stability(value=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 Classes

Modifier and Type	Interface and Description
static class	GatewayResponseProps.Builder A builder for GatewayResponseProps
static class	GatewayResponseProps.Jsii$Proxy An implementation for GatewayResponseProps

Method Summary

Modifier and Type	Method and Description
static GatewayResponseProps.Builder	builder()
IRestApi	getRestApi() Rest api resource to target.

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

getResponseHeaders, getStatusCode, getTemplates, getType

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApi

@Stability(value=Stable)
 @NotNull
IRestApi getRestApi()

Rest api resource to target.

builder

@Stability(value=Stable)
static GatewayResponseProps.Builder builder()

Specified by:

builder in interface GatewayResponseOptions

Returns:

a GatewayResponseProps.Builder of GatewayResponseProps