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

# HttpApi
<a name="sam-property-function-httpapi"></a>

HttpAPI 유형의 이벤트 소스를 설명하는 객체입니다.

지정된 경로 및 메서드에 대한 OpenAPI 정의가 API에 있는 경우 SAM은 Lambda 통합 및 보안 섹션(해당하는 경우)을 자동으로 추가합니다.

API에 지정된 경로와 메서드에 대한 OpenApi 정의가 없는 경우 SAM이 이 정의를 자동으로 생성합니다.

## 구문
<a name="sam-property-function-httpapi-syntax"></a>

 AWS Serverless Application Model (AWS SAM) 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.

### YAML
<a name="sam-property-function-httpapi-syntax.yaml"></a>

```
  [ApiId](#sam-function-httpapi-apiid): {{String}}
  [Auth](#sam-function-httpapi-auth): {{HttpApiFunctionAuth}}
  [Method](#sam-function-httpapi-method): {{String}}
  [Path](#sam-function-httpapi-path): {{String}}
  [PayloadFormatVersion](#sam-function-httpapi-payloadformatversion): {{String}}
  [RouteSettings](#sam-function-httpapi-routesettings): {{[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)}}
  [TimeoutInMillis](#sam-function-httpapi-timeoutinmillis): {{Integer}}
```

## 속성
<a name="sam-property-function-httpapi-properties"></a>

 `ApiId`   <a name="sam-function-httpapi-apiid"></a>
이 템플릿에 정의된 [AWS::Serverless::HttpApi](sam-resource-httpapi.md) 리소스의 식별자입니다.  
정의되지 않은 경우, [AWS::Serverless::HttpApi](sam-resource-httpapi.md)을 정의하지 않는 이 템플릿에 정의된 Api 이벤트에 의해 정의된 모든 경로와 메서드의 집합을 포함하는 생성된 OpenAPI 문서를 사용하여 `ServerlessHttpApi`라는 명칭의 기본 `ApiId` 리소스가 생성됩니다.  
이것은 다른 템플릿에 정의된 [AWS::Serverless::HttpApi](sam-resource-httpapi.md) 리소스를 참조할 수 없습니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `Auth`   <a name="sam-function-httpapi-auth"></a>
이 특정 Api\+Path\+Method에 대한 인증 구성입니다.  
지정된 `DefaultAuthorizer`가 없는 경우, API의 `DefaultAuthorizer`을 재정의하거나 개별 경로에 인증 구성을 설정하는 데 유용합니다.   
*유형*: [http://API/FunctionAuth](sam-property-function-httpapifunctionauth.md)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `Method`   <a name="sam-function-httpapi-method"></a>
이 함수가 간접 호출되는 HTTP 메서드입니다.  
`Path`이나 `Method` 어느 것도 지정되지 않은 경우, SAM은 다른 엔드포인트에 매핑되지 않는 모든 요청을 이 Lambda 함수로 라우팅하는 기본 API 경로를 생성합니다. API당 이러한 기본 경로 중 하나만 존재할 수 있습니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `Path`   <a name="sam-function-httpapi-path"></a>
이 함수가 간접 호출되는 Uri 경로입니다. `/`로 시작해야 합니다.  
`Path`이나 `Method` 어느 것도 지정되지 않은 경우, SAM은 다른 엔드포인트에 매핑되지 않는 모든 요청을 이 Lambda 함수로 라우팅하는 기본 API 경로를 생성합니다. API당 이러한 기본 경로 중 하나만 존재할 수 있습니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `PayloadFormatVersion`   <a name="sam-function-httpapi-payloadformatversion"></a>
통합으로 전송되는 페이로드의 형식을 지정합니다.  
참고: PayloadFormatVersion을 사용하려면 SAM이 OpenAPI 정의를 수정해야 하므로 `DefinitionBody` 속성에 정의된 인라인 OpenApi와만 작동합니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*기본값*: 2.0  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `RouteSettings`   <a name="sam-function-httpapi-routesettings"></a>
이 HTTP API의 경로별 경로 설정입니다. 경로 설정에 대한 자세한 내용은 [API 게이트웨이 개발자 가이드](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)의 *AWS::API 게이트웨이V2::StageRouteSettings*을 참조하세요.  
참고: HttpApi 리소스와 이벤트 소스 모두에 RouteSettings가 지정된 경우는 이를 이벤트 소스 속성과 AWS SAM 병합합니다.  
*유형*: [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGatewayV2::Stage` 리소스의 `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` 속성으로 직접 전달됩니다.

 `TimeoutInMillis`   <a name="sam-function-httpapi-timeoutinmillis"></a>
50\~29,000밀리초 사이의 제한 시간 사용자 지정입니다.  
참고: TimeoutInMillis를 사용하려면 SAM이 OpenAPI 정의를 수정해야 하므로 `DefinitionBody` 속성에 정의된 인라인 OpenApi와만 작동합니다.  
*유형*: 정수  
*필수 항목 여부*: 아니요  
*기본값*: 5000  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

## 예제
<a name="sam-property-function-httpapi--examples"></a>

### 기본 HttpApi 이벤트
<a name="sam-property-function-httpapi--examples--default-httpapi-event"></a>

기본 경로를 사용하는 HttpApi 이벤트입니다. 이 API의 매핑되지 않은 모든 경로와 메서드는 이 엔드포인트로 라우팅됩니다.

#### YAML
<a name="sam-property-function-httpapi--examples--default-httpapi-event--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
```

### HttpApi
<a name="sam-property-function-httpapi--examples--httpapi"></a>

특정 경로와 메서드를 사용하는 HttpApi 이벤트입니다.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET
```

### HttpApi 승인
<a name="sam-property-function-httpapi--examples--httpapi-authorization"></a>

권한 부여자를 사용하는HttpApi 이벤트입니다.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi-authorization--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2
```