aws-cdk-lib.aws_apigateway.CfnGatewayResponseProps

interface CfnGatewayResponseProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnGatewayResponseProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnGatewayResponseProps
Javasoftware.amazon.awscdk.services.apigateway.CfnGatewayResponseProps
Pythonaws_cdk.aws_apigateway.CfnGatewayResponseProps
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
responseTypestringThe response type of the associated GatewayResponse.
restApiIdstringThe 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?stringThe 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.