CfnGatewayResponseProps Struct
Properties for defining a CfnGatewayResponse.
Example
ts
// 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
responseParametersoptionalIResolvable | { [key: string]: string }response_parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]responseParametersoptionalIResolvableResponseParametersoptionalIResolvableResponseParametersoptionalinterface{}#Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
responseTemplatesoptionalIResolvable | { [key: string]: string }response_templatesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]responseTemplatesoptionalIResolvableResponseTemplatesoptionalIResolvableResponseTemplatesoptionalinterface{}#Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
The response type of the associated GatewayResponse.
restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}required#The string identifier of the associated RestApi.
statusCodeoptionalstringstatus_codeoptionalstrstatusCodeoptionalStringStatusCodeoptionalstringStatusCodeoptional*string#The HTTP status code for this GatewayResponse.