software.amazon.awscdk.services.apigateway

Class GatewayResponse

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.GatewayResponse

All Implemented Interfaces:

IConstruct, IDependable, IResource, IGatewayResponse

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.632Z")
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 and Description
static class	GatewayResponse.Builder A fluent builder for GatewayResponse.

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

IGatewayResponse.Jsii$Default, IGatewayResponse.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

GatewayResponse

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

GatewayResponse

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

GatewayResponse

public GatewayResponse(software.constructs.Construct scope,
                       java.lang.String id,
                       GatewayResponseProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.