WebSocketApiDomainConfiguration

Configura un dominio personalizado para una WebSocket API.

Sintaxis

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

YAML

  BasePath: List
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  Route53: Route53Configuration
  SecurityPolicy: String

Propiedades

BasePath

Una lista de las rutas base que se deben configurar con el nombre de dominio de Amazon API Gateway.

Tipo: lista

Obligatorio: no

Valor predeterminado: /

CloudFormation compatibilidad: esta propiedad es similar a la ApiMappingKey propiedad de un AWS::ApiGatewayV2::ApiMapping recurso. AWS SAM crea varios AWS::ApiGatewayV2::ApiMapping recursos, uno por cada valor especificado en esta propiedad.

CertificateArn

El nombre de recurso de Amazon (ARN) de un certificado AWS administrado para el punto final de este nombre de dominio. AWS Certificate Manager es la única fuente compatible.

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: esta propiedad se pasa directamente a la CertificateArn propiedad de un AWS::ApiGatewayV2::DomainName DomainNameConfiguration recurso.

DomainName

El nombre de dominio personalizado de tu API WebSocket API Gateway. No se admiten letras mayúsculas.

AWS SAM genera un AWS::ApiGatewayV2::DomainName recurso cuando se establece esta propiedad. Para obtener información sobre CloudFormation los recursos generados, consulteCloudFormation Recursos generados para AWS SAM.

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la DomainName propiedad de un AWS::ApiGatewayV2::DomainName recurso.

EndpointConfiguration

Define el tipo de punto de conexión de API Gateway que se va a asignar al dominio personalizado. El valor de esta propiedad determina cómo se mapea la CertificateArn propiedad. CloudFormation

El único valor válido para WebSocket APIs esREGIONAL.

Tipo: cadena

Obligatorio: no

Valor predeterminado: REGIONAL

CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

Route53

Define una configuración de Route 53.

Tipo: Route53Configuration

Obligatorio: no

CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.

SecurityPolicy

La versión TLS de la política de seguridad para este nombre de dominio.

El único valor válido para WebSocket APIs esTLS_1_2.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la SecurityPolicy propiedad del tipo de AWS::ApiGatewayV2::DomainName DomainNameConfiguration datos.

Ejemplos

DomainName

DomainName ejemplo

YAML

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