Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# HttpApiAuth
<a name="sam-property-httpapi-httpapiauth"></a>

Mengonfigurasi otorisasi untuk mengendalikan akses ke API HTTP dari Amazon API Gateway Anda.

Untuk informasi selengkapnya tentang mengonfigurasi akses ke HTTP APIs, lihat [Mengontrol dan mengelola akses ke API HTTP di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) di *Panduan Pengembang API Gateway*.

## Sintaksis
<a name="sam-property-httpapi-httpapiauth-syntax"></a>

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

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

```
  [Authorizers](#sam-httpapi-httpapiauth-authorizers): OAuth2Authorizer | LambdaAuthorizer
  [DefaultAuthorizer](#sam-httpapi-httpapiauth-defaultauthorizer): String
  [EnableIamAuthorizer](#sam-httpapi-httpapiauth-enableiamauthorizer): Boolean
```

## Sifat-sifat
<a name="sam-property-httpapi-httpapiauth-properties"></a>

 `Authorizers`   <a name="sam-httpapi-httpapiauth-authorizers"></a>
Pengotorisasi yang digunakan untuk mengendalikan akses ke API dari API Gateway Anda.  
*Jenis*: [OAuth2Authorizer \$1 [LambdaAuthorizer](sam-property-httpapi-lambdaauthorizer.md)](sam-property-httpapi-oauth2authorizer.md)  
*Wajib*: Tidak  
*Default*: Tidak ada  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: AWS SAM menambahkan otorisasi ke definisi OpenAPI.

 `DefaultAuthorizer`   <a name="sam-httpapi-httpapiauth-defaultauthorizer"></a>
Tentukan otorisasi default yang digunakan untuk mengotorisasi panggilan API ke API dari API Gateway Anda. Anda dapat menentukan `AWS_IAM` sebagai otorisasi default jika `EnableIamAuthorizer` diatur ke`true`. Jika tidak, tentukan otorisasi yang telah Anda tentukan. `Authorizers`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Tidak ada  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `EnableIamAuthorizer`   <a name="sam-httpapi-httpapiauth-enableiamauthorizer"></a>
Tentukan apakah akan menggunakan otorisasi IAM untuk rute API.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-httpapi-httpapiauth--examples"></a>

### OAuth 2.0 Pengotorisasi
<a name="sam-property-httpapi-httpapiauth--examples--oauth-2.0-authorizer"></a>

OAuth 2.0 contoh otorisasi

#### YAML
<a name="sam-property-httpapi-httpapiauth--examples--oauth-2.0-authorizer--yaml"></a>

```
Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer
```

### Pengotorisasi IAM
<a name="sam-property-httpapi-httpapiauth--examples--iam-authorizer"></a>

Contoh otorisasi IAM

#### YAML
<a name="sam-property-httpapi-httpapiauth--examples--iam-authorizer--yaml"></a>

```
Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM
```

# LambdaAuthorizer
<a name="sam-property-httpapi-lambdaauthorizer"></a>

Konfigurasikan otorisasi Lambda untuk mengontrol akses ke API HTTP Amazon API Gateway Anda dengan suatu fungsi. AWS Lambda 

Untuk informasi dan contoh selengkapnya, lihat [Bekerja dengan AWS Lambda otorisasi untuk HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) di *Panduan Pengembang API Gateway*.

## Sintaksis
<a name="sam-property-httpapi-lambdaauthorizer-syntax"></a>

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

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

```
  [AuthorizerPayloadFormatVersion](#sam-httpapi-lambdaauthorizer-authorizerpayloadformatversion): String
  EnableFunctionDefaultPermissions: Boolean
  [EnableSimpleResponses](#sam-httpapi-lambdaauthorizer-enablesimpleresponses): Boolean
  [FunctionArn](#sam-httpapi-lambdaauthorizer-functionarn): String
  [FunctionInvokeRole](#sam-httpapi-lambdaauthorizer-functioninvokerole): String
  [Identity](#sam-httpapi-lambdaauthorizer-identity): LambdaAuthorizationIdentity
```

## Sifat-sifat
<a name="sam-property-httpapi-lambdaauthorizer-properties"></a>

 `AuthorizerPayloadFormatVersion`   <a name="sam-httpapi-lambdaauthorizer-authorizerpayloadformatversion"></a>
