View a markdown version of this page

WebSocketApiDomainConfiguration - 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.

WebSocketApiDomainConfiguration

Konfiguriert eine benutzerdefinierte Domain für eine WebSocket 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 Gateway-Domänennamen konfiguriert werden sollen.

Typ: Liste

Required: No

Standard:/

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der ApiMappingKey Eigenschaft einer AWS::ApiGatewayV2::ApiMapping Ressource. AWS SAM erstellt mehrere AWS::ApiGatewayV2::ApiMapping Ressourcen, eine pro Wert, der in dieser Eigenschaft angegeben ist.

CertificateArn

Der Amazon-Ressourcenname (ARN) eines AWS verwalteten Zertifikats für den Endpunkt dieses Domainnamens. AWS Certificate Manager ist die einzige unterstützte Quelle.

Typ: Zeichenfolge

Erforderlich: Ja

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

DomainName

Der benutzerdefinierte Domainname für Ihre WebSocket API-Gateway-API. Großbuchstaben werden nicht unterstützt.

AWS SAM generiert eine AWS::ApiGatewayV2::DomainName Ressource, wenn diese Eigenschaft festgelegt ist. Hinweise zu generierten CloudFormation Ressourcen finden Sie unterGenerierte CloudFormation Ressourcen für AWS SAM.

Typ: Zeichenfolge

Erforderlich: Ja

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

EndpointConfiguration

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

Der einzig gültige Wert für WebSocket APIs istREGIONAL.

Typ: Zeichenfolge

Required: No

Standardwert: REGIONAL

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

Route53

Definiert eine Route 53-Konfiguration.

Typ: Route53-Konfiguration

Required: No

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

SecurityPolicy

Die TLS-Version der Sicherheitsrichtlinie für diesen Domainnamen.

Der einzig gültige Wert für WebSocket APIs istTLS_1_2.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die SecurityPolicy Eigenschaft des AWS::ApiGatewayV2::DomainName DomainNameConfiguration Datentyps übergeben.

Beispiele

DomainName

DomainName Beispiel

YAML

Domain:
  DomainName: ws.example.com
  CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - v1
    - v2