View a markdown version of this page

CloudFormation AWS::Serverless::WebSocketApi が指定されているときに生成される リソース - AWS Serverless Application Model
Auth プロパティは AuthType を CUSTOM に設定して指定しますDomainName プロパティが指定されているBasePath プロパティが指定されていますRoute53 プロパティが指定されています

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

CloudFormation AWS::Serverless::WebSocketApi が指定されているときに生成される リソース

AWS::Serverless::WebSocketApi を指定すると、 AWS Serverless Application Model (AWS SAM) は AWS::ApiGatewayV2::Api ベース CloudFormation リソースを生成します。さらに、常に AWS::ApiGatewayV2::Stageリソースを生成し、 Routesプロパティで定義されたルートごとに、、AWS::ApiGatewayV2::Integration、および AWS::ApiGatewayV2::RouteAWS::Lambda::Permissionリソース AWS SAM を生成します。

AWS::ApiGatewayV2::Api

LogicalId: <websocketapi‑LogicalId>

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

AWS::ApiGatewayV2::Stage

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

<stage‑name> は、StageName プロパティが設定されている文字列です。が指定されStageNameていない場合、デフォルト値は ですdefault。例えば、StageName を prod に設定とすると、LogicalId が MyWebSocketApiprodStage になります。

参照可能なプロパティ: <websocketapi‑LogicalId>.Stage

AWS::ApiGatewayV2::Route

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

<normalized‑route‑key> は、特殊文字が削除されたルートキーです。たとえば、ルートキー の場合$connect、 LogicalIdは ですMyWebSocketApiconnectRoute。

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

AWS::ApiGatewayV2::Integration

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

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

AWS::Lambda::Permission

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

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

これらの CloudFormation リソースに加えて、 を指定すると、 AWS::Serverless::WebSocketApiは次のシナリオの CloudFormation リソース AWS SAM も生成します。

Auth プロパティは AuthType を CUSTOM に設定して指定します

の AuthプロパティAWS::Serverless::WebSocketApiを AuthTypeに設定して指定するとCUSTOM、 は AWS::ApiGatewayV2::Authorizer CloudFormation リソース AWS SAM を生成します。が指定されていない場合、 InvokeRoleは API Gateway がオーソライザー関数を呼び出すことを許可する AWS::Lambda::Permissionリソース AWS SAM も生成します。

AWS::ApiGatewayV2::Authorizer

LogicalId: <websocketapi‑LogicalId>Authorizer

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

AWS::Lambda::Permission ( InvokeRoleが指定されていない場合)

LogicalId: <websocketapi‑LogicalId>AuthorizerPermission

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

DomainName プロパティが指定されている

の DomainNameプロパティの Domainプロパティを指定すると、 AWS::Serverless::WebSocketApiは AWS::ApiGatewayV2::DomainName CloudFormation リソース AWS SAM を生成します。

AWS::ApiGatewayV2::DomainName

LogicalId: ApiGatewayDomainNameV2<sha>

<sha> は、スタックが作成されるときに生成される一意のハッシュ値です。例: ApiGatewayDomainNameV2926eeb5ff1。

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

BasePath プロパティが指定されています

の BasePathプロパティの Domain プロパティを指定すると、 AWS::Serverless::WebSocketApiは指定されたベースパスごとに 1 つずつAWS::ApiGatewayV2::ApiMapping CloudFormation リソース AWS SAM を生成します。

AWS::ApiGatewayV2::ApiMapping

LogicalId: <websocketapi‑LogicalId><basepath>ApiMapping

<basepath> は基本パス値です。たとえば、ベースパスv1として を指定した場合、 LogicalIdは ですMyWebSocketApiv1ApiMapping。

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)

Route53 プロパティが指定されています

の Route53プロパティの Domainプロパティを指定すると、 AWS::Serverless::WebSocketApiは AWS::Route53::RecordSetGroup CloudFormation リソース AWS SAM を生成します。

AWS::Route53::RecordSetGroup

LogicalId: RecordSetGroup<sha>

<sha> は、スタックが作成されるときに生成される一意のハッシュ値です。例: RecordSetGroup926eeb5ff1。

参照可能なプロパティ: 該当なし (この CloudFormation リソースを参照LogicalIdするには を使用する必要があります)