AWS::ApiGatewayV2::Api BodyS3Location - Amazon CloudFormation
SyntaxProperties
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::ApiGatewayV2::Api BodyS3Location

The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.

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 S3 bucket that contains the OpenAPI definition to import. Required if you specify a BodyS3Location for an API.

Required: Conditional

Type: String

Update requires: No interruption

Etag

The Etag of the S3 object.

Required: No

Type: String

Update requires: No interruption

Key

The key of the S3 object. Required if you specify a BodyS3Location for an API.

Required: Conditional

Type: String

Update requires: No interruption

Version

The version of the S3 object.

Required: No

Type: String

Update requires: No interruption