

The source of the API key for metering requests according to a usage plan. To declare this entity in your AWS Serverless Application Model (AWS SAM) template, use the following syntax.Ĭonfigures Access Log Setting for a stage.ĪWS CloudFormation compatibility: This property is passed directly to the AccessLogSetting property of an AWS::ApiGateway::Stage resource. We recommend that you use AWS CloudFormation hooks or IAM policies to verify that API Gateway resources have authorizers attached to them to control access to them.įor more information about using AWS CloudFormation hooks, see Registering hooks in the AWS CloudFormation CLI user guide and the apigw-enforce-authorizer GitHub repository.įor more information about using IAM policies, see Require that API routes have authorization in the API Gateway Developer Guide. A resource of this type is implicitly created from the union of Api events defined on AWS::Serverless::Function resources defined in the template that do not refer to an AWS::Serverless::Api resource.Īn AWS::Serverless::Api resource should be used to define and document the API using OpenApi, which provides more ability to configure the underlying Amazon API Gateway resources. Creates a collection of Amazon API Gateway resources and methods that can be invoked through HTTPS endpoints.Īn AWS::Serverless::Api resource need not be explicitly added to a AWS Serverless Application Definition template.
