interface CfnModelProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGatewayv2.CfnModelProps |
 Java | software.amazon.awscdk.services.apigatewayv2.CfnModelProps |
 Python | aws_cdk.aws_apigatewayv2.CfnModelProps |
 TypeScript | @aws-cdk/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 * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
declare const schema: any;
const cfnModelProps: apigatewayv2.CfnModelProps = {
apiId: 'apiId',
name: 'name',
schema: schema,
// the properties below are optional
contentType: 'contentType',
description: 'description',
};
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The API identifier. |
| name | string | The name of the model. |
| schema | any | The schema for the model. |
| content | string | The content-type for the model, for example, "application/json". |
| description? | string | The 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.