AWS API Gateway V2 Model
This page shows how to write Terraform and CloudFormation for API Gateway V2 Model and write them securely.
aws_apigatewayv2_model (Terraform)
The Model in API Gateway V2 can be configured in Terraform with the resource name aws_apigatewayv2_model. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
api_idrequired - string -
content_typerequired - string -
descriptionoptional - string -
idoptional computed - string -
namerequired - string -
schemarequired - string
Explanation in Terraform Registry
Manages an Amazon API Gateway Version 2 model.
AWS::ApiGatewayV2::Model (CloudFormation)
The Model in ApiGatewayV2 can be configured in CloudFormation with the resource name AWS::ApiGatewayV2::Model. The following sections describe 1 example of how to use the resource and its parameters.
Example Usage from GitHub
"default" : "AWS::ApiGatewayV2::Model"
},
"Properties" : {
"$ref" : "AWS_ApiGatewayV2_Model.schema.json"
}
}
Parameters
-
Descriptionoptional - String -
ContentTypeoptional - String -
Schemarequired - Json -
ApiIdrequired - String -
Namerequired - String
Explanation in CloudFormation Registry
The
AWS::ApiGatewayV2::Modelresource updates data model for a WebSocket API. For more information, see Model Selection Expressions in the API Gateway Developer Guide.
Frequently asked questions
What is AWS API Gateway V2 Model?
AWS API Gateway V2 Model is a resource for API Gateway V2 of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS API Gateway V2 Model?
For CloudFormation, the shiver-me-timbers/smt-cloudformation-parent source code example is useful. See the CloudFormation Example section for further details.
