AWS-Variablen für OpenAPI-Import - Amazon API Gateway
Beispiel für AWS-Variablen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS-Variablen für OpenAPI-Import

Sie können die folgenden AWS-Variablen in OpenAPI-Definitionen verwenden. API Gateway löst die Variablen auf, wenn die API importiert wird. Um eine Variable anzugeben, verwenden Sie ${variable-name}. In der folgenden Tabelle werden die verfügbaren AWS-Variablen beschrieben.

Variablenname Beschreibung
AWS::AccountId Die AWS-Konto-ID für den API-Import. Zum Beispiel: 123456789012.
AWS::Partition Die AWS-Partition, in die die API importiert wird. Für AWS-Standardregionen lautet die Partition aws.
AWS::Region Die AWS-Region, in die die API importiert wird. Beispiel, us-east-2.

Beispiel für AWS-Variablen

Im folgenden Beispiel werden AWS-Variablen verwendet, um eine AWS Lambda-Funktion für eine Integration anzugeben.

OpenAPI 3.0
openapi: "3.0.1"
info:
  title: "tasks-api"
  version: "v1.0"
paths:
  /:
    get:
      summary: List tasks
      description: Returns a list of tasks
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
        500:
          description: "Internal Server Error"
          content: {}
      x-amazon-apigateway-integration:
        uri:
          arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:LambdaFunctionName/invocations
        responses:
          default:
            statusCode: "200"
        passthroughBehavior: "when_no_match"
        httpMethod: "POST"
        contentHandling: "CONVERT_TO_TEXT"
        type: "aws_proxy"
components:
  schemas:
    Task:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string