DomainConfiguration - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

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

Konfiguriert eine benutzerdefinierte Domain für eine. API

Syntax

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

Eigenschaften

BasePath

Eine Liste der Basepfade, die mit dem Amazon API Gateway-Domänennamen konfiguriert werden sollen.

Typ: Liste

Required: No

Standard:/

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der BasePath Eigenschaft einer AWS::ApiGateway::BasePathMapping Ressource. AWS SAM erstellt mehrere AWS::ApiGateway::BasePathMapping Ressourcen, eine pro, die in dieser Eigenschaft BasePath angegeben ist.

NormalizeBasePath

Gibt an, ob in Basepfaden, die durch die Eigenschaft definiert sind, nicht-alphanumerische Zeichen 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

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

CertificateArn

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

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der CertificateArn Eigenschaft einer AWS::ApiGateway::DomainName Ressource. Wenn auf REGIONAL (der Standardwert) gesetzt EndpointConfiguration ist, CertificateArn wird RegionalCertificateArnin zugeordnetAWS::ApiGateway::DomainName. Wenn der auf gesetzt EndpointConfiguration istEDGE, CertificateArn wird CertificateArnin zugeordnetAWS::ApiGateway::DomainName.

Zusätzliche Hinweise: Für einen EDGE Endpunkt müssen Sie das Zertifikat in der us-east-1 AWS Region erstellen.

DomainName

Der benutzerdefinierte Domainname für Ihr API GatewayAPI. Großbuchstaben werden nicht unterstützt.

AWS SAM generiert eine AWS::ApiGateway::DomainNameRessource, wenn diese Eigenschaft festgelegt ist. Hinweise zu diesem Szenario finden Sie unterDomainNameEigenschaft ist angegeben. Hinweise zu generierten AWS CloudFormation Ressourcen finden Sie unterGenerierte AWS CloudFormation Ressourcen für AWS SAM.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die DomainName Eigenschaft einer AWS::ApiGateway::DomainName Ressource übergeben.

EndpointConfiguration

Definiert den Typ des API Gateway-Endpunkts, der der benutzerdefinierten Domäne zugeordnet werden soll. Der Wert dieser Eigenschaft bestimmt, wie die CertificateArn Eigenschaft zugeordnet wird. AWS CloudFormation

Zulässige Werte: REGIONAL oder EDGE.

Typ: Zeichenfolge

Required: No

Standardwert: REGIONAL

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

MutualTlsAuthentication

Die Konfiguration der gegenseitigen Transport Layer Security (TLS) -Authentifizierung für einen benutzerdefinierten Domainnamen.

Typ: MutualTlsAuthentication

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die MutualTlsAuthentication Eigenschaft einer AWS::ApiGateway::DomainName Ressource übergeben.

OwnershipVerificationCertificateArn

Das öffentliche Zertifikat, das ARN von ausgestellt wurdeACM, um die Inhaberschaft Ihrer benutzerdefinierten Domain zu bestätigen. Nur erforderlich, wenn Sie Mutual konfigurieren TLS und ein ACM importiertes oder privates CA-Zertifikat ARN für angebenCertificateArn.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die OwnershipVerificationCertificateArn Eigenschaft einer AWS::ApiGateway::DomainName Ressource übergeben.

Route53

Definiert eine Amazon Route 53-Konfiguration.

Typ: Route53-Konfiguration

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. AWS CloudFormation

SecurityPolicy

Die TLS Version plus Cipher Suite für diesen Domainnamen.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die SecurityPolicy Eigenschaft einer AWS::ApiGateway::DomainName Ressource übergeben.

Beispiele

DomainName

DomainName Beispiel

YAML

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