View a markdown version of this page

WebSocketApiDomainConfiguration - AWS Serverless Application Model
SintaksisSifat-sifatContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

WebSocketApiDomainConfiguration

Mengonfigurasi domain kustom untuk WebSocket API.

Sintaksis

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

Sifat-sifat

BasePath

Daftar basepaths untuk mengonfigurasi dengan nama domain Amazon API Gateway.

Tipe: Daftar

Wajib: Tidak

Default:/

CloudFormation kompatibilitas: Properti ini mirip dengan ApiMappingKey properti AWS::ApiGatewayV2::ApiMapping sumber daya. AWS SAM menciptakan beberapa AWS::ApiGatewayV2::ApiMapping sumber daya, satu per nilai yang ditentukan dalam properti ini.

CertificateArn

Nama Sumber Daya Amazon (ARN) dari sertifikat AWS terkelola untuk titik akhir nama domain ini. AWS Certificate Manager adalah satu-satunya sumber yang didukung.

Tipe: String

Wajib: Ya

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke CertificateArn properti AWS::ApiGatewayV2::DomainName DomainNameConfiguration sumber daya.

DomainName

Nama domain kustom untuk API Gateway WebSocket API Anda. Huruf kapital tidak didukung.

AWS SAM menghasilkan sumber AWS::ApiGatewayV2::DomainName daya saat properti ini disetel. Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihatCloudFormation Sumber daya yang dihasilkan untuk AWS SAM.

Tipe: String

Wajib: Ya

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke DomainName properti AWS::ApiGatewayV2::DomainName sumber daya.

EndpointConfiguration

Menentukan tipe titik akhir API Gateway untuk memetakan ke domain kustom. Nilai properti ini menentukan bagaimana CertificateArn properti dipetakan. CloudFormation

Satu-satunya nilai yang valid untuk WebSocket APIs adalahREGIONAL.

Tipe: String

Wajib: Tidak

Default: REGIONAL

CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

Route53

Mendefinisikan konfigurasi Route 53.

Tipe:Route53Configuration

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

SecurityPolicy

Versi TLS kebijakan keamanan untuk nama domain ini.

Satu-satunya nilai yang valid untuk WebSocket APIs adalahTLS_1_2.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke SecurityPolicy properti tipe AWS::ApiGatewayV2::DomainName DomainNameConfiguration data.

Contoh

DomainName

DomainName contoh

YAML

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