aws-cdk-lib.aws_apigatewayv2.CfnModelProps

interface CfnModelProps

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnModelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnModelProps
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnModelProps
Pythonaws_cdk.aws_apigatewayv2.CfnModelProps
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnModelProps

Properties for defining a CfnModel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const schema: any;
const cfnModelProps: apigatewayv2.CfnModelProps = {
  apiId: 'apiId',
  name: 'name',
  schema: schema,

  // the properties below are optional
  contentType: 'contentType',
  description: 'description',
};

Properties

NameTypeDescription
apiIdstringThe API identifier.
namestringThe name of the model.
schemaanyThe schema for the model.
contentType?stringThe content-type for the model, for example, "application/json".
description?stringThe description of the model.

apiId

Type: string

The API identifier.


name

Type: string

The name of the model.


schema

Type: any

The schema for the model.

For application/json models, this should be JSON schema draft 4 model.


contentType?

Type: string (optional)

The content-type for the model, for example, "application/json".


description?

Type: string (optional)

The description of the model.