Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon API Gateway Resource Types Reference » AWS::ApiGateway::RestApi

AWS::ApiGateway::RestApi

The AWS::ApiGateway::RestApi resource contains a collection of Amazon API Gateway resources and methods that can be invoked through HTTPS endpoints. For more information, see restapi:create in the Amazon API Gateway REST API Reference.

Note

On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ApiGateway::RestApi",
  "Properties" : {  
    "ApiKeySourceType" : String,
    "BinaryMediaTypes" : [ String, ... ],
    "Body" : JSON object,
    "BodyS3Location" : S3Location,
    "CloneFrom" : String,
    "Description" : String,      
    "EndpointConfiguration" : EndpointConfiguration,
    "FailOnWarnings" : Boolean,
    "MinimumCompressionSize" : Integer,
    "Name" : String,
    "Parameters" : { String:String, ... },
    "Policy" : JSON object
  }
}

YAML

Type: AWS::ApiGateway::RestApi
Properties:
  ApiKeySourceType: String
  BinaryMediaTypes:
    - String
  Body: JSON object
  BodyS3Location:
    S3Location
  CloneFrom: String
  Description: String
  EndpointConfiguration: EndpointConfiguration
  FailOnWarnings: Boolean
  MinimumCompressionSize: Integer
  Name: String
  Parameters:
    String: String
  Policy: JSON object

Properties

ApiKeySourceType

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.

  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Required: No

Type: String

Update requires: No interruption

BinaryMediaTypes

The list of binary media types that are supported by the RestApi resource, such as image/png or application/octet-stream. By default, RestApi supports only UTF-8-encoded text payloads. For more information, see Enable Support for Binary Payloads in API Gateway in the API Gateway Developer Guide. Duplicates are not allowed.

Required: No

Type: List of String values

Update requires: No interruption

Body

An OpenAPI specification that defines a set of RESTful APIs in the JSON format. For YAML templates, you can also provide the specification in the YAML format.

Required: No

Type: JSON object

Update requires: No interruption

BodyS3Location

The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.

Required: No

Type: Amazon API Gateway RestApi S3Location

Update requires: No interruption

CloneFrom

The ID of the API Gateway RestApi resource that you want to clone.

Required: No

Type: String

Update requires: No interruption

Description

A description of the purpose of this API Gateway RestApi resource.

Required: No

Type: String

Update requires: No interruption

EndpointConfiguration

A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.

Required: No

Type: EndpointConfiguration

Update requires: No interruption

FailOnWarnings

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

Required: No

Type: Boolean

Update requires: No interruption

MinimumCompressionSize

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Required: No

Type: Integer

Update requires: No interruption

Name

A name for the API Gateway RestApi resource.

Required: Conditional. Required if you don't specify a OpenAPI definition.

Type: String

Update requires: No interruption

Parameters

Custom header parameters for the request.

For more information on specifying parameters when importing an API, see import-rest-api operation in the AWS CLI Command Reference.

Required: No

Type: String to String map

Update requires: No interruption

Policy

A policy document that contains the permissions for this RestApi resource, in JSON format.

Required: No

Type: JSON object

Update requires: No interruption

Return Values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the RestApi ID, such as a1bcdef2gh.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. This section lists the available attribute and a sample return value.

RootResourceId

The root resource ID for a RestApi resource, such as a0bc123d4e.

For more information about using Fn::GetAtt, see Fn::GetAtt.

Examples

The following example creates an API Gateway RestApi resource based on an OpenAPI specification.

JSON

"MyRestApi": {
  "Type": "AWS::ApiGateway::RestApi",
  "Properties": {
    "Body": {
      OpenAPI specification
    }
    "Description": "A test API",
    "Name": "MyRestAPI"
  }
}

YAML

MyRestApi: 
  Type: AWS::ApiGateway::RestApi
  Properties:
    Body:
      OpenAPI specification    
    Description: "A test API"
    Name: "MyRestAPI"

The following example creates an API Gateway RestApi resource with an endpoint type.

JSON

{
  "Parameters": {
    "apiName": {
      "Type": "String"
    },
    "type": {
      "Type": "String"
    }
  },
  "Resources": {
    "MyRestApi": {
      "Type": "AWS::ApiGateway::RestApi",
      "Properties": {
        "EndpointConfiguration": {
          "Types": [
            {
              "Ref": "type"
            }
          ]
        },
        "Name": {
          "Ref": "apiName"
        }
      }
    }
  }
}

YAML

Parameters:
  apiName:
    Type: String
  type:
    Type: String
Resources:
  MyRestApi:
    Type: AWS::ApiGateway::RestApi
    Properties:
      EndpointConfiguration:
        Types:
          - !Ref type
      Name: !Ref apiName

The following example imports an API Gateway RestApi resource with an endpoint type of REGIONAL.

JSON

{
    "Resources": {
        "RestApi": {
            "Type": "AWS::ApiGateway::RestApi",
            "Properties": {
                "Body": {
                    "swagger": 2,
                    "info": {
                        "version": "0.0.1",
                        "title": "test"
                    },
                    "basePath": "/pete",
                    "schemes": [
                        "https"
                    ],
                    "definitions": {
                        "Empty": {
                            "type": "object"
                        }
                    }
                },
                "Name": "myApi",
                "Parameters": {
                    "endpointConfigurationTypes": "REGIONAL"
                }
            }
        }
    }
}

YAML

Resources :
    RestApi :
        Type : AWS::ApiGateway::RestApi
        Properties :
            Body :
                swagger : 2.0
                info :
                    version : 0.0.1
                    title : test
                basePath : /pete
                schemes :
                    - https
                definitions:
                    Empty :
                        type : object
            Name : myApi
            Parameters:
                endpointConfigurationTypes: REGIONAL

The following example creates an API Gateway RestApi resource with ApiKeySourceType, BinaryMediaTypes and MinimumCompressionSize.

JSON

{
    "Parameters": {
        "apiKeySourceType": {
            "Type": "String"
        },
        "apiName": {
            "Type": "String"
        },
        "binaryMediaType1": {
            "Type": "String"
        },
        "binaryMediaType2": {
            "Type": "String"
        },
        "minimumCompressionSize": {
            "Type": "String"
        }
    },
    "Resources": {
        "MyRestApi": {
            "Type": "AWS::ApiGateway::RestApi",
            "Properties": {
                "ApiKeySourceType": {
                    "Ref": "apiKeySourceType"
                },
                "BinaryMediaTypes": [
                    {
                        "Ref": "binaryMediaType1"
                    },
                    {
                        "Ref": "binaryMediaType2"
                    }
                ],
                "MinimumCompressionSize": {
                    "Ref": "minimumCompressionSize"
                },
                "Name": {
                    "Ref": "apiName"
                }
            }
        }
    }
}

YAML

Parameters:
    apiKeySourceType:
        Type: String
    apiName:
        Type: String
    binaryMediaType1:
        Type: String
    binaryMediaType2:
        Type: String
    minimumCompressionSize:
        Type: String
Resources:
    MyRestApi:
        Type: AWS::ApiGateway::RestApi
        Properties:
            ApiKeySourceType: !Ref apiKeySourceType
            BinaryMediaTypes:
                - !Ref binaryMediaType1
                - !Ref binaryMediaType2
            MinimumCompressionSize: !Ref minimumCompressionSize
            Name: !Ref apiName

See Also