An OpenAPI document defining the API.
To declare this entity in your AWS Serverless Application Model (AWS SAM) template, use the following syntax.
[Bucket](#sam-httpapi-httpapidefinition-bucket): String
[Key](#sam-httpapi-httpapidefinition-key): String
[Version](#sam-httpapi-httpapidefinition-version): String
Bucket
The name of the Amazon S3 bucket where the OpenAPI file is stored.
Type: String
Required: Yes
AWS CloudFormation compatibility: This property is passed directly to the [Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket)
property of the AWS::ApiGatewayV2::Api
BodyS3Location
data type.
Key
The Amazon S3 key of the OpenAPI file.
Type: String
Required: Yes
AWS CloudFormation compatibility: This property is passed directly to the [Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key)
property of the AWS::ApiGatewayV2::Api
BodyS3Location
data type.
Version
For versioned objects, the version of the OpenAPI file.
Type: String
Required: No
AWS CloudFormation compatibility: This property is passed directly to the [Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version)
property of the AWS::ApiGatewayV2::Api
BodyS3Location
data type.
API Definition example
DefinitionUri:
Bucket: mybucket-name
Key: mykey-name
Version: 121212