

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.

# HttpApiDefinition
<a name="sam-property-httpapi-httpapidefinition"></a>

Ein OpenAPI-Dokument, das die API definiert.

## Syntax
<a name="sam-property-httpapi-httpapidefinition-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-httpapidefinition-syntax.yaml"></a>

```
  [Bucket](#sam-httpapi-httpapidefinition-bucket): String
  [Key](#sam-httpapi-httpapidefinition-key): String
  [Version](#sam-httpapi-httpapidefinition-version): String
```

## Eigenschaften
<a name="sam-property-httpapi-httpapidefinition-properties"></a>

 `Bucket`   <a name="sam-httpapi-httpapidefinition-bucket"></a>
Der Name des Amazon S3 S3-Buckets, in dem die OpenAPI-Datei gespeichert ist.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket)` Eigenschaft des `AWS::ApiGatewayV2::Api` `BodyS3Location` Datentyps übergeben.

 `Key`   <a name="sam-httpapi-httpapidefinition-key"></a>
Der Amazon S3 S3-Schlüssel der OpenAPI-Datei.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key)` Eigenschaft des `AWS::ApiGatewayV2::Api` `BodyS3Location` Datentyps übergeben.

 `Version`   <a name="sam-httpapi-httpapidefinition-version"></a>
Für versionierte Objekte die Version der OpenAPI-Datei.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version)` Eigenschaft des `AWS::ApiGatewayV2::Api` `BodyS3Location` Datentyps übergeben.

## Beispiele
<a name="sam-property-httpapi-httpapidefinition--examples"></a>

### Definition: Uri, Beispiel
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example"></a>

Beispiel für eine API-Definition

#### YAML
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example--yaml"></a>

```
DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```