2.233.0

interface CfnGatewayResponseMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnGatewayResponseMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnGatewayResponseMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnGatewayResponseMixinProps
Pythonaws_cdk.mixins_preview.aws_apigateway.mixins.CfnGatewayResponseMixinProps
TypeScript @aws-cdk/mixins-preview » aws_apigateway » mixins » CfnGatewayResponseMixinProps

Properties for CfnGatewayResponsePropsMixin.

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 { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnGatewayResponseMixinProps: apigateway_mixins.CfnGatewayResponseMixinProps = {
  responseParameters: {
    responseParametersKey: 'responseParameters',
  },
  responseTemplates: {
    responseTemplatesKey: 'responseTemplates',
  },
  responseType: 'responseType',
  restApiId: 'restApiId',
  statusCode: 'statusCode',
};

Properties

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

responseParameters?

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

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

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

responseTemplates?

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

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

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

responseType?

Type: string (optional)

The response type of the associated GatewayResponse.

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

restApiId?

Type: string (optional)

The string identifier of the associated RestApi.

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

statusCode?

Type: string (optional)

The HTTP status code for this GatewayResponse.

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

← PreviousNext →