aws-cdk-lib.aws_apigateway.CfnGatewayResponseProps

CfnGatewayResponseProps Struct

Properties for defining a CfnGatewayResponse.

CfnGatewayResponseProps

used as props by

• CfnGatewayResponse

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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';
const cfnGatewayResponseProps: apigateway.CfnGatewayResponseProps = {
  responseType: 'responseType',
  restApiId: 'restApiId',

  // the properties below are optional
  responseParameters: {
    responseParametersKey: 'responseParameters',
  },
  responseTemplates: {
    responseTemplatesKey: 'responseTemplates',
  },
  statusCode: 'statusCode',
};

Properties

responseParametersIResolvable | { [key: string]: string }response_parameterstyping.Union[IResolvable, typing.Mapping[str, str]]responseParametersIResolvableResponseParametersIResolvableResponseParametersinterface{}#

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

responseTemplatesIResolvable | { [key: string]: string }response_templatestyping.Union[IResolvable, typing.Mapping[str, str]]responseTemplatesIResolvableResponseTemplatesIResolvableResponseTemplatesinterface{}#

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseTypestringresponse_typestrresponseTypeStringResponseTypestringResponseType*stringrequired#

The response type of the associated GatewayResponse.

restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}required#

The string identifier of the associated RestApi.

statusCodestringstatus_codestrstatusCodeStringStatusCodestringStatusCode*string#

The HTTP status code for this GatewayResponse.