Ejemplo de clave de API - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplo de clave de API

Puede controlar el acceso a sus API exigiendo claves de API en su AWS SAM plantilla. Para ello, utilice el tipo de datos ApiAuth.

A continuación, se muestra un ejemplo de una sección AWS SAM de plantillas para las claves de API:

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Auth:
        ApiKeyRequired: true # sets for all methods

  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: .
      Handler: index.handler
      Runtime: nodejs12.x
      Events:
        ApiKey:
          Type: Api
          Properties:
            RestApiId: !Ref MyApi
            Path: /
            Method: get
            Auth:
              ApiKeyRequired: true

Para obtener más información sobre claves de API, consulte el tema Creación y utilización de planes de uso de claves API en la Guía para desarrolladores de API Gateway.