WebSocketApiDomainConfiguration

Configura um domínio personalizado para uma WebSocket API.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

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

Propriedades

BasePath

Uma lista dos caminhos básicos a serem configurados com o nome de domínio do Amazon API Gateway.

Tipo: lista

Obrigatório: não

Padrão: /

CloudFormation compatibilidade: essa propriedade é semelhante à ApiMappingKey propriedade de um AWS::ApiGatewayV2::ApiMapping recurso. AWS SAM cria vários AWS::ApiGatewayV2::ApiMapping recursos, um por valor especificado nessa propriedade.

CertificateArn

O Amazon Resource Name (ARN) de um certificado AWS gerenciado para o endpoint desse nome de domínio. AWS Certificate Manager é a única fonte compatível.

Tipo: string

Obrigatório: Sim

CloudFormation compatibilidade: essa propriedade é passada diretamente para a CertificateArn propriedade de um AWS::ApiGatewayV2::DomainName DomainNameConfiguration recurso.

DomainName

O nome de domínio personalizado para sua API do WebSocket API Gateway. Letras maiúsculas não são compatíveis.

AWS SAM gera um AWS::ApiGatewayV2::DomainName recurso quando essa propriedade é definida. Para obter informações sobre CloudFormation os recursos gerados, consulteCloudFormation Recursos gerados para AWS SAM.

Tipo: string

Obrigatório: Sim

CloudFormation compatibilidade: essa propriedade é passada diretamente para a DomainName propriedade de um AWS::ApiGatewayV2::DomainName recurso.

EndpointConfiguration

Define o tipo de endpoint do API Gateway a ser mapeado para o domínio personalizado. O valor dessa propriedade determina como a CertificateArn propriedade é mapeada CloudFormation.

O único valor válido para WebSocket APIs éREGIONAL.

Tipo: string

Obrigatório: não

Padrão: REGIONAL

CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

Route53

Define uma configuração do Route 53.

Tipo:: Route53Configuration

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

SecurityPolicy

A versão da política de segurança da TLS para esse nome de domínio.

O único valor válido para WebSocket APIs éTLS_1_2.

Tipo: string

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a SecurityPolicy propriedade do tipo de AWS::ApiGatewayV2::DomainName DomainNameConfiguration dados.

Exemplos

DomainName

DomainName exemplo

YAML

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