AWS::ApiGateway::RestApi S3Location - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ApiGateway::RestApi S3Location

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

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 Amazon CloudFormation template, use the following 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

Update requires: No interruption

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

Update requires: No interruption

Key

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

Required: No

Type: String

Update requires: No interruption

Version

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

Required: No

Type: String

Update requires: No interruption

See also

  • RestApi in the Amazon API Gateway REST API Reference