SAM で API Gateway に API Key を設定する

この記事は、AWS Serverless Application Model (AWS SAM) で API Gateway の API Key を設定した際の記録です。

はじめに

• SAM では、API仕様を定義した Swagger を使用することで、API Gateway のリソースを作成できます

参考

• SwaggerをAWS Serverless Application Modelから扱う方法を理解する
• AWS Serverless Application Model (AWS SAM) とは
• Swagger

API Gateway の API に API Key を指定する

１．Swagger の securityDefinitions に apiKey を定義する

swagger.yml

securityDefinitions:

  SampleApiKey:
    type: apiKey
    name: x-api-key
    in: header

２．API Key を要求する path に対して security に apiKey を指定する

swagger.yml

paths:
  /pet:
    post:
      summary: "Add a new pet to the store"
      operationId: "addPet"
      security:
        - SampleApiKey: []

      （以下省略）

３．SAM の template で AWS::Serverless::Api に加えて以下のリソースを作成する
- AWS::ApiGateway::ApiKey
- AWS::ApiGateway::UsagePlan
- AWS::ApiGateway::UsagePlanKey

template.yml

  SampleApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      DefinitionUri: swagger.yml

  SampleApiKey:
    Type: AWS::ApiGateway::ApiKey
    DependsOn: SampleApi
    Properties: 
      Name: sample-api-key
      Enabled: true
      StageKeys: 
        - RestApiId: 
            Ref: SampleApi
          StageName: Prod

  SampleApiUsagePlan:
    Type: AWS::ApiGateway::UsagePlan
    DependsOn: SampleApi
    Properties:
      ApiStages:
      - ApiId: !Ref SampleApi
        Stage: !Ref SampleApiProdStage
        # AWS::Serverless::Api のリソース名 + AWS::Serverless::Api の 'StageName' + Stage 
      Throttle:
        BurstLimit: 200
        RateLimit: 100
      UsagePlanName: sample-api-usage-plan

  SampleApiUsagePlanKey:
    Type: AWS::ApiGateway::UsagePlanKey
    DependsOn:
      - SampleApiKey
      - SampleApiUsagePlan
    Properties : 
      KeyId: !Ref SampleApiKey
      KeyType: API_KEY
      UsagePlanId: !Ref SampleApiUsagePlan