class GatewayResponse (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.GatewayResponse`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#GatewayResponse`
Java	`software.amazon.awscdk.services.apigateway.GatewayResponse`
Python	`aws_cdk.aws_apigateway.GatewayResponse`
TypeScript (source)	`aws-cdk-lib` » `aws_apigateway` » `GatewayResponse`

Implements IConstruct, IDependable, IResource, 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 { aws_apigateway as apigateway } from 'aws-cdk-lib';

declare const responseType: apigateway.ResponseType;
declare const restApi: apigateway.RestApi;
const gatewayResponse = new apigateway.GatewayResponse(this, 'MyGatewayResponse', {
  restApi: restApi,
  type: responseType,

  // the properties below are optional
  responseHeaders: {
    responseHeadersKey: 'responseHeaders',
  },
  statusCode: 'statusCode',
  templates: {
    templatesKey: 'templates',
  },
});

Initializer

new GatewayResponse(scope: Construct, id: string, props: GatewayResponseProps)

Parameters

scope Construct
id string
props GatewayResponseProps

Construct Props

Name	Type	Description
restApi	`IRestApi`	Rest api resource to target.
type	`ResponseType`	Response type to associate with gateway response.
responseHeaders?	`{ [string]: string }`	Custom headers parameters for response.
statusCode?	`string`	Http status code for response.
templates?	`{ [string]: string }`	Custom templates to get mapped as response.

restApi

Type: IRestApi

Rest api resource to target.

type

Type: ResponseType

Response type to associate with gateway response.

responseHeaders?

Type: { [string]: string } (optional, default: no headers)

Custom headers parameters for response.

statusCode?

Type: string (optional, default: standard http status code for the response type.)

Http status code for response.

templates?

Type: { [string]: string } (optional, default: Response from api will be returned without applying any transformation.)

Custom templates to get mapped as response.

Properties

Name	Type	Description
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`Node`	The tree node.
stack	`Stack`	The stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: Node

The tree node.

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.