View a markdown version of this page

CloudFormation AWS::Serverless::WebSocketApi가 지정될 때 생성되는 리소스 - AWS Serverless Application Model
인증 속성은 AuthType이 사용자 지정으로 설정된 상태로 지정됩니다.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::Route AWS::ApiGatewayV2::Integration및 AWS::Lambda::Permission 리소스를 AWS SAM 생성합니다.

AWS::ApiGatewayV2::Api

LogicalId: <websocketapi‑LogicalId>

참조 가능한 속성: N/A(이 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.

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

AWS::ApiGatewayV2::Integration

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

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

AWS::Lambda::Permission

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

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

이러한 CloudFormation 리소스 외에도이 지정되면 AWS::Serverless::WebSocketApi는 다음 시나리오에 대한 CloudFormation 리소스 AWS SAM 도 생성합니다.

인증 속성은 AuthType이 사용자 지정으로 설정된 상태로 지정됩니다.

의 Auth 속성AWS::Serverless::WebSocketApi이 로 AuthType 설정된 상태로 지정되면가 AWS::ApiGatewayV2::Authorizer CloudFormation 리소스를 CUSTOM AWS SAM 생성합니다. InvokeRole를 지정하지 않으면 API Gateway가 권한 부여자 함수를 호출할 수 있는 AWS::Lambda::Permission 리소스 AWS SAM 도 생성됩니다.

AWS::ApiGatewayV2::Authorizer

LogicalId: <websocketapi‑LogicalId>Authorizer

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

AWS::Lambda::Permission (InvokeRole이 지정되지 않은 경우)

LogicalId: <websocketapi‑LogicalId>AuthorizerPermission

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

DomainName 속성이 지정되었습니다.

의 DomainName 속성 Domain 속성이 지정되면 AWS::Serverless::WebSocketApi가 AWS::ApiGatewayV2::DomainName CloudFormation 리소스를 AWS SAM 생성합니다.

AWS::ApiGatewayV2::DomainName

LogicalId: ApiGatewayDomainNameV2<sha>

<sha>은 스택이 만들어질 때 생성되는 고유한 해시 값입니다. 예를 들어 ApiGatewayDomainNameV2926eeb5ff1입니다.

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

BasePath 속성이 지정됨

의 BasePath 속성 Domain 속성AWS::Serverless::WebSocketApi이 지정되면 지정된 각 기본 경로에 대해 하나씩 AWS::ApiGatewayV2::ApiMapping CloudFormation 리소스를 AWS SAM 생성합니다.

AWS::ApiGatewayV2::ApiMapping

LogicalId: <websocketapi‑LogicalId><basepath>ApiMapping

<basepath>는 기본 경로 값입니다. 예를 들어를 기본 경로v1로 지정하면는 LogicalId입니다MyWebSocketApiv1ApiMapping.

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)

Route53 속성이 지정됨

의 Route53 속성 Domain 속성이 지정되면 AWS::Serverless::WebSocketApi가 AWS::Route53::RecordSetGroup CloudFormation 리소스를 AWS SAM 생성합니다.

AWS::Route53::RecordSetGroup

LogicalId: RecordSetGroup<sha>

<sha>은 스택이 만들어질 때 생성되는 고유한 해시 값입니다. 예를 들어 RecordSetGroup926eeb5ff1입니다.

참조 가능한 속성: N/A(이 CloudFormation 리소스를 참조LogicalId하려면를 사용해야 함)