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.

# DomainConfiguration
<a name="sam-property-api-domainconfiguration"></a>

Konfiguriert eine benutzerdefinierte Domain für eine API.

## Syntax
<a name="sam-property-api-domainconfiguration-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-api-domainconfiguration-syntax.yaml"></a>

```
  [AccessAssociation](#sam-api-domainconfiguration-domainaccessassociation): DomainAccessAssociation
  [BasePath](#sam-api-domainconfiguration-basepath): List
  [CertificateArn](#sam-api-domainconfiguration-certificatearn): String
  [DomainName](#sam-api-domainconfiguration-domainname): String
  [EndpointConfiguration](#sam-api-domainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-api-domainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)
  [NormalizeBasePath](#sam-api-domainconfiguration-normalizebasepath): Boolean
  [OwnershipVerificationCertificateArn](#sam-api-domainconfiguration-ownershipverificationcertificatearn): String
  [Policy: ](#sam-api-domainconfiguration-policy)Json
  [Route53](#sam-api-domainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-api-domainconfiguration-securitypolicy): String
```

## Eigenschaften
<a name="sam-property-api-domainconfiguration-properties"></a>

 `AccessAssociation`   <a name="sam-api-domainconfiguration-domainaccessassociation"></a>
Die Konfiguration, die zum Generieren der ` AWS::ApiGateway::DomainNameAccessAssociation` Ressource erforderlich ist.  
AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html)Ressource, wenn diese Eigenschaft festgelegt ist. Hinweise zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* [DomainAccessAssociation](sam-property-api-domainaccessassociation.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `BasePath`   <a name="sam-api-domainconfiguration-basepath"></a>
Eine Liste der Basepfade, die mit dem Amazon API Gateway Gateway-Domänennamen konfiguriert werden sollen.  
*Typ*: Liste  
*Required*: No  
*Standard:/*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` Eigenschaft einer `AWS::ApiGateway::BasePathMapping` Ressource. AWS SAM erstellt mehrere `AWS::ApiGateway::BasePathMapping` Ressourcen, eine pro, die in dieser Eigenschaft `BasePath` angegeben ist.

 `CertificateArn`   <a name="sam-api-domainconfiguration-certificatearn"></a>
Der Amazon-Ressourcenname (ARN) eines AWS verwalteten Zertifikats, der Endpunkt dieses Domainnamens. AWS Certificate Manager ist die einzige unterstützte Quelle.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource. Wenn auf `REGIONAL` (der Standardwert) gesetzt `EndpointConfiguration` ist, `CertificateArn` wird [RegionalCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn)in zugeordnet`AWS::ApiGateway::DomainName`. Wenn der auf gesetzt `EndpointConfiguration` ist`EDGE`, `CertificateArn` wird [CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)in zugeordnet`AWS::ApiGateway::DomainName`. Wenn auf gesetzt `EndpointConfiguration` ist`PRIVATE`, wird diese Eigenschaft an die [AWS::ApiGateway::DomainNameV2-Ressource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2) übergeben.  
*Zusätzliche Hinweise*: Für einen `EDGE` Endpunkt müssen Sie das Zertifikat in der `us-east-1` AWS Region erstellen.

 `DomainName`   <a name="sam-api-domainconfiguration-domainname"></a>
Der benutzerdefinierte Domainname für Ihre API-Gateway-API. Großbuchstaben werden nicht unterstützt.  
AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html)Ressource, wenn diese Eigenschaft festgelegt ist. Hinweise zu diesem Szenario finden Sie unter[DomainName Eigenschaft ist angegeben](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-domain-name). Hinweise zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben, oder an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)when, auf gesetzt EndpointConfiguration ist`PRIVATE`.

 `EndpointConfiguration`   <a name="sam-api-domainconfiguration-endpointconfiguration"></a>
Definiert den Typ des API-Gateway-Endpunkts, der der benutzerdefinierten Domain zugeordnet werden soll. Der Wert dieser Eigenschaft bestimmt, wie die `CertificateArn` Eigenschaft zugeordnet wird. CloudFormation  
*Gültige Werte*: `EDGE`, `REGIONAL`, oder `PRIVATE`  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `REGIONAL`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MutualTlsAuthentication`   <a name="sam-api-domainconfiguration-mutualtlsauthentication"></a>
Die TLS-Authentifizierungskonfiguration (Mutual Transport Layer Security) für einen benutzerdefinierten Domainnamen.  
*Typ:* [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben.

 `NormalizeBasePath`   <a name="sam-api-domainconfiguration-normalizebasepath"></a>
Gibt an, ob nicht-alphanumerische Zeichen in den durch die Eigenschaft definierten Basepfaden zulässig sind. `BasePath` Wenn auf gesetzt, werden nicht-alphanumerische Zeichen aus `True` Basepfaden entfernt.  
Wird zusammen mit der Eigenschaft verwendet. `NormalizeBasePath` `BasePath`  
*Typ*: Boolesch  
*Required*: No  
*Standard*: Wahr  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `OwnershipVerificationCertificateArn`   <a name="sam-api-domainconfiguration-ownershipverificationcertificatearn"></a>
Die ARN des öffentlichen Zertifikats, das von ACM ausgestellt wurde, um den Besitz Ihrer benutzerdefinierten Domain zu überprüfen. Nur erforderlich, wenn Sie Mutual TLS konfigurieren und einen von ACM importierten oder privaten CA-Zertifikat-ARN für angeben. `CertificateArn`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben.

 `Policy`   <a name="sam-api-domainconfiguration-policy"></a>
Die IAM-Richtlinie, die an den API-Gateway-Domänennamen angehängt werden soll. Gilt nur, wenn auf `PRIVATE` eingestellt `EndpointConfiguration` ist.  
*Type*: Json  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `Policy` Eigenschaft einer `AWS::ApiGateway::DomainNameV2` Ressource übergeben, wenn sie auf gesetzt `EndpointConfiguration` ist`PRIVATE`. Beispiele für gültige Richtliniendokumente finden Sie unter [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2).

 `Route53`   <a name="sam-api-domainconfiguration-route53"></a>
Definiert eine Amazon Route 53-Konfiguration.  
*Typ*: [Route53-Konfiguration](sam-property-api-route53configuration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `SecurityPolicy`   <a name="sam-api-domainconfiguration-securitypolicy"></a>
Die TLS-Version plus die Cipher Suite für diesen Domainnamen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben, oder an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)when `EndpointConfiguration` ist auf gesetzt. `PRIVATE` Für `PRIVATE` Endgeräte wird nur TLS\$11\$12 unterstützt.

## Beispiele
<a name="sam-property-api-domainconfiguration--examples"></a>

### DomainName
<a name="sam-property-api-domainconfiguration--examples--domainname"></a>

DomainName Beispiel

#### YAML
<a name="sam-property-api-domainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```