Menentukan format muatan yang dikirim ke pemberi otorisasi Lambda API HTTP. Diperlukan untuk Otorisasi Lambda API HTTP.  
Ini dilewatkan ke bagian `authorizerPayloadFormatVersion` dari `x-amazon-apigateway-authorizer` di bagian `securitySchemes` dari ketentuan OpenAPI.  
*Nilai yang valid*: `1.0` atau `2.0`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `EnableFunctionDefaultPermissions`   <a name="sam-httpapi-lambdaauthorizer-enablefunctiondefaultpermissions"></a>
Secara default, sumber daya HTTP API tidak diberikan izin untuk memanggil otorisasi Lambda. Tentukan properti ini `true` untuk secara otomatis membuat izin antara sumber daya HTTP API dan otorisasi Lambda Anda.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Nilai default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `EnableSimpleResponses`   <a name="sam-httpapi-lambdaauthorizer-enablesimpleresponses"></a>
Menentukan apakah pemberi otorisasi Lambda mengembalikan respons dalam format sederhana. Secara default, otorisasi Lambda harus mengembalikan kebijakan AWS Identity and Access Management (IAM). Jika diaktifkan, Otorisasi Lambda dapat mengembalikan nilai boolean bukan kebijakan IAM.  
Ini diteruskan ke bagian `enableSimpleResponses` dari `x-amazon-apigateway-authorizer` di bagian `securitySchemes` dari ketentuan OpenAPI.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionArn`   <a name="sam-httpapi-lambdaauthorizer-functionarn"></a>
Amazon Resource Name (ARN) dari fungsi Lambda yang menyediakan otorisasi untuk API.  
Ini dilewatkan ke bagian `authorizerUri` dari `x-amazon-apigateway-authorizer` di bagian `securitySchemes` dari ketentuan OpenAPI.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionInvokeRole`   <a name="sam-httpapi-lambdaauthorizer-functioninvokerole"></a>
ARN IAM role yang memiliki kredensial yang diperlukan untuk API Gateway untuk memanggil fungsi otorisasi. Tentukan parameter ini jika kebijakan berbasis sumber daya fungsi Anda tidak memberikan izin `lambda:InvokeFunction` API Gateway.  
Ini diteruskan ke bagian `authorizerCredentials` dari `x-amazon-apigateway-authorizer` di bagian `securitySchemes` dari ketentuan OpenAPI.  
Untuk informasi lebih lanjut, lihat [Buat otorisasi Lambda](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.example-create) di *Panduan Developer API Gateway*.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Identity`   <a name="sam-httpapi-lambdaauthorizer-identity"></a>
Menentukan `IdentitySource` dalam permintaan masuk untuk otorisasi.  
Ini diteruskan ke bagian `identitySource` dari `x-amazon-apigateway-authorizer` di bagian `securitySchemes` dari ketentuan OpenAPI.  
*Jenis*: [LambdaAuthorizationIdentity](sam-property-httpapi-lambdaauthorizationidentity.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-httpapi-lambdaauthorizer--examples"></a>

### LambdaAuthorizer
<a name="sam-property-httpapi-lambdaauthorizer--examples--lambdaauthorizer"></a>

LambdaAuthorizer contoh

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

```
Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization
```

# LambdaAuthorizationIdentity
<a name="sam-property-httpapi-lambdaauthorizationidentity"></a>

Properti penggunaan dapat digunakan untuk menentukan permintaan masuk untuk otorisasi Lambda. IdentitySource Untuk informasi selengkapnya tentang sumber identitas, lihat [Sumber identitas](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.identity-sources) di *Panduan Developer API Gateway*.

## Sintaksis
<a name="sam-property-httpapi-lambdaauthorizationidentity-syntax"></a>

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

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

```
  [Context](#sam-httpapi-lambdaauthorizationidentity-context): List
  [Headers](#sam-httpapi-lambdaauthorizationidentity-headers): List
  [QueryStrings](#sam-httpapi-lambdaauthorizationidentity-querystrings): List
  [ReauthorizeEvery](#sam-httpapi-lambdaauthorizationidentity-reauthorizeevery): Integer
  [StageVariables](#sam-httpapi-lambdaauthorizationidentity-stagevariables): List
```

## Sifat-sifat
<a name="sam-property-httpapi-lambdaauthorizationidentity-properties"></a>

 `Context`   <a name="sam-httpapi-lambdaauthorizationidentity-context"></a>
Mengonversi string konteks yang diberikan ke daftar ekspresi pemetaan dalam format `$context.contextString`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Headers`   <a name="sam-httpapi-lambdaauthorizationidentity-headers"></a>
Mengonversi header ke daftar ekspresi pemetaan dalam format `$request.header.name`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueryStrings`   <a name="sam-httpapi-lambdaauthorizationidentity-querystrings"></a>
Mengonversi string kueri yang diberikan ke daftar ekspresi pemetaan dalam format `$request.querystring.queryString`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ReauthorizeEvery`   <a name="sam-httpapi-lambdaauthorizationidentity-reauthorizeevery"></a>
Periode time-to-live (TTL), dalam hitungan detik, yang menentukan berapa lama API Gateway menyimpan hasil otorisasi. Jika Anda menentukan nilai lebih dari 0, API Gateway akan menyimpan respons pengirim. Nilai maksimumnya adalah 3600, atau 1 jam.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `StageVariables`   <a name="sam-httpapi-lambdaauthorizationidentity-stagevariables"></a>
Mengonversi variabel persiapan yang diberikan ke daftar ekspresi pemetaan dalam format `$stageVariables.stageVariable`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-httpapi-lambdaauthorizationidentity--examples"></a>

### LambdaRequestIdentity
<a name="sam-property-httpapi-lambdaauthorizationidentity--examples--lambdarequestidentity"></a>

Contoh identitas permintaan Lambda

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

```
Identity:
  QueryStrings:
    - auth
  Headers:
    - Authorization
  StageVariables:
    - VARIABLE
  Context:
    - authcontext
  ReauthorizeEvery: 100
```

# OAuth2Authorizer
<a name="sam-property-httpapi-oauth2authorizer"></a>

Definisi untuk otorisasi OAuth 2.0, juga dikenal sebagai otorisasi JSON Web Token (JWT).

Untuk informasi selengkapnya, lihat [Mengontrol akses ke HTTP APIs dengan otorisasi JWT di Panduan Pengembang](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) *API Gateway*.

## Sintaksis
<a name="sam-property-httpapi-oauth2authorizer-syntax"></a>

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

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

```
  [AuthorizationScopes](#sam-httpapi-oauth2authorizer-authorizationscopes): List
  [IdentitySource](#sam-httpapi-oauth2authorizer-identitysource): String
  [JwtConfiguration](#sam-httpapi-oauth2authorizer-jwtconfiguration): Map
```

## Sifat-sifat
<a name="sam-property-httpapi-oauth2authorizer-properties"></a>

 `AuthorizationScopes`   <a name="sam-httpapi-oauth2authorizer-authorizationscopes"></a>
Daftar cakupan otorisasi untuk pemberi kuasa ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IdentitySource`   <a name="sam-httpapi-oauth2authorizer-identitysource"></a>
Ekspresi sumber identitas untuk otorisasi ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `JwtConfiguration`   <a name="sam-httpapi-oauth2authorizer-jwtconfiguration"></a>
Konfigurasi JWT untuk otorisasi ini.  
Ini diteruskan ke bagian `jwtConfiguration` dari `x-amazon-apigateway-authorizer` di bagian `securitySchemes` dari ketentuan OpenAPI.  
Properti `issuer` dan `audience` tidak peka huruf besar/kecil dan dapat digunakan baik huruf kecil seperti di OpenAPI atau huruf besar dan seperti dalam. `Issuer` `Audience` [AWS::ApiGatewayV2::Authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html) 
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-httpapi-oauth2authorizer--examples"></a>

### OAuth 2.0 otorisasi
<a name="sam-property-httpapi-oauth2authorizer--examples--oauth-2.0-authorizer"></a>

OAuth 2.0 Authorizer Contoh

#### YAML
<a name="sam-property-httpapi-oauth2authorizer--examples--oauth-2.0-authorizer--yaml"></a>

```
Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer
```