ApiDefinition - AWS Serverless Application Model
SyntaxPropertiesExamples
This documentation is a draft for private preview for regions in the AWS European Sovereign Cloud. Documentation content will continue to evolve. Published: January 2, 2026.

ApiDefinition

An OpenAPI document defining the API.

Syntax

To declare this entity in your AWS Serverless Application Model (AWS SAM) template, use the following syntax.

YAML

  Bucket: String
  Key: String
  Version: String

Properties

Bucket

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

Type: String

Required: Yes

CloudFormation compatibility: This property is passed directly to the Bucket property of the AWS::ApiGateway::RestApi S3Location data type.

Key

The Amazon S3 key of the OpenAPI file.

Type: String

Required: Yes

CloudFormation compatibility: This property is passed directly to the Key property of the AWS::ApiGateway::RestApi S3Location data type.

Version

For versioned objects, the version of the OpenAPI file.

Type: String

Required: No

CloudFormation compatibility: This property is passed directly to the Version property of the AWS::ApiGateway::RestApi S3Location data type.

Examples

Definition Uri example

API Definition example

YAML

DefinitionUri:
  Bucket: amzn-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212