---
type: resource-type
title: ServerlessApi
description: aws resource type AWS::Serverless::Api
name: ServerlessApi
lexicon: aws
resource_type: AWS::Serverless::Api
---
`AWS::Serverless::Api`, a resource type of the aws lexicon.

## Properties

- `StageName` (`string`, required)
- `AccessLogSetting` (`any`, optional)
- `Auth` (`ServerlessApi_Auth`, optional)
- `BinaryMediaTypes` (`string[]`, optional)
- `CacheClusterEnabled` (`boolean`, optional)
- `CacheClusterSize` (`string`, optional)
- `CanarySetting` (`any`, optional)
- `Cors` (`any`, optional)
- `DefinitionBody` (`any`, optional)
- `DefinitionUri` (`any`, optional)
- `EndpointConfiguration` (`string`, optional)
- `GatewayResponses` (`Record<string, unknown>`, optional)
- `MethodSettings` (`any[]`, optional)
- `MinimumCompressionSize` (`number`, optional)
- `Name` (`string`, optional)
- `OpenApiVersion` (`string`, optional)
- `Tags` (`Record<string, unknown>`, optional)
- `TracingEnabled` (`boolean`, optional)
- `Variables` (`Record<string, unknown>`, optional)

## Attributes

- `RootResourceId`