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 » Amazon API Gateway RestApi S3Location

Amazon API Gateway RestApi S3Location

S3Location is a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon Simple Storage Service (Amazon S3) location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML for an Amazon API Gateway (API Gateway) RestApi.

Note

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

Syntax

JSON

{
  "Bucket" : String,
  "ETag" : String,
  "Key" : String,
  "Version" : String
}

YAML

Bucket: String
ETag: String
Key: String
Version: String

Properties

Bucket

The name of the S3 bucket where the OpenAPI file is stored.

Required: No

Type: String

ETag

The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.

Required: No

Type: String

Key

The file name of the OpenAPI file (Amazon S3 object name).

Required: No

Type: String

Version

For versioning-enabled buckets, a specific version of the OpenAPI file.

Required: No

Type: String

On this page: