interface CfnGatewayResponseProps

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

Properties for defining a CfnGatewayResponse.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html

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

Name	Type	Description
responseType	`string`	The response type of the associated GatewayResponse.
restApiId	`string`	The string identifier of the associated RestApi.
responseParameters?	`{ [string]: string } \|` `IResolvable`	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
responseTemplates?	`{ [string]: string } \|` `IResolvable`	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
statusCode?	`string`	The HTTP status code for this GatewayResponse.