View a markdown version of this page

CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::WebSocketApi ditentukan - AWS Serverless Application Model
Properti autentikasi ditentukan dengan AuthType diatur ke CUSTOMDomainName properti ditentukanBasePath properti ditentukanProperti Route53 ditentukan

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

CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::WebSocketApi ditentukan

Ketika AWS::Serverless::WebSocketApi ditentukan, AWS Serverless Application Model (AWS SAM) menghasilkan sumber CloudFormation daya AWS::ApiGatewayV2::Api dasar. Selain itu, ia juga selalu menghasilkan AWS::ApiGatewayV2::Stage sumber daya, dan untuk setiap rute yang ditentukan dalam Routes properti, AWS SAM menghasilkan AWS::ApiGatewayV2::RouteAWS::ApiGatewayV2::Integration, dan AWS::Lambda::Permission sumber daya.

AWS::ApiGatewayV2::Api

LogicalId: <websocketapi‑LogicalId>

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

AWS::ApiGatewayV2::Stage

LogicalId: <websocketapi‑LogicalId><stage‑name>Stage

<stage‑name> adalah string dari properti StageName yang diatur kepadanya. Jika tidak StageName ditentukan, nilai defaultnya adalahdefault. Misalnya, jika Anda mengatur StageName ke prod, sehingga LogicalId adalah MyWebSocketApiprodStage.

Properti yang dapat direferensikan: <websocketapi‑LogicalId>.Stage

AWS::ApiGatewayV2::Route

LogicalId: <websocketapi‑LogicalId><normalized‑route‑key>Route

<normalized‑route‑key>adalah kunci rute dengan karakter khusus dihapus. Misalnya, untuk kunci rute$connect, LogicalId adalahMyWebSocketApiconnectRoute.

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

AWS::ApiGatewayV2::Integration

LogicalId: <websocketapi‑LogicalId><normalized‑route‑key>Integration

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

AWS::Lambda::Permission

LogicalId: <websocketapi‑LogicalId><normalized‑route‑key>Permission

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

Selain CloudFormation sumber daya ini, ketika AWS::Serverless::WebSocketApi ditentukan, AWS SAM juga menghasilkan CloudFormation sumber daya untuk skenario berikut:

Properti autentikasi ditentukan dengan AuthType diatur ke CUSTOM

Ketika Auth properti dari AWS::Serverless::WebSocketApi ditentukan dengan AuthType set toCUSTOM, AWS SAM menghasilkan AWS::ApiGatewayV2::Authorizer CloudFormation sumber daya. Jika tidak InvokeRole ditentukan, buat AWS SAM juga AWS::Lambda::Permission sumber daya untuk memungkinkan API Gateway menjalankan fungsi otorisasi.

AWS::ApiGatewayV2::Authorizer

LogicalId: <websocketapi‑LogicalId>Authorizer

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

AWS::Lambda::Permission(kapan InvokeRole tidak ditentukan)

LogicalId: <websocketapi‑LogicalId>AuthorizerPermission

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

DomainName properti ditentukan

Ketika DomainName properti Domain properti AWS::Serverless::WebSocketApi ditentukan, AWS SAM menghasilkan AWS::ApiGatewayV2::DomainName CloudFormation sumber daya.

AWS::ApiGatewayV2::DomainName

LogicalId: ApiGatewayDomainNameV2<sha>

<sha> adalah nilai hash unik yang dibuat ketika tumpukan dibuat. Sebagai contoh: ApiGatewayDomainNameV2926eeb5ff1.

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

BasePath properti ditentukan

Ketika BasePath properti properti AWS::Serverless::WebSocketApi ditentukan, AWS SAM menghasilkan AWS::ApiGatewayV2::ApiMapping CloudFormation sumber daya, satu untuk setiap jalur dasar yang ditentukan. Domain

AWS::ApiGatewayV2::ApiMapping

LogicalId: <websocketapi‑LogicalId><basepath>ApiMapping

<basepath>adalah nilai jalur dasar. Misalnya, jika Anda menentukan v1 sebagai jalur dasar, LogicalId adalahMyWebSocketApiv1ApiMapping.

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation

Properti Route53 ditentukan

Ketika Route53 properti Domain properti AWS::Serverless::WebSocketApi ditentukan, AWS SAM menghasilkan sumber AWS::Route53::RecordSetGroup CloudFormation daya.

AWS::Route53::RecordSetGroup

LogicalId: RecordSetGroup<sha>

<sha> adalah nilai hash unik yang dibuat ketika tumpukan dibuat. Sebagai contoh: RecordSetGroup926eeb5ff1.

Properti yang dapat direferensikan: N/A (Anda harus menggunakan LogicalId untuk referensi sumber daya ini) CloudFormation