interface CfnGatewayResponseProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnGatewayResponseProps
Java	software.amazon.awscdk.services.apigateway.CfnGatewayResponseProps
Python	aws_cdk.aws_apigateway.CfnGatewayResponseProps
TypeScript	@aws-cdk/aws-apigateway » CfnGatewayResponseProps

Properties for defining a CfnGatewayResponse.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
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?	IResolvable | { [string]: string }	Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
responseTemplates?	IResolvable | { [string]: string }	Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
statusCode?	string	The HTTP status code for this GatewayResponse.

---

responseType

Type: string

The response type of the associated GatewayResponse.

---

restApiId

Type: string

The string identifier of the associated RestApi.

---

responseParameters?

Type: IResolvable | { [string]: string } (optional)

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

---

responseTemplates?

Type: IResolvable | { [string]: string } (optional)

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

---

statusCode?

Type: string (optional)

The HTTP status code for this GatewayResponse.