RouteConfiguration

Sintaksis

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

YAML

ApiKeyRequired: Boolean
FunctionArn: String
IntegrationTimeout: Integer
ModelSelectionExpression: String
OperationName: String
RequestModels: Json
RequestParameters: Json
RouteResponseSelectionExpression: String

Sifat-sifat

ApiKeyRequired

Menentukan apakah kunci API diperlukan untuk rute ini.

Tipe: Boolean

Wajib: Tidak

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

FunctionArn

ARN dari fungsi Lambda yang menangani rute ini. AWS SAM membuat integrasi dan izin yang diperlukan untuk API Gateway untuk menjalankan fungsi.

Tipe: String

Wajib: Ya

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

IntegrationTimeout

Batas waktu untuk integrasi, dalam milidetik. Nilai maksimumnya adalah 29.000 milidetik (29 detik).

Tipe: Integer

Wajib: Tidak

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

ModelSelectionExpression

Ekspresi pemilihan model untuk rute.

Tipe: String

Wajib: Tidak

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

OperationName

Nama operasi untuk rute.

Tipe: String

Wajib: Tidak

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

RequestModels

Model permintaan untuk rute.

Jenis: Json

Wajib: Tidak

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

RequestParameters

Parameter permintaan untuk rute.

Jenis: Json

Wajib: Tidak

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

RouteResponseSelectionExpression

Ekspresi pemilihan tanggapan rute untuk rute.

Tipe: String

Wajib: Tidak

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

Contoh

Rute Sederhana

Contoh berikut mengkonfigurasi rute sederhana.

Routes:
  $connect:
    FunctionArn: !GetAtt ConnectFunction.Arn
  sendMessage:
    FunctionArn: !GetAtt SendMessageFunction.Arn
    OperationName: SendMessage