AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::Model

ApiGateway Model

The AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method.

Properties

5 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
RestApiId
string
RequiredCreate-only
ContentType
string
Create-only
Description
string
Name
string
Create-only
Schema
objectstring

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::Model

Resources:
  MyResource:
    Type: AWS::ApiGateway::Model
    Properties:
      RestApiId: "my-restapiid"
      Description: !Ref "AWS::StackName"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTapigateway:GET

read

apigateway:GET

update

apigateway:PATCHapigateway:GET

delete

apigateway:GETapigateway:DELETE

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties5
Required1
TaggingNot supported
Primary IDRestApiId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ContentTypeNameRestApiId

Related Resources

External Links