翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# RouteConfiguration
<a name="sam-property-websocketapi-routeconfiguration"></a>

## 構文
<a name="sam-property-websocketapi-routeconfiguration-syntax"></a>

 AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

### YAML
<a name="sam-property-websocketapi-routeconfiguration-syntax.yaml"></a>

```
[ApiKeyRequired](#sam-routeconfiguration-apikeyrequired): {{Boolean}}
[FunctionArn](#sam-routeconfiguration-functionarn): {{String}}
[IntegrationTimeout](#sam-routeconfiguration-integrationtimeout): {{Integer}}
[ModelSelectionExpression](#sam-routeconfiguration-modelselectionexpression): {{String}}
[OperationName](#sam-routeconfiguration-operationname): {{String}}
[RequestModels](#sam-routeconfiguration-requestmodels): {{Json}}
[RequestParameters](#sam-routeconfiguration-requestparameters): {{Json}}
[RouteResponseSelectionExpression](#sam-routeconfiguration-routeresponseselectionexpression): {{String}}
```

## プロパティ
<a name="sam-property-websocketapi-routeconfiguration-properties"></a>

 `ApiKeyRequired`   <a name="sam-routeconfiguration-apikeyrequired"></a>
このルートに API キーが必要かどうかを指定します。  
型: ブール  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Route`リソースの `[ApiKeyRequired](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired)`プロパティに直接渡されます。

 `FunctionArn`   <a name="sam-routeconfiguration-functionarn"></a>
このルートを処理する Lambda 関数の ARN。 は、統合と、API Gateway が関数を呼び出すために必要なアクセス許可 AWS SAM を作成します。  
*タイプ*: 文字列  
*必須*: はい  
*CloudFormation 互換性*: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

 `IntegrationTimeout`   <a name="sam-routeconfiguration-integrationtimeout"></a>
統合のタイムアウトをミリ秒単位で表します。最大値は 29,000 ミリ秒 (29 秒) です。  
*タイプ:* 整数  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Integration`リソースの `[TimeoutInMillis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis)`プロパティに直接渡されます。

 `ModelSelectionExpression`   <a name="sam-routeconfiguration-modelselectionexpression"></a>
ルートのモデル選択式です。  
*タイプ*: 文字列  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Route`リソースの `[ModelSelectionExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression)`プロパティに直接渡されます。

 `OperationName`   <a name="sam-routeconfiguration-operationname"></a>
ルートのオペレーション名です。  
*タイプ*: 文字列  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Route`リソースの `[OperationName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname)`プロパティに直接渡されます。

 `RequestModels`   <a name="sam-routeconfiguration-requestmodels"></a>
ルートのリクエストモデルです。  
型: Json  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Route`リソースの `[RequestModels](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels)`プロパティに直接渡されます。

 `RequestParameters`   <a name="sam-routeconfiguration-requestparameters"></a>
ルートのリクエストパラメータです。  
型: Json  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Route`リソースの `[RequestParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters)`プロパティに直接渡されます。

 `RouteResponseSelectionExpression`   <a name="sam-routeconfiguration-routeresponseselectionexpression"></a>
ルートのルートレスポンス選択式です。  
*タイプ*: 文字列  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::Route`リソースの `[RouteResponseSelectionExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression)`プロパティに直接渡されます。

## 例
<a name="sam-property-websocketapi-routeconfiguration-examples"></a>

### シンプルなルート
<a name="sam-property-websocketapi-routeconfiguration-examples-simple"></a>

次の の例では、シンプルなルートを設定します。

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