

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# CloudFormation AWS::Serverless::WebSocketApi가 지정될 때 생성되는 리소스
<a name="sam-specification-generated-resources-websocketapi"></a>

`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`은 `{{MyWebSocketApi}}prodStage`가 됩니다.  
*참조 가능한 속성: *`{{<websocketapi‑LogicalId>}}.Stage`

**`AWS::ApiGatewayV2::Route`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Route`  
`{{<normalized‑route‑key>}}`는 특수 문자가 제거된 라우팅 키입니다. 예를 들어 라우팅 키 `$connect`의 경우는 `LogicalId`입니다`{{MyWebSocketApi}}connectRoute`.  
*참조 가능한 속성: *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 도 생성합니다.

**Topics**
+ [인증 속성은 AuthType이 사용자 지정으로 설정된 상태로 지정됩니다.](#sam-specification-generated-resources-websocketapi-auth)
+ [DomainName 속성이 지정되었습니다.](#sam-specification-generated-resources-websocketapi-domain-name)
+ [BasePath 속성이 지정됨](#sam-specification-generated-resources-websocketapi-basepath)
+ [Route53 속성이 지정됨](#sam-specification-generated-resources-websocketapi-route53)

## 인증 속성은 AuthType이 사용자 지정으로 설정된 상태로 지정됩니다.
<a name="sam-specification-generated-resources-websocketapi-auth"></a>

의 `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 속성이 지정되었습니다.
<a name="sam-specification-generated-resources-websocketapi-domain-name"></a>

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

**`AWS::ApiGatewayV2::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainNameV2{{<sha>}}`  
`{{<sha>}}`은 스택이 만들어질 때 생성되는 고유한 해시 값입니다. 예를 들어 `ApiGatewayDomainNameV2{{926eeb5ff1}}`입니다.  
*참조 가능한 속성: *N/A(이 CloudFormation 리소스를 참조`LogicalId`하려면를 사용해야 함)

## BasePath 속성이 지정됨
<a name="sam-specification-generated-resources-websocketapi-basepath"></a>

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

**`AWS::ApiGatewayV2::ApiMapping`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<basepath>}}ApiMapping`  
`{{<basepath>}}`는 기본 경로 값입니다. 예를 들어를 기본 경로`v1`로 지정하면는 `LogicalId`입니다`{{MyWebSocketApi}}v1ApiMapping`.  
*참조 가능한 속성: *N/A(이 CloudFormation 리소스를 참조`LogicalId`하려면를 사용해야 함)

## Route53 속성이 지정됨
<a name="sam-specification-generated-resources-websocketapi-route53"></a>

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

**`AWS::Route53::RecordSetGroup`**  
*`LogicalId`: *`RecordSetGroup{{<sha>}}`  
`{{<sha>}}`은 스택이 만들어질 때 생성되는 고유한 해시 값입니다. 예를 들어 `RecordSetGroup{{926eeb5ff1}}`입니다.  
*참조 가능한 속성: *N/A(이 CloudFormation 리소스를 참조`LogicalId`하려면를 사용해야 함)