View a markdown version of this page

WebSocketApiDomainConfiguration - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

WebSocketApiDomainConfiguration

Configure un domaine personnalisé pour une WebSocket API.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

Propriétés

BasePath

Une liste des chemins de base à configurer avec le nom de domaine Amazon API Gateway.

Type : liste

Obligatoire : non

Par défaut : /

CloudFormation compatibilité : cette propriété est similaire à celle ApiMappingKey d'une AWS::ApiGatewayV2::ApiMapping ressource. AWS SAM crée plusieurs AWS::ApiGatewayV2::ApiMapping ressources, une par valeur spécifiée dans cette propriété.

CertificateArn

Le nom de ressource Amazon (ARN) d'un certificat AWS géré pour le point de terminaison de ce nom de domaine. AWS Certificate Manager est la seule source prise en charge.

Type : chaîne

Obligatoire : oui

CloudFormation compatibilité : cette propriété est transmise directement à la CertificateArn propriété d'une AWS::ApiGatewayV2::DomainName DomainNameConfiguration ressource.

DomainName

Le nom de domaine personnalisé de votre API WebSocket API Gateway. Les majuscules ne sont pas prises en charge.

AWS SAM génère une AWS::ApiGatewayV2::DomainName ressource lorsque cette propriété est définie. Pour plus d'informations sur CloudFormation les ressources générées, consultezCloudFormation Ressources générées pour AWS SAM.

Type : chaîne

Obligatoire : oui

CloudFormation compatibilité : cette propriété est transmise directement à la DomainName propriété d'une AWS::ApiGatewayV2::DomainName ressource.

EndpointConfiguration

Définit le type de point de terminaison API Gateway à mapper au domaine personnalisé. La valeur de cette propriété détermine la manière dont la CertificateArn propriété est mappée CloudFormation.

La seule valeur valide pour WebSocket APIs estREGIONAL.

Type : chaîne

Obligatoire : non

Par défaut : REGIONAL

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

Route53

Définit une configuration Route 53.

Type : Route53Configuration

Obligatoire : non

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

SecurityPolicy

La version TLS de la stratégie de sécurité pour ce nom de domaine.

La seule valeur valide pour WebSocket APIs estTLS_1_2.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la SecurityPolicy propriété du type de AWS::ApiGatewayV2::DomainName DomainNameConfiguration données.

Exemples

DomainName

DomainName exemple

YAML

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