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

# AWS SAM Template
<a name="sam-specification"></a>

Setelah Anda menjalankan **sam init** perintah dan menyelesaikan alur kerja berikutnya, AWS SAM buat direktori proyek aplikasi Anda, yang merupakan AWS SAM proyek Anda. Anda menentukan aplikasi tanpa server Anda dengan menambahkan kode ke proyek Anda AWS SAM . Sementara AWS SAM proyek Anda terdiri dari satu set file dan folder, file yang terutama Anda kerjakan adalah AWS SAM template Anda (bernama`template.yaml`). Dalam template ini, Anda menulis kode untuk mengekspresikan sumber daya, pemetaan sumber peristiwa, dan properti lain yang menentukan aplikasi tanpa server Anda.

**catatan**  
Elemen kunci dari AWS SAM template adalah spesifikasi AWS SAM template. Spesifikasi ini menyediakan sintaks singkat yang, jika dibandingkan dengan CloudFormation, memungkinkan Anda menggunakan lebih sedikit baris kode untuk menentukan sumber daya, pemetaan sumber peristiwa, izin APIs, dan properti lain dari aplikasi tanpa server Anda.

Bagian ini memberikan detail tentang cara Anda menggunakan bagian dalam AWS SAM templat untuk menentukan jenis sumber daya, properti sumber daya, tipe data, atribut sumber daya, fungsi intrinsik, dan ekstensi API Gateway.

AWS SAM template adalah perpanjangan dari CloudFormation template, dengan jenis sintaks unik yang menggunakan sintaks singkatan dengan lebih sedikit baris kode daripada. CloudFormation Ini mempercepat pengembangan Anda saat membangun aplikasi tanpa server. Untuk informasi lebih lanjut, lihat[AWS SAM sumber daya dan properti](sam-specification-resources-and-properties.md). Untuk referensi lengkap untuk CloudFormation template, lihat [Referensi CloudFormation Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-reference.html) di *Panduan AWS CloudFormation Pengguna*.

Saat mengembangkan, Anda akan sering merasa bermanfaat untuk memecah kode aplikasi Anda menjadi file terpisah untuk mengatur dan mengelola aplikasi Anda dengan lebih baik. Contoh dasar dari ini adalah menggunakan file terpisah untuk kode AWS Lambda fungsi Anda daripada memiliki kode ini di AWS SAM template Anda. Lakukan ini dengan mengatur kode fungsi Lambda Anda di subdirektori proyek Anda dan mereferensikan jalur lokalnya dalam templat () Anda AWS Serverless Application Model .AWS SAM

**Topics**
+ [AWS SAM template anatomi](sam-specification-template-anatomy.md)
+ [AWS SAM sumber daya dan properti](sam-specification-resources-and-properties.md)
+ [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md)
+ [Atribut sumber daya yang didukung oleh AWS SAM](sam-specification-resource-attributes.md)
+ [Ekstensi API Gateway untuk AWS SAM](sam-specification-api-gateway-extensions.md)
+ [Fungsi intrinsik untuk AWS SAM](sam-specification-intrinsic-functions.md)

# AWS SAM template anatomi
<a name="sam-specification-template-anatomy"></a>

File AWS SAM templat mengikuti format file CloudFormation templat, yang dijelaskan dalam [Anatomi templat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) di *Panduan AWS CloudFormation Pengguna*. Perbedaan utama antara file AWS SAM template dan file CloudFormation template adalah sebagai berikut:
+ **Transformasi deklarasi.** Deklarasi `Transform: AWS::Serverless-2016-10-31` diperlukan untuk file templat AWS SAM . Deklarasi ini mengidentifikasi file CloudFormation template sebagai file AWS SAM template. Untuk informasi selengkapnya tentang transformasi, lihat [Transformasi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) di *Panduan Pengguna AWS CloudFormation *.
+ **Bagian global.** `Globals`Bagian ini unik untuk AWS SAM. Ini mendefinisikan properti yang umum untuk semua fungsi tanpa server Anda dan. APIs Semua`AWS::Serverless::Function`,,`AWS::Serverless::Api`,`AWS::Serverless::CapacityProvider`, `AWS::Serverless::HttpApi``AWS::Serverless::SimpleTable`, dan `AWS::Serverless::StateMachine` sumber daya mewarisi properti yang didefinisikan di `Globals` bagian tersebut. Untuk informasi lebih lanjut tentang bagian ini, lihat [Bagian global dari template AWS SAM](sam-specification-template-anatomy-globals.md).
+ **Bagian sumber daya.** Dalam AWS SAM template `Resources` bagian ini dapat berisi kombinasi CloudFormation sumber daya dan sumber AWS SAM daya. Untuk informasi selengkapnya tentang CloudFormation sumber daya, lihat [referensi jenis AWS sumber daya dan properti](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) di *Panduan AWS CloudFormation Pengguna*. Untuk informasi selengkapnya tentang AWS SAM sumber daya, lihat[AWS SAM sumber daya dan properti](sam-specification-resources-and-properties.md).

Semua bagian lain dari file AWS SAM template sesuai dengan bagian file CloudFormation template dengan nama yang sama.

## YAML
<a name="template-anatomy-outline.yaml"></a>

Contoh berikut menunjukkan fragmen templat dalam format YMAL.

```
Transform: AWS::Serverless-2016-10-31

Globals:
  set of globals

Description:
  String

Metadata:
  template metadata

Parameters:
  set of parameters

Mappings:
  set of mappings

Conditions:
  set of conditions

Resources:
  set of resources

Outputs:
  set of outputs
```

## Bagian templat
<a name="template-anatomy-sections"></a>

AWS SAM template dapat mencakup beberapa bagian utama. Hanya bagian `Transform` dan `Resources` yang wajib diisi.

Anda dapat menyertakan bagian templat dengan urutan apa pun. Namun, jika menggunakan ekstensi bahasa, Anda harus menambahkan `AWS::LanguageExtensions` *sebelum* transformasi tanpa server (yaitu, sebelumnya`AWS::Serverless-2016-10-31`) seperti yang ditunjukkan pada contoh berikut:

```
Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31
```

Saat Anda membangun template Anda, akan sangat membantu untuk menggunakan urutan logis yang ditampilkan dalam daftar berikut. Hal ini karena nilai-nilai dalam satu bagian mungkin merujuk ke nilai-nilai dari bagian sebelumnya.

**[Transformasi (wajib)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html)**  
Untuk AWS SAM template, Anda harus menyertakan bagian ini dengan nilai`AWS::Serverless-2016-10-31`.  
Transformasi tambahan termasuk hal opsional. Untuk informasi selengkapnya tentang transformasi, lihat [Transformasi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) di *Panduan Pengguna AWS CloudFormation *.

**[Globals (opsional)](sam-specification-template-anatomy-globals.md)**  
Properti yang umum untuk semua fungsi tanpa server Anda, APIs, dan tabel sederhana. Semua`AWS::Serverless::Function`,,`AWS::Serverless::Api`,`AWS::Serverless::CapacityProvider`, `AWS::Serverless::HttpApi``AWS::Serverless::SimpleTable`, dan `AWS::Serverless::StateMachine` sumber daya mewarisi properti yang didefinisikan di `Globals` bagian tersebut.  
Bagian ini unik untuk AWS SAM. Tidak ada bagian yang sesuai di templat CloudFormation .

**[Deskripsi (opsional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html)**  
Sebuah string teks yang menggambarkan templat.  
Bagian ini sesuai langsung dengan `Description` bagian CloudFormation templat.

**[Metadata (opsional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html)**  
Objek yang memberikan informasi tambahan tentang templat.  
Bagian ini sesuai langsung dengan `Metadata` bagian CloudFormation templat.

**[Parameter (opsional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)**  
Nilai-nilai untuk diteruskan ke templat Anda pada saat waktu aktif (ketika Anda membuat atau memperbarui tumpukan). Anda dapat merujuk ke parameter dari bagian `Resources` dan `Outputs` dari templat. Objek yang dinyatakan dalam bagian `Parameters` menyebabkan perintah **sam deploy --guided** untuk memberikan petunjuk tambahan kepada pengguna.  
Nilai yang diteruskan menggunakan `--parameter-overrides` parameter `sam deploy` perintah—dan entri dalam file konfigurasi—lebih diutamakan daripada entri dalam file template. AWS SAM Untuk informasi selengkapnya tentang `sam deploy` perintah, lihat [sam deploy](sam-cli-command-reference-sam-deploy.md) di referensi AWS SAMCLI perintah. Untuk informasi selengkapnya tentang file konfigurasi, lihat [AWS SAMCLIberkas konfigurasi](serverless-sam-cli-config.md).

**[Pemetaan (opsional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html)**  
Pemetaan dari kunci dan nilai-nilai terkait yang dapat Anda gunakan untuk menentukan nilai parameter bersyarat, mirip dengan tabel pencarian. Anda dapat mencocokkan kunci ke nilai yang sesuai dengan menggunakan fungsi intrinsik [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html) dalam bagian `Resources` dan `Outputs`.  
Bagian ini sesuai langsung dengan `Mappings` bagian CloudFormation templat.

**[Kondisi (opsional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html)**  
Kondisi yang mengendalikan apakah sumber daya tertentu dibuat atau apakah properti sumber daya tertentu ditetapkan nilai selama pembuatan atau pembaruan tumpukan. Sebagai contoh, Anda dapat secara bersyarat membuat sumber daya yang bergantung pada apakah tumpukan untuk lingkungan produksi atau pengujian.  
Bagian ini sesuai langsung dengan `Conditions` bagian CloudFormation templat.

**[Sumber daya (wajib)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html)**  
Sumber daya tumpukan dan propertinya, seperti instans Amazon Elastic Compute Cloud (Amazon EC2) atau bucket Amazon Simple Storage Service (Amazon S3). Anda dapat merujuk ke sumber daya dalam bagian `Resources` dan `Outputs` dari templat.  
Bagian ini mirip dengan bagian `Resources` dari templat CloudFormation . Dalam AWS SAM template, bagian ini dapat berisi AWS SAM sumber daya selain CloudFormation sumber daya.

**[Output (opsional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html)**  
Nilai-nilai yang dikembalikan setiap kali Anda melihat properti tumpukan Anda. Misalnya, Anda dapat mendeklarasikan output untuk nama bucket S3, lalu memanggil perintah `aws cloudformation describe-stacks` AWS Command Line Interface (AWS CLI) untuk melihat nama.  
Bagian ini berhubungan langsung dengan bagian `Outputs` dari templat CloudFormation .

## Langkah selanjutnya
<a name="template-anatomy-next-steps"></a>

Untuk mengunduh dan menyebarkan contoh aplikasi tanpa server yang berisi file AWS SAM templat, lihat [Memulai dengan AWS SAM](serverless-getting-started.md) dan ikuti instruksi di. [Tutorial: Menyebarkan aplikasi Hello World dengan AWS SAM](serverless-getting-started-hello-world.md)

# Bagian global dari template AWS SAM
<a name="sam-specification-template-anatomy-globals"></a>

Terkadang sumber daya yang Anda deklarasikan dalam AWS SAM template memiliki konfigurasi umum. Misalnya, Anda mungkin memiliki aplikasi dengan beberapa sumber daya `AWS::Serverless::Function` yang memiliki konfigurasi `Runtime`, `Memory`, `VPCConfig`, `Environment`, dan `Cors` yang identik. Alih-alih menggandakan informasi ini di setiap sumber daya, Anda dapat mendeklarasikan mereka sekali pada bagian `Globals` dan biarkan sumber daya Anda mewarisi mereka.

`Globals`Bagian ini mendukung jenis AWS SAM sumber daya berikut:
+ `AWS::Serverless::Api`
+ `AWS::Serverless::CapacityProvider`
+ `AWS::Serverless::Function`
+ `AWS::Serverless::HttpApi`
+ `AWS::Serverless::SimpleTable`
+ `AWS::Serverless::StateMachine`

Contoh:

```
Globals:
  Function:
    Runtime: nodejs12.x
    Timeout: 180
    Handler: index.handler
    Environment:
      Variables:
        TABLE_NAME: data-table

Resources:
  HelloWorldFunction:
    Type: AWS::Serverless::Function
    Properties:
      Environment:
        Variables:
          MESSAGE: "Hello From SAM"

  ThumbnailFunction:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        Thumbnail:
          Type: Api
          Properties:
            Path: /thumbnail
            Method: POST
```

Dalam contoh ini, `HelloWorldFunction` dan `ThumbnailFunction` menggunakan "nodejs12.x" untuk `Runtime`, "180" detik untuk `Timeout`, dan "index.handler" untuk `Handler`. `HelloWorldFunction` menambahkan variabel lingkungan MESSAGE, selain dari mewarisi TABLE\$1NAME. `ThumbnailFunction` mewarisi semua properti `Globals` dan menambahkan sumber peristiwa API.

## Sumber daya dan properti yang didukung
<a name="sam-specification-template-anatomy-globals-supported-resources-and-properties"></a>

AWS SAM mendukung sumber daya dan properti berikut.

```
Globals:
  Api:
    AccessLogSetting:
    Auth:
    BinaryMediaTypes:
    CacheClusterEnabled:
    CacheClusterSize:
    CanarySetting:
    Cors:
    DefinitionUri:
    Domain:
    EndpointConfiguration:
    GatewayResponses:
    MethodSettings:
    MinimumCompressionSize:
    Name:
    OpenApiVersion:
    PropagateTags:
    TracingEnabled:
    Variables:
  
  CapacityProvider:
    InstanceRequirements:
    KmsKeyArn:
    OperatorRole:
    PropagateTags:
    ScalingConfig:
    Tags:
    VpcConfig:
  
  Function:
    Architectures:
    AssumeRolePolicyDocument:
    AutoPublishAlias:
    AutoPublishAliasAllProperties:
    CapacityProviderConfig:
    CodeSigningConfigArn:
    CodeUri:
    DeadLetterQueue:
    DeploymentPreference:
    Description:
    DurableConfig:
    Environment:
    EphemeralStorage:
    EventInvokeConfig:
    FileSystemConfigs:
    FunctionScalingConfig:
    FunctionUrlConfig:
    Handler:
    KmsKeyArn:
    Layers:
    LoggingConfig:
    MemorySize:
    PermissionsBoundary:
    PropagateTags:
    ProvisionedConcurrencyConfig:
    PublishToLatestPublished:
    RecursiveLoop:
    ReservedConcurrentExecutions:
    RolePath:
    Runtime:
    RuntimeManagementConfig:
    SnapStart:
    SourceKMSKeyArn:
    Tags:
    TenancyConfig:
    Timeout:
    Tracing:
    VersionDeletionPolicy:
    VpcConfig:

  HttpApi:
    AccessLogSettings:
    Auth:
    PropagateTags:
    StageVariables:
    Tags:

  SimpleTable:
    SSESpecification:
    
  StateMachine:
    PropagateTags:
```

**catatan**  
Setiap sumber daya dan properti yang tidak termasuk dalam daftar sebelumnya tidak didukung. Beberapa alasan mereka tidak didukung dikarenakan: 1) Mereka membuka potensi masalah keamanan, atau 2) Mereka membuat templatnya sulit untuk dipahami.

## Tersirat APIs
<a name="sam-specification-template-anatomy-globals-implicit-apis"></a>

AWS SAM membuat *implisit APIs* saat Anda mendeklarasikan API di bagian tersebut. `Events` Anda dapat menggunakan `Globals` untuk mengganti semua properti implisit APIs.

## Properti yang dapat ditimpa
<a name="sam-specification-template-anatomy-globals-overrideable"></a>

Sumber daya dapat menimpa properti yang Anda deklarasikan pada bagian `Globals`. Misalnya, Anda dapat menambahkan variabel baru ke peta variabel lingkungan, atau Anda dapat mengganti variabel yang dideklarasikan secara global. Tetapi sumber daya tidak dapat menghapus properti yang ditentukan pada bagian `Globals`.

Secara umum, `Globals` mendeklarasikan properti yang dibagikan oleh semua sumber daya Anda. Beberapa sumber daya dapat memberikan nilai baru untuk properti yang dideklarasikan secara global, tetapi mereka tidak dapat menghapusnya. Jika beberapa sumber daya menggunakan properti namun yang lainnya tidak, maka Anda tidak harus mendeklarasikan mereka dalam bagian `Globals`.

Bagian berikut menjelaskan cara kerja utama untuk tipe data yang berbeda.

### Tipe data primitif diganti
<a name="sam-specification-template-anatomy-globals-overrideable-primitives"></a>

Tipe data primitif mencakup string, angka, Boolean, dan sebagainya.

Nilai yang ditentukan dalam bagian `Resources` menggantikan nilai dalam bagian `Globals`.

Contoh:

```
Globals:
  Function:
    Runtime: nodejs12.x

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: python3.9
```

Parameter `Runtime` untuk `MyFunction` diatur ke `python3.9`.

### Peta digabung
<a name="sam-specification-template-anatomy-globals-overrideable-maps"></a>

Peta juga dikenal sebagai kamus atau koleksi pasangan nilai kunci.

Entri peta dalam bagian `Resources` digabung dengan entri peta global. Jika terdapat duplikat, bagian entri `Resource` menimpa bagian entri `Globals`.

Contoh:

```
Globals:
  Function:
    Environment:
      Variables:
        STAGE: Production
        TABLE_NAME: global-table

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      Environment:
        Variables:
          TABLE_NAME: resource-table
          NEW_VAR: hello
```

Variabel lingkungan dari `MyFunction` ditetapkan sebagai berikut:

```
{
  "STAGE": "Production",
  "TABLE_NAME": "resource-table",
  "NEW_VAR": "hello"
}
```

### Daftar adalah aditif
<a name="sam-specification-template-anatomy-globals-overrideable-lists"></a>

Daftar juga dikenal sebagai array.

Daftar entri di bagian `Globals` ditambahkan ke daftar di bagian `Resources`.

Contoh:

```
Globals:
  Function:
    VpcConfig:
      SecurityGroupIds:
        - sg-123
        - sg-456

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      VpcConfig:
        SecurityGroupIds:
          - sg-first
```

Parameter `SecurityGroupIds` untuk `MyFunction` `VpcConfig` ditetapkan sebagai berikut:

```
[ "sg-123", "sg-456", "sg-first" ]
```

# AWS SAM sumber daya dan properti
<a name="sam-specification-resources-and-properties"></a>

Bagian ini menjelaskan jenis sumber daya dan properti yang khusus untuk. AWS SAM Anda mendefinisikan sumber daya dan properti ini menggunakan AWS SAM sintaks singkatan. AWS SAM juga mendukung jenis CloudFormation sumber daya dan properti. Untuk informasi referensi untuk semua jenis dan AWS SAM dukungan AWS sumber daya CloudFormation dan properti, lihat [referensi jenis AWS sumber daya dan properti](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) di *Panduan AWS CloudFormation Pengguna*.

**Topics**
+ [AWS::Serverless::Api](sam-resource-api.md)
+ [AWS::Serverless::Application](sam-resource-application.md)
+ [AWS::Serverless::CapacityProvider](sam-resource-capacityprovider.md)
+ [AWS::Serverless::Connector](sam-resource-connector.md)
+ [AWS::Serverless::Function](sam-resource-function.md)
+ [AWS::Serverless::GraphQLApi](sam-resource-graphqlapi.md)
+ [AWS::Serverless::HttpApi](sam-resource-httpapi.md)
+ [AWS::Serverless::LayerVersion](sam-resource-layerversion.md)
+ [AWS::Serverless::SimpleTable](sam-resource-simpletable.md)
+ [AWS::Serverless::StateMachine](sam-resource-statemachine.md)

# AWS::Serverless::Api
<a name="sam-resource-api"></a>

Membuat koleksi sumber daya Amazon API Gateway dan metode yang dapat dipanggil melalui titik akhir HTTPS.

[AWS::Serverless::Api](#sam-resource-api)Sumber daya tidak perlu ditambahkan secara eksplisit ke template Definisi Aplikasi AWS Tanpa Server. Sumber daya tupe ini secara implisit dibuat dari penyatuan peristiwa Api yang ditentukan pada sumber daya [AWS::Serverless::Function](sam-resource-function.md) yang ditentukan dalam templat yang tidak mengacu pada sumber daya [AWS::Serverless::Api](#sam-resource-api).

[AWS::Serverless::Api](#sam-resource-api)Resource harus digunakan untuk mendefinisikan dan mendokumentasikan penggunaan API OpenApi, yang memberikan lebih banyak kemampuan untuk mengonfigurasi sumber daya Amazon API Gateway yang mendasarinya.

Kami menyarankan Anda menggunakan CloudFormation kait atau kebijakan IAM untuk memverifikasi bahwa sumber daya API Gateway memiliki otorisasi yang melekat padanya untuk mengontrol akses ke sumber daya tersebut.

Untuk informasi selengkapnya tentang penggunaan CloudFormation kait, lihat [Mendaftarkan kait](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/registering-hook-python.html) di *panduan pengguna CloudFormation CLI* dan repositori. [apigw-enforce-authorizer](https://github.com/aws-cloudformation/aws-cloudformation-samples/tree/main/hooks/python-hooks/apigw-enforce-authorizer/) GitHub 

Untuk informasi selengkapnya tentang penggunaan kebijakan IAM, lihat [Mengharuskan rute API memiliki otorisasi dalam Panduan](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-require-authorization) *Pengembang API Gateway*.

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaksis
<a name="sam-resource-api-syntax"></a>

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

### YAML
<a name="sam-resource-api-syntax.yaml"></a>

```
Type: AWS::Serverless::Api
Properties:
  [AccessLogSetting](#sam-api-accesslogsetting): [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)
  AlwaysDeploy: Boolean
  [ApiKeySourceType](#sam-api-apikeysourcetype): String
  [Auth](#sam-api-auth): ApiAuth
  [BinaryMediaTypes](#sam-api-binarymediatypes): List
  [CacheClusterEnabled](#sam-api-cacheclusterenabled): Boolean
  [CacheClusterSize](#sam-api-cacheclustersize): String
  [CanarySetting](#sam-api-canarysetting): [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)
  [Cors](#sam-api-cors): String | CorsConfiguration
  [DefinitionBody](#sam-api-definitionbody): JSON
  [DefinitionUri](#sam-api-definitionuri): String | ApiDefinition
  [Description](#sam-api-description): String
  [DisableExecuteApiEndpoint](#sam-api-disableexecuteapiendpoint): Boolean
  [Domain](#sam-api-domain): DomainConfiguration
  [EndpointConfiguration](#sam-api-endpointconfiguration): EndpointConfiguration
  [FailOnWarnings](#sam-api-failonwarnings): Boolean
  [GatewayResponses](#sam-api-gatewayresponses): Map
  MergeDefinitions: Boolean
  [MethodSettings](#sam-api-methodsettings): MethodSettings
  [MinimumCompressionSize](#sam-api-minimumcompressionsize): Integer
  [Mode](#sam-api-mode): String
  [Models](#sam-api-models): Map
  [Name](#sam-api-name): String
  [OpenApiVersion](#sam-api-openapiversion): String
  PropagateTags: Boolean
  [Policy](#sam-api-policy): JSON
  [StageName](#sam-api-stagename): String
  [Tags](#sam-api-tags): Map
  [TracingEnabled](#sam-api-tracingenabled): Boolean
  [Variables](#sam-api-variables): Map
```

## Sifat-sifat
<a name="sam-resource-api-properties"></a>

 `AccessLogSetting`   <a name="sam-api-accesslogsetting"></a>
Mengonfigurasi Pengaturan Log Ac untuk tahap.  
*Jenis*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)` properti `AWS::ApiGateway::Stage` sumber daya.

 `AlwaysDeploy`   <a name="sam-api-alwaysdeploy"></a>
Selalu menerapkan API, bahkan ketika tidak ada perubahan pada API yang terdeteksi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ApiKeySourceType`   <a name="sam-api-apikeysourcetype"></a>
Sumber kunci API untuk permintaan pengukuran sesuai dengan rencana penggunaan. Nilai yang valid adalah `HEADER` dan `AUTHORIZER`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ApiKeySourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `Auth`   <a name="sam-api-auth"></a>
Konfigurasikan otorisasi untuk mengendalikan akses ke API Gateway Anda.  
Untuk informasi selengkapnya tentang mengonfigurasi akses menggunakan AWS SAM lihat[Kontrol akses API dengan AWS SAM template Anda](serverless-controlling-access-to-apis.md). Untuk contoh yang menunjukkan cara mengganti otorisasi global, lihat. [Ganti otorisasi global untuk REST API Amazon API Gateway](sam-property-function-apifunctionauth.md#sam-property-function-apifunctionauth--examples--override)  
*Jenis*: [ApiAuth](sam-property-api-apiauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `BinaryMediaTypes`   <a name="sam-api-binarymediatypes"></a>
Daftar tipe MIME yang dapat dikembalikan API Anda. Gunakan ini untuk mengaktifkan dukungan biner untukAPIs.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BinaryMediaTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes)` properti `AWS::ApiGateway::RestApi` sumber daya. Daftar BinaryMediaTypes ditambahkan ke CloudFormation sumber daya dan dokumen OpenAPI.

 `CacheClusterEnabled`   <a name="sam-api-cacheclusterenabled"></a>
Menunjukkan apakah caching diaktifkan untuk panggung. Untuk cache respons, Anda juga harus mengatur `CachingEnabled` ke `true` bawah`MethodSettings`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CacheClusterEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled)` properti `AWS::ApiGateway::Stage` sumber daya.

 `CacheClusterSize`   <a name="sam-api-cacheclustersize"></a>
Ukuran klaster cache dari tahap tersebut.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CacheClusterSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize)` properti `AWS::ApiGateway::Stage` sumber daya.

 `CanarySetting`   <a name="sam-api-canarysetting"></a>
Konfigurasikan pengaturan canary ke tahap deployment reguler.  
*Jenis*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)` properti `AWS::ApiGateway::Stage` sumber daya.

 `Cors`   <a name="sam-api-cors"></a>
Kelola berbagi sumber daya lintas asal (CORS) untuk semua API Gateway Anda. APIs Tentukan domain untuk diizinkan sebagai string atau tentukan kamus dengan konfigurasi Cors tambahan.   
CORS AWS SAM perlu memodifikasi definisi OpenAPI Anda. Buat definisi OpenAPI sebaris di untuk mengaktifkan `DefinitionBody` CORS.
Untuk informasi lebih lanjut tentang CORS, lihat [Aktifkan CORS untuk sumber daya API REST API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html) di *Panduan Developer API Gateway*.  
*Jenis*: String \$1 [CorsConfiguration](sam-property-api-corsconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `DefinitionBody`   <a name="sam-api-definitionbody"></a>
Spesifikasi OpenAPI yang menggambarkan API Anda. Jika `DefinitionUri` dan `DefinitionBody` tidak ditentukan, SAM akan membuat `DefinitionBody` untuk Anda berdasarkan konfigurasi templat Anda.  
Untuk mereferensikan OpenAPI file lokal yang mendefinisikan API Anda, gunakan `AWS::Include` transformasi. Untuk mempelajari selengkapnya, lihat [Cara AWS SAM mengunggah file lokal](deploy-upload-local-files.md).  
*Tipe*: JSON  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body)` properti `AWS::ApiGateway::RestApi` sumber daya. Jika properti tertentu disediakan, konten dapat dimasukkan atau dimodifikasi ke dalam DefinitionBody sebelum diteruskan ke CloudFormation. Properti termasuk`Auth`, `BinaryMediaTypes``Cors`,`GatewayResponses`,`Models`,, dan `EventSource` tipe Api untuk yang sesuai`AWS::Serverless::Function`.

 `DefinitionUri`   <a name="sam-api-definitionuri"></a>
Amazon S3 Uri, jalur file lokal, atau objek lokasi dokumen OpenAPI menentukan API. Objek Amazon S3 yang dirujuk properti ini harus menjadi file OpenAPI yang valid. Jika `DefinitionUri` dan `DefinitionBody` tidak ditentukan, SAM akan membuat `DefinitionBody` untuk Anda berdasarkan konfigurasi templat Anda.  
Jika lintasan file lokal disediakan, templat harus melalui alur kerja yang mencakup perintah `sam deploy` atau `sam package`, agar ketentuan diubah dengan benar.  
Fungsi intrinsik tidak didukung dalam OpenApi file eksternal yang direferensikan oleh. `DefinitionUri` Gunakan sebagai gantinya `DefinitionBody` properti dengan [Include Transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) untuk mengimpor OpenApi definisi ke dalam template.  
*Jenis*: String \$1 [ApiDefinition](sam-property-api-apidefinition.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location)` properti `AWS::ApiGateway::RestApi` sumber daya. Properti Amazon S3 nest diberi nama berbeda.

 `Description`   <a name="sam-api-description"></a>
Deskripsi sumber daya Api.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `DisableExecuteApiEndpoint`   <a name="sam-api-disableexecuteapiendpoint"></a>
Menentukan apakah klien dapat memanggil API dengan menggunakan titik akhir `execute-api` default. Secara default, klien dapat memanggil API Anda dengan default`https://{api_id}.execute-api.{region}.amazonaws.com`. Untuk mengharuskan klien menggunakan nama domain khusus untuk menjalankan API Anda, tentukan`True`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint)` properti `AWS::ApiGateway::RestApi` sumber daya. Itu diteruskan langsung ke `disableExecuteApiEndpoint` properti `[ x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)` ekstensi, yang akan ditambahkan ke ` [ Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `Domain`   <a name="sam-api-domain"></a>
Mengonfigurasi domain khusus untuk API dari API Gateway ini.  
*Jenis*: [DomainConfiguration](sam-property-api-domainconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `EndpointConfiguration`   <a name="sam-api-endpointconfiguration"></a>
Tipe titik akhir dari REST API.  
*Jenis*: [EndpointConfiguration](sam-property-api-endpointconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration)` properti `AWS::ApiGateway::RestApi` sumber daya. Properti konfigurasi nest diberi nama berbeda.

 `FailOnWarnings`   <a name="sam-api-failonwarnings"></a>
Menentukan apakah akan memutar kembali penciptaan API (`true`) atau not (`false`) ketika peringatan ditemui. Nilai default-nya adalah `false`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `GatewayResponses`   <a name="sam-api-gatewayresponses"></a>
Mengonfigurasi Respons Gateway untuk API. Respons Gateway adalah respons yang dikembalikan oleh API Gateway, secara langsung atau melalui penggunaan Lambda Authorizers. Untuk informasi selengkapnya, lihat dokumentasi untuk [ OpenApi ekstensi Api Gateway untuk Tanggapan Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.html).  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `MergeDefinitions`   <a name="sam-api-mergedefinitions"></a>
AWS SAM menghasilkan OpenAPI spesifikasi dari sumber peristiwa API Anda. Tentukan `true` untuk AWS SAM menggabungkan ini ke dalam OpenAPI spesifikasi sebaris yang ditentukan dalam sumber daya Anda`AWS::Serverless::Api`. Tentukan `false` untuk tidak bergabung.  
`MergeDefinitions`membutuhkan `DefinitionBody` properti `AWS::Serverless::Api` untuk didefinisikan. `MergeDefinitions`tidak kompatibel dengan `DefinitionUri` properti untuk`AWS::Serverless::Api`.  
*Nilai default*: `false`  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `MethodSettings`   <a name="sam-api-methodsettings"></a>
Mengonfigurasi semua pengaturan untuk tahap API termasuk Logging, Metrik, CacheTTL, Throttling.  
*Jenis*: Daftar [ MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MethodSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings)` properti `AWS::ApiGateway::Stage` sumber daya.

 `MinimumCompressionSize`   <a name="sam-api-minimumcompressionsize"></a>
Izinkan kompresi isi respons berdasarkan header Accept-Encoding klien. Kompresi terpicu ketika ukuran tubuh respons lebih besar dari atau sama dengan ambang batas Anda yang telah dikonfigurasi. Ambang batas ukuran isi maksimum adalah 10 MB (10.485.760 Bita). - Tipe kompresi berikut didukung: gzip, mengempis, dan identitas.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MinimumCompressionSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `Mode`   <a name="sam-api-mode"></a>
Properti ini hanya berlaku bila Anda menggunakan OpenAPI untuk menentukan API REST Anda. `Mode` menentukan bagaimana API Gateway menangani pembaruan sumber daya. Untuk informasi selengkapnya, lihat Properti [mode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode) dari jenis [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)sumber daya.  
*Nilai yang valid*: `overwrite` atau `merge`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Mode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `Models`   <a name="sam-api-models"></a>
Skema yang akan digunakan oleh metode API Anda. Skema ini dapat dijelaskan menggunakan JSON atau YAML. Lihat bagian Contoh di bagian bawah halaman ini misalnya model.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Name`   <a name="sam-api-name"></a>
Nama untuk RestApi sumber daya API Gateway  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name)` properti `AWS::ApiGateway::RestApi` sumber daya.

 `OpenApiVersion`   <a name="sam-api-openapiversion"></a>
Versi OpenApi untuk digunakan. Ini bisa `2.0` untuk spesifikasi Swagger, atau salah satu versi OpenApi 3.0, seperti. `3.0.1` Untuk informasi selengkapnya tentang OpenAPI, lihat [Spesifikasi OpenAPI](https://swagger.io/specification/).  
 AWS SAM menciptakan tahap yang disebut secara `Stage` default. Menyetel properti ini ke nilai yang valid akan mencegah pembuatan panggung`Stage`. 
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`PropagateTags`  <a name="sam-api-propagatetags"></a>
Tunjukkan apakah akan meneruskan tag dari `Tags` properti ke sumber daya yang Anda [AWS::Serverless::Api](sam-specification-generated-resources-api.md) hasilkan atau tidak. Tentukan `True` untuk menyebarkan tag di sumber daya yang Anda hasilkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Policy`  <a name="sam-api-policy"></a>
Dokumen kebijakan yang berisi izin untuk API. Untuk menetapkan ARN untuk kebijakan, gunakan fungsi intrinsik `!Join` dengan `""` sebagai pembatas dan nilai-nilai `"execute-api:/"` dan `"*"`.  
*Tipe*: JSON  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke properti [Kebijakan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy) `AWS::ApiGateway::RestApi` sumber daya.

 `StageName`   <a name="sam-api-stagename"></a>
Nama tahap, yang digunakan API Gateway sebagai segmen jalur pertama dalam Uniform Resource Identifier (URI) panggil.  
Untuk referensi sumber daya tahap, gunakan `<api-logical-id>.Stage`. Untuk informasi lebih lanjut tentang referensi sumber daya yang dibuat ketika sumber daya [AWS::Serverless::Api](#sam-resource-api) ditentukan, lihat [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Api ditentukan](sam-specification-generated-resources-api.md). Untuk informasi umum tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename)` properti `AWS::ApiGateway::Stage` sumber daya. Hal ini diperlukan dalam SAM, tetapi tidak diperlukan di API Gateway  
*Catatan tambahan*: API implisit memiliki nama tahap “Prod”.

 `Tags`   <a name="sam-api-tags"></a>
Sebuah peta (string ke string) yang menentukan tanda yang akan ditambahkan ke tahap API Gateway ini. Untuk detail tentang kunci dan nilai tag yang valid, lihat [Tag sumber daya](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) di *Panduan AWS CloudFormation Pengguna*.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags)` properti `AWS::ApiGateway::Stage` sumber daya. Properti Tags di SAM terdiri dari pasangan Key:Value; di CloudFormation dalamnya terdiri dari daftar objek Tag.

 `TracingEnabled`   <a name="sam-api-tracingenabled"></a>
Menunjukkan apakah penelusuran aktif dengan X-Ray diaktifkan untuk tahap tersebut. Untuk informasi selengkapnya tentang X-Ray, lihat [Menelusuri permintaan pengguna ke REST APIs menggunakan X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) di *Panduan Pengembang API Gateway*.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TracingEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled)` properti `AWS::ApiGateway::Stage` sumber daya.

 `Variables`   <a name="sam-api-variables"></a>
Sebuah peta (string ke string) yang menentukan variabel tahap, dengan nama variabel adalah kunci dan nilai variabel adalah nilai. Nama variabel terbatas pada karakter alfanumerik. Nilai harus sesuai dengan ekspresi reguler berikut: `[A-Za-z0-9._~:/?#&=,-]+`.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Variables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables)` properti `AWS::ApiGateway::Stage` sumber daya.

## Nilai Pengembalian
<a name="sam-resource-api-return-values"></a>

### Ref
<a name="sam-resource-api-return-values-ref"></a>

Ketika ID logis dari sumber daya ini disediakan untuk fungsi intrinsik `Ref`, ID logis mengembalikan ID dari API Gateway utama.

Untuk informasi lebih lanjut tentang menggunakan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

### Fn:: GetAtt
<a name="sam-resource-api-return-values-fn--getatt"></a>

`Fn::GetAtt` mengembalikan nilai untuk atribut yang ditentukan dari jenis ini. Berikut ini adalah atribut yang tersedia dan nilai-nilai kembali sampel. 

Untuk informasi lebih lanjut tentang `Fn::GetAtt`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) di *Panduan Pengguna AWS CloudFormation * 

`RootResourceId`  <a name="RootResourceId-fn::getatt"></a>
ID sumber daya root untuk sumber daya `RestApi`, seperti `a0bc123d4e`.

## Contoh
<a name="sam-resource-api--examples"></a>

### SimpleApiExample
<a name="sam-resource-api--examples--simpleapiexample"></a>

File AWS SAM template Hello World yang berisi Fungsi Lambda dengan titik akhir API. Ini adalah file AWS SAM template lengkap untuk aplikasi tanpa server yang berfungsi.

#### YAML
<a name="sam-resource-api--examples--simpleapiexample--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS SAM template with a simple API definition
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
  ApiFunction: # Adds a GET method at the root resource via an Api event
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /
            Method: get
            RestApiId:
              Ref: ApiGatewayApi
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
```

### ApiCorsExample
<a name="sam-resource-api--examples--apicorsexample"></a>

Cuplikan AWS SAM template dengan API yang ditentukan dalam file Swagger eksternal bersama dengan integrasi Lambda dan konfigurasi CORS. Ini hanya sebagian dari file AWS SAM template yang menunjukkan [AWS::Serverless::Api](#sam-resource-api) definisi.

#### YAML
<a name="sam-resource-api--examples--apicorsexample--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      # Allows www.example.com to call these APIs
      # SAM will automatically add AllowMethods with a list of methods for this API
      Cors: "'www.example.com'"
      DefinitionBody: # Pull in an OpenApi definition from S3
        'Fn::Transform':
          Name: 'AWS::Include'
          # Replace "bucket" with your bucket name
          Parameters:
            Location: s3://bucket/swagger.yaml
```

### ApiCognitoAuthExample
<a name="sam-resource-api--examples--apicognitoauthexample"></a>

Cuplikan AWS SAM template dengan API yang menggunakan Amazon Cognito untuk mengotorisasi permintaan terhadap API. Ini hanya sebagian dari file AWS SAM template yang menunjukkan [AWS::Serverless::Api](#sam-resource-api) definisi.

#### YAML
<a name="sam-resource-api--examples--apicognitoauthexample--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Cors: "'*'"
      Auth:
        DefaultAuthorizer: MyCognitoAuthorizer
        Authorizers:
          MyCognitoAuthorizer:
            UserPoolArn:
              Fn::GetAtt: [MyCognitoUserPool, Arn]
```

### ApiModelsExample
<a name="sam-resource-api--examples--apimodelsexample"></a>

Cuplikan AWS SAM template dengan API yang menyertakan skema Model. Ini hanya sebagian dari file AWS SAM template, menunjukkan [AWS::Serverless::Api](#sam-resource-api) definisi dengan dua skema model.

#### YAML
<a name="sam-resource-api--examples--apimodelsexample--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Models:
        User:
          type: object
          required:
            - username
            - employee_id
          properties:
            username:
              type: string
            employee_id:
              type: integer
            department:
              type: string
        Item:
          type: object
          properties:
            count:
              type: integer
            category:
              type: string
            price:
              type: integer
```

### Contoh caching
<a name="sam-resource-api--examples--caching-example"></a>

File AWS SAM template Hello World yang berisi Fungsi Lambda dengan titik akhir API. API telah mengaktifkan caching untuk satu sumber daya dan metode. Untuk informasi selengkapnya tentang caching, lihat [Mengaktifkan caching API untuk meningkatkan daya tanggap](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) dalam Panduan Pengembang *API* Gateway.

#### YAML
<a name="sam-resource-api--examples--caching-example--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS SAM template with a simple API definition with caching turned on
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
      CacheClusterEnabled: true
      CacheClusterSize: '0.5'
      MethodSettings:
        - ResourcePath: /
          HttpMethod: GET
          CachingEnabled: true
          CacheTtlInSeconds: 300
      Tags:
        CacheMethods: All 

  ApiFunction: # Adds a GET method at the root resource via an Api event
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /
            Method: get
            RestApiId:
              Ref: ApiGatewayApi
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
```

### Domain khusus dengan contoh API pribadi
<a name="sam-resource-api--examples--custom-domain-example"></a>

File AWS SAM template Hello World yang berisi fungsi Lambda dengan titik akhir API yang dipetakan ke domain pribadi. Template membuat asosiasi akses domain antara titik akhir VPC dan domain pribadi. Untuk informasi selengkapnya, lihat [Nama domain khusus untuk pribadi APIs di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html).

#### YAML
<a name="sam-resource-api--examples--custom-domain-example--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS SAM template configured with a custom domain using a private API

Parameters:
    DomainName:
      Type: String
      Default: mydomain.example.com
    CertificateArn:
      Type: String
    HostedZoneId:
      Type: String
    VpcEndpointId:
      Type: String
    VpcEndpointDomainName:
      Type: String
    VpcEndpointHostedZoneId:
      Type: String

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
      Handler: index.handler
      Runtime: python3.13
      Events:
        Fetch:
          Type: Api
          Properties:
            RestApiId:
              Ref: MyApi
            Method: Get
            Path: /get
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      EndpointConfiguration:
        Type: PRIVATE
        VPCEndpointIds:
        - !Ref VpcEndpointId
      Policy:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Effect: Allow
          Principal: '*'
          Action: execute-api:Invoke
          Resource: execute-api:/*
        - Effect: Deny
          Principal: '*'
          Action: execute-api:Invoke
          Resource: execute-api:/*
          Condition:
            StringNotEquals:
              aws:SourceVpce: !Ref VpcEndpointId
      Domain:
        DomainName: !Ref DomainName
        CertificateArn: !Ref CertificateArn
        EndpointConfiguration: PRIVATE
        BasePath:
        - /
        Route53:
          HostedZoneId: !Ref HostedZoneId
          VpcEndpointDomainName: !Ref VpcEndpointDomainName
          VpcEndpointHostedZoneId: !Ref VpcEndpointHostedZoneId
        AccessAssociation:
          VpcEndpointId: !Ref VpcEndpointId
        Policy:
          Version: '2012-10-17		 	 	 '
          Statement:
          - Effect: Allow
            Principal: '*'
            Action: execute-api:Invoke
            Resource: execute-api:/*
          - Effect: Deny
            Principal: '*'
            Action: execute-api:Invoke
            Resource: execute-api:/*
            Condition:
              StringNotEquals:
                aws:SourceVpce: !Ref VpcEndpointId
```

# ApiAuth
<a name="sam-property-api-apiauth"></a>

Konfigurasikan otorisasi untuk mengendalikan akses ke API Gateway Anda.

Untuk informasi selengkapnya dan contoh untuk mengonfigurasi akses menggunakan AWS SAM lihat[Kontrol akses API dengan AWS SAM template Anda](serverless-controlling-access-to-apis.md).

## Sintaksis
<a name="sam-property-api-apiauth-syntax"></a>

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

### YAML
<a name="sam-property-api-apiauth-syntax.yaml"></a>

```
  AddApiKeyRequiredToCorsPreflight: Boolean
  [AddDefaultAuthorizerToCorsPreflight](#sam-api-apiauth-adddefaultauthorizertocorspreflight): Boolean
  [ApiKeyRequired](#sam-api-apiauth-apikeyrequired): Boolean
  [Authorizers](#sam-api-apiauth-authorizers): CognitoAuthorizer | LambdaTokenAuthorizer | LambdaRequestAuthorizer | AWS_IAM
  [DefaultAuthorizer](#sam-api-apiauth-defaultauthorizer): String
  [InvokeRole](#sam-api-apiauth-invokerole): String
  [ResourcePolicy](#sam-api-apiauth-resourcepolicy): ResourcePolicyStatement
  [UsagePlan](#sam-api-apiauth-usageplan): ApiUsagePlan
```

**catatan**  
`Authorizers`Properti termasuk`AWS_IAM`, tetapi tidak ada konfigurasi tambahan yang diperlukan untuk`AWS_IAM`. Sebagai contoh, lihat [AWS IAM](#sam-property-api-apiauth--examples--aws_iam).

## Sifat-sifat
<a name="sam-property-api-apiauth-properties"></a>

 `AddApiKeyRequiredToCorsPreflight`   <a name="sam-api-apiauth-addapikeyrequiredtocorspreflight"></a>
Jika `Cors` properti `ApiKeyRequired` dan disetel, maka pengaturan `AddApiKeyRequiredToCorsPreflight` akan menyebabkan kunci API ditambahkan ke `Options` properti.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `True`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AddDefaultAuthorizerToCorsPreflight`   <a name="sam-api-apiauth-adddefaultauthorizertocorspreflight"></a>
Jika properti `DefaultAuthorizer` dan `Cors` ditetapkan, kemudian pengaturan `AddDefaultAuthorizerToCorsPreflight` akan menyebabkan otorisasi default yang akan ditambahkan ke properti `Options` di bagian OpenAPI.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: BETUL  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ApiKeyRequired`   <a name="sam-api-apiauth-apikeyrequired"></a>
Jika diatur ke BETUL, kunci API diperlukan untuk semua peristiwa API. Untuk informasi selengkapnya tentang kunci API lihat [Buat dan Gunakan Rencana Penggunaan dengan Kunci API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) di *Panduan Developer API Gateway*.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Authorizers`   <a name="sam-api-apiauth-authorizers"></a>
Pengotorisasi yang digunakan untuk mengendalikan akses ke API dari API Gateway Anda.  
Untuk informasi selengkapnya, lihat [Kontrol akses API dengan AWS SAM template Anda](serverless-controlling-access-to-apis.md).  
*Jenis*: [CognitoAuthorizer](sam-property-api-cognitoauthorizer.md)\$1 [LambdaTokenAuthorizer](sam-property-api-lambdatokenauthorizer.md)\$1 [LambdaRequestAuthorizer](sam-property-api-lambdarequestauthorizer.md)\$1 AWS\$1IAM  
*Wajib*: Tidak  
*Default*: Tidak ada  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: SAM menambahkan Authorizers ke OpenApi definisi Api.

 `DefaultAuthorizer`   <a name="sam-api-apiauth-defaultauthorizer"></a>
Tentukan otorisasi default untuk API Gateway dari API, yang akan digunakan untuk otorisasi panggilan API secara default.  
Jika Api EventSource untuk fungsi yang terkait dengan API ini dikonfigurasi untuk menggunakan Izin IAM, maka properti ini harus disetel ke`AWS_IAM`, jika tidak, kesalahan akan terjadi.
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Tidak ada  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `InvokeRole`   <a name="sam-api-apiauth-invokerole"></a>
Mengatur kredensial integrasi untuk semua sumber daya dan metode untuk nilai ini.  
`CALLER_CREDENTIALS` memetakan ke `arn:aws:iam:::<user>/`, yang menggunakan kredensial pemanggil untuk memanggil titik akhir.  
*Nilai yang valid*:`CALLER_CREDENTIALS`,`NONE`, `IAMRoleArn`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `CALLER_CREDENTIALS`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ResourcePolicy`   <a name="sam-api-apiauth-resourcepolicy"></a>
Konfigurasikan Kebijakan Sumber Daya untuk semua metode dan jalur pada API.  
*Jenis*: [ResourcePolicyStatement](sam-property-api-resourcepolicystatement.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: Pengaturan ini juga dapat ditentukan pada `AWS::Serverless::Function` individu menggunakan [ApiFunctionAuth](sam-property-function-apifunctionauth.md). Ini diperlukan untuk APIs dengan`EndpointConfiguration: PRIVATE`.

 `UsagePlan`   <a name="sam-api-apiauth-usageplan"></a>
Mengonfigurasi rencana penggunaan yang terkait dengan API ini. Untuk informasi selengkapnya tentang rencana penggunaan lihat [Buat dan Gunakan Rencana Penggunaan dengan Kunci API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) di *Panduan Developer API Gateway*.  
 AWS SAM Properti ini menghasilkan tiga CloudFormation sumber daya tambahan ketika properti ini disetel: an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html), an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html), dan an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html). Untuk informasi selengkapnya tentang skenario ini, lihat [UsagePlan properti ditentukan](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-usage-plan). Untuk informasi umum tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Jenis*: [ApiUsagePlan](sam-property-api-apiusageplan.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-apiauth--examples"></a>

### CognitoAuth
<a name="sam-property-api-apiauth--examples--cognitoauth"></a>

Contoh Cognito Auth

#### YAML
<a name="sam-property-api-apiauth--examples--cognitoauth--yaml"></a>

```
Auth:
  Authorizers:
    MyCognitoAuth:
     UserPoolArn:
       Fn::GetAtt:
         - MyUserPool
         - Arn
     AuthType: "COGNITO_USER_POOLS"
  DefaultAuthorizer: MyCognitoAuth
  InvokeRole: CALLER_CREDENTIALS
  AddDefaultAuthorizerToCorsPreflight: false
  ApiKeyRequired: false
  ResourcePolicy:
    CustomStatements: [{
      "Effect": "Allow",
      "Principal": "*",
      "Action": "execute-api:Invoke",
      "Resource": "execute-api:/Prod/GET/pets",
      "Condition": {
          "IpAddress": {
              "aws:SourceIp": "1.2.3.4"
          }
        }
    }]
    IpRangeDenylist:
      - "10.20.30.40"
```

### AWS IAM
<a name="sam-property-api-apiauth--examples--aws_iam"></a>

AWS Contoh IAM

#### YAML
<a name="sam-property-api-apiauth--examples--cognitoauth--yaml"></a>

```
Auth:
  Authorizers: AWS_IAM
```

# ApiUsagePlan
<a name="sam-property-api-apiusageplan"></a>

Mengonfigurasi rencana penggunaan untuk API dari API Gateway. Untuk informasi selengkapnya tentang rencana penggunaan, lihat [Buat dan Gunakan Rencana Penggunaan dengan Kunci API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) di *Panduan Developer API Gateway*.

## Sintaksis
<a name="sam-property-api-apiusageplan-syntax"></a>

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

### YAML
<a name="sam-property-api-apiusageplan-syntax.yaml"></a>

```
  [CreateUsagePlan](#sam-api-apiusageplan-createusageplan): String
  [Description](#sam-api-apiusageplan-description): String
  [Quota](#sam-api-apiusageplan-quota): [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)
  [Tags](#sam-api-apiusageplan-tags): List
  [Throttle](#sam-api-apiusageplan-throttle): [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)
  [UsagePlanName](#sam-api-apiusageplan-usageplanname): String
```

## Sifat-sifat
<a name="sam-property-api-apiusageplan-properties"></a>

 `CreateUsagePlan`   <a name="sam-api-apiusageplan-createusageplan"></a>
Menentukan cara rencana penggunaan ini dikonfigurasi. Nilai yang valid adalah `PER_API`, `SHARED`, dan `NONE`.  
`PER_API`membuat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html), dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html)sumber daya yang khusus untuk API ini. Sumber daya ini memiliki logika IDs `<api-logical-id>UsagePlan`,`<api-logical-id>ApiKey`, dan`<api-logical-id>UsagePlanKey`, masing-masing.  
`SHARED`membuat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html), dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html)sumber daya yang dibagikan di seluruh API apa pun yang juga ada `CreateUsagePlan: SHARED` di AWS SAM template yang sama. Sumber daya ini memiliki logika IDs `ServerlessUsagePlan`,`ServerlessApiKey`, dan`ServerlessUsagePlanKey`, masing-masing. Jika Anda menggunakan opsi ini, kami sarankan Anda menambahkan konfigurasi tambahan untuk rencana penggunaan ini hanya pada satu sumber daya API untuk menghindari ketentuan yang bertentangan dan keadaan tidak pasti.  
`NONE` menonaktifkan pembuatan atau asosiasi rencana penggunaan dengan API ini. Ini hanya diperlukan jika `SHARED` atau `PER_API` ditentukan dalam [Bagian global dari template AWS SAM](sam-specification-template-anatomy-globals.md).  
*Nilai yang valid adalah *: `PER_API`, `SHARED`, and `NONE`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Description`   <a name="sam-api-apiusageplan-description"></a>
Deskripsi rencana penggunaan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `Quota`   <a name="sam-api-apiusageplan-quota"></a>
Mengonfigurasi jumlah permintaan yang dapat dibuat pengguna dalam interval tertentu.  
*Jenis*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Quota](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `Tags`   <a name="sam-api-apiusageplan-tags"></a>
Susunan tanda bebas (pasangan nilai kunci) untuk mengaitkan dengan rencana penggunaan.  
Properti ini menggunakan [Jenis CloudFormation Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `Throttle`   <a name="sam-api-apiusageplan-throttle"></a>
Mengonfigurasi laju permintaan keseluruhan (permintaan rata-rata per detik) dan kapasitas lonjakan.  
*Jenis*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Throttle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `UsagePlanName`   <a name="sam-api-apiusageplan-usageplanname"></a>
Sebuah nama untuk rencana penggunaan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[UsagePlanName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

## Contoh
<a name="sam-property-api-apiusageplan--examples"></a>

### UsagePlan
<a name="sam-property-api-apiusageplan--examples--usageplan"></a>

Berikut ini adalah contoh rencana penggunaan.

#### YAML
<a name="sam-property-api-apiusageplan--examples--usageplan--yaml"></a>

```
Auth:
  UsagePlan:
    CreateUsagePlan: PER_API
    Description: Usage plan for this API
    Quota:
      Limit: 500
      Period: MONTH
    Throttle:
      BurstLimit: 100
      RateLimit: 50
    Tags:
      - Key: TagName
        Value: TagValue
```

# CognitoAuthorizer
<a name="sam-property-api-cognitoauthorizer"></a>

Menentukan otorisasi Kolam Pengguna Amazon Cognito.

Untuk informasi selengkapnya dan contoh tambahan, lihat [Kontrol akses API dengan AWS SAM template Anda](serverless-controlling-access-to-apis.md).

## Sintaksis
<a name="sam-property-api-cognitoauthorizer-syntax"></a>

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

### YAML
<a name="sam-property-api-cognitoauthorizer-syntax.yaml"></a>

```
  [AuthorizationScopes](#sam-api-cognitoauthorizer-authorizationscopes): List
  [Identity](#sam-api-cognitoauthorizer-identity): CognitoAuthorizationIdentity
  [UserPoolArn](#sam-api-cognitoauthorizer-userpoolarn): String
```

## Sifat-sifat
<a name="sam-property-api-cognitoauthorizer-properties"></a>

 `AuthorizationScopes`   <a name="sam-api-cognitoauthorizer-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.

 `Identity`   <a name="sam-api-cognitoauthorizer-identity"></a>
Properti ini dapat digunakan untuk menentukan `IdentitySource` dalam permintaan masuk untuk otorisasi.  
*Jenis*: [CognitoAuthorizationIdentity](sam-property-api-cognitoauthorizationidentity.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `UserPoolArn`   <a name="sam-api-cognitoauthorizer-userpoolarn"></a>
Dapat merujuk ke pengguna pool/specify arn userpool yang ingin Anda tambahkan otorisasi cognito ini  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-cognitoauthorizer--examples"></a>

### CognitoAuth
<a name="sam-property-api-cognitoauthorizer--examples--cognitoauth"></a>

Contoh Cognito Auth

#### YAML
<a name="sam-property-api-cognitoauthorizer--examples--cognitoauth--yaml"></a>

```
Auth:
  Authorizers:
    MyCognitoAuth:
      AuthorizationScopes:
        - scope1
        - scope2
      UserPoolArn:
        Fn::GetAtt:
          - MyCognitoUserPool
          - Arn
      Identity:
        Header: MyAuthorizationHeader
        ValidationExpression: myauthvalidationexpression
```

# CognitoAuthorizationIdentity
<a name="sam-property-api-cognitoauthorizationidentity"></a>

Properti ini dapat digunakan untuk menentukan permintaan masuk untuk otorisasi. IdentitySource Untuk informasi selengkapnya, IdentitySource lihat [ OpenApi ekstensi ApiGateway Authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html).

## Sintaksis
<a name="sam-property-api-cognitoauthorizationidentity-syntax"></a>

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

### YAML
<a name="sam-property-api-cognitoauthorizationidentity-syntax.yaml"></a>

```
  [Header](#sam-api-cognitoauthorizationidentity-header): String
  [ReauthorizeEvery](#sam-api-cognitoauthorizationidentity-reauthorizeevery): Integer
  [ValidationExpression](#sam-api-cognitoauthorizationidentity-validationexpression): String
```

## Sifat-sifat
<a name="sam-property-api-cognitoauthorizationidentity-properties"></a>

 `Header`   <a name="sam-api-cognitoauthorizationidentity-header"></a>
Tentukan nama header untuk Otorisasi dalam OpenApi definisi.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Otorisasi  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ReauthorizeEvery`   <a name="sam-api-cognitoauthorizationidentity-reauthorizeevery"></a>
Periode time-to-live (TTL), dalam hitungan detik, yang menentukan berapa lama API Gateway menyimpan hasil otorisasi. Jika Anda menentukan nilai yang lebih besar dari 0, API Gateway akan menyimpan tanggapan pemberi kuasa. Secara default, API Gateway mengatur properti ini ke 300. Nilai maksimumnya adalah 3600, atau 1 jam.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 300  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ValidationExpression`   <a name="sam-api-cognitoauthorizationidentity-validationexpression"></a>
Tentukan ekspresi validasi untuk memvalidasi Identitas masuk  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-cognitoauthorizationidentity--examples"></a>

### CognitoAuthIdentity
<a name="sam-property-api-cognitoauthorizationidentity--examples--cognitoauthidentity"></a>

#### YAML
<a name="sam-property-api-cognitoauthorizationidentity--examples--cognitoauthidentity--yaml"></a>

```
Identity:
  Header: MyCustomAuthHeader
  ValidationExpression: Bearer.*
  ReauthorizeEvery: 30
```

# LambdaRequestAuthorizer
<a name="sam-property-api-lambdarequestauthorizer"></a>

Mengonfigurasi Otorisasi Lambda untuk mengendalikan akses ke API Anda dengan fungsi Lambda.

Untuk informasi selengkapnya dan contoh tambahan, lihat [Kontrol akses API dengan AWS SAM template Anda](serverless-controlling-access-to-apis.md).

## Sintaksis
<a name="sam-property-api-lambdarequestauthorizer-syntax"></a>

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

### YAML
<a name="sam-property-api-lambdarequestauthorizer-syntax.yaml"></a>

```
DisableFunctionDefaultPermissions: Boolean
[FunctionArn](#sam-api-lambdarequestauthorizer-functionarn): String
[FunctionInvokeRole](#sam-api-lambdarequestauthorizer-functioninvokerole): String
[FunctionPayloadType](#sam-api-lambdarequestauthorizer-functionpayloadtype): String
[Identity](#sam-api-lambdarequestauthorizer-identity): LambdaRequestAuthorizationIdentity
```

## Sifat-sifat
<a name="sam-property-api-lambdarequestauthorizer-properties"></a>

 `DisableFunctionDefaultPermissions`   <a name="sam-api-lambdarequestauthorizer-disablefunctiondefaultpermissions"></a>
Tentukan `true` untuk AWS SAM mencegah membuat sumber daya secara otomatis untuk memberikan izin antara `AWS::Lambda::Permissions` sumber `AWS::Serverless::Api` daya Anda dan fungsi Lambda otorisasi.  
*Nilai default*: `false`  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionArn`   <a name="sam-api-lambdarequestauthorizer-functionarn"></a>
Tentukan fungsi ARN dari fungsi Lambda yang menyediakan otorisasi untuk API.  
AWS SAM akan secara otomatis membuat `AWS::Lambda::Permissions` sumber daya ketika `FunctionArn` ditentukan untuk`AWS::Serverless::Api`. Sumber `AWS::Lambda::Permissions` daya menyediakan izin antara API Anda dan fungsi Lambda otorisasi.
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionInvokeRole`   <a name="sam-api-lambdarequestauthorizer-functioninvokerole"></a>
Menambahkan kredensi otorisasi ke OpenApi definisi otorisasi Lambda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionPayloadType`   <a name="sam-api-lambdarequestauthorizer-functionpayloadtype"></a>
Properti ini dapat digunakan untuk menentukan tipe Otorisasi Lambda untuk API.  
*Nilai yang valid*: `TOKEN` atau `REQUEST`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `TOKEN`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Identity`   <a name="sam-api-lambdarequestauthorizer-identity"></a>
Properti ini dapat digunakan untuk menentukan `IdentitySource` dalam permintaan masuk untuk otorisasi. Properti ini hanya diperlukan jika properti `FunctionPayloadType` diatur ke `REQUEST`.  
*Jenis*: [LambdaRequestAuthorizationIdentity](sam-property-api-lambdarequestauthorizationidentity.md)  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-lambdarequestauthorizer--examples"></a>

### LambdaRequestAuth
<a name="sam-property-api-lambdarequestauthorizer--examples--lambdarequestauth"></a>

#### YAML
<a name="sam-property-api-lambdarequestauthorizer--examples--lambdarequestauth--yaml"></a>

```
Authorizers:
  MyLambdaRequestAuth:
    FunctionPayloadType: REQUEST
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    FunctionInvokeRole:
      Fn::GetAtt:
        - LambdaAuthInvokeRole
        - Arn
    Identity:
      Headers:
        - Authorization1
```

# LambdaRequestAuthorizationIdentity
<a name="sam-property-api-lambdarequestauthorizationidentity"></a>

Properti ini dapat digunakan untuk menentukan permintaan masuk untuk otorisasi. IdentitySource Untuk informasi selengkapnya, IdentitySource lihat [ OpenApi ekstensi ApiGateway Authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html).

## Sintaksis
<a name="sam-property-api-lambdarequestauthorizationidentity-syntax"></a>

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

### YAML
<a name="sam-property-api-lambdarequestauthorizationidentity-syntax.yaml"></a>

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

## Sifat-sifat
<a name="sam-property-api-lambdarequestauthorizationidentity-properties"></a>

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

 `Headers`   <a name="sam-api-lambdarequestauthorizationidentity-headers"></a>
Mengonversi header untuk string yang dipisahkan koma dari ekspresi pemetaan format `method.request.header.name`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueryStrings`   <a name="sam-api-lambdarequestauthorizationidentity-querystrings"></a>
Mengonversi string kueri yang diberikan menjadi string yang dipisahkan koma dari ekspresi pemetaan format `method.request.querystring.queryString`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ReauthorizeEvery`   <a name="sam-api-lambdarequestauthorizationidentity-reauthorizeevery"></a>
Periode time-to-live (TTL), dalam hitungan detik, yang menentukan berapa lama API Gateway menyimpan hasil otorisasi. Jika Anda menentukan nilai yang lebih besar dari 0, API Gateway akan menyimpan tanggapan pemberi kuasa. Secara default, API Gateway mengatur properti ini ke 300. Nilai maksimumnya adalah 3600, atau 1 jam.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 300  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `StageVariables`   <a name="sam-api-lambdarequestauthorizationidentity-stagevariables"></a>
Mengonversi variabel tahap yang diberikan menjadi string yang dipisahkan koma dari ekspresi pemetaan format `stageVariables.stageVariable`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-lambdarequestauthorizationidentity--examples"></a>

### LambdaRequestIdentity
<a name="sam-property-api-lambdarequestauthorizationidentity--examples--lambdarequestidentity"></a>

#### YAML
<a name="sam-property-api-lambdarequestauthorizationidentity--examples--lambdarequestidentity--yaml"></a>

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

# LambdaTokenAuthorizer
<a name="sam-property-api-lambdatokenauthorizer"></a>

Mengonfigurasi Otorisasi Lambda untuk mengendalikan akses ke API Anda dengan fungsi Lambda.

Untuk informasi selengkapnya dan contoh tambahan, lihat [Kontrol akses API dengan AWS SAM template Anda](serverless-controlling-access-to-apis.md).

## Sintaksis
<a name="sam-property-api-lambdatokenauthorizer-syntax"></a>

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

### YAML
<a name="sam-property-api-lambdatokenauthorizer-syntax.yaml"></a>

```
DisableFunctionDefaultPermissions: Boolean
[FunctionArn](#sam-api-lambdatokenauthorizer-functionarn): String
[FunctionInvokeRole](#sam-api-lambdatokenauthorizer-functioninvokerole): String
[FunctionPayloadType](#sam-api-lambdatokenauthorizer-functionpayloadtype): String
[Identity](#sam-api-lambdatokenauthorizer-identity): LambdaTokenAuthorizationIdentity
```

## Sifat-sifat
<a name="sam-property-api-lambdatokenauthorizer-properties"></a>

 `DisableFunctionDefaultPermissions`   <a name="sam-api-lambdatokenauthorizer-disablefunctiondefaultpermissions"></a>
Tentukan `true` untuk AWS SAM mencegah membuat sumber daya secara otomatis untuk memberikan izin antara `AWS::Lambda::Permissions` sumber `AWS::Serverless::Api` daya Anda dan fungsi Lambda otorisasi.  
*Nilai default*: `false`  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionArn`   <a name="sam-api-lambdatokenauthorizer-functionarn"></a>
Tentukan fungsi ARN dari fungsi Lambda yang menyediakan otorisasi untuk API.  
AWS SAM akan secara otomatis membuat `AWS::Lambda::Permissions` sumber daya ketika `FunctionArn` ditentukan untuk`AWS::Serverless::Api`. Sumber `AWS::Lambda::Permissions` daya menyediakan izin antara API Anda dan fungsi Lambda otorisasi.
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionInvokeRole`   <a name="sam-api-lambdatokenauthorizer-functioninvokerole"></a>
Menambahkan kredensi otorisasi ke OpenApi definisi otorisasi Lambda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionPayloadType`   <a name="sam-api-lambdatokenauthorizer-functionpayloadtype"></a>
Properti ini dapat digunakan untuk menentukan tipe Otorisasi Lambda untuk API.  
*Nilai yang valid*: `TOKEN` atau `REQUEST`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `TOKEN`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Identity`   <a name="sam-api-lambdatokenauthorizer-identity"></a>
Properti ini dapat digunakan untuk menentukan `IdentitySource` dalam permintaan masuk untuk otorisasi. Properti ini hanya diperlukan jika properti `FunctionPayloadType` diatur ke `REQUEST`.  
*Jenis*: [LambdaTokenAuthorizationIdentity](sam-property-api-lambdatokenauthorizationidentity.md)  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-lambdatokenauthorizer--examples"></a>

### LambdaTokenAuth
<a name="sam-property-api-lambdatokenauthorizer--examples--lambdatokenauth"></a>

#### YAML
<a name="sam-property-api-lambdatokenauthorizer--examples--lambdatokenauth--yaml"></a>

```
Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    Identity:
      Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization'
      ValidationExpression: mycustomauthexpression # OPTIONAL
      ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300
```

### BasicLambdaTokenAuth
<a name="sam-property-api-lambdatokenauthorizer--examples--basiclambdatokenauth"></a>

#### YAML
<a name="sam-property-api-lambdatokenauthorizer--examples--basiclambdatokenauth--yaml"></a>

```
Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
```

# LambdaTokenAuthorizationIdentity
<a name="sam-property-api-lambdatokenauthorizationidentity"></a>

Properti ini dapat digunakan untuk menentukan permintaan masuk untuk otorisasi. IdentitySource Untuk informasi selengkapnya, IdentitySource lihat [ OpenApi ekstensi ApiGateway Authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html).

## Sintaksis
<a name="sam-property-api-lambdatokenauthorizationidentity-syntax"></a>

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

### YAML
<a name="sam-property-api-lambdatokenauthorizationidentity-syntax.yaml"></a>

```
  [Header](#sam-api-lambdatokenauthorizationidentity-header): String
  [ReauthorizeEvery](#sam-api-lambdatokenauthorizationidentity-reauthorizeevery): Integer
  [ValidationExpression](#sam-api-lambdatokenauthorizationidentity-validationexpression): String
```

## Sifat-sifat
<a name="sam-property-api-lambdatokenauthorizationidentity-properties"></a>

 `Header`   <a name="sam-api-lambdatokenauthorizationidentity-header"></a>
Tentukan nama header untuk Otorisasi dalam OpenApi definisi.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Otorisasi  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ReauthorizeEvery`   <a name="sam-api-lambdatokenauthorizationidentity-reauthorizeevery"></a>
Periode time-to-live (TTL), dalam hitungan detik, yang menentukan berapa lama API Gateway menyimpan hasil otorisasi. Jika Anda menentukan nilai yang lebih besar dari 0, API Gateway akan menyimpan tanggapan pemberi kuasa. Secara default, API Gateway mengatur properti ini ke 300. Nilai maksimumnya adalah 3600, atau 1 jam.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 300  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ValidationExpression`   <a name="sam-api-lambdatokenauthorizationidentity-validationexpression"></a>
Tentukan ekspresi validasi untuk memvalidasi Identitas yang masuk.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-lambdatokenauthorizationidentity--examples"></a>

### LambdaTokenIdentity
<a name="sam-property-api-lambdatokenauthorizationidentity--examples--lambdatokenidentity"></a>

#### YAML
<a name="sam-property-api-lambdatokenauthorizationidentity--examples--lambdatokenidentity--yaml"></a>

```
Identity:
  Header: MyCustomAuthHeader
  ValidationExpression: Bearer.*
  ReauthorizeEvery: 30
```

# ResourcePolicyStatement
<a name="sam-property-api-resourcepolicystatement"></a>

Mengonfigurasi kebijakan sumber daya untuk semua metode dan jalur API. Untuk informasi selengkapnya tentang kebijakan sumber daya, lihat [Mengendalikan akses ke API dengan kebijakan sumber daya API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) di *Panduan Developer API Gateway*.

## Sintaksis
<a name="sam-property-api-resourcepolicystatement-syntax"></a>

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

### YAML
<a name="sam-property-api-resourcepolicystatement-syntax.yaml"></a>

```
  [AwsAccountBlacklist](#sam-api-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-api-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-api-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-api-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-api-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-api-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-api-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-api-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-api-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-api-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-api-resourcepolicystatement-sourcevpcwhitelist): List
```

## Sifat-sifat
<a name="sam-property-api-resourcepolicystatement-properties"></a>

 `AwsAccountBlacklist`   <a name="sam-api-resourcepolicystatement-awsaccountblacklist"></a>
 AWS Akun yang akan diblokir.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AwsAccountWhitelist`   <a name="sam-api-resourcepolicystatement-awsaccountwhitelist"></a>
 AWS Akun untuk memungkinkan. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CustomStatements`   <a name="sam-api-resourcepolicystatement-customstatements"></a>
Daftar pernyataan kebijakan sumber daya kustom untuk diterapkan ke API ini. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcBlacklist`   <a name="sam-api-resourcepolicystatement-intrinsicvpcblacklist"></a>
Daftar virtual private cloud (VPCs) yang akan diblokir, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcWhitelist`   <a name="sam-api-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Daftar VPCs to allow, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceBlacklist`   <a name="sam-api-resourcepolicystatement-intrinsicvpceblacklist"></a>
Daftar VPC endpoint yang akan diblokir, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceWhitelist`   <a name="sam-api-resourcepolicystatement-intrinsicvpcewhitelist"></a>
Daftar VPC endpoint yang akan diizinkan, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeBlacklist`   <a name="sam-api-resourcepolicystatement-iprangeblacklist"></a>
Alamat IP atau jangkauan alamat yang akan diblokir. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeWhitelist`   <a name="sam-api-resourcepolicystatement-iprangewhitelist"></a>
Alamat IP atau jangkauan alamat yang akan diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcBlacklist`   <a name="sam-api-resourcepolicystatement-sourcevpcblacklist"></a>
Sumber VPC atau VPC endpoint yang akan diblokir. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcWhitelist`   <a name="sam-api-resourcepolicystatement-sourcevpcwhitelist"></a>
VPC sumber atau VPC endpoint yang akan diizinkan. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-resourcepolicystatement--examples"></a>

### Contoh Kebijakan Sumber Daya
<a name="sam-property-api-resourcepolicystatement--examples--resource-policy-example"></a>

Contoh berikut memblokir dua alamat IP dan VPC sumber, dan memungkinkan akun AWS .

#### YAML
<a name="sam-property-api-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# ApiDefinition
<a name="sam-property-api-apidefinition"></a>

Dokumen OpenAPI yang menentukan API.

## Sintaksis
<a name="sam-property-api-apidefinition-syntax"></a>

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

### YAML
<a name="sam-property-api-apidefinition-syntax.yaml"></a>

```
  [Bucket](#sam-api-apidefinition-bucket): String
  [Key](#sam-api-apidefinition-key): String
  [Version](#sam-api-apidefinition-version): String
```

## Sifat-sifat
<a name="sam-property-api-apidefinition-properties"></a>

 `Bucket`   <a name="sam-api-apidefinition-bucket"></a>
Nama bucket Amazon S3 tempat file OpenAPI disimpan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket)` properti tipe `AWS::ApiGateway::RestApi` `S3Location` data.

 `Key`   <a name="sam-api-apidefinition-key"></a>
Kunci Amazon S3 dari file OpenAPI.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key)` properti tipe `AWS::ApiGateway::RestApi` `S3Location` data.

 `Version`   <a name="sam-api-apidefinition-version"></a>
Untuk objek berversi, versi file OpenAPI.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version)` properti tipe `AWS::ApiGateway::RestApi` `S3Location` data.

## Contoh
<a name="sam-property-api-apidefinition--examples"></a>

### Contoh Uri Ketentuan
<a name="sam-property-api-apidefinition--examples--definition-uri-example"></a>

Contoh ketentuan API

#### YAML
<a name="sam-property-api-apidefinition--examples--definition-uri-example--yaml"></a>

```
DefinitionUri:
  Bucket: amzn-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# CorsConfiguration
<a name="sam-property-api-corsconfiguration"></a>

Kelola berbagi sumber daya lintas asal (CORS) untuk API Gateway Anda. APIs Tentukan domain untuk diizinkan sebagai string atau tentukan kamus dengan konfigurasi Cors tambahan.

**catatan**  
CORS AWS SAM perlu memodifikasi definisi OpenAPI Anda. Buat definisi OpenAPI sebaris di untuk mengaktifkan `DefinitionBody` CORS. Jika `CorsConfiguration` disetel dalam definisi OpenAPI dan juga di tingkat properti, AWS SAM gabungkan mereka. Level properti lebih diutamakan daripada definisi OpenAPI.

Untuk informasi lebih lanjut tentang CORS, lihat [Aktifkan CORS untuk sumber daya API REST API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html) di *Panduan Developer API Gateway*.

## Sintaksis
<a name="sam-property-api-corsconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-api-corsconfiguration-syntax.yaml"></a>

```
  [AllowCredentials](#sam-api-corsconfiguration-allowcredentials): Boolean
  [AllowHeaders](#sam-api-corsconfiguration-allowheaders): String
  [AllowMethods](#sam-api-corsconfiguration-allowmethods): String
  [AllowOrigin](#sam-api-corsconfiguration-alloworigin): String
  [MaxAge](#sam-api-corsconfiguration-maxage): String
```

## Sifat-sifat
<a name="sam-property-api-corsconfiguration-properties"></a>

 `AllowCredentials`   <a name="sam-api-corsconfiguration-allowcredentials"></a>
Boolean yang menunjukkan apakah permintaan diizinkan untuk berisi kredensial.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AllowHeaders`   <a name="sam-api-corsconfiguration-allowheaders"></a>
String header yang akan diizinkan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AllowMethods`   <a name="sam-api-corsconfiguration-allowmethods"></a>
String yang berisi metode HTTP yang akan diizinkan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AllowOrigin`   <a name="sam-api-corsconfiguration-alloworigin"></a>
String asal yang akan diizinkan. Ini bisa berupa daftar yang dipisahkan koma dalam format string.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `MaxAge`   <a name="sam-api-corsconfiguration-maxage"></a>
String yang berisi jumlah detik untuk men-cache permintaan CORS Preflight.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-api-corsconfiguration--examples"></a>

### CorsConfiguration
<a name="sam-property-api-corsconfiguration--examples--corsconfiguration"></a>

Contoh Konfigurasi CORS. Ini hanyalah sebagian dari file AWS SAM template yang menunjukkan [AWS::Serverless::Api](sam-resource-api.md) definisi dengan CORS dikonfigurasi dan file. [AWS::Serverless::Function](sam-resource-function.md) Jika Anda menggunakan integrasi proxy Lambda atau integrasi proxy HTTP, backend Anda harus mengembalikan`Access-Control-Allow-Origin`,, `Access-Control-Allow-Methods` dan header. `Access-Control-Allow-Headers`

#### YAML
<a name="sam-property-api-corsconfiguration--examples--corsconfiguration--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Cors:
        AllowMethods: "'POST, GET'"
        AllowHeaders: "'X-Forwarded-For'"
        AllowOrigin: "'https://example.com'"
        MaxAge: "'600'"
        AllowCredentials: true
  ApiFunction: # Adds a GET method at the root resource via an Api event
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /
            Method: get
            RestApiId:
              Ref: ApiGatewayApi
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        import json
        def handler(event, context):
          return {
          'statusCode': 200,
          'headers': {
            'Access-Control-Allow-Headers': 'Content-Type',
            'Access-Control-Allow-Origin': 'https://example.com',
            'Access-Control-Allow-Methods': 'POST, GET'
            },
          'body': json.dumps('Hello from Lambda!')
          }
```

# DomainConfiguration
<a name="sam-property-api-domainconfiguration"></a>

Mengonfigurasi domain kustom untuk API.

## Sintaksis
<a name="sam-property-api-domainconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-api-domainconfiguration-syntax.yaml"></a>

```
  [AccessAssociation](#sam-api-domainconfiguration-domainaccessassociation): DomainAccessAssociation
  [BasePath](#sam-api-domainconfiguration-basepath): List
  [CertificateArn](#sam-api-domainconfiguration-certificatearn): String
  [DomainName](#sam-api-domainconfiguration-domainname): String
  [EndpointConfiguration](#sam-api-domainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-api-domainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)
  [NormalizeBasePath](#sam-api-domainconfiguration-normalizebasepath): Boolean
  [OwnershipVerificationCertificateArn](#sam-api-domainconfiguration-ownershipverificationcertificatearn): String
  [Policy: ](#sam-api-domainconfiguration-policy)Json
  [Route53](#sam-api-domainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-api-domainconfiguration-securitypolicy): String
```

## Sifat-sifat
<a name="sam-property-api-domainconfiguration-properties"></a>

 `AccessAssociation`   <a name="sam-api-domainconfiguration-domainaccessassociation"></a>
Konfigurasi yang diperlukan untuk menghasilkan ` AWS::ApiGateway::DomainNameAccessAssociation` sumber daya.  
AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html)daya saat properti ini disetel. Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Jenis*: [DomainAccessAssociation](sam-property-api-domainaccessassociation.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `BasePath`   <a name="sam-api-domainconfiguration-basepath"></a>
Daftar basepaths untuk mengonfigurasi dengan nama domain Amazon API Gateway.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*:/  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` properti `AWS::ApiGateway::BasePathMapping` sumber daya. AWS SAM menciptakan beberapa `AWS::ApiGateway::BasePathMapping` sumber daya, satu per `BasePath` ditentukan dalam properti ini.

 `CertificateArn`   <a name="sam-api-domainconfiguration-certificatearn"></a>
Nama Sumber Daya Amazon (ARN) dari sertifikat AWS terkelola titik akhir nama domain ini. AWS Certificate Manager adalah satu-satunya sumber yang didukung.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)` properti `AWS::ApiGateway::DomainName` sumber daya. Jika `EndpointConfiguration` diatur ke `REGIONAL` (nilai default), `CertificateArn` peta ke [RegionalCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn)in`AWS::ApiGateway::DomainName`. Jika `EndpointConfiguration` diatur ke`EDGE`, `CertificateArn` petakan ke [CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)in`AWS::ApiGateway::DomainName`. Jika `EndpointConfiguration` disetel ke`PRIVATE`, properti ini diteruskan ke sumber daya [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2).  
*Catatan tambahan*: Untuk `EDGE` titik akhir, Anda harus membuat sertifikat di `us-east-1` AWS Wilayah.

 `DomainName`   <a name="sam-api-domainconfiguration-domainname"></a>
Nama domain khusus untuk API dari API Gateway Anda. Tidak didukung huruf besar.  
AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html)daya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat [DomainName properti ditentukan](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-domain-name). Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname)` properti `AWS::ApiGateway::DomainName` sumber daya, atau [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)kapan EndpointConfiguration disetel ke`PRIVATE`.

 `EndpointConfiguration`   <a name="sam-api-domainconfiguration-endpointconfiguration"></a>
Menentukan tipe titik akhir API Gateway untuk memetakan ke domain kustom. Nilai properti ini menentukan bagaimana `CertificateArn` properti dipetakan. CloudFormation  
*Nilai yang valid*: `EDGE`, `REGIONAL`, atau `PRIVATE`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `REGIONAL`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `MutualTlsAuthentication`   <a name="sam-api-domainconfiguration-mutualtlsauthentication"></a>
Konfigurasi autentikasi Keamanan Lapisan Pengangkutan (TLS) yang saling terkait untuk nama domain kustom.  
*Jenis*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)` properti `AWS::ApiGateway::DomainName` sumber daya.

 `NormalizeBasePath`   <a name="sam-api-domainconfiguration-normalizebasepath"></a>
Menunjukkan apakah karakter non-alfanumerik diizinkan dalam basepaths yang ditentukan oleh properti. `BasePath` Ketika diatur ke`True`, karakter non-alfanumerik dihapus dari basepaths.  
Gunakan `NormalizeBasePath` dengan `BasePath` properti.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: BETUL  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `OwnershipVerificationCertificateArn`   <a name="sam-api-domainconfiguration-ownershipverificationcertificatearn"></a>
ARN sertifikat publik yang dikeluarkan oleh ACM untuk memvalidasi kepemilikan domain kustom Anda. Diperlukan hanya ketika Anda mengonfigurasi TLS timbal balik dan Anda menentukan ARN sertifikat CA yang diimpor atau pribadi ACM untuk ARN. `CertificateArn`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn)` properti `AWS::ApiGateway::DomainName` sumber daya.

 `Policy`   <a name="sam-api-domainconfiguration-policy"></a>
Kebijakan IAM untuk melampirkan ke nama domain API Gateway. Hanya berlaku bila `EndpointConfiguration` disetel ke`PRIVATE`.  
*Jenis*: Json  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `Policy` properti `AWS::ApiGateway::DomainNameV2` sumber daya saat `EndpointConfiguration` disetel ke`PRIVATE`. Untuk contoh dokumen kebijakan yang valid, lihat [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2).

 `Route53`   <a name="sam-api-domainconfiguration-route53"></a>
Menentukan konfigurasi Amazon Route 53.  
*Tipe*:[Route53Configuration](sam-property-api-route53configuration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SecurityPolicy`   <a name="sam-api-domainconfiguration-securitypolicy"></a>
Versi TLS ditambah paket sandi untuk nama domain ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy)` properti `AWS::ApiGateway::DomainName` sumber daya, atau [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)kapan `EndpointConfiguration` disetel ke`PRIVATE`. Untuk `PRIVATE` titik akhir, hanya TLS\$11\$12 yang didukung.

## Contoh
<a name="sam-property-api-domainconfiguration--examples"></a>

### DomainName
<a name="sam-property-api-domainconfiguration--examples--domainname"></a>

DomainName contoh

#### YAML
<a name="sam-property-api-domainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```

# DomainAccessAssociation
<a name="sam-property-api-domainaccessassociation"></a>

Mengkonfigurasi asosiasi akses domain antara sumber asosiasi akses dan nama domain kustom pribadi. Satu-satunya sumber asosiasi akses yang didukung adalah ID titik akhir VPC. Untuk informasi selengkapnya, lihat [Nama domain khusus untuk pribadi APIs di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html).

## Sintaksis
<a name="sam-property-api-domainaccessassociation-syntax"></a>

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

### YAML
<a name="sam-property-api-domainaccessassociation-syntax.yaml"></a>

```
 VpcEndpointId: String
```

## Sifat-sifat
<a name="sam-property-api-domainaccessassociation-properties"></a>

 `VpcEndpointId`   <a name="sam-api-domainaccessassociation-vpcendpointid"></a>
ID titik akhir dari titik akhir antarmuka VPC yang terkait dengan layanan VPC API Gateway.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ AccessAssociationSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsource)` properti `AWS::ApiGateway::DomainNameAccessAssociation` sumber daya.

# Route53Configuration
<a name="sam-property-api-route53configuration"></a>

Mengonfigurasi set catatan Route53 untuk API.

## Sintaksis
<a name="sam-property-api-route53configuration-syntax"></a>

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

### YAML
<a name="sam-property-api-route53configuration-syntax.yaml"></a>

```
  [DistributionDomainName](#sam-api-route53configuration-distributiondomainname): String
  [EvaluateTargetHealth](#sam-api-route53configuration-evaluatetargethealth): Boolean
  [HostedZoneId](#sam-api-route53configuration-hostedzoneid): String
  [HostedZoneName](#sam-api-route53configuration-hostedzonename): String
  [IpV6](#sam-api-route53configuration-ipv6): Boolean
  Region: String
  SetIdentifier: String
  VpcEndpointDomainName: String
  VpcEndpointHostedZoneId: String
```

## Sifat-sifat
<a name="sam-property-api-route53configuration-properties"></a>

 `DistributionDomainName`   <a name="sam-api-route53configuration-distributiondomainname"></a>
Mengonfigurasi distribusi kustom nama domain kustom API.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Gunakan distribusi API Gateway.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname)` properti `AWS::Route53::RecordSetGroup AliasTarget` sumber daya.  
*Catatan tambahan*: Nama domain [CloudFrontdistribusi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).

 `EvaluateTargetHealth`   <a name="sam-api-route53configuration-evaluatetargethealth"></a>
Kapan EvaluateTargetHealth benar, catatan alias mewarisi kesehatan AWS sumber daya yang direferensikan, seperti penyeimbang beban Elastic Load Balancing atau catatan lain di zona yang dihosting.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)` properti `AWS::Route53::RecordSetGroup AliasTarget` sumber daya.  
*Catatan tambahan*: Anda tidak dapat mengatur EvaluateTargetHealth ke true ketika target alias adalah CloudFront distribusi.

 `HostedZoneId`   <a name="sam-api-route53configuration-hostedzoneid"></a>
ID zona yang di-hosting tempat Anda ingin membuat catatan.  
Tentukan `HostedZoneName` atau `HostedZoneId`, tapi tidak keduanya. Jika Anda memiliki beberapa zona yang di-hosting dengan nama domain yang sama, Anda harus menentukan zona yang di-hosting menggunakan `HostedZoneId`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid)` properti `AWS::Route53::RecordSetGroup RecordSet` sumber daya.

 `HostedZoneName`   <a name="sam-api-route53configuration-hostedzonename"></a>
Nama zona yang di-hosting tempat ingin Anda membuat catatan.  
Tentukan `HostedZoneName` atau `HostedZoneId`, jangan keduanya. Jika Anda memiliki beberapa zona yang di-hosting dengan nama domain yang sama, Anda harus menentukan zona yang di-hosting menggunakan `HostedZoneId`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename)` properti `AWS::Route53::RecordSetGroup RecordSet` sumber daya.

 `IpV6`   <a name="sam-api-route53configuration-ipv6"></a>
Saat properti ini disetel, AWS SAM buat `AWS::Route53::RecordSet` sumber daya dan set [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type) `AAAA` untuk yang disediakan HostedZone.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Region`  <a name="sam-api-route53configuration-region"></a>
*Hanya set catatan sumber daya berbasis latensi*: EC2 Wilayah Amazon tempat Anda membuat sumber daya yang dirujuk oleh kumpulan catatan sumber daya ini. Sumber daya biasanya adalah AWS sumber daya, seperti EC2 instance atau penyeimbang beban ELB, dan disebut dengan alamat IP atau nama domain DNS, tergantung pada jenis catatan.  
Saat Amazon Route 53 menerima kueri DNS untuk nama domain dan jenis yang telah Anda buat set catatan sumber daya latensi, Route 53 memilih kumpulan catatan sumber daya latensi yang memiliki latensi terendah antara pengguna akhir dan Wilayah Amazon terkait. EC2 Route 53 kemudian mengembalikan nilai yang terkait dengan set catatan sumber daya yang dipilih.  
Perhatikan hal-hal berikut:  
+ Anda hanya dapat menentukan satu `ResourceRecord` per set catatan sumber daya latensi.
+ Anda hanya dapat membuat satu set catatan sumber daya latensi untuk setiap EC2 Wilayah Amazon.
+ Anda tidak diharuskan membuat kumpulan rekaman sumber daya latensi untuk semua EC2 Wilayah Amazon. Route 53 akan memilih wilayah dengan latensi terbaik dari antara wilayah yang Anda buat set catatan sumber daya latensi.
+ Anda tidak dapat membuat set catatan sumber daya non-latensi yang memiliki nilai yang sama untuk elemen `Name` dan `Type` sebagai set catatan sumber daya latensi.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-region)` properti tipe `AWS::Route53::RecordSetGroup` `RecordSet` data.

`SetIdentifier`  <a name="sam-api-route53configuration-setidentifier"></a>
*Set catatan sumber daya yang memiliki kebijakan perutean selain sederhana:* Pengenal yang membedakan antara beberapa set catatan sumber daya yang memiliki kombinasi nama dan jenis yang sama, seperti beberapa set catatan sumber daya tertimbang bernama acme.example.com yang memiliki tipe A. Dalam grup set catatan sumber daya yang memiliki nama dan tipe yang sama, nilai `SetIdentifier` harus unik untuk setiap set catatan sumber daya.  
Untuk informasi tentang kebijakan perutean, lihat [Memilih kebijakan perutean di Panduan](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) *Pengembang Amazon Route 53*.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ SetIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-setidentifier)` properti tipe `AWS::Route53::RecordSetGroup` `RecordSet` data.

`VpcEndpointDomainName`  <a name="sam-api-route53configuration-vpcendpointdomainname"></a>
Nama DNS dari titik akhir antarmuka VPC yang terkait dengan layanan VPC API Gateway. Properti ini hanya diperlukan untuk domain pribadi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-aliastarget.html)` properti `AWS::Route53::RecordSet` `AliasTarget` bidang.

`VpcEndpointHostedZoneId`  <a name="sam-api-route53configuration-vpcendpointhostedzoneid"></a>
ID zona yang dihosting dari titik akhir antarmuka VPC yang terkait dengan layanan VPC API Gateway. Properti ini hanya diperlukan untuk domain pribadi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-aliastarget.html)` properti `AWS::Route53::RecordSet` `AliasTarget` bidang.

## Contoh
<a name="sam-property-api-route53configuration--examples"></a>

### Contoh basic
<a name="sam-property-api-route53configuration--examples--route-53-configuration-example"></a>

Dalam contoh ini, kami mengonfigurasi domain kustom dan set rekaman Route 53 untuk API kami.

#### YAML
<a name="sam-property-api-route53configuration--examples--route-53-configuration-example--yaml"></a>

```
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Domain:
        DomainName: www.example.com
        CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/abcdef12-3456-7890-abcd-ef1234567890
        EndpointConfiguration: REGIONAL
        Route53:
          HostedZoneId: ABCDEFGHIJKLMNOP
```

# EndpointConfiguration
<a name="sam-property-api-endpointconfiguration"></a>

Tipe titik akhir dari REST API.

## Sintaksis
<a name="sam-property-api-endpointconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-api-endpointconfiguration-syntax.yaml"></a>

```
  [IpAddressType](#sam-api-endpointconfiguration-ipaddresstype): String
  [Type](#sam-api-endpointconfiguration-type): String
  [VPCEndpointIds](#sam-api-endpointconfiguration-vpcendpointids): List
```

## Sifat-sifat
<a name="sam-property-api-endpointconfiguration-properties"></a>

 `IpAddressType`   <a name="sam-api-endpointconfiguration-ipaddresstype"></a>
Jenis alamat IP yang dapat memanggil API (RestApi).  
*Nilai yang valid*: `ipv4` atau `dualstack`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[IpAddressType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype)` properti tipe `AWS::ApiGateway::RestApi` `EndpointConfiguration` data.

 `Type`   <a name="sam-api-endpointconfiguration-type"></a>
Tipe titik akhir dari REST API.  
*Nilai yang valid*: `EDGE` atau `REGIONAL` atau `PRIVATE`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Types](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types)` properti tipe `AWS::ApiGateway::RestApi` `EndpointConfiguration` data.

 `VPCEndpointIds`   <a name="sam-api-endpointconfiguration-vpcendpointids"></a>
Daftar titik akhir IDs VPC dari REST API yang digunakan untuk membuat alias Route53.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[VpcEndpointIds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids)` properti tipe `AWS::ApiGateway::RestApi` `EndpointConfiguration` data.

## Contoh
<a name="sam-property-api-endpointconfiguration--examples"></a>

### EndpointConfiguration
<a name="sam-property-api-endpointconfiguration--examples--endpointconfiguration"></a>

Contoh Konfigurasi Titik Akhir

#### YAML
<a name="sam-property-api-endpointconfiguration--examples--endpointconfiguration--yaml"></a>

```
EndpointConfiguration:
  Type: PRIVATE
  VPCEndpointIds:
    - vpce-123a123a
    - vpce-321a321a
```

# AWS::Serverless::Application
<a name="sam-resource-application"></a>

Menyematkan aplikasi nirserver dari [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications) atau dari bucket Amazon S3 sebagai aplikasi yang di-nest. Aplikasi bersarang digunakan sebagai [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html)sumber daya bersarang, yang dapat berisi beberapa sumber daya lain termasuk sumber daya lainnya. [AWS::Serverless::Application](#sam-resource-application)

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaksis
<a name="sam-resource-application-syntax"></a>

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

### YAML
<a name="sam-resource-application-syntax.yaml"></a>

```
Type: AWS::Serverless::Application
Properties:
  [Location](#sam-application-location): String | ApplicationLocationObject
  [NotificationARNs](#sam-application-notificationarns): List
  [Parameters](#sam-application-parameters): Map
  [Tags](#sam-application-tags): Map
  [TimeoutInMinutes](#sam-application-timeoutinminutes): Integer
```

## Sifat-sifat
<a name="sam-resource-application-properties"></a>

 `Location`   <a name="sam-application-location"></a>
URL templat, jalur file, atau lokasi objek dari aplikasi yang di-nest.  
Jika URL template disediakan, itu harus mengikuti format yang ditentukan dalam [CloudFormation TemplateUrl dokumentasi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl) dan berisi template yang valid CloudFormation atau SAM. [ApplicationLocationObject](sam-property-application-applicationlocationobject.md) dapat digunakan untuk menentukan aplikasi yang telah diterbitkan ke [AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html).  
Jika jalur file lokal tersedia, templat harus melalui alur kerja yang mencakup perintah `sam deploy` atau `sam package`, agar aplikasi dapat diubah dengan benar.  
*Jenis*: String \$1 [ApplicationLocationObject](sam-property-application-applicationlocationobject.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[TemplateURL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl)` properti `AWS::CloudFormation::Stack` sumber daya. CloudFormation Versi tidak mengambil [ApplicationLocationObject](sam-property-application-applicationlocationobject.md) untuk mengambil aplikasi dari file. AWS Serverless Application Repository

 `NotificationARNs`   <a name="sam-application-notificationarns"></a>
Daftar topik Amazon SNS yang ada tempat notifikasi tentang peristiwa tumpukan dikirim.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[NotificationARNs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns)` properti `AWS::CloudFormation::Stack` sumber daya.

 `Parameters`   <a name="sam-application-parameters"></a>
Nilai parameter aplikasi.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters)` properti `AWS::CloudFormation::Stack` sumber daya.

 `Tags`   <a name="sam-application-tags"></a>
Sebuah peta (string ke string) yang menentukan tanda yang akan ditambahkan ke aplikasi ini. Kunci dan nilai terbatas pada karakter alfanumerik. Kunci dapat berisi 1 hingga 127 karakter Unicode dan tidak boleh diawali dengan aws:. Nilai dapat berisi 1 hingga 255 karakter Unicode.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags)` properti `AWS::CloudFormation::Stack` sumber daya. Properti Tags di SAM terdiri dari pasangan Key:Value; di CloudFormation dalamnya terdiri dari daftar objek Tag. Ketika tumpukan dibuat, SAM secara otomatis akan menambahkan tanda `lambda:createdBy:SAM` untuk aplikasi ini. Selain itu, jika aplikasi ini dari AWS Serverless Application Repository, maka SAM juga akan otomatis dua tag tambahan `serverlessrepo:applicationId:ApplicationId` dan`serverlessrepo:semanticVersion:SemanticVersion`.

 `TimeoutInMinutes`   <a name="sam-application-timeoutinminutes"></a>
Lamanya waktu, dalam hitungan menit, yang CloudFormation menunggu tumpukan bersarang mencapai status. `CREATE_COMPLETE` Default tidak memiliki waktu habis. Ketika CloudFormation mendeteksi bahwa tumpukan bersarang telah mencapai `CREATE_COMPLETE` status, itu menandai sumber daya tumpukan bersarang seperti `CREATE_COMPLETE` pada tumpukan induk dan melanjutkan pembuatan tumpukan induk. Jika periode batas waktu berakhir sebelum tumpukan bersarang mencapai`CREATE_COMPLETE`, CloudFormation tandai tumpukan bersarang sebagai gagal dan memutar kembali tumpukan bersarang dan tumpukan induk.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TimeoutInMinutes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes)` properti `AWS::CloudFormation::Stack` sumber daya.

## Nilai Pengembalian
<a name="sam-resource-application-return-values"></a>

### Ref
<a name="sam-resource-application-return-values-ref"></a>

Ketika ID logis dari sumber daya ini disediakan untuk fungsi intrinsik `Ref`, ia mengembalikan nama sumber daya dari sumber daya `AWS::CloudFormation::Stack` utama.

Untuk informasi lebih lanjut tentang penggunaan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

### Fn:: GetAtt
<a name="sam-resource-application-return-values-fn--getatt"></a>

`Fn::GetAtt` mengembalikan nilai untuk atribut yang ditentukan dari jenis ini. Berikut ini adalah atribut yang tersedia dan nilai-nilai kembali sampel. 

Untuk informasi lebih lanjut tentang menggunakan `Fn::GetAtt`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) di *Panduan Pengguna AWS CloudFormation *. 

`Outputs.ApplicationOutputName`  <a name="Outputs.ApplicationOutputName-fn::getatt"></a>
Nilai output tumpukan dengan nama `ApplicationOutputName`.

## Contoh
<a name="sam-resource-application--examples"></a>

### Aplikasi SAR
<a name="sam-resource-application--examples--sar-application"></a>

Aplikasi yang menggunakan templat dari Serverless Application Repository

#### YAML
<a name="sam-resource-application--examples--sar-application--yaml"></a>

```
Type: AWS::Serverless::Application
Properties:
  Location:
    ApplicationId: 'arn:aws:serverlessrepo:us-east-1:012345678901:applications/my-application'
    SemanticVersion: 1.0.0
  Parameters:
    StringParameter: parameter-value
    IntegerParameter: 2
```

### Aplikasi-Normal
<a name="sam-resource-application--examples--normal-application"></a>

Aplikasi dari url S3

#### YAML
<a name="sam-resource-application--examples--normal-application--yaml"></a>

```
Type: AWS::Serverless::Application
Properties:
  Location: https://s3.amazonaws.com/sam-s3-demo-bucket/template.yaml
```

# ApplicationLocationObject
<a name="sam-property-application-applicationlocationobject"></a>

Aplikasi yang telah diterbitkan ke [AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html).

## Sintaksis
<a name="sam-property-application-applicationlocationobject-syntax"></a>

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

### YAML
<a name="sam-property-application-applicationlocationobject-syntax.yaml"></a>

```
  [ApplicationId](#sam-application-applicationlocationobject-applicationid): String
  [SemanticVersion](#sam-application-applicationlocationobject-semanticversion): String
```

## Sifat-sifat
<a name="sam-property-application-applicationlocationobject-properties"></a>

 `ApplicationId`   <a name="sam-application-applicationlocationobject-applicationid"></a>
Amazon Resource Name (ARN) dari aplikasi.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SemanticVersion`   <a name="sam-application-applicationlocationobject-semanticversion"></a>
Versi semantik aplikasi.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-application-applicationlocationobject--examples"></a>

### my-application
<a name="sam-property-application-applicationlocationobject--examples--my-application"></a>

Contoh objek lokasi aplikasi

#### YAML
<a name="sam-property-application-applicationlocationobject--examples--my-application--yaml"></a>

```
Location:
  ApplicationId: 'arn:aws:serverlessrepo:us-east-1:012345678901:applications/my-application'
  SemanticVersion: 1.0.0
```

# AWS::Serverless::CapacityProvider
<a name="sam-resource-capacityprovider"></a>

 Membuat penyedia kapasitas untuk AWS Lambda fungsi yang memungkinkan menjalankan Instans Terkelola Lambda pada instans Amazon Elastic Compute Cloud milik pelanggan. Sumber daya ini merupakan bagian dari fitur Instans Terkelola Lambda, yang menyediakan pengoptimalan biaya untuk beban kerja Lambda skala besar dengan memanfaatkan model penetapan harga Amazon. EC2 

 Penyedia kapasitas mengelola siklus hidup EC2 instans Amazon dan menyediakan infrastruktur yang diperlukan untuk fungsi Lambda untuk dijalankan pada sumber daya komputasi milik pelanggan sambil mempertahankan model pemrograman tanpa server. 

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md). 

## Sintaksis
<a name="sam-resource-capacityprovider-syntax"></a>

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

### YAML
<a name="sam-resource-capacityprovider-syntax.yaml"></a>

```
Type: AWS::Serverless::CapacityProvider
Properties:
  [CapacityProviderName](#sam-capacityprovider-capacityprovidername): String
  [VpcConfig](#sam-capacityprovider-vpcconfig): VpcConfig
  [OperatorRole](#sam-capacityprovider-operatorrole): String
  [Tags](#sam-capacityprovider-tags): Map
  [PropagateTags](#sam-capacityprovider-propagatetags): Boolean
  [InstanceRequirements](#sam-capacityprovider-instancerequirements): InstanceRequirements
  [ScalingConfig](#sam-capacityprovider-scalingconfig): ScalingConfig
  [KmsKeyArn](#sam-capacityprovider-kmskeyarn): String
```

## Sifat-sifat
<a name="sam-resource-capacityprovider-properties"></a>

 `CapacityProviderName`   <a name="sam-capacityprovider-capacityprovidername"></a>
Nama dari penyedia kapasitas. Nama ini harus unik dalam AWS akun dan wilayah Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CapacityProviderName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityprovidername)` properti `AWS::Lambda::CapacityProvider` sumber daya. 

 `VpcConfig`   <a name="sam-capacityprovider-vpcconfig"></a>
Konfigurasi VPC untuk penyedia kapasitas. Menentukan subnet VPC dan grup keamanan tempat instans EC2 Amazon akan diluncurkan.  
*Jenis*: [VpcConfig](sam-property-capacityprovider-vpcconfig.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig)` properti `AWS::Lambda::CapacityProvider` sumber daya. 

 `OperatorRole`   <a name="sam-capacityprovider-operatorrole"></a>
 ARN peran operator untuk Lambda dengan izin untuk membuat dan mengelola EC2 instans Amazon dan sumber daya terkait di akun pelanggan. Jika tidak disediakan, AWS SAM secara otomatis menghasilkan peran dengan izin yang diperlukan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CapacityProviderOperatorRoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.html#cfn-lambda-capacityprovider-capacityproviderpermissionsconfig-capacityprovideroperatorrolearn)` properti `[PermissionsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-permissionsconfig)` `AWS::Lambda::CapacityProvider` sumber daya. 

 `Tags`   <a name="sam-capacityprovider-tags"></a>
Peta pasangan nilai kunci untuk diterapkan pada penyedia kapasitas dan sumber daya terkaitnya.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-tags)` properti `AWS::Lambda::CapacityProvider` sumber daya. `Tags`Properti di AWS SAM terdiri dari pasangan kunci-nilai (sedangkan dalam properti CloudFormation ini terdiri dari daftar objek Tag). Selain itu, AWS SAM secara otomatis menambahkan `lambda:createdBy:SAM` tag ke fungsi Lambda ini, dan ke peran default yang dihasilkan untuk fungsi ini. 

 `PropagateTags`   <a name="sam-capacityprovider-propagatetags"></a>
 Menunjukkan apakah akan meneruskan tag dari properti Tag ke sumber daya yang Anda `AWS::Serverless::CapacityProvider` hasilkan atau tidak. Setel ini `True` untuk menyebarkan tag di sumber daya yang Anda hasilkan.   
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `InstanceRequirements`   <a name="sam-capacityprovider-instancerequirements"></a>
 Spesifikasi untuk jenis contoh komputasi yang dapat digunakan oleh penyedia kapasitas. Ini termasuk persyaratan arsitektur dan `allowed` atau jenis `excluded` instance.  
*Jenis*: [InstanceRequirements](sam-property-capacityprovider-instancerequirements.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` properti `AWS::Lambda::CapacityProvider` sumber daya. 

 `ScalingConfig`   <a name="sam-capacityprovider-scalingconfig"></a>
 Konfigurasi penskalaan untuk penyedia kapasitas. Mendefinisikan bagaimana penyedia kapasitas menskalakan EC2 instans Amazon berdasarkan permintaan.  
*Jenis*: [ScalingConfig](sam-property-capacityprovider-scalingconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CapacityProviderScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig)` properti `AWS::Lambda::CapacityProvider` sumber daya. 

 `KmsKeyArn`   <a name="sam-capacityprovider-kmskeyarn"></a>
ARN dari AWS KMS kunci yang digunakan untuk mengenkripsi data saat istirahat dan dalam perjalanan untuk penyedia kapasitas.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-kmskeyarn)` properti `AWS::Lambda::CapacityProvider` sumber daya. 

## Nilai Pengembalian
<a name="sam-resource-capacityprovider-return-values"></a>

### Ref
<a name="sam-resource-capacityprovider-return-values-ref"></a>

Ketika ID logis dari sumber daya ini disediakan untuk fungsi `Ref` intrinsik, ia mengembalikan nama penyedia kapasitas.

Untuk informasi lebih lanjut tentang menggunakan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

### Fn:: GetAtt
<a name="sam-resource-capacityprovider-return-values-fn--getatt"></a>

`Fn::GetAtt` mengembalikan nilai untuk atribut yang ditentukan dari jenis ini. Berikut ini adalah atribut yang tersedia dan nilai-nilai kembali sampel. 

Untuk informasi lebih lanjut tentang `Fn::GetAtt`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) di *Panduan Pengguna AWS CloudFormation * 

`Arn`  <a name="Arn-fn::getatt"></a>
ARN dari penyedia kapasitas.

## Contoh
<a name="sam-resource-capacityprovider-examples"></a>

### Penyedia kapasitas dasar
<a name="sam-resource-capacityprovider-examples-basic"></a>

Contoh berikut membuat penyedia kapasitas dasar dengan konfigurasi VPC.

```
MyCapacityProvider:
  Type: AWS::Serverless::CapacityProvider
  Properties:
    CapacityProviderName: my-capacity-provider
    VpcConfig:
      SubnetIds:
        - subnet-12345678
        - subnet-87654321
      SecurityGroupIds:
        - sg-12345678
    Tags:
      Environment: Production
      Team: ServerlessTeam
```

### Penyedia kapasitas canggih dengan penskalaan
<a name="sam-resource-capacityprovider-examples-advanced"></a>

Contoh berikut membuat penyedia kapasitas dengan persyaratan instance khusus dan konfigurasi penskalaan.

```
AdvancedCapacityProvider:
  Type: AWS::Serverless::CapacityProvider
  Properties:
    CapacityProviderName: advanced-capacity-provider
    VpcConfig:
      SubnetIds:
        - subnet-12345678
        - subnet-87654321
      SecurityGroupIds:
        - sg-12345678
    OperatorRole: arn:aws:iam::123456789012:role/MyCapacityProviderRole
    PropagateTags: true
    InstanceRequirements:
      Architectures:
        - x86_64
      ExcludedTypes:
        - t2.micro
    ScalingConfig:
      MaxInstanceCount: 10
      ManualScalingPolicies:
        AverageCPUUtilization: 70.0
    KmsKeyArn: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
    Tags:
      Environment: Production
      CostCenter: Engineering
```

# VpcConfig
<a name="sam-property-capacityprovider-vpcconfig"></a>

Mengkonfigurasi pengaturan VPC untuk penyedia kapasitas, termasuk subnet dan grup keamanan EC2 tempat instance akan diluncurkan.

## Sintaksis
<a name="sam-property-capacityprovider-vpcconfig-syntax"></a>

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

### YAML
<a name="sam-property-capacityprovider-vpcconfig-syntax.yaml"></a>

```
[SubnetIds](#sam-capacityprovider-vpcconfig-subnetids): List
[SecurityGroupIds](#sam-capacityprovider-vpcconfig-securitygroupids): List
```

## Sifat-sifat
<a name="sam-property-capacityprovider-vpcconfig-properties"></a>

 `SubnetIds`   <a name="sam-capacityprovider-vpcconfig-subnetids"></a>
Daftar subnet IDs tempat EC2 instance akan diluncurkan. Setidaknya satu subnet harus ditentukan.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SubnetIds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-subnetids)` properti `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig) ` `AWS::Lambda::CapacityProvider` sumber daya. 

 `SecurityGroupIds`   <a name="sam-capacityprovider-vpcconfig-securitygroupids"></a>
Daftar grup keamanan IDs untuk diasosiasikan dengan EC2 instance. Jika tidak ditentukan, grup keamanan default untuk VPC akan digunakan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig)` properti properti `AWS::Lambda::CapacityProvider` sumber daya. `[SecurityGroupIds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-securitygroupids)` 

## Contoh
<a name="sam-property-capacityprovider-vpcconfig-examples"></a>

### Konfigurasi VPC
<a name="sam-property-capacityprovider-vpcconfig-examples-basic"></a>

Contoh berikut menunjukkan konfigurasi VPC dengan beberapa subnet dan grup keamanan.

```
VpcConfig:
  SubnetIds:
    - subnet-12345678
    - subnet-87654321
  SecurityGroupIds:
    - sg-12345678
    - sg-87654321
```

# InstanceRequirements
<a name="sam-property-capacityprovider-instancerequirements"></a>

Menentukan persyaratan untuk EC2 instance yang akan diluncurkan oleh penyedia kapasitas, termasuk arsitektur dan batasan tipe instans.

## Sintaksis
<a name="sam-property-capacityprovider-instancerequirements-syntax"></a>

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

### YAML
<a name="sam-property-capacityprovider-instancerequirements-syntax.yaml"></a>

```
[Architectures](#sam-capacityprovider-instancerequirements-architectures): List
[AllowedTypes](#sam-capacityprovider-instancerequirements-allowedtypes): List
[ExcludedTypes](#sam-capacityprovider-instancerequirements-excludedtypes): List
```

**catatan**  
Anda dapat memilih untuk menentukan salah satu `AllowedTypes` atau `ExcludedTypes` saat menentukan persyaratan instans untuk penyedia kapasitas Anda, tetapi tidak keduanya.

## Sifat-sifat
<a name="sam-property-capacityprovider-instancerequirements-properties"></a>

 `Architectures`   <a name="sam-capacityprovider-instancerequirements-architectures"></a>
Instruksi mengatur arsitektur untuk instance penyedia kapasitas.  
*Nilai yang valid*: `x86_64` atau `arm64`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*: `x86_64`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-architectures)` properti `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` `AWS::Lambda::CapacityProvider` sumber daya. 

 `AllowedTypes`   <a name="sam-capacityprovider-instancerequirements-allowedtypes"></a>
Daftar jenis EC2 instans yang diizinkan untuk instance penyedia kapasitas.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AllowedInstanceTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-allowedinstancetypes)` properti `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` `AWS::Lambda::CapacityProvider` sumber daya. 

 `ExcludedTypes`   <a name="sam-capacityprovider-instancerequirements-excludedtypes"></a>
Daftar jenis EC2 instance untuk dikecualikan dari penyedia kapasitas.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ExcludedInstanceTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-excludedinstancetypes)` properti `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` `AWS::Lambda::CapacityProvider` sumber daya. 

## Contoh
<a name="sam-property-capacityprovider-instancerequirements-examples"></a>

### Konfigurasi persyaratan instans
<a name="sam-property-capacityprovider-instancerequirements-examples-basic"></a>

Contoh berikut menunjukkan persyaratan instance dengan arsitektur tertentu dan batasan tipe instance.

```
InstanceRequirements:
  Architectures:
    - x86_64
  ExcludedTypes:
    - t2.micro
```

# ScalingConfig
<a name="sam-property-capacityprovider-scalingconfig"></a>

Mengonfigurasi cara penyedia kapasitas EC2 menskalakan instans berdasarkan permintaan, termasuk batas instans maksimum dan kebijakan penskalaan.

## Sintaksis
<a name="sam-property-capacityprovider-scalingconfig-syntax"></a>

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

### YAML
<a name="sam-property-capacityprovider-scalingconfig-syntax.yaml"></a>

```
[MaxVCpuCount](#sam-capacityprovider-scalingconfig-maxvcpucount): Integer
[AverageCPUUtilization](#sam-capacityprovider-scalingconfig-averagecpuutilization): Double
```

## Sifat-sifat
<a name="sam-property-capacityprovider-scalingconfig-properties"></a>

 `MaxVCpuCount`   <a name="sam-capacityprovider-scalingconfig-maxvcpucount"></a>
Jumlah maksimum v CPUs yang dapat disediakan oleh penyedia kapasitas di semua instance komputasi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaxVCpuCount](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-maxvcpucount)` properti `[CapacityProviderScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig)` `AWS::Lambda::CapacityProvider` sumber daya. 

 `AverageCPUUtilization`   <a name="sam-capacityprovider-scalingconfig-averagecpuutilization"></a>
Target rata-rata persentase pemanfaatan CPU (0-100) untuk keputusan penskalaan. Ketika penggunaan CPU rata-rata melebihi ambang batas ini, penyedia kapasitas akan meningkatkan EC2 instans Amazon. Ketika ditentukan, AWS SAM konstruksi `[CapacityProviderScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig)` `AWS::Lambda::CapacityProvider` sumber daya dengan `[ScalingMode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-scalingmode)` set ke `'Manual'` dan `[ScalingPolicies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-scalingpolicies)` set ke`[{PredefinedMetricType: 'LambdaCapacityProviderAverageCPUUtilization', TargetValue: <this value>}]`.   
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. 

## Contoh
<a name="sam-property-capacityprovider-scalingconfig-examples"></a>

### Konfigurasi penskalaan
<a name="sam-property-capacityprovider-scalingconfig-examples-basic"></a>

Contoh berikut menunjukkan konfigurasi penskalaan dengan VCpu jumlah maksimum dan pemanfaatan CPU rata-rata.

```
ScalingConfig:
  MaxVCpuCount: 10
  AverageCPUUtilization: 70.0
```

# AWS::Serverless::Connector
<a name="sam-resource-connector"></a>

Mengkonfigurasi izin antara dua sumber daya. Untuk pengenalan konektor, lihat[Mengelola izin sumber daya dengan konektor AWS SAM](managing-permissions-connectors.md).

Untuk informasi selengkapnya tentang AWS CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation sumber daya yang dihasilkan saat Anda menentukan AWS::Serverless::Connector](sam-specification-generated-resources-connector.md).

Untuk memberikan umpan balik tentang konektor, [kirimkan masalah baru](https://github.com/aws/serverless-application-model/issues/new?assignees=&labels=area%2Fconnectors,stage%2Fneeds-triage&template=other.md&title=%28Feature%20Request%29) di *serverless-application-model AWS GitHub repositori*.

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaksis
<a name="sam-resource-connector-syntax"></a>

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

**catatan**  
Sebaiknya gunakan sintaks konektor tertanam untuk sebagian besar kasus penggunaan. Tertanam dalam sumber daya membuatnya lebih mudah untuk membaca dan memelihara dari waktu ke waktu. Bila Anda perlu mereferensikan sumber daya sumber yang tidak berada dalam AWS SAM template yang sama, seperti sumber daya dalam tumpukan bersarang atau sumber daya bersama, gunakan `AWS::Serverless::Connector` sintaks.

### Konektor tertanam
<a name="sam-resource-connector-syntax-embedded"></a>

```
<source-resource-logical-id>:
  Connectors:
    <connector-logical-id:
      Properties:
        [Destination](#sam-connector-destination): ResourceReference | List of ResourceReference
        [Permissions](#sam-connector-permissions): List
        [SourceReference](#sam-connector-sourcereference): SourceReference
```

### AWS::Serverless::Connector
<a name="sam-resource-connector-syntax-connector"></a>

```
Type: AWS::Serverless::Connector
Properties:
  [Destination](#sam-connector-destination): ResourceReference | List of ResourceReference
  [Permissions](#sam-connector-permissions): List
  [Source](#sam-connector-source): ResourceReference
```

## Sifat-sifat
<a name="sam-resource-connector-properties"></a>

 `Destination`   <a name="sam-connector-destination"></a>
Sumber daya tujuan.  
*Jenis*: [ResourceReference](sam-property-connector-resourcereference.md)\$1 Daftar [ResourceReference](sam-property-connector-resourcereference.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Permissions`   <a name="sam-connector-permissions"></a>
Jenis izin yang diizinkan untuk dilakukan sumber daya sumber daya pada sumber daya tujuan.  
`Read`termasuk tindakan AWS Identity and Access Management (IAM) yang memungkinkan membaca data dari sumber daya.  
`Write`termasuk tindakan IAM yang memungkinkan memulai dan menulis data ke sumber daya.  
*Nilai yang valid*: `Read` atau `Write`  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Source`   <a name="sam-connector-source"></a>
Sumber sumber daya. Diperlukan saat menggunakan `AWS::Serverless::Connector` sintaks.  
*Jenis*: [ResourceReference](sam-property-connector-resourcereference.md)  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceReference`   <a name="sam-connector-sourcereference"></a>
Sumber sumber daya.  
Gunakan dengan sintaks konektor tertanam saat mendefinisikan properti tambahan untuk sumber daya sumber.
*Jenis*: [SourceReference](sam-property-connector-sourcereference.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-resource-connector-examples"></a>

### Konektor tertanam
<a name="sam-resource-connector-examples-embedded"></a>

Contoh berikut menggunakan konektor tertanam untuk menentukan koneksi `Write` data antara AWS Lambda fungsi dan tabel Amazon DynamoDB:

```
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyTable:
    Type: AWS::Serverless::SimpleTable
  MyFunction:
    Type: AWS::Serverless::Function
    Connectors:
      MyConn:
        Properties:
          Destination:
            Id: MyTable
          Permissions:
            - Write
    ...
```

Contoh berikut menggunakan konektor tertanam untuk menentukan `Read` dan `Write` izin:

```
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Connectors:
      MyConn:
        Properties:
          Destination:
            Id: MyTable
          Permissions:
            - Read
            - Write
  MyTable:
    Type: AWS::DynamoDB::Table
    ...
```

Contoh berikut menggunakan konektor tertanam untuk menentukan sumber daya sumber dengan properti selain`Id`:

```
Transform: AWS::Serverless-2016-10-31
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Connectors:
      ApitoLambdaConn:
        Properties:
          SourceReference:
            Qualifier: Prod/GET/foobar
          Destination:
            Id: MyTable
          Permissions:
            - Read
            - Write
  MyTable:
    Type: AWS::DynamoDB::Table
    ...
```

### AWS::Serverless::Connector
<a name="sam-resource-connector--examples-connector"></a>

Contoh berikut menggunakan [AWS::Serverless::Connector](#sam-resource-connector) resource untuk memiliki AWS Lambda fungsi read from, dan write ke tabel Amazon DynamoDB:

```
MyConnector:
  Type: AWS::Serverless::Connector
  Properties:
    Source:
      Id: MyFunction
    Destination:
      Id: MyTable
    Permissions:
      - Read
      - Write
```

Contoh berikut menggunakan [AWS::Serverless::Connector](#sam-resource-connector) sumber daya agar fungsi Lambda menulis ke topik Amazon SNS, dengan kedua sumber daya dalam templat yang sama:

```
MyConnector:
  Type: AWS::Serverless::Connector
  Properties:
    Source:
      Id: MyLambda
    Destination:
      Id: MySNSTopic
    Permissions:
      - Write
```

Contoh berikut menggunakan [AWS::Serverless::Connector](#sam-resource-connector) sumber daya agar topik Amazon SNS menulis ke fungsi Lambda, yang kemudian menulis ke tabel Amazon DynamoDB, dengan semua sumber daya dalam templat yang sama:

```
Transform: AWS::Serverless-2016-10-31
Resources:
  Topic:
    Type: AWS::SNS::Topic
    Properties:
      Subscription:
        - Endpoint: !GetAtt Function.Arn
          Protocol: lambda

  Function:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs16.x
      Handler: index.handler
      InlineCode: |
        const AWS = require('aws-sdk');
        exports.handler = async (event, context) => {
          const docClient = new AWS.DynamoDB.DocumentClient();
          await docClient.put({ 
            TableName: process.env.TABLE_NAME, 
            Item: {
              id: context.awsRequestId,
              event: JSON.stringify(event)
            }
          }).promise();
        };
      Environment:
        Variables:
          TABLE_NAME: !Ref Table

  Table:
    Type: AWS::Serverless::SimpleTable

  TopicToFunctionConnector:
    Type: AWS::Serverless::Connector
    Properties:
      Source: 
        Id: Topic
      Destination: 
        Id: Function
      Permissions:
        - Write

  FunctionToTableConnector:
    Type: AWS::Serverless::Connector
    Properties:
      Source: 
        Id: Function
      Destination: 
        Id: Table
      Permissions:
        - Write
```

Berikut ini adalah AWS CloudFormation template yang diubah dari contoh di atas:

```
"FunctionToTableConnectorPolicy": {
  "Type": "AWS::IAM::ManagedPolicy",
  "Metadata": {
    "aws:sam:connectors": {
      "FunctionToTableConnector": {
        "Source": {
          "Type": "AWS::Lambda::Function"
        },
        "Destination": {
          "Type": "AWS::DynamoDB::Table"
        }
      }
    }
  },
  "Properties": {
    "PolicyDocument": {
      "Version": "2012-10-17",		 	 	 
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "dynamodb:PutItem",
            "dynamodb:UpdateItem",
            "dynamodb:DeleteItem",
            "dynamodb:BatchWriteItem",
            "dynamodb:PartiQLDelete",
            "dynamodb:PartiQLInsert",
            "dynamodb:PartiQLUpdate"
          ],
          "Resource": [
            {
              "Fn::GetAtt": [
                "MyTable",
                "Arn"
              ]
            },
            {
              "Fn::Sub": [
                "${DestinationArn}/index/*",
                {
                  "DestinationArn": {
                    "Fn::GetAtt": [
                      "MyTable",
                      "Arn"
                    ]
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "Roles": [
      {
        "Ref": "MyFunctionRole"
      }
    ]
  }
}
```

# ResourceReference
<a name="sam-property-connector-resourcereference"></a>

Referensi ke sumber daya yang digunakan tipe [AWS::Serverless::Connector](sam-resource-connector.md) sumber daya.

**catatan**  
Untuk sumber daya dalam templat yang sama, berikan`Id`. Untuk sumber daya yang tidak dalam templat yang sama, gunakan kombinasi properti lainnya. Untuk informasi selengkapnya, lihat [AWS SAM referensi konektor](reference-sam-connector.md).

## Sintaksis
<a name="sam-property-connector-resourcereference-syntax"></a>

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

### YAML
<a name="sam-property-connector-resourcereference-syntax.yaml"></a>

```
  [Arn](#sam-connector-resourcereference-arn): String
  [Id](#sam-connector-resourcereference-id): String
  [Name](#sam-connector-resourcereference-name): String
  [Qualifier](#sam-connector-resourcereference-qualifier): String
  [QueueUrl](#sam-connector-resourcereference-queueurl): String
  [ResourceId](#sam-connector-resourcereference-resourceid): String
  [RoleName](#sam-connector-resourcereference-rolename): String
  [Type](#sam-connector-resourcereference-type): String
```

## Sifat-sifat
<a name="sam-property-connector-resourcereference-properties"></a>

 `Arn`   <a name="sam-connector-resourcereference-arn"></a>
ARN sumber daya.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Id`   <a name="sam-connector-resourcereference-id"></a>
[ID logis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html) dari sumber daya dalam template yang sama.  
Kapan `Id` ditentukan, jika konektor menghasilkan kebijakan AWS Identity and Access Management (IAM), peran IAM yang terkait dengan kebijakan tersebut akan disimpulkan dari sumber daya. `Id` Bila tidak `Id` ditentukan, sediakan `RoleName` sumber daya untuk konektor untuk melampirkan kebijakan IAM yang dihasilkan ke peran IAM.
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Name`   <a name="sam-connector-resourcereference-name"></a>
Nama sumber daya.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Qualifier`   <a name="sam-connector-resourcereference-qualifier"></a>
Kualifikasi untuk sumber daya yang mempersempit ruang lingkupnya. `Qualifier`menggantikan `*` nilai pada akhir kendala sumber daya ARN. Sebagai contoh, lihat [API Gateway menjalankan fungsi Lambda](#sam-property-connector-resourcereference--examples--api-gateway-invoking-a-lambda-function).  
Definisi kualifikasi bervariasi per jenis sumber daya. Untuk daftar jenis sumber daya dan tujuan yang didukung, lihat[AWS SAM referensi konektor](reference-sam-connector.md).
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueueUrl`   <a name="sam-connector-resourcereference-queueurl"></a>
URL antrian Amazon SQS. Properti ini hanya berlaku untuk sumber daya Amazon SQS.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ResourceId`   <a name="sam-connector-resourcereference-resourceid"></a>
ID sumber daya. Misalnya, API Gateway API ID.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RoleName`   <a name="sam-connector-resourcereference-rolename"></a>
Nama peran yang terkait dengan sumber daya.  
Kapan `Id` ditentukan, jika konektor menghasilkan kebijakan IAM, peran IAM yang terkait dengan kebijakan tersebut akan disimpulkan dari sumber daya. `Id` Bila tidak `Id` ditentukan, sediakan `RoleName` sumber daya untuk konektor untuk melampirkan kebijakan IAM yang dihasilkan ke peran IAM.
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-connector-resourcereference-type"></a>
 CloudFormation Jenis sumber daya. Untuk informasi lebih lanjut, buka [referensi jenis AWS sumber daya dan properti](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-connector-resourcereference--examples"></a>

### API Gateway menjalankan fungsi Lambda
<a name="sam-property-connector-resourcereference--examples--api-gateway-invoking-a-lambda-function"></a>

Contoh berikut menggunakan [AWS::Serverless::Connector](sam-resource-connector.md) sumber daya untuk mengizinkan Amazon API Gateway menjalankan AWS Lambda fungsi.

#### YAML
<a name="sam-property-connector-resourcereference--examples--api-gateway-invoking-a-lambda-function--yaml"></a>

```
Transform: AWS::Serverless-2016-10-31
Resources:
  MyRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service: lambda.amazonaws.com
      ManagedPolicyArns:
        - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole

  MyFunction:
    Type: AWS::Lambda::Function
    Properties:
      Role: !GetAtt MyRole.Arn
      Runtime: nodejs16.x
      Handler: index.handler
      Code:
        ZipFile: |
          exports.handler = async (event) => {
            return {
              statusCode: 200,
              body: JSON.stringify({
                "message": "It works!"
              }),
            };
          };

  MyApi:
    Type: AWS::ApiGatewayV2::Api
    Properties:
      Name: MyApi
      ProtocolType: HTTP

  MyStage:
    Type: AWS::ApiGatewayV2::Stage
    Properties:
      ApiId: !Ref MyApi
      StageName: prod
      AutoDeploy: True

  MyIntegration:
    Type: AWS::ApiGatewayV2::Integration
    Properties:
      ApiId: !Ref MyApi
      IntegrationType: AWS_PROXY
      IntegrationUri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${MyFunction.Arn}/invocations
      IntegrationMethod: POST
      PayloadFormatVersion: "2.0"

  MyRoute:
    Type: AWS::ApiGatewayV2::Route
    Properties:
      ApiId: !Ref MyApi
      RouteKey: GET /hello
      Target: !Sub integrations/${MyIntegration}

  MyConnector:
    Type: AWS::Serverless::Connector
    Properties:
      Source: # Use 'Id' when resource is in the same template
        Type: AWS::ApiGatewayV2::Api
        ResourceId: !Ref MyApi
        Qualifier: prod/GET/hello # Or "*" to allow all routes
      Destination: # Use 'Id' when resource is in the same template
        Type: AWS::Lambda::Function
        Arn: !GetAtt MyFunction.Arn
      Permissions:
        - Write

Outputs:
  Endpoint:
    Value: !Sub https://${MyApi}.execute-api.${AWS::Region}.${AWS::URLSuffix}/prod/hello
```

# SourceReference
<a name="sam-property-connector-sourcereference"></a>

Referensi ke sumber daya sumber daya yang digunakan tipe [AWS::Serverless::Connector](sam-resource-connector.md) sumber daya.

## Sintaksis
<a name="sam-property-connector-sourcereference-syntax"></a>

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

### YAML
<a name="sam-property-connector-sourcereference-syntax.yaml"></a>

```
[Qualifier](#sam-connector-sourcereference-qualifier): String
```

## Sifat-sifat
<a name="sam-property-connector-sourcereference-properties"></a>

 `Qualifier`   <a name="sam-connector-sourcereference-qualifier"></a>
Kualifikasi untuk sumber daya yang mempersempit ruang lingkupnya. `Qualifier`menggantikan `*` nilai pada akhir kendala sumber daya ARN.  
Definisi kualifikasi bervariasi per jenis sumber daya. Untuk daftar jenis sumber daya dan tujuan yang didukung, lihat[AWS SAM referensi konektor](reference-sam-connector.md).
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-connector-sourcereference--examples"></a>

**Contoh berikut menggunakan konektor tertanam untuk menentukan sumber daya sumber dengan properti selain`Id`:**

```
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Connectors:
      ApitoLambdaConn:
        Properties:
          SourceReference:
            Qualifier: Prod/GET/foobar
          Destination:
            Id: MyTable
          Permissions:
            - Read
            - Write
  MyTable:
    Type: AWS::DynamoDB::Table
    ...
```

# AWS::Serverless::Function
<a name="sam-resource-function"></a>

Membuat AWS Lambda fungsi, peran eksekusi AWS Identity and Access Management (IAM), dan pemetaan sumber peristiwa yang memicu fungsi.

[AWS::Serverless::Function](#sam-resource-function)Resource juga mendukung atribut `Metadata` resource, sehingga Anda dapat menginstruksikan AWS SAM untuk membuat runtime kustom yang dibutuhkan aplikasi Anda. Untuk informasi selengkapnya tentang membangun waktu aktif kustom, lihat [Membangun fungsi Lambda dengan runtime khusus di AWS SAM](building-custom-runtimes.md).

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaksis
<a name="sam-resource-function-syntax"></a>

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

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

```
Type: AWS::Serverless::Function
Properties:
  [Architectures](#sam-function-architectures): List
  [AssumeRolePolicyDocument](#sam-function-assumerolepolicydocument): JSON
  [AutoPublishAlias](#sam-function-autopublishalias): String
  AutoPublishAliasAllProperties: Boolean
  [AutoPublishCodeSha256](#sam-function-autopublishcodesha256): String
  [CapacityProviderConfig](#sam-function-capacityproviderconfig): CapacityProviderConfig
  [CodeSigningConfigArn](#sam-function-codesigningconfigarn): String
  [CodeUri](#sam-function-codeuri): String | FunctionCode
  [DeadLetterQueue](#sam-function-deadletterqueue): Map | DeadLetterQueue
  [DeploymentPreference](#sam-function-deploymentpreference): DeploymentPreference
  [Description](#sam-function-description): String
  [DurableConfig](#sam-function-durableconfig): DurableConfig
  [Environment](#sam-function-environment): [Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)
  [EphemeralStorage](#sam-function-ephemeralstorage): [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)
  [EventInvokeConfig](#sam-function-eventinvokeconfig): EventInvokeConfiguration
  [Events](#sam-function-events): EventSource
  [FileSystemConfigs](#sam-function-filesystemconfigs): List
  [FunctionName](#sam-function-functionname): String
  [FunctionScalingConfig](#sam-function-functionscalingconfig): FunctionScalingConfig
  [FunctionUrlConfig](#sam-function-functionurlconfig): FunctionUrlConfig
  [Handler](#sam-function-handler): String
  [ImageConfig](#sam-function-imageconfig): [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)
  [ImageUri](#sam-function-imageuri): String
  [InlineCode](#sam-function-inlinecode): String
  [KmsKeyArn](#sam-function-kmskeyarn): String
  [Layers](#sam-function-layers): List
  LoggingConfig: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)
  [MemorySize](#sam-function-memorysize): Integer
  [PackageType](#sam-function-packagetype): String
  [PermissionsBoundary](#sam-function-permissionsboundary): String
  [Policies](#sam-function-policies): String | List | Map
  [PublishToLatestPublished](#sam-function-publishtolatestpublished): Boolean
  PropagateTags: Boolean
  [ProvisionedConcurrencyConfig](#sam-function-provisionedconcurrencyconfig): [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)
  RecursiveLoop: String
  [ReservedConcurrentExecutions](#sam-function-reservedconcurrentexecutions): Integer
  [Role](#sam-function-role): String
  [RolePath](#sam-function-rolepath): String
  [Runtime](#sam-function-runtime): String
  RuntimeManagementConfig: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)
  SnapStart: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)
  [SourceKMSKeyArn](#sam-function-sourcekmskeyarn): String
  [Tags](#sam-function-tags): Map
  [TenancyConfig](#sam-function-tenancyconfig): TenancyConfig
  [Timeout](#sam-function-timeout): Integer
  [Tracing](#sam-function-tracing): String
  [VersionDescription](#sam-function-versiondescription): String
  [VersionDeletionPolicy](#sam-function-versiondeletionpolicy): String
  [VpcConfig](#sam-function-vpcconfig): [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)
```

## Sifat-sifat
<a name="sam-resource-function-properties"></a>

 `Architectures`   <a name="sam-function-architectures"></a>
Arsitektur set instruksi untuk fungsi tersebut.  
*Untuk informasi selengkapnya tentang properti ini, lihat [Arsitektur set instruksi Lambda di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) Pengembang.AWS Lambda *  
*Nilai yang valid*: Salah satu `x86_64` atau `arm64`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*: `x86_64`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures)` properti `AWS::Lambda::Function` sumber daya.

 `AssumeRolePolicyDocument`   <a name="sam-function-assumerolepolicydocument"></a>
Menambahkan AssumeRolePolicyDocument untuk default yang dibuat `Role` untuk fungsi ini. Jika properti ini tidak ditentukan, AWS SAM menambahkan peran asumsi default untuk fungsi ini.  
*Tipe*: JSON  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[AssumeRolePolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument)` properti `AWS::IAM::Role` sumber daya. AWS SAM menambahkan properti ini ke peran IAM yang dihasilkan untuk fungsi ini. Jika Amazon Resource Name (ARN) peran tersedia untuk fungsi ini, properti ini tidak melakukan apa-apa.

 `AutoPublishAlias`   <a name="sam-function-autopublishalias"></a>
Nama alias Lambda. Untuk informasi selengkapnya tentang alias Lambda, lihat [Alias fungsi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) di *Panduan Developer AWS Lambda *. Untuk contoh yang menggunakan properti ini, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).  
AWS SAM menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html)sumber daya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat [AutoPublishAlias properti ditentukan](sam-specification-generated-resources-function.md#sam-specification-generated-resources-function-autopublishalias). Untuk informasi umum tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AutoPublishAliasAllProperties`   <a name="sam-function-autopublishaliasallproperties"></a>
Menentukan ketika baru [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)dibuat. Kapan`true`, versi Lambda baru dibuat ketika properti apa pun dalam fungsi Lambda diubah. Kapan`false`, versi Lambda baru dibuat hanya jika salah satu properti berikut dimodifikasi:  
+ `Environment`, `MemorySize`, atau `SnapStart`.
+ Setiap perubahan yang menghasilkan pembaruan ke `Code` properti, seperti`CodeDict`,`ImageUri`, atau`InlineCode`.
Properti ini `AutoPublishAlias` harus didefinisikan.  
Jika juga `AutoPublishCodeSha256` ditentukan, perilakunya lebih diutamakan. `AutoPublishAliasAllProperties: true`  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Nilai default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AutoPublishCodeSha256`   <a name="sam-function-autopublishcodesha256"></a>
Saat digunakan, string ini bekerja dengan `CodeUri` nilai untuk menentukan apakah versi Lambda baru perlu dipublikasikan. Properti ini sering digunakan untuk mengatasi masalah penerapan berikut: Paket penerapan disimpan di lokasi Amazon S3 dan digantikan oleh paket penerapan baru dengan kode fungsi Lambda yang diperbarui tetapi properti tetap tidak berubah (sebagai lawan `CodeUri` dari paket penerapan baru yang diunggah ke lokasi Amazon S3 baru dan diubah ke lokasi baru). `CodeUri`  
Masalah ini ditandai dengan AWS SAM template yang memiliki karakteristik sebagai berikut:  
+ `DeploymentPreference`Objek dikonfigurasi untuk penerapan bertahap (seperti yang dijelaskan dalam) [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md)
+ `AutoPublishAlias`Properti disetel dan tidak berubah di antara penerapan
+ `CodeUri`Properti disetel dan tidak berubah di antara penerapan.
Dalam skenario ini, memperbarui `AutoPublishCodeSha256` menghasilkan versi Lambda baru yang berhasil dibuat. Namun, kode fungsi baru yang diterapkan ke Amazon S3 tidak akan dikenali. Untuk mengenali kode fungsi baru, pertimbangkan untuk menggunakan pembuatan versi di bucket Amazon S3 Anda. Tentukan `Version` properti untuk fungsi Lambda Anda dan konfigurasikan bucket Anda agar selalu menggunakan paket penerapan terbaru.  
Dalam skenario ini, agar berhasil memicu deployment bertahap, Anda harus memberikan nilai unik untuk `AutoPublishCodeSha256`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CapacityProviderConfig`   <a name="sam-function-capacityproviderconfig"></a>
Mengkonfigurasi penyedia kapasitas tempat versi fungsi yang diterbitkan akan dilampirkan. Ini memungkinkan fungsi berjalan pada instans EC2 milik pelanggan yang dikelola oleh Instans Terkelola Lambda.  
*Jenis*: [CapacityProviderConfig](sam-property-function-capacityproviderconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: SAM meratakan properti yang diteruskan ke `[CapacityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig)` properti `AWS::Lambda::Function` sumber daya dan merekonstruksi struktur bersarang.

 `CodeSigningConfigArn`   <a name="sam-function-codesigningconfigarn"></a>
ARN [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html)sumber daya, digunakan untuk mengaktifkan penandatanganan kode untuk fungsi ini. Untuk informasi selengkapnya tentang penandatanganan kode, lihat [Siapkan penandatanganan kode untuk AWS SAM aplikasi Anda](authoring-codesigning.md).  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CodeSigningConfigArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn)` properti `AWS::Lambda::Function` sumber daya.

 `CodeUri`   <a name="sam-function-codeuri"></a>
Kode untuk fungsi. Nilai yang diterima meliputi:  
+ Fungsi Amazon S3 URI. Misalnya, `s3://bucket-123456789/sam-app/1234567890abcdefg`.
+ Jalur lokal ke fungsi. Misalnya, `hello_world/`.
+ Sebuah objek [FunctionCode](sam-property-function-functioncode.md).
Jika Anda menyediakan URI atau [FunctionCode](sam-property-function-functioncode.md) objek Amazon S3 fungsi, Anda harus mereferensikan paket penerapan [Lambda](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) yang valid.  
Jika Anda menyediakan jalur file lokal, gunakan AWS SAMCLI untuk mengunggah file lokal saat penerapan. Untuk mempelajari selengkapnya, lihat [Cara AWS SAM mengunggah file lokal saat penerapan](deploy-upload-local-files.md).  
Jika Anda menggunakan fungsi intrinsik di `CodeUri` properti, tidak AWS SAM akan dapat mengurai nilai dengan benar. Pertimbangkan untuk menggunakan [AWS::LanguageExtensions transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-languageextensions.html) sebagai gantinya.
*Jenis*: [String \$1[FunctionCode](sam-property-function-functioncode.md)]  
*Diperlukan*: Bersyarat. Kapan `PackageType` diatur ke`Zip`, salah satu `CodeUri` atau `InlineCode` diperlukan.  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[ Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code)` properti `AWS::Lambda::Function` sumber daya. Properti Amazon S3 yang di-nest diberi nama berbeda.

 `DeadLetterQueue`   <a name="sam-function-deadletterqueue"></a>
Mengonfigurasi topik Amazon Simple Notification Service (Amazon SNS) atau antrean Amazon Simple Queue Service (Amazon SQS) tempat Lambda mengirimkan peristiwa yang tidak dapat diproses. *Untuk informasi selengkapnya tentang fungsionalitas antrian huruf mati, lihat Antrian [huruf mati di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) Pengembang.AWS Lambda *  
Jika sumber peristiwa fungsi Lambda Anda adalah antrean Amazon SQS, konfigurasikan antrian huruf mati untuk antrean sumber, bukan untuk fungsi Lambda. Antrean surat mati yang dikonfigurasikan untuk fungsi digunakan untuk [antrean invokasi tidak sinkron](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) fungsi, bukan untuk antrean sumber peristiwa.
*Jenis*: Peta \$1 [DeadLetterQueue](sam-property-function-deadletterqueue.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html)` properti `AWS::Lambda::Function` sumber daya. Dalam CloudFormation jenis ini berasal dari`TargetArn`, sedangkan di AWS SAM Anda harus melewati tipe bersama dengan`TargetArn`.

 `DeploymentPreference`   <a name="sam-function-deploymentpreference"></a>
Pengaturan untuk mengaktifkan deployment Lambda bertahap.  
Jika `DeploymentPreference` objek ditentukan, AWS SAM membuat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html)dipanggil `ServerlessDeploymentApplication` (satu per tumpukan), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html)dipanggil`<function-logical-id>DeploymentGroup`, dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)dipanggil`CodeDeployServiceRole`.  
*Jenis*: [DeploymentPreference](sam-property-function-deploymentpreference.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Lihat juga*: Untuk informasi selengkapnya tentang properti ini, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).

 `Description`   <a name="sam-function-description"></a>
Deskripsi fungsi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description)` properti `AWS::Lambda::Function` sumber daya.

 `DurableConfig`   <a name="sam-function-durableconfig"></a>
Konfigurasi untuk fungsi yang tahan lama. Mengaktifkan eksekusi stateful dengan kemampuan checkpointing dan replay otomatis.  
*Jenis*: [DurableConfig](sam-property-function-durableconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Environment`   <a name="sam-function-environment"></a>
Konfigurasi untuk lingkungan waktu aktif.  
*Tipe*: [Lingkungan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)` properti `AWS::Lambda::Function` sumber daya.

 `EphemeralStorage`   <a name="sam-function-ephemeralstorage"></a>
Objek yang menentukan ruang disk, dalam MB, tersedia untuk fungsi Lambda Anda di. `/tmp`  
Untuk informasi selengkapnya tentang properti ini, lihat [lingkungan eksekusi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) di Panduan *AWS Lambda Pengembang*.  
*Jenis*: [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)` properti `AWS::Lambda::Function` sumber daya.

 `EventInvokeConfig`   <a name="sam-function-eventinvokeconfig"></a>
Objek yang menggambarkan peristiwa memanggil konfigurasi pada fungsi Lambda.  
*Jenis*: [EventInvokeConfiguration](sam-property-function-eventinvokeconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Events`   <a name="sam-function-events"></a>
Menentukan peristiwa yang memicu fungsi ini. Peristiwa terdiri dari tipe dan satu set properti yang bergantung pada tipenya.  
*Jenis*: [EventSource](sam-property-function-eventsource.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FileSystemConfigs`   <a name="sam-function-filesystemconfigs"></a>
Daftar [FileSystemConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html)objek yang menentukan pengaturan koneksi untuk sistem file Amazon Elastic File System (Amazon EFS).  
Jika template Anda berisi [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)sumber daya, Anda juga harus menentukan atribut `DependsOn` resource untuk memastikan bahwa target mount dibuat atau diperbarui sebelum fungsi.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FileSystemConfigs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs)` properti `AWS::Lambda::Function` sumber daya.

 `FunctionName`   <a name="sam-function-functionname"></a>
Nama untuk fungsi. Jika Anda tidak menentukan nama, nama unik akan dibuat untuk Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname)` properti `AWS::Lambda::Function` sumber daya.

 `FunctionScalingConfig`   <a name="sam-function-functionscalingconfig"></a>
Mengonfigurasi perilaku penskalaan untuk fungsi Lambda yang berjalan pada penyedia kapasitas. Mendefinisikan jumlah minimum dan maksimum lingkungan eksekusi.  
*Jenis*: [FunctionScalingConfig](sam-property-function-functionscalingconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig)` properti `AWS::Lambda::Function` sumber daya.

 `FunctionUrlConfig`   <a name="sam-function-functionurlconfig"></a>
Objek yang menggambarkan URL fungsi. URL fungsi adalah titik akhir HTTPS yang dapat Anda gunakan untuk menjalankan fungsi Anda.  
Untuk informasi selengkapnya, lihat [Fungsi URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) dalam *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FunctionUrlConfig](sam-property-function-functionurlconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Handler`   <a name="sam-function-handler"></a>
Fungsi dalam kode Anda yang dipanggil untuk memulai eksekusi. Properti ini hanya diperlukan jika properti `PackageType` diatur ke `Zip`.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Handler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler)` properti `AWS::Lambda::Function` sumber daya.

 `ImageConfig`   <a name="sam-function-imageconfig"></a>
Objek yang digunakan untuk mengonfigurasi pengaturan citra kontainer Lambda. Untuk informasi selengkapnya, lihat [Menggunakan citra kontainer dengan Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) di *Panduan Developer AWS Lambda *.  
*Jenis*: [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)` properti `AWS::Lambda::Function` sumber daya.

 `ImageUri`   <a name="sam-function-imageuri"></a>
URI repositori Amazon Elastic Container Registry (Amazon ECR) untuk citra kontainer fungsi Lambda ini. Properti ini hanya berlaku jika properti `PackageType` diatur ke `Image`, jika tidak akan diabaikan. Untuk informasi selengkapnya, lihat [Menggunakan citra kontainer dengan Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) di *Panduan Developer AWS Lambda *.  
Jika `PackageType` properti disetel ke`Image`, maka `ImageUri` diperlukan, atau Anda harus membangun aplikasi Anda dengan `Metadata` entri yang diperlukan dalam file AWS SAM template. Untuk informasi selengkapnya, lihat [Membangun default dengan AWS SAM](serverless-sam-cli-using-build.md).
Membangun aplikasi Anda dengan `Metadata` entri yang diperlukan lebih diutamakan`ImageUri`, jadi jika Anda menentukan keduanya maka `ImageUri` diabaikan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ImageUri](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri)` properti tipe `AWS::Lambda::Function` `Code` data.

 `InlineCode`   <a name="sam-function-inlinecode"></a>
Kode fungsi Lambda yang ditulis langsung dalam templat. Properti ini hanya berlaku jika properti `PackageType` diatur ke `Zip`, jika tidak akan diabaikan.  
Jika properti `PackageType` diatur ke `Zip` (default), salah satu `CodeUri` atau `InlineCode` harus ada.
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ZipFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile)` properti tipe `AWS::Lambda::Function` `Code` data.

 `KmsKeyArn`   <a name="sam-function-kmskeyarn"></a>
ARN dari kunci AWS Key Management Service (AWS KMS) yang digunakan Lambda untuk mengenkripsi dan mendekripsi variabel lingkungan fungsi Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn)` properti `AWS::Lambda::Function` sumber daya.

 `Layers`   <a name="sam-function-layers"></a>
Daftar `LayerVersion` ARNs yang harus digunakan fungsi ini. Urutan yang ditentukan di sini adalah urutan ketika urutan impor saat menjalankan fungsi Lambda. Versi ini adalah ARN lengkap termasuk versi atau referensi ke sumber daya. LayerVersion Misalnya, referensi ke a `LayerVersion` akan `!Ref MyLayer` sementara ARN lengkap termasuk versi akan. `arn:aws:lambda:region:account-id:layer:layer-name:version`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Layers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers)` properti `AWS::Lambda::Function` sumber daya.

 `LoggingConfig`   <a name="sam-function-loggingconfig"></a>
Pengaturan konfigurasi Amazon CloudWatch Logs fungsi.  
*Jenis*: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig)properti `AWS::Lambda::Function` sumber daya.

 `MemorySize`   <a name="sam-function-memorysize"></a>
Ukuran memori dalam MB yang dialokasikan per pemanggilan fungsi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MemorySize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize)` properti `AWS::Lambda::Function` sumber daya.

 `PackageType`   <a name="sam-function-packagetype"></a>
Tipe paket deployment fungsi Lambda. Untuk informasi lebih lanjut, lihat [Paket deployment Lambda](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) di *Panduan Developer AWS Lambda *.  
**Catatan:**  
1. Jika properti ini diatur ke `Zip` (default), `CodeUri` atau `InlineCode` berlaku, dan `ImageUri` diabaikan.  
2. Jika properti ini diatur ke `Image`, hanya `ImageUri` yang berlaku, dan `CodeUri` dan `InlineCode` diabaikan. Repositori Amazon ECR yang diperlukan untuk menyimpan gambar kontainer fungsi dapat dibuat secara otomatis oleh file. AWS SAMCLI Untuk informasi selengkapnya, lihat [sam deploy](sam-cli-command-reference-sam-deploy.md).  
*Nilai yang valid*: `Zip` atau `Image`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `Zip`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PackageType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype)` properti `AWS::Lambda::Function` sumber daya.

 `PermissionsBoundary`   <a name="sam-function-permissionsboundary"></a>
ARN batas izin untuk digunakan untuk peran eksekusi fungsi ini. Properti ini bekerja hanya jika peran dibuat untuk Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` properti `AWS::IAM::Role` sumber daya.

 `Policies`   <a name="sam-function-policies"></a>
Kebijakan izin untuk fungsi ini. Kebijakan akan ditambahkan ke peran eksekusi default AWS Identity and Access Management (IAM) fungsi.  
Properti ini menerima satu nilai atau daftar nilai. Nilai yang diizinkan meliputi:  
+ [AWS SAM templat kebijakan](serverless-policy-templates.md).
+ Kebijakan ARN [AWS terkelola atau kebijakan](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) yang [dikelola pelanggan](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ Nama kebijakan AWS terkelola dari [daftar](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json) berikut.
+ [Kebijakan IAM sebaris](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies) yang diformat YAML sebagai peta.
Jika Anda menyetel `Role` properti, properti ini diabaikan.
*Tipe*: String \$1 Daftar \$1 Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Policies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies)` properti `AWS::IAM::Role` sumber daya.

 `PublishToLatestPublished`   <a name="sam-function-publishtolatestpublished"></a>
Menentukan apakah akan menerbitkan versi fungsi terbaru ketika fungsi diperbarui.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PublishToLatestPublished](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished)` properti `AWS::Lambda::Function` sumber daya.

`PropagateTags`  <a name="sam-function-propagatetags"></a>
Tunjukkan apakah akan meneruskan tag dari `Tags` properti ke sumber daya yang Anda [AWS::Serverless::Function](sam-specification-generated-resources-function.md) hasilkan atau tidak. Tentukan `True` untuk menyebarkan tag di sumber daya yang Anda hasilkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ProvisionedConcurrencyConfig`   <a name="sam-function-provisionedconcurrencyconfig"></a>
Konfigurasi konkurensi yang disediakan untuk alias fungsi.  
`ProvisionedConcurrencyConfig`dapat ditentukan hanya jika `AutoPublishAlias` diatur. Jika tidak, akan terjadi kesalahan.
*Jenis*: [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)` properti `AWS::Lambda::Alias` sumber daya.

 `RecursiveLoop`   <a name="sam-function-recursiveloop"></a>
Status konfigurasi deteksi loop rekursif fungsi Anda.  
Ketika nilai ini disetel ke `Allow` dan Lambda mendeteksi fungsi Anda dipanggil sebagai bagian dari loop rekursif, itu tidak mengambil tindakan apa pun.  
Ketika nilai ini disetel ke `Terminate` dan Lambda mendeteksi fungsi Anda dipanggil sebagai bagian dari loop rekursif, itu menghentikan fungsi Anda dipanggil dan memberi tahu Anda.   
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RecursiveLoop](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop)` properti `AWS::Lambda::Function` sumber daya.

 `ReservedConcurrentExecutions`   <a name="sam-function-reservedconcurrentexecutions"></a>
Jumlah maksimum eksekusi bersamaan yang ingin Anda simpan untuk fungsi tersebut.  
Untuk informasi lebih lanjut, lihat [Skala Fungsi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/scaling.html) dalam *Panduan Developer AWS Lambda *.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ReservedConcurrentExecutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions)` properti `AWS::Lambda::Function` sumber daya.

 `Role`   <a name="sam-function-role"></a>
ARN dari IAM role untuk digunakan sebagai peran eksekusi fungsi ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role)` properti `AWS::Lambda::Function` sumber daya. Ini diperlukan di CloudFormation tetapi tidak di AWS SAM. Jika peran tidak ditentukan, satu dibuat untuk Anda dengan ID logis `<function-logical-id>Role`.

 `RolePath`   <a name="sam-function-rolepath"></a>
Jalur ke peran eksekusi IAM fungsi.  
Gunakan properti ini saat peran dibuat untuk Anda. Jangan gunakan saat peran ditentukan dengan `Role` properti.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` properti `AWS::IAM::Role` sumber daya.

 `Runtime`   <a name="sam-function-runtime"></a>
Pengenal [waktu aktif](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) fungsi. Properti ini hanya diperlukan jika properti `PackageType` diatur ke `Zip`.  
Jika Anda menentukan `provided` identifier untuk properti ini, Anda dapat menggunakan atribut `Metadata` resource untuk menginstruksikan AWS SAM untuk membangun runtime kustom yang diperlukan fungsi ini. Untuk informasi selengkapnya tentang membangun waktu aktif kustom, lihat [Membangun fungsi Lambda dengan runtime khusus di AWS SAM](building-custom-runtimes.md).
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime)` properti `AWS::Lambda::Function` sumber daya.

 `RuntimeManagementConfig`   <a name="sam-function-runtimemanagementconfig"></a>
Konfigurasikan opsi manajemen runtime untuk fungsi Lambda Anda seperti pembaruan lingkungan runtime, perilaku rollback, dan memilih versi runtime tertentu. *Untuk mempelajari selengkapnya, lihat [Pembaruan runtime Lambda di Panduan](https://docs.aws.amazon.com//lambda/latest/dg/runtimes-update.html) Pengembang.AWS Lambda *  
*Jenis*: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)` properti `AWS::Lambda::Function` sumber daya.

 `SnapStart`   <a name="sam-function-snapstart"></a>
Buat snapshot dari versi fungsi Lambda baru. Snapshot adalah status cache dari fungsi inisialisasi Anda, termasuk semua dependensinya. Fungsi ini diinisialisasi hanya sekali dan status cache digunakan kembali untuk semua pemanggilan future, meningkatkan kinerja aplikasi dengan mengurangi berapa kali fungsi Anda harus diinisialisasi. Untuk mempelajari lebih lanjut, lihat [Meningkatkan kinerja startup dengan Lambda SnapStart di Panduan AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) *Pengembang*.  
*Jenis*: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)` properti `AWS::Lambda::Function` sumber daya.

 `SourceKMSKeyArn`   <a name="sam-function-sourcekmskeyarn"></a>
Merupakan ARN kunci KMS yang digunakan untuk mengenkripsi kode fungsi ZIP pelanggan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SourceKMSKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-sourcekmskeyarn)` properti tipe `AWS::Lambda::Function` `Code` data.

 `Tags`   <a name="sam-function-tags"></a>
Sebuah peta (string ke string) yang menentukan tanda ditambahkan ke fungsi ini. Untuk detail tentang kunci dan nilai yang valid untuk tag, lihat [Kunci Tag dan Persyaratan Nilai](https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html#configuration-tags-restrictions) di *Panduan AWS Lambda Pengembang*.  
Saat tumpukan dibuat, AWS SAM secara otomatis menambahkan `lambda:createdBy:SAM` tag ke fungsi Lambda ini, dan ke peran default yang dihasilkan untuk fungsi ini.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags)` properti `AWS::Lambda::Function` sumber daya. `Tags`Properti di AWS SAM terdiri dari pasangan kunci-nilai (sedangkan dalam properti CloudFormation ini terdiri dari daftar `Tag` objek). Selain itu, AWS SAM secara otomatis menambahkan `lambda:createdBy:SAM` tag ke fungsi Lambda ini, dan ke peran default yang dihasilkan untuk fungsi ini.

 `TenancyConfig`   <a name="sam-function-tenancyconfig"></a>
Konfigurasi untuk mode isolasi penyewa Lambda. Memastikan lingkungan eksekusi tidak pernah dibagi antara penyewa yang berbeda IDs, menyediakan isolasi tingkat komputasi untuk aplikasi multi-penyewa.  
*Jenis*: [TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig)` properti `AWS::Lambda::Function` sumber daya.

 `Timeout`   <a name="sam-function-timeout"></a>
Waktu maksimum dalam detik bahwa fungsi dapat berjalan sebelum dihentikan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 3  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Timeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout)` properti `AWS::Lambda::Function` sumber daya.

 `Tracing`   <a name="sam-function-tracing"></a>
String yang menentukan mode pelacakan X-Ray fungsi.  
+ `Active`- Mengaktifkan penelusuran X-Ray untuk fungsi tersebut.
+ `Disabled`- Menonaktifkan X-Ray untuk fungsinya.
+ `PassThrough`- Mengaktifkan penelusuran X-Ray untuk fungsi tersebut. Keputusan pengambilan sampel didelegasikan ke layanan hilir.
Jika ditentukan sebagai `Active` atau `PassThrough` dan `Role` properti tidak disetel, AWS SAM tambahkan `arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess` kebijakan ke peran eksekusi Lambda yang dibuatnya untuk Anda.  
Untuk informasi selengkapnya tentang X-Ray, lihat [Menggunakan AWS Lambda dengan AWS X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html) di *Panduan AWS Lambda Pengembang*.  
*Nilai yang valid*: [`Active`\$1 `Disabled` \$1`PassThrough`]  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[TracingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig)` properti `AWS::Lambda::Function` sumber daya.

 `VersionDescription`   <a name="sam-function-versiondescription"></a>
Menentukan bidang `Description` yang ditambahkan pada sumber daya versi Lambda baru.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description)` properti `AWS::Lambda::Version` sumber daya.

 `VersionDeletionPolicy`   <a name="sam-function-versiondeletionpolicy"></a>
Menentukan kebijakan penghapusan untuk sumber daya versi Lambda yang dibuat saat disetel. `AutoPublishAlias` Ini mengontrol apakah sumber daya versi dipertahankan atau dihapus saat tumpukan dihapus.  
*Nilai yang valid*: `Delete`, `Retain`, atau `Snapshot`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. Ini menetapkan `DeletionPolicy` atribut pada `AWS::Lambda::Version` sumber daya yang dihasilkan.

 `VpcConfig`   <a name="sam-function-vpcconfig"></a>
Konfigurasi yang memungkinkan fungsi ini mengakses sumber daya privat dalam virtual private cloud (VPC) Anda.  
*Jenis*: [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)` properti `AWS::Lambda::Function` sumber daya.

## Nilai Pengembalian
<a name="sam-resource-function-return-values"></a>

### Ref
<a name="sam-resource-function-return-values-ref"></a>

Ketika ID logis dari sumber daya ini disediakan untuk fungsi intrinsik `Ref`, ID mengembalikan nama sumber daya dari fungsi Lambda utama.

Untuk informasi lebih lanjut tentang menggunakan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di*Panduan Pengguna AWS CloudFormation *. 

### Fn:: GetAtt
<a name="sam-resource-function-return-values-fn--getatt"></a>

`Fn::GetAtt` mengembalikan nilai untuk atribut yang ditentukan dari jenis ini. Berikut ini adalah atribut yang tersedia dan nilai-nilai kembali sampel. 

Untuk informasi lebih lanjut tentang menggunakan `Fn::GetAtt`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) di *Panduan Pengguna AWS CloudFormation *. 

`Arn`  <a name="Arn-fn::getatt"></a>
ARN fungsi Lambda utama.

## Contoh
<a name="sam-resource-function-examples"></a>

### Fungsi sederhana
<a name="sam-resource-function-examples-simple-function"></a>

Berikut ini adalah contoh dasar sumber daya [AWS::Serverless::Function](#sam-resource-function) dari tipe paket `Zip` (default) dan kode fungsi dalam bucket Amazon S3.

#### YAML
<a name="sam-resource-function-examples-simple-function--yaml"></a>

```
Type: AWS::Serverless::Function
Properties:
  Handler: index.handler
  Runtime: python3.9
  CodeUri: s3://bucket-name/key-name
```

### Contoh properti fungsi
<a name="sam-resource-function-examples-function-properties-example"></a>

Berikut ini adalah contoh-contoh [AWS::Serverless::Function](#sam-resource-function) dari tipe paket `Zip` (default) yang menggunakan `InlineCode`, `Layers`, `Tracing`, `Policies`, `Amazon EFS`, dan sumber peristiwa `Api`.

#### YAML
<a name="sam-resource-function-examples-function-properties-example--yaml"></a>

```
Type: AWS::Serverless::Function
DependsOn: MyMountTarget        # This is needed if an AWS::EFS::MountTarget resource is declared for EFS
Properties:
  Handler: index.handler
  Runtime: python3.9
  InlineCode: |
    def handler(event, context):
      print("Hello, world!")
  ReservedConcurrentExecutions: 30
  Layers:
    - Ref: MyLayer
  Tracing: Active
  Timeout: 120
  FileSystemConfigs:
    - Arn: !Ref MyEfsFileSystem
      LocalMountPath: /mnt/EFS
  Policies:
    - AWSLambdaExecute
    - Version: '2012-10-17		 	 	 ' 
      Statement:
        - Effect: Allow
          Action:
            - s3:GetObject
            - s3:GetObjectACL
          Resource: 'arn:aws:s3:::sam-s3-demo-bucket/*'
  Events:
    ApiEvent:
      Type: Api
      Properties:
        Path: /path
        Method: get
```

### ImageConfig contoh
<a name="sam-resource-function-examples-imageconfig-example"></a>

Berikut ini adalah contoh-contoh `ImageConfig` untuk fungsi Lambda dari tipe paket `Image`.

#### YAML
<a name="sam-resource-function-examples-imageconfig-example--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    PackageType: Image
    ImageUri: account-id.dkr.ecr.region.amazonaws.com/ecr-repo-name:image-name
    ImageConfig:
      Command:
        - "app.lambda_handler"
      EntryPoint:
        - "entrypoint1"
      WorkingDirectory: "workDir"
```

### RuntimeManagementConfig contoh
<a name="sam-resource-function-examples-runtimemanagementconfig-examples"></a>

Fungsi Lambda yang dikonfigurasi untuk memperbarui lingkungan runtime-nya sesuai dengan perilaku saat ini:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: Auto
```

Fungsi Lambda yang dikonfigurasi untuk memperbarui lingkungan runtime-nya saat fungsi diperbarui:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: FunctionUpdate
```

Fungsi Lambda yang dikonfigurasi untuk memperbarui lingkungan runtime-nya secara manual:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      RuntimeVersionArn: arn:aws:lambda:us-east-1::runtime:4c459dd0104ee29ec65dcad056c0b3ddbe20d6db76b265ade7eda9a066859b1e
      UpdateRuntimeOn: Manual
```

### SnapStart contoh
<a name="sam-resource-function-examples-snapstart-examples"></a>

Contoh fungsi Lambda dengan SnapStart dihidupkan untuk versi masa depan:

```
TestFunc
  Type: AWS::Serverless::Function
  Properties:
    ...
    SnapStart:
      ApplyOn: PublishedVersions
```

### TenancyConfig contoh
<a name="sam-resource-function-examples-tenancyconfig-examples"></a>

Contoh fungsi Lambda dengan mode isolasi penyewa diaktifkan:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    TenancyConfig:
      TenantIsolationMode: PER_TENANT
```

# DeadLetterQueue
<a name="sam-property-function-deadletterqueue"></a>

Menentukan antrian SQS atau topik SNS yang ( AWS Lambda Lambda) mengirimkan peristiwa ketika tidak dapat memproses mereka. *Untuk informasi selengkapnya tentang fungsionalitas antrian surat mati, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq)AWS Lambda *

SAM akan secara otomatis menambahkan izin yang sesuai ke peran eksekusi fungsi Lambda Anda untuk memberikan akses layanan Lambda ke sumber daya. sqs: SendMessage akan ditambahkan untuk antrian SQS dan SNS: Publikasikan untuk topik SNS.

## Sintaksis
<a name="sam-property-function-deadletterqueue-syntax"></a>

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

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

```
  [TargetArn](#sam-function-deadletterqueue-targetarn): String
  [Type](#sam-function-deadletterqueue-type): String
```

## Sifat-sifat
<a name="sam-property-function-deadletterqueue-properties"></a>

 `TargetArn`   <a name="sam-function-deadletterqueue-targetarn"></a>
Amazon Resource Name (ARN) antrean Amazon SQS atau topik Amazon SNS.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TargetArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn)` properti tipe `AWS::Lambda::Function` `DeadLetterConfig` data.

 `Type`   <a name="sam-function-deadletterqueue-type"></a>
Tipe antrean surat mati.  
*Nilai valid:* `SNS`, `SQS`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-deadletterqueue--examples"></a>

### DeadLetterQueue
<a name="sam-property-function-deadletterqueue--examples--deadletterqueue"></a>

Contoh Antrean Surat Mati untuk topik SNS.

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

```
DeadLetterQueue:
  Type: SNS
  TargetArn: arn:aws:sns:us-east-2:123456789012:my-topic
```

# DeploymentPreference
<a name="sam-property-function-deploymentpreference"></a>

Menentukan konfigurasi untuk mengaktifkan deployment Lambda bertahap. Untuk informasi selengkapnya tentang konfigurasi deployment Lambda secara bertahap, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).

**catatan**  
Anda harus menentukan `AutoPublishAlias` dalam Anda [AWS::Serverless::Function](sam-resource-function.md) untuk menggunakan `DeploymentPreference` objek, jika tidak kesalahan akan terjadi.

## Sintaksis
<a name="sam-property-function-deploymentpreference-syntax"></a>

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

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

```
  [Alarms](#sam-function-deploymentpreference-alarms): List
  [Enabled](#sam-function-deploymentpreference-enabled): Boolean
  [Hooks](#sam-function-deploymentpreference-hooks): Hooks
  [PassthroughCondition](#sam-function-deploymentpreference-passthroughcondition): Boolean
  [Role](#sam-function-deploymentpreference-role): String
  [TriggerConfigurations](#sam-function-deploymentpreference-triggerconfigurations): List
  [Type](#sam-function-deploymentpreference-type): String
```

## Sifat-sifat
<a name="sam-property-function-deploymentpreference-properties"></a>

 `Alarms`   <a name="sam-function-deploymentpreference-alarms"></a>
Daftar CloudWatch alarm yang ingin Anda picu oleh kesalahan apa pun yang dimunculkan oleh penerapan.  
Properti ini menerima fungsi intrinsik `Fn::If`. Lihat bagian Contoh di bagian bawah topik ini untuk contoh templat yang menggunakan `Fn::If`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Enabled`   <a name="sam-function-deploymentpreference-enabled"></a>
Apakah preferensi deployment ini diaktifkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: BETUL  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Hooks`   <a name="sam-function-deploymentpreference-hooks"></a>
Validasi fungsi Lambda yang dijalankan sebelum dan sesudah pergeseran lalu lintas.  
*Tipe*: [Hook](sam-property-function-hooks.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PassthroughCondition`   <a name="sam-function-deploymentpreference-passthroughcondition"></a>
Jika Benar, dan jika preferensi penerapan ini diaktifkan, Kondisi fungsi akan diteruskan ke CodeDeploy sumber daya yang dihasilkan. Umumnya, Anda harus mengatur ini ke True. Jika tidak, CodeDeploy sumber daya akan dibuat bahkan jika Kondisi fungsi diselesaikan menjadi False.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Role`   <a name="sam-function-deploymentpreference-role"></a>
Peran IAM ARN CodeDeploy yang akan digunakan untuk pergeseran lalu lintas. IAM role tidak akan dibuat jika ini disediakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `TriggerConfigurations`   <a name="sam-function-deploymentpreference-triggerconfigurations"></a>
Daftar konfigurasi pemicu yang ingin Anda kaitkan dengan grup deployment. Digunakan untuk memberitahu topik SNS pada peristiwa siklus hidup.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TriggerConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations)` properti `AWS::CodeDeploy::DeploymentGroup` sumber daya.

 `Type`   <a name="sam-function-deploymentpreference-type"></a>
Ada dua kategori tipe deployment pada saat ini: Linear dan Canary. Untuk informasi selengkapnya tentang tipe deployment yang tersedia, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-deploymentpreference--examples"></a>

### DeploymentPreference dengan kait sebelum dan sesudah lalu lintas.
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks."></a>

Contoh preferensi deployment yang berisi kait pra dan pascalalulintas.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks.--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    - !Ref: AliasErrorMetricGreaterThanZeroAlarm
    - !Ref: LatestVersionErrorMetricGreaterThanZeroAlarm
  Hooks:
    PreTraffic:
      !Ref: PreTrafficLambdaFunction
    PostTraffic:
      !Ref: PostTrafficLambdaFunction
```

### DeploymentPreference dengan Fn: :Jika fungsi intrinsik
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function"></a>

Contoh preferensi deployment yang menggunakan `Fn::If` untuk mengonfigurasi alarm. Dalam contoh ini, `Alarm1` akan dikonfigurasi jika `MyCondition` adalah `true`, dan `Alarm2` dan `Alarm5` akan dikonfigurasi jika `MyCondition` adalah `false`.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    Fn::If:
      - MyCondition
      - - Alarm1
      - - Alarm2
        - Alarm5
```

# Hooks
<a name="sam-property-function-hooks"></a>

Validasi fungsi Lambda yang dijalankan sebelum dan sesudah pergeseran lalu lintas.

**catatan**  
Fungsi Lambda yang direferensikan dalam properti ini mengkonfigurasi `CodeDeployLambdaAliasUpdate` objek sumber daya yang dihasilkan. [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html) Untuk informasi selengkapnya, lihat [CodeDeployLambdaAliasUpdate Kebijakan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-codedeploylambdaaliasupdate) di *Panduan AWS CloudFormation Pengguna*.

## Sintaksis
<a name="sam-property-function-hooks-syntax"></a>

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

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

```
  [PostTraffic](#sam-function-hooks-posttraffic): String
  [PreTraffic](#sam-function-hooks-pretraffic): String
```

## Sifat-sifat
<a name="sam-property-function-hooks-properties"></a>

 `PostTraffic`   <a name="sam-function-hooks-posttraffic"></a>
Fungsi Lambda yang dijalankan setelah pergeseran lalu lintas.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PreTraffic`   <a name="sam-function-hooks-pretraffic"></a>
Fungsi Lambda yang dijalankan sebelum pergeseran lalu lintas.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-hooks--examples"></a>

### Hook
<a name="sam-property-function-hooks--examples--hooks"></a>

Contoh fungsi kait

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

```
Hooks:
  PreTraffic:
    Ref: PreTrafficLambdaFunction
  PostTraffic:
    Ref: PostTrafficLambdaFunction
```

# DurableConfig
<a name="sam-property-function-durableconfig"></a>

Mengkonfigurasi pengaturan eksekusi tahan lama untuk AWS Lambda fungsi. Fungsi yang tahan lama dapat berjalan hingga satu tahun dan secara otomatis memeriksa kemajuan pos, memungkinkan alur kerja yang berjalan lama dan aplikasi yang toleran terhadap kesalahan. Untuk informasi selengkapnya tentang fungsi tahan lama, lihat [Fungsi tahan lama Lambda](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html) di Panduan *AWS Lambda Pengembang*.

## Sintaksis
<a name="sam-property-function-durableconfig-syntax"></a>

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

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

```
  [ExecutionTimeout](#sam-function-durableconfig-executiontimeout): Integer
  [RetentionPeriodInDays](#sam-function-durableconfig-retentionperiodindays): Integer
```

## Sifat-sifat
<a name="sam-property-function-durableconfig-properties"></a>

 `ExecutionTimeout`   <a name="sam-function-durableconfig-executiontimeout"></a>
Jumlah waktu (dalam detik) yang memungkinkan Lambda menjalankan fungsi yang tahan lama sebelum menghentikannya. Maksimal satu tahun 366 hari atau 31.622.400 detik.  
*Tipe*: Integer  
*Wajib*: Ya  
*Minimal*: 1  
*Maksimal*: 31622400  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ExecutionTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-executiontimeout)` properti tipe `AWS::Lambda::Function` `DurableConfig` data.

 `RetentionPeriodInDays`   <a name="sam-function-durableconfig-retentionperiodindays"></a>
Jumlah hari setelah eksekusi yang tahan lama ditutup sehingga Lambda mempertahankan sejarahnya, dari satu hingga 90 hari. Defaultnya adalah 14 hari.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 14  
*Minimal*: 1  
*Maksimal*: 90  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetentionPeriodInDays](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-retentionperiodindays)` properti tipe `AWS::Lambda::Function` `DurableConfig` data.

## Contoh
<a name="sam-property-function-durableconfig--examples"></a>

### DurableConfig
<a name="sam-property-function-durableconfig--examples--durableconfig"></a>

Contoh konfigurasi tahan lama untuk fungsi dengan batas waktu eksekusi 1 jam dan periode retensi 7 hari.

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

```
DurableConfig:
  ExecutionTimeout: 3600
  RetentionPeriodInDays: 7
```

# EventInvokeConfiguration
<a name="sam-property-function-eventinvokeconfiguration"></a>

Opsi konfigurasi untuk pemanggilan alias atau versi Lambda [tidak sinkron](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html).

## Sintaksis
<a name="sam-property-function-eventinvokeconfiguration-syntax"></a>

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

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

```
  [DestinationConfig](#sam-function-eventinvokeconfiguration-destinationconfig): EventInvokeDestinationConfiguration
  [MaximumEventAgeInSeconds](#sam-function-eventinvokeconfiguration-maximumeventageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-eventinvokeconfiguration-maximumretryattempts): Integer
```

## Sifat-sifat
<a name="sam-property-function-eventinvokeconfiguration-properties"></a>

 `DestinationConfig`   <a name="sam-function-eventinvokeconfiguration-destinationconfig"></a>
Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.  
*Jenis*: [EventInvokeDestinationConfiguration](sam-property-function-eventinvokedestinationconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. SAM membutuhkan parameter tambahan, “Type”, yang tidak ada di CloudFormation.

 `MaximumEventAgeInSeconds`   <a name="sam-function-eventinvokeconfiguration-maximumeventageinseconds"></a>
Masa maksimum permintaan yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumEventAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds)` properti `AWS::Lambda::EventInvokeConfig` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-eventinvokeconfiguration-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts)` properti `AWS::Lambda::EventInvokeConfig` sumber daya.

## Contoh
<a name="sam-property-function-eventinvokeconfiguration--examples"></a>

### MaximumEventAgeInSeconds
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds"></a>

MaximumEventAgeInSeconds contoh

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

```
EventInvokeConfig:
  MaximumEventAgeInSeconds: 60
  MaximumRetryAttempts: 2
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# EventInvokeDestinationConfiguration
<a name="sam-property-function-eventinvokedestinationconfiguration"></a>

Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.

## Sintaksis
<a name="sam-property-function-eventinvokedestinationconfiguration-syntax"></a>

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

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

```
  [OnFailure](#sam-function-eventinvokedestinationconfiguration-onfailure): OnFailure
  [OnSuccess](#sam-function-eventinvokedestinationconfiguration-onsuccess): OnSuccess
```

## Sifat-sifat
<a name="sam-property-function-eventinvokedestinationconfiguration-properties"></a>

 `OnFailure`   <a name="sam-function-eventinvokedestinationconfiguration-onfailure"></a>
Tujuan untuk peristiwa yang gagal diproses.  
*Jenis*: [OnFailure](sam-property-function-onfailure.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. Membutuhkan `Type`, properti hanya-SAM tambahan.

 `OnSuccess`   <a name="sam-function-eventinvokedestinationconfiguration-onsuccess"></a>
Tujuan untuk peristiwa yang berhasil diproses.  
*Jenis*: [OnSuccess](sam-property-function-onsuccess.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. Membutuhkan `Type`, properti hanya-SAM tambahan.

## Contoh
<a name="sam-property-function-eventinvokedestinationconfiguration--examples"></a>

### OnSuccess
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess"></a>

OnSuccess contoh

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

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# OnFailure
<a name="sam-property-function-onfailure"></a>

Tujuan untuk peristiwa yang gagal diproses.

## Sintaksis
<a name="sam-property-function-onfailure-syntax"></a>

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

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

```
  [Destination](#sam-function-onfailure-destination): String
  [Type](#sam-function-onfailure-type): String
```

## Sifat-sifat
<a name="sam-property-function-onfailure-properties"></a>

 `Destination`   <a name="sam-function-onfailure-destination"></a>
Amazon Resource Name (ARN) dari sumber daya tujuan.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. SAM akan menambahkan izin yang diperlukan untuk membuat IAM role yang dibuat secara otomatis terkait dengan fungsi ini untuk mengakses sumber daya yang dirujuk dalam properti ini.  
*Catatan tambahan*: Jika jenisnya adalah Lambda/EventBridge, Tujuan diperlukan.

 `Type`   <a name="sam-function-onfailure-type"></a>
Tipe sumber daya yang dirujuk di tujuan. Jenis yang didukung adalah`SQS`,`SNS`,`S3`,`Lambda`, dan`EventBridge`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: Jika jenisnya SQS/SNS dan `Destination` properti dibiarkan kosong, maka SQS/SNS sumber daya dihasilkan secara otomatis oleh SAM. Untuk referensi sumber daya, gunakan `<function-logical-id>.DestinationQueue` untuk SQS atau `<function-logical-id>.DestinationTopic` untuk SNS. Jika jenisnya adalah Lambda/EventBridge, `Destination` diperlukan.

## Contoh
<a name="sam-property-function-onfailure--examples"></a>

### EventInvoke Contoh Konfigurasi dengan tujuan SQS dan Lambda
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

Dalam contoh ini tidak ada Tujuan yang diberikan untuk OnSuccess konfigurasi SQS, sehingga SAM secara implisit membuat antrian SQS dan menambahkan izin yang diperlukan. Juga untuk contoh ini, Tujuan untuk sumber daya Lambda yang dideklarasikan dalam file template ditentukan dalam OnFailure konfigurasi, jadi SAM menambahkan izin yang diperlukan ke fungsi Lambda ini untuk memanggil fungsi Lambda tujuan.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Contoh Konfigurasi dengan tujuan SNS
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination"></a>

Dalam contoh ini Tujuan diberikan untuk topik SNS yang dideklarasikan dalam file template untuk OnSuccess konfigurasi.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# OnSuccess
<a name="sam-property-function-onsuccess"></a>

Tujuan untuk peristiwa yang berhasil diproses.

## Sintaksis
<a name="sam-property-function-onsuccess-syntax"></a>

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

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

```
  [Destination](#sam-function-onsuccess-destination): String
  [Type](#sam-function-onsuccess-type): String
```

## Sifat-sifat
<a name="sam-property-function-onsuccess-properties"></a>

 `Destination`   <a name="sam-function-onsuccess-destination"></a>
Amazon Resource Name (ARN) dari sumber daya tujuan.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. SAM akan menambahkan izin yang diperlukan untuk membuat IAM role yang dibuat secara otomatis terkait dengan fungsi ini untuk mengakses sumber daya yang dirujuk dalam properti ini.  
*Catatan tambahan*: Jika jenisnya adalah Lambda/EventBridge, Tujuan diperlukan.

 `Type`   <a name="sam-function-onsuccess-type"></a>
Tipe sumber daya yang dirujuk di tujuan. Jenis yang didukung adalah`SQS`,`SNS`,`S3`,`Lambda`, dan`EventBridge`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: Jika jenisnya SQS/SNS dan `Destination` properti dibiarkan kosong, maka SQS/SNS sumber daya dihasilkan secara otomatis oleh SAM. Untuk referensi sumber daya, gunakan `<function-logical-id>.DestinationQueue` untuk SQS atau `<function-logical-id>.DestinationTopic` untuk SNS. Jika jenisnya adalah Lambda/EventBridge, `Destination` diperlukan.

## Contoh
<a name="sam-property-function-onsuccess--examples"></a>

### EventInvoke Contoh Konfigurasi dengan tujuan SQS dan Lambda
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

Dalam contoh ini tidak ada Tujuan yang diberikan untuk OnSuccess konfigurasi SQS, sehingga SAM secara implisit membuat antrian SQS dan menambahkan izin yang diperlukan. Juga untuk contoh ini, Tujuan untuk sumber daya Lambda yang dideklarasikan dalam file template ditentukan dalam OnFailure konfigurasi, jadi SAM menambahkan izin yang diperlukan ke fungsi Lambda ini untuk memanggil fungsi Lambda tujuan.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Contoh Konfigurasi dengan tujuan SNS
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination"></a>

Dalam contoh ini Tujuan diberikan untuk topik SNS yang dideklarasikan dalam file template untuk OnSuccess konfigurasi.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# EventSource
<a name="sam-property-function-eventsource"></a>

Objek yang menggambarkan sumber peristiwa yang memicu fungsi. Setiap peristiwa terdiri dari tipe dan satu set properti yang bergantung pada tipe itu. Untuk informasi lebih lanjut tentang properti dari setiap sumber peristiwa, lihat topik yang sesuai dengan tipe tersebut.

## Sintaksis
<a name="sam-property-function-eventsource-syntax"></a>

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

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

```
  [Properties](#sam-function-eventsource-properties): AlexaSkill | Api | CloudWatchEvent | CloudWatchLogs | Cognito | DocumentDB | DynamoDB | EventBridgeRule | HttpApi | IoTRule | Kinesis | MQ | MSK | S3 | Schedule | ScheduleV2 | SelfManagedKafka | SNS | SQS
  [Type](#sam-function-eventsource-type): String
```

## Sifat-sifat
<a name="sam-property-function-eventsource-properties"></a>

 `Properties`   <a name="sam-function-eventsource-properties"></a>
Objek menggambarkan sifat pemetaan peristiwa ini. Set properti harus sesuai dengan tipe yang ditentukan.  
*Jenis* [[[[[[: [AlexaSkill](sam-property-function-alexaskill.md)\$1 [Api](sam-property-function-api.md) \$1 \$1 \$1 [Cognito [CloudWatchEvent[CloudWatchLogs](sam-property-function-cloudwatchlogs.md)](sam-property-function-cloudwatchevent.md)](sam-property-function-cognito.md)\$1 DocumentDB \$1 DynamoDB [\$1 \$1 \$1 [EventBridgeRule](sam-property-function-eventbridgerule.md)](sam-property-function-documentdb.md)Io \$1 [TRuleKinesis \$1 [MQ](sam-property-function-mq.md) \$1 MSK [\$1](sam-property-function-dynamodb.md) S3 [HttpApi](sam-property-function-httpapi.md)\$1 Jadwal \$1 Schedulev2](sam-property-function-iotrule.md)[\$1 \$1](sam-property-function-kinesis.md) SNS \$1 SQS [SelfManagedKafka](sam-property-function-selfmanagedkafka.md)](sam-property-function-sqs.md)](sam-property-function-sns.md)](sam-property-function-schedulev2.md)](sam-property-function-schedule.md)](sam-property-function-s3.md)](sam-property-function-msk.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-function-eventsource-type"></a>
Jenis peristiwa.  
*Nilai yang valid*: `AlexaSkill``Api`,`CloudWatchEvent`,`CloudWatchLogs`,`Cognito`,`DocumentDB`,`DynamoDB`,,`EventBridgeRule`,`HttpApi`,`IoTRule`,`Kinesis`,`MQ`,`MSK`,`S3`,`Schedule`,`ScheduleV2`,`SelfManagedKafka`,`SNS`, `SQS`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-eventsource--examples"></a>

### APIEvent
<a name="sam-property-function-eventsource--examples--apievent"></a>

Contoh menggunakan peristiwa API

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

```
ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi
```

# AlexaSkill
<a name="sam-property-function-alexaskill"></a>

Objek yang menggambarkan tipe sumber peristiwa `AlexaSkill`.

## Sintaksis
<a name="sam-property-function-alexaskill-syntax"></a>

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

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

```
  [SkillId](#sam-function-alexaskill-skillid): String
```

## Sifat-sifat
<a name="sam-property-function-alexaskill-properties"></a>

 `SkillId`   <a name="sam-function-alexaskill-skillid"></a>
ID Keterampilan Alexa untuk Keterampilan Alexa Anda. Untuk informasi selengkapnya tentang ID Keterampilan lihat [Konfigurasikan pemicu untuk fungsi Lambda](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger) dalam dokumentasi Kit Keterampilan Alexa.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-alexaskill--examples"></a>

### AlexaSkillTrigger
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger"></a>

Contoh Peristiwa Keterampilan Alexa

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

```
AlexaSkillEvent:
  Type: AlexaSkill
```

# Api
<a name="sam-property-function-api"></a>

Objek yang menggambarkan tipe sumber peristiwa `Api`. Jika sumber daya [AWS::Serverless::Api](sam-resource-api.md) didefinisikan, nilai jalur dan metode harus sesuai dengan operasi dalam ketentuan OpenAPI API.

Jika [AWS::Serverless::Api](sam-resource-api.md) tidak ditentukan, input dan output fungsi adalah representasi dari permintaan HTTP dan respons HTTP.

Misalnya, menggunakan JavaScript API, kode status dan isi respons dapat dikontrol dengan mengembalikan objek dengan kunci StatusCode dan body.

## Sintaksis
<a name="sam-property-function-api-syntax"></a>

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

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

```
  [Auth](#sam-function-api-auth): ApiFunctionAuth
  [Method](#sam-function-api-method): String
  [Path](#sam-function-api-path): String
  [RequestModel](#sam-function-api-requestmodel): RequestModel
  [RequestParameters](#sam-function-api-requestparameters): List of [ String | RequestParameter ]
  [RestApiId](#sam-function-api-restapiid): String
  [ResponseTransferMode](#sam-function-api-responsetransfermode): String
  TimeoutInMillis: Integer
```

## Sifat-sifat
<a name="sam-property-function-api-properties"></a>

 `Auth`   <a name="sam-function-api-auth"></a>
Konfigurasi auth untuk Api\$1Path\$1Metode tertentu ini.  
Berguna untuk membatalkan config auth pengaturan `DefaultAuthorizer` API pada jalur individu ketika `DefaultAuthorizer` tidak ditentukan atau membatalkan pengaturan `ApiKeyRequired` default.  
*Jenis*: [ApiFunctionAuth](sam-property-function-apifunctionauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Method`   <a name="sam-function-api-method"></a>
Metode HTTP yang membuat fungsi ini dipanggil. Pilihan termasuk`DELETE`,`GET`,`HEAD`,`OPTIONS`,`PATCH`,`POST`,`PUT`, dan`ANY`. Lihat [Mengatur metode HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-add-http-method) di *Panduan Pengembang API Gateway* untuk detailnya.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Path`   <a name="sam-function-api-path"></a>
Jalur Uri yang membuat fungsi ini dipanggil. Harus dimulai dengan `/`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RequestModel`   <a name="sam-function-api-requestmodel"></a>
Permintaan model yang akan digunakan untuk Api\$1Path\$1Metode tertentu ini. Ini harus merujuk nama model yang ditentukan dalam bagian `Models` dari sumber daya [AWS::Serverless::Api](sam-resource-api.md).  
*Jenis*: [RequestModel](sam-property-function-requestmodel.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RequestParameters`   <a name="sam-function-api-requestparameters"></a>
Konfigurasi parameter permintaan untuk Api\$1Path\$1Metode tertentu ini. Semua nama parameter harus dimulai dengan `method.request` dan harus terbatas pada `method.request.header`, `method.request.querystring`, atau `method.request.path`.  
Daftar dapat berisi string nama parameter dan [RequestParameter](sam-property-function-requestparameter.md)objek. Untuk string, `Caching` properti `Required` and akan default ke`false`.  
*Jenis*: Daftar [String \$1 [RequestParameter](sam-property-function-requestparameter.md)]  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RestApiId`   <a name="sam-function-api-restapiid"></a>
Pengidentifikasi RestApi sumber daya, yang harus berisi operasi dengan jalur dan metode yang diberikan. Biasanya, ini diatur untuk merujuk sumber daya [AWS::Serverless::Api](sam-resource-api.md) yang ditentukan dalam templat ini.  
Jika Anda tidak mendefinisikan properti ini, AWS SAM buat [AWS::Serverless::Api](sam-resource-api.md) sumber daya default menggunakan `OpenApi` dokumen yang dihasilkan. Sumber daya tersebut berisi penyatuan dari semua jalur dan metode yang ditentukan oleh peristiwa `Api` dalam templat yang sama yang tidak menentukan `RestApiId`.  
Ini tidak dapat merujuk sumber daya [AWS::Serverless::Api](sam-resource-api.md) yang ditentukan dalam templat lain.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`ResponseTransferMode`  <a name="sam-function-api-responsetransfermode"></a>
Mode transfer respons untuk integrasi fungsi Lambda. Setel `RESPONSE_STREAM` untuk mengaktifkan streaming respons Lambda melalui API Gateway, memungkinkan fungsi untuk mengalirkan respons kembali ke klien. Saat disetel ke`RESPONSE_STREAM`, API Gateway menggunakan API Lambda InvokeWithResponseStreaming .  
*Tipe*: String  
*Wajib*: Tidak  
*Nilai yang valid*: `BUFFERED` \$1 `RESPONSE_STREAM`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode)properti`AWS::ApiGateway::Method Integration`.

`TimeoutInMillis`  <a name="sam-function-api-timeoutinmillis"></a>
Waktu habis khusus antara 50 dan 29.000 milidetik.  
Saat Anda menentukan properti ini, AWS SAM memodifikasi definisi OpenAPI Anda. Definisi OpenAPI harus ditentukan sebaris menggunakan properti. `DefinitionBody` 
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 29.000 milidetik atau 29 detik  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-api--examples"></a>

### Contoh basic
<a name="sam-property-function-api--examples--apievent"></a>

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

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false
```

# ApiFunctionAuth
<a name="sam-property-function-apifunctionauth"></a>

Mengonfigurasi otorisasi di tingkat peristiwa, untuk API, jalur, dan metode tertentu.

## Sintaksis
<a name="sam-property-function-apifunctionauth-syntax"></a>

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

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

```
  [ApiKeyRequired](#sam-function-apifunctionauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-function-apifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-apifunctionauth-authorizer): String
  [InvokeRole](#sam-function-apifunctionauth-invokerole): String
  OverrideApiAuth: Boolean
  [ResourcePolicy](#sam-function-apifunctionauth-resourcepolicy): ResourcePolicyStatement
```

## Sifat-sifat
<a name="sam-property-function-apifunctionauth-properties"></a>

 `ApiKeyRequired`   <a name="sam-function-apifunctionauth-apikeyrequired"></a>
Memerlukan kunci API untuk API, jalur, dan metode ini.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AuthorizationScopes`   <a name="sam-function-apifunctionauth-authorizationscopes"></a>
Cakupan otorisasi yang akan diterapkan ke API, path, dan metode ini.  
Cakupan yang Anda tentukan akan membatalkan setiap cakupan yang diterapkan oleh properti `DefaultAuthorizer` jika Anda telah menentukannya.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Authorizer`   <a name="sam-function-apifunctionauth-authorizer"></a>
`Authorizer`Untuk fungsi tertentu.  
Jika Anda memiliki otorisasi global yang ditentukan untuk `AWS::Serverless::Api` sumber daya Anda, Anda dapat mengganti otorisasi dengan menyetelnya. `Authorizer` `NONE` Sebagai contoh, lihat [Ganti otorisasi global untuk REST API Amazon API Gateway](#sam-property-function-apifunctionauth--examples--override).  
Jika Anda menggunakan `DefinitionBody` properti `AWS::Serverless::Api` sumber daya untuk mendeskripsikan API Anda, Anda harus menggunakan `OverrideApiAuth` with `Authorizer` untuk mengganti otorisasi global Anda. Untuk informasi selengkapnya, lihat `OverrideApiAuth`.
*Nilai valid*:`AWS_IAM`,`NONE`, atau ID logis untuk otorisasi apa pun yang ditentukan dalam AWS SAM template Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `InvokeRole`   <a name="sam-function-apifunctionauth-invokerole"></a>
Menentukan `InvokeRole` untuk digunakan untuk otorisasi `AWS_IAM`.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `CALLER_CREDENTIALS`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: `CALLER_CREDENTIALS` memetakan ke `arn:aws:iam:::<user>/`, yang menggunakan kredensial pemanggil untuk memanggil titik akhir.

`OverrideApiAuth`  <a name="sam-function-apifunctionauth-overrideapiauth"></a>
Tentukan `true` untuk mengganti konfigurasi otorisasi global sumber daya Anda`AWS::Serverless::Api`. Properti ini hanya diperlukan jika Anda menentukan otorisasi global dan menggunakan `DefinitionBody` properti `AWS::Serverless::Api` sumber daya untuk mendeskripsikan API Anda.  
Saat Anda menentukan `OverrideApiAuth` sebagai`true`, AWS SAM akan mengganti otorisasi global Anda dengan nilai apa pun yang disediakan untuk`ApiKeyRequired`,`Authorizer`, atau. `ResourcePolicy` Oleh karena itu, setidaknya satu dari properti ini juga harus ditentukan saat menggunakan`OverrideApiAuth`. Sebagai contoh, lihat [Ganti otorisasi global saat DefinitionBody for ditentukan AWS::Serverless::Api](#sam-property-function-apifunctionauth--examples--override2).
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ResourcePolicy`   <a name="sam-function-apifunctionauth-resourcepolicy"></a>
Mengonfigurasi Kebijakan Sumber Daya untuk jalur ini pada API.  
*Jenis*: [ResourcePolicyStatement](sam-property-function-resourcepolicystatement.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-apifunctionauth--examples"></a>

### Function-Auth
<a name="sam-property-function-apifunctionauth--examples--function-auth"></a>

Contoh berikut menentukan otorisasi pada tingkat fungsi.

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

```
Auth:
  ApiKeyRequired: true
  Authorizer: NONE
```

### Ganti otorisasi global untuk REST API Amazon API Gateway
<a name="sam-property-function-apifunctionauth--examples--override"></a>

Anda dapat menentukan otorisasi global untuk `AWS::Serverless::Api` sumber daya Anda. Berikut ini adalah contoh yang mengkonfigurasi otorisasi default global:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Untuk mengganti authorizer default untuk AWS Lambda fungsi Anda, Anda dapat menentukan `Authorizer` sebagai. `NONE` Berikut ini adalah contohnya:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  ...
  MyFn:
    Type: AWS::Serverless::Function
    Properties:
      ...
      Events:
        LambdaRequest:
          Type: Api
          Properties:
            RestApiId: !Ref MyApiWithLambdaRequestAuth
            Method: GET
            Auth:
              Authorizer: NONE
```

### Ganti otorisasi global saat DefinitionBody for ditentukan AWS::Serverless::Api
<a name="sam-property-function-apifunctionauth--examples--override2"></a>

Saat menggunakan `DefinitionBody` properti untuk mendeskripsikan `AWS::Serverless::Api` sumber daya Anda, metode penggantian sebelumnya tidak berfungsi. Berikut ini adalah contoh penggunaan `DefinitionBody` properti untuk sumber `AWS::Serverless::Api` daya:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2.0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Untuk mengganti otorisasi global, gunakan properti. `OverrideApiAuth` Berikut ini adalah contoh yang digunakan `OverrideApiAuth` untuk mengganti otorisasi global dengan nilai yang disediakan untuk: `Authorizer`

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2-0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
    
    MyAuthFn:
      Type: AWS::Serverless::Function
      ...
    
    MyFn:
      Type: AWS::Serverless::Function
        Properties:
          ...
          Events:
            LambdaRequest:
              Type: Api
              Properties:
                RestApiId: !Ref MyApiWithLambdaRequestAuth
                Method: GET
                Auth:
                  Authorizer: NONE
                  OverrideApiAuth: true
                Path: /lambda-token
```

# ResourcePolicyStatement
<a name="sam-property-function-resourcepolicystatement"></a>

Mengonfigurasi kebijakan sumber daya untuk semua metode dan jalur API. Untuk informasi selengkapnya tentang kebijakan sumber daya, lihat [Mengendalikan akses ke API dengan kebijakan sumber daya API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) di *Panduan Developer API Gateway*.

## Sintaksis
<a name="sam-property-function-resourcepolicystatement-syntax"></a>

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

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

```
  [AwsAccountBlacklist](#sam-function-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-function-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-function-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-function-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-function-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-function-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-function-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-function-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-function-resourcepolicystatement-sourcevpcwhitelist): List
```

## Sifat-sifat
<a name="sam-property-function-resourcepolicystatement-properties"></a>

 `AwsAccountBlacklist`   <a name="sam-function-resourcepolicystatement-awsaccountblacklist"></a>
 AWS Akun yang akan diblokir.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AwsAccountWhitelist`   <a name="sam-function-resourcepolicystatement-awsaccountwhitelist"></a>
 AWS Akun untuk memungkinkan. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CustomStatements`   <a name="sam-function-resourcepolicystatement-customstatements"></a>
Daftar pernyataan kebijakan sumber daya kustom untuk diterapkan ke API ini. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcBlacklist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcblacklist"></a>
Daftar virtual private cloud (VPCs) yang akan diblokir, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcWhitelist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Daftar VPCs to allow, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceBlacklist`   <a name="sam-function-resourcepolicystatement-intrinsicvpceblacklist"></a>
Daftar VPC endpoint yang akan diblokir, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceWhitelist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcewhitelist"></a>
Daftar VPC endpoint yang akan diizinkan, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeBlacklist`   <a name="sam-function-resourcepolicystatement-iprangeblacklist"></a>
Alamat IP atau jangkauan alamat yang akan diblokir. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeWhitelist`   <a name="sam-function-resourcepolicystatement-iprangewhitelist"></a>
Alamat IP atau jangkauan alamat yang akan diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcBlacklist`   <a name="sam-function-resourcepolicystatement-sourcevpcblacklist"></a>
Sumber VPC atau VPC endpoint yang akan diblokir. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcWhitelist`   <a name="sam-function-resourcepolicystatement-sourcevpcwhitelist"></a>
VPC sumber atau VPC endpoint yang akan diizinkan. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-resourcepolicystatement--examples"></a>

### Contoh Kebijakan Sumber Daya
<a name="sam-property-function-resourcepolicystatement--examples--resource-policy-example"></a>

Contoh berikut memblokir dua alamat IP dan VPC sumber, dan memungkinkan akun AWS .

#### YAML
<a name="sam-property-function-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# RequestModel
<a name="sam-property-function-requestmodel"></a>

Mengkonfigurasi Model Permintaan untuk Metode Api\$1Path\$1tertentu.

## Sintaksis
<a name="sam-property-function-requestmodel-syntax"></a>

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

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

```
  [Model](#sam-function-requestmodel-model): String
  [Required](#sam-function-requestmodel-required): Boolean
  [ValidateBody](#sam-function-requestmodel-validatebody): Boolean
  [ValidateParameters](#sam-function-requestmodel-validateparameters): Boolean
```

## Sifat-sifat
<a name="sam-property-function-requestmodel-properties"></a>

 `Model`   <a name="sam-function-requestmodel-model"></a>
Nama model yang ditentukan dalam properti Model dari [AWS::Serverless::Api](sam-resource-api.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Required`   <a name="sam-function-requestmodel-required"></a>
Menambahkan `required` properti di bagian parameter OpenApi definisi untuk titik akhir API yang diberikan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ValidateBody`   <a name="sam-function-requestmodel-validatebody"></a>
Menentukan apakah API Gateway menggunakan `Model` untuk memvalidasi badan permintaan. Untuk informasi selengkapnya, lihat [Mengaktifkan validasi permintaan di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) di *Panduan Pengembang API Gateway*.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ValidateParameters`   <a name="sam-function-requestmodel-validateparameters"></a>
Menentukan apakah API Gateway menggunakan `Model` untuk memvalidasi parameter jalur permintaan, string kueri, dan header. Untuk informasi selengkapnya, lihat [Mengaktifkan validasi permintaan di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) di *Panduan Pengembang API Gateway*.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-requestmodel--examples"></a>

### Model Permintaan
<a name="sam-property-function-requestmodel--examples--request-model"></a>

Contoh Permintaan Model

#### YAML
<a name="sam-property-function-requestmodel--examples--request-model--yaml"></a>

```
RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true
```

# RequestParameter
<a name="sam-property-function-requestparameter"></a>

Mengonfigurasi Parameter Permintaan untuk Api\$1Path\$1Metode tertentu.

Properti `Required` atau `Caching` perlu ditentukan untuk parameter permintaan

## Sintaksis
<a name="sam-property-function-requestparameter-syntax"></a>

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

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

```
  [Caching](#sam-function-requestparameter-caching): Boolean
  [Required](#sam-function-requestparameter-required): Boolean
```

## Sifat-sifat
<a name="sam-property-function-requestparameter-properties"></a>

 `Caching`   <a name="sam-function-requestparameter-caching"></a>
Menambahkan `cacheKeyParameters` bagian ke OpenApi definisi API Gateway  
*Tipe*: Boolean  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Required`   <a name="sam-function-requestparameter-required"></a>
Bidang ini menentukan apakah parameter diperlukan  
*Tipe*: Boolean  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-requestparameter--examples"></a>

### Parameter permintaan
<a name="sam-property-function-requestparameter--examples--request-parameter"></a>

Contoh Parameter Permintaan pengaturan

#### YAML
<a name="sam-property-function-requestparameter--examples--request-parameter--yaml"></a>

```
RequestParameters:
  - method.request.header.Authorization:
      Required: true
      Caching: true
```

# CloudWatchEvent
<a name="sam-property-function-cloudwatchevent"></a>

Objek yang menggambarkan tipe sumber peristiwa `CloudWatchEvent`.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)sumber daya saat jenis acara ini disetel.

**Catatan Penting**: [EventBridgeRule](sam-property-function-eventbridgerule.md) adalah jenis sumber acara yang disukai untuk digunakan, bukan`CloudWatchEvent`. `EventBridgeRule`dan `CloudWatchEvent` menggunakan layanan, API, dan CloudFormation sumber daya dasar yang sama. Namun, AWS SAM akan menambahkan dukungan untuk fitur baru hanya untuk`EventBridgeRule`.

## Sintaksis
<a name="sam-property-function-cloudwatchevent-syntax"></a>

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

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

```
  [Enabled](#sam-function-cloudwatchevent-enabled): Boolean
  [EventBusName](#sam-function-cloudwatchevent-eventbusname): String
  [Input](#sam-function-cloudwatchevent-input): String
  [InputPath](#sam-function-cloudwatchevent-inputpath): String
  [Pattern](#sam-function-cloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [State](#sam-function-cloudwatchevent-state): String
```

## Sifat-sifat
<a name="sam-property-function-cloudwatchevent-properties"></a>

 `Enabled`   <a name="sam-function-cloudwatchevent-enabled"></a>
Menunjukkan apakah aturan diaktifkan.  
Untuk menonaktifkan aturan, tetapkan properti ini ke `false`.  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya. Jika properti ini diatur untuk `true` kemudian AWS SAM lolos`ENABLED`, jika tidak maka akan lewat`DISABLED`.

 `EventBusName`   <a name="sam-function-cloudwatchevent-eventbusname"></a>
Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Bus peristiwa default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` properti `AWS::Events::Rule` sumber daya.

 `Input`   <a name="sam-function-cloudwatchevent-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `InputPath`   <a name="sam-function-cloudwatchevent-inputpath"></a>
Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti `InputPath` untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` properti `AWS::Events::Rule Target` sumber daya.

 `Pattern`   <a name="sam-function-cloudwatchevent-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [Peristiwa dan Pola Peristiwa EventBridge di](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` properti `AWS::Events::Rule` sumber daya.

 `State`   <a name="sam-function-cloudwatchevent-state"></a>
Keadaan aturan.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya.

## Contoh
<a name="sam-property-function-cloudwatchevent--examples"></a>

### CloudWatchEvent
<a name="sam-property-function-cloudwatchevent--examples--cloudwatchevent"></a>

Berikut adalah contoh peristiwa dari tipe sumber peristiwa `CloudWatchEvent`.

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

```
CWEvent:
  Type: CloudWatchEvent
  Properties:
    Enabled: false
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running
```

# CloudWatchLogs
<a name="sam-property-function-cloudwatchlogs"></a>

Objek yang menggambarkan tipe sumber peristiwa `CloudWatchLogs`.

Acara ini menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html)sumber daya dan menentukan filter langganan dan mengaitkannya dengan grup log yang ditentukan.

## Sintaksis
<a name="sam-property-function-cloudwatchlogs-syntax"></a>

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

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

```
  [FilterPattern](#sam-function-cloudwatchlogs-filterpattern): String
  [LogGroupName](#sam-function-cloudwatchlogs-loggroupname): String
```

## Sifat-sifat
<a name="sam-property-function-cloudwatchlogs-properties"></a>

 `FilterPattern`   <a name="sam-function-cloudwatchlogs-filterpattern"></a>
Ekspresi pemfilteran yang membatasi apa yang dikirim ke sumber daya tujuan AWS . Untuk informasi selengkapnya tentang sintaks pola filter, lihat [Sintaks Filter dan Pola](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)..  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern)` properti `AWS::Logs::SubscriptionFilter` sumber daya.

 `LogGroupName`   <a name="sam-function-cloudwatchlogs-loggroupname"></a>
Grup log yang dikaitkan dengan filter langganan. Semua peristiwa log yang diunggah ke grup log ini difilter dan dikirim ke AWS sumber daya yang ditentukan jika pola filter cocok dengan peristiwa log.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LogGroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname)` properti `AWS::Logs::SubscriptionFilter` sumber daya.

## Contoh
<a name="sam-property-function-cloudwatchlogs--examples"></a>

### Filter Langganan Cloudwatchlogs
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter"></a>

Contoh filter Langganan Cloudwatchlogs

#### YAML
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter--yaml"></a>

```
CWLog:
  Type: CloudWatchLogs
  Properties:
    LogGroupName:
      Ref: CloudWatchLambdaLogsGroup
    FilterPattern: My pattern
```

# Cognito
<a name="sam-property-function-cognito"></a>

Objek yang menggambarkan tipe sumber peristiwa `Cognito`.

## Sintaksis
<a name="sam-property-function-cognito-syntax"></a>

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

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

```
  [Trigger](#sam-function-cognito-trigger): List
  [UserPool](#sam-function-cognito-userpool): String
```

## Sifat-sifat
<a name="sam-property-function-cognito-properties"></a>

 `Trigger`   <a name="sam-function-cognito-trigger"></a>
Lambda memicu informasi konfigurasi untuk kolam pengguna baru.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html)` properti `AWS::Cognito::UserPool` sumber daya.

 `UserPool`   <a name="sam-function-cognito-userpool"></a>
Referensi untuk UserPool didefinisikan dalam template yang sama  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-cognito--examples"></a>

### Peristiwa Cognito
<a name="sam-property-function-cognito--examples--cognito-event"></a>

Contoh Cognito

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

```
CognitoUserPoolPreSignup:
  Type: Cognito
  Properties:
    UserPool:
      Ref: MyCognitoUserPool
    Trigger: PreSignUp
```

# DocumentDB
<a name="sam-property-function-documentdb"></a>

Objek yang menggambarkan tipe sumber peristiwa `DocumentDB`. *Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) di AWS Lambda Panduan Pengembang.*

## Sintaksis
<a name="sam-property-function-documentdb-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

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

```
BatchSize: Integer
Cluster: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double
```

## Sifat-sifat
<a name="sam-property-function-documentdb-properties"></a>

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
Nama Sumber Daya Amazon (ARN) dari cluster Amazon DocumentDB.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
Nama koleksi untuk dikonsumsi dalam database. Jika Anda tidak menentukan koleksi, Lambda mengkonsumsi semua koleksi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` properti tipe `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
Nama database untuk dikonsumsi dalam cluster Amazon DocumentDB.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` properti tipe `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
Jika`true`, pemetaan sumber peristiwa aktif. Untuk menjeda polling dan pemanggilan, atur ke `false`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Objek yang mendefinisikan kriteria yang menentukan apakah Lambda harus memproses suatu peristiwa. *Untuk informasi selengkapnya, lihat [Pemfilteran acara Lambda di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Pengembang.AWS Lambda *  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
Menentukan apa yang Amazon DocumentDB kirimkan ke aliran acara Anda selama operasi pembaruan dokumen. Jika disetel ke`UpdateLookup`, Amazon DocumentDB mengirimkan delta yang menjelaskan perubahan, bersama dengan salinan seluruh dokumen. Jika tidak, Amazon DocumentDB hanya mengirimkan sebagian dokumen yang berisi perubahan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` properti tipe `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
ID kunci AWS Key Management Service (AWS KMS) kunci kunci yang dikelola pelanggan dari AWS Secrets Manager. Diperlukan saat Anda menggunakan kunci terkelola pelanggan dari Secrets Manager dengan peran eksekusi Lambda yang tidak menyertakan izin. `kms:Decrypt`  
Nilai properti ini adalah UUID. Sebagai contoh: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
Array protokol otentikasi atau host virtual. Tentukan ini menggunakan tipe [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)data.  
Untuk tipe sumber `DocumentDB` acara, satu-satunya jenis konfigurasi yang valid adalah`BASIC_AUTH`.  
+ `BASIC_AUTH`Rahasia Secrets Manager yang menyimpan kredensi broker Anda. Untuk tipe ini, kredensialnya harus dalam format berikut: `{"username": "your-username", "password": "your-password"}`. Hanya satu objek dari tipe `BASIC_AUTH` diizinkan.
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-documentdb-examples"></a>

### Sumber acara Amazon DocumentDB
<a name="sam-property-function-documentdb-examples-example1"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
    ...
      Events:
        MyDDBEvent:
          Type: DocumentDB
          Properties:
            Cluster: "arn:aws:rds:us-west-2:123456789012:cluster:docdb-2023-01-01"
            BatchSize: 10
            MaximumBatchingWindowInSeconds: 5
            DatabaseName: "db1"
            CollectionName: "collection1"
            FullDocument: "UpdateLookup"
            SourceAccessConfigurations:
              - Type: BASIC_AUTH
                URI: "arn:aws:secretsmanager:us-west-2:123456789012:secret:doc-db"
```

# DynamoDB
<a name="sam-property-function-dynamodb"></a>

Objek yang menggambarkan tipe sumber peristiwa `DynamoDB`. *Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Amazon DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) di AWS Lambda Panduan Pengembang.*

AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)daya saat jenis acara ini disetel.

## Sintaksis
<a name="sam-property-function-dynamodb-syntax"></a>

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

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

```
  [BatchSize](#sam-function-dynamodb-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-dynamodb-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-dynamodb-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-dynamodb-enabled): Boolean
  [FilterCriteria](#sam-function-dynamodb-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-dynamodb-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-dynamodb-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-dynamodb-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-dynamodb-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-dynamodb-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-dynamodb-parallelizationfactor): Integer
  [StartingPosition](#sam-function-dynamodb-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-dynamodb-stream): String
  [TumblingWindowInSeconds](#sam-function-dynamodb-tumblingwindowinseconds): Integer
```

## Sifat-sifat
<a name="sam-property-function-dynamodb-properties"></a>

 `BatchSize`   <a name="sam-function-dynamodb-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `1000`

 `BisectBatchOnFunctionError`   <a name="sam-function-dynamodb-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-dynamodb-destinationconfig"></a>
Antrean Amazon Simple Queue Service (Amazon SQS) atau tujuan topik Amazon Simple Notification Service (Amazon SNS) untuk catatan yang dibuang.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-dynamodb-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-dynamodb-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-dynamodb-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-dynamodb-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-dynamodb-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-dynamodb-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-dynamodb-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-dynamodb-metricsconfig"></a>
Konfigurasi keikutsertaan untuk mendapatkan metrik yang disempurnakan untuk pemetaan sumber peristiwa yang menangkap setiap tahap pemrosesan. Sebagai contoh, lihat [MetricsConfig acara](#sam-property-function-dynamodb-example-metricsconfigevent).  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ParallelizationFactor`   <a name="sam-function-dynamodb-parallelizationfactor"></a>
Jumlah batch yang akan diproses dari tiap serpihan secara bersamaan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-dynamodb-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-dynamodb-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Stream`   <a name="sam-function-dynamodb-stream"></a>
Amazon Resource Name (ARN) dari pengaliran DynamoDB.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `TumblingWindowInSeconds`   <a name="sam-function-dynamodb-tumblingwindowinseconds"></a>
Durasi dalam detik dari periode pemrosesan. Kisaran yang valid adalah 1 sampai 900 (15 menit).  
Untuk informasi selengkapnya, lihat [Periode Jatuh](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#streams-tumbling) di *Panduan Developer AWS Lambda *.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-dynamodb--examples"></a>

### MetricsConfig acara
<a name="sam-property-function-dynamodb-example-metricsconfigevent"></a>

Berikut ini adalah contoh sumber daya yang menggunakan `MetricsConfig` properti untuk menangkap setiap tahap pemrosesan untuk pemetaan sumber peristiwa mereka.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Sumber peristiwa DynamoDB untuk tabel DynamoDB yang ada
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table"></a>

DynamoDB sumber peristiwa untuk tabel DynamoDB yang sudah ada di akun. AWS 

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: arn:aws:dynamodb:us-east-1:123456789012:table/TestTable/stream/2016-08-11T21:21:33.291
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

### Peristiwa DynamoDB untuk tabel DynamoDB yang dinyatakan dalam Templat
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template"></a>

Peristiwa DynamoDB untuk tabel DynamoDB yang dinyatakan dalam file templat yang sama.

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: 
        !GetAtt MyDynamoDBTable.StreamArn   # This must be the name of a DynamoDB table declared in the same template file
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

# EventBridgeRule
<a name="sam-property-function-eventbridgerule"></a>

Objek yang menjelaskan jenis sumber `EventBridgeRule` peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target aturan Amazon. EventBridge Untuk informasi lebih lanjut, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) di *Panduan EventBridge Pengguna Amazon*.

AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)daya saat jenis acara ini disetel. AWS SAM juga menciptakan `AWS::Lambda::Permission` sumber daya, yang diperlukan sehingga `EventBridgeRule` dapat memanggil Lambda.

## Sintaksis
<a name="sam-property-function-eventbridgerule-syntax"></a>

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

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

```
  [DeadLetterConfig](#sam-function-eventbridgerule-deadletterconfig): DeadLetterConfig
  [EventBusName](#sam-function-eventbridgerule-eventbusname): String
  [Input](#sam-function-eventbridgerule-input): String
  [InputPath](#sam-function-eventbridgerule-inputpath): String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [RetryPolicy](#sam-function-eventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String 
  State: String
  [Target](#sam-function-eventbridgerule-target): Target
```

## Sifat-sifat
<a name="sam-property-function-eventbridgerule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-eventbridgerule-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa`DeadLetterQueue`, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Jenis*: [DeadLetterConfig](sam-property-function-deadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` properti tipe `AWS::Events::Rule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `EventBusName`   <a name="sam-function-eventbridgerule-eventbusname"></a>
Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Bus peristiwa default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` properti `AWS::Events::Rule` sumber daya.

 `Input`   <a name="sam-function-eventbridgerule-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `InputPath`   <a name="sam-function-eventbridgerule-inputpath"></a>
Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti `InputPath` untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` properti `AWS::Events::Rule Target` sumber daya.

 `InputTransformer`   <a name="sam-function-eventbridgerule-inputtransformer"></a>
Pengaturan untuk memungkinkan Anda memberikan input kustom ke target berdasarkan data peristiwa tertentu. Anda dapat mengekstrak satu atau beberapa pasangan nilai kunci dari peristiwa dan kemudian menggunakan data tersebut untuk mengirim input yang disesuaikan ke target. Untuk informasi selengkapnya, lihat [Transformasi EventBridge input Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) *di Panduan EventBridge Pengguna Amazon*.   
*Jenis*: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)` properti tipe `AWS::Events::Rule` `Target` data.

 `Pattern`   <a name="sam-function-eventbridgerule-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [ EventBridgeperistiwa Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html) dan [pola EventBridge acara](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) di *Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` properti `AWS::Events::Rule` sumber daya.

 `RetryPolicy`   <a name="sam-function-eventbridgerule-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` properti tipe `AWS::Events::Rule` `Target` data.

 `RuleName`   <a name="sam-function-eventbridgerule-rulename"></a>
Nama aturan .  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` properti `AWS::Events::Rule` sumber daya.

 `State`   <a name="sam-function-eventbridgerule-state"></a>
Keadaan aturan.  
*Nilai yang diterima*: `DISABLED` \$1 `ENABLED` \$1 `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state) ` properti `AWS::Events::Rule` sumber daya.

 `Target`   <a name="sam-function-eventbridgerule-target"></a>
Sumber AWS daya yang EventBridge dipanggil ketika aturan dipicu. Anda dapat menggunakan properti ini untuk menentukan ID logis dari target. Jika properti ini tidak ditentukan, maka AWS SAM menghasilkan ID logis dari target.  
*Tipe*: [Target](sam-property-function-target.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` properti `AWS::Events::Rule` sumber daya. `Amazon EC2 RebootInstances API call`adalah contoh dari properti target. Versi AWS SAM properti ini hanya mengizinkan Anda untuk menentukan ID logis dari satu target.

## Contoh
<a name="sam-property-function-eventbridgerule--examples"></a>

### EventBridgeRule
<a name="sam-property-function-eventbridgerule--examples--eventbridgerule"></a>

Berikut adalah contoh tipe sumber peristiwa `EventBridgeRule`.

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget
```

# DeadLetterConfig
<a name="sam-property-function-deadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Permintaan dapat gagal, misalnya, ketika mengirim peristiwa ke fungsi Lambda yang tidak ada, atau izin tidak cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *

**catatan**  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa, `DeadLetterQueue` yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *

## Sintaksis
<a name="sam-property-function-deadletterconfig-syntax"></a>

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

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

```
  [Arn](#sam-function-deadletterconfig-arn): String
  [QueueLogicalId](#sam-function-deadletterconfig-queuelogicalid): String
  [Type](#sam-function-deadletterconfig-type): String
```

## Sifat-sifat
<a name="sam-property-function-deadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-deadletterconfig-arn"></a>
Amazon Resource Name (ARN) dari antrean Amazon SQS yang ditetapkan sebagai target antrean surat mati.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` properti tipe `AWS::Events::Rule` `DeadLetterConfig` data.

 `QueueLogicalId`   <a name="sam-function-deadletterconfig-queuelogicalid"></a>
Nama kustom antrian huruf mati yang AWS SAM menciptakan if `Type` ditentukan.  
Jika `Type` properti tidak disetel, properti ini diabaikan.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-function-deadletterconfig-type"></a>
Tipe antrean. Ketika properti ini disetel, AWS SAM secara otomatis membuat [antrean huruf mati dan melampirkan kebijakan berbasis sumber daya yang diperlukan untuk memberikan izin untuk mengatur sumber daya](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) untuk mengirim peristiwa ke antrian.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Nilai yang valid*: `SQS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-deadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-function-deadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

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

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-function-target"></a>

Mengkonfigurasi AWS sumber daya yang EventBridge dipanggil ketika aturan dipicu.

## Sintaksis
<a name="sam-property-function-target-syntax"></a>

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

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

```
  [Id](#sam-function-target-id): String
```

## Sifat-sifat
<a name="sam-property-function-target-properties"></a>

 `Id`   <a name="sam-function-target-id"></a>
ID logis dari target.  
Nilai dari `Id` dapat mencakup karakter alfanumerik, titik (`.`), tanda hubung (`-`), dan garis bawah (`_`).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` properti tipe `AWS::Events::Rule` `Target` data.

## Contoh
<a name="sam-property-function-target--examples"></a>

### Target
<a name="sam-property-function-target--examples--target"></a>

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```

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

Objek yang menggambarkan sumber peristiwa dengan tipe HttpApi.

Jika OpenApi definisi untuk jalur dan metode yang ditentukan ada di API, SAM akan menambahkan bagian integrasi dan keamanan Lambda (jika ada) untuk Anda.

Jika tidak ada OpenApi definisi untuk jalur dan metode yang ditentukan di API, SAM akan membuat definisi ini untuk Anda.

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

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

### 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
```

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

 `ApiId`   <a name="sam-function-httpapi-apiid"></a>
Pengenal dari sumber daya [AWS::Serverless::HttpApi](sam-resource-httpapi.md) yang ditentukan dalam templat ini.  
Jika tidak ditentukan, [AWS::Serverless::HttpApi](sam-resource-httpapi.md) sumber daya default dibuat dengan `ServerlessHttpApi` menggunakan OpenApi dokumen yang dihasilkan yang berisi gabungan semua jalur dan metode yang ditentukan oleh peristiwa Api yang ditentukan dalam templat ini yang tidak menentukan`ApiId`.  
Ini tidak dapat merujuk sumber daya [AWS::Serverless::HttpApi](sam-resource-httpapi.md) yang ditentukan dalam templat lain.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Auth`   <a name="sam-function-httpapi-auth"></a>
Konfigurasi auth untuk Api\$1Path\$1Metode tertentu ini.  
Berguna untuk membatalkan `DefaultAuthorizer` API atau mengatur auth config pada jalur individu ketika `DefaultAuthorizer` tidak ditentukan.  
*Jenis*: [HttpApiFunctionAuth](sam-property-function-httpapifunctionauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Method`   <a name="sam-function-httpapi-method"></a>
Metode HTTP yang membuat fungsi ini dipanggil.  
Jika `Path` dan `Method` tidak ditentukan, SAM akan membuat jalur API default yang merutekan setiap permintaan yang tidak memetakan ke titik akhir yang berbeda untuk fungsi Lambda ini. Hanya satu dari jalur default ini yang boleh ada per API.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Path`   <a name="sam-function-httpapi-path"></a>
Jalur Uri yang membuat fungsi ini dipanggil. Harus dimulai dengan `/`.  
Jika `Path` dan `Method` tidak ditentukan, SAM akan membuat jalur API default yang merutekan setiap permintaan yang tidak memetakan ke titik akhir yang berbeda untuk fungsi Lambda ini. Hanya satu dari jalur default ini yang boleh ada per API.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PayloadFormatVersion`   <a name="sam-function-httpapi-payloadformatversion"></a>
Menentukan format muatan yang dikirim ke integrasi.  
CATATAN: PayloadFormatVersion mengharuskan SAM untuk memodifikasi definisi OpenAPI Anda, sehingga hanya berfungsi dengan definisi sebaris di OpenApi properti. `DefinitionBody`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: 2.0  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RouteSettings`   <a name="sam-function-httpapi-routesettings"></a>
Pengaturan rute per rute untuk API HTTP ini. Untuk informasi selengkapnya tentang setelan rute, lihat [AWS::ApiGatewayV2::Stage RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)di *Panduan Pengembang API Gateway*.  
Catatan: Jika RouteSettings ditentukan dalam HttpApi sumber daya dan sumber peristiwa, AWS SAM gabungkan mereka dengan properti sumber peristiwa yang diutamakan.  
*Jenis*: [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `TimeoutInMillis`   <a name="sam-function-httpapi-timeoutinmillis"></a>
Waktu habis khusus antara 50 dan 29.000 milidetik.  
CATATAN: TimeoutInMillis mengharuskan SAM untuk memodifikasi definisi OpenAPI Anda, sehingga hanya berfungsi dengan definisi sebaris di OpenApi properti. `DefinitionBody`  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 5000  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### HttpApi Acara Default
<a name="sam-property-function-httpapi--examples--default-httpapi-event"></a>

HttpApi Peristiwa yang menggunakan jalur default. Semua jalur dan metode yang belum dipetakan pada API ini akan merutekan ke titik akhir ini.

#### 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 Peristiwa yang menggunakan jalur dan metode tertentu.

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

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

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

HttpApi Event yang menggunakan Authorizer.

#### 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
```

# HttpApiFunctionAuth
<a name="sam-property-function-httpapifunctionauth"></a>

Mengonfigurasi otorisasi di tingkat peristiwa.

Mengonfigurasi Auth untuk API \$1 Path \$1 Metode tertentu

## Sintaksis
<a name="sam-property-function-httpapifunctionauth-syntax"></a>

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

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

```
  [AuthorizationScopes](#sam-function-httpapifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-httpapifunctionauth-authorizer): String
```

## Sifat-sifat
<a name="sam-property-function-httpapifunctionauth-properties"></a>

 `AuthorizationScopes`   <a name="sam-function-httpapifunctionauth-authorizationscopes"></a>
Cakupan otorisasi yang akan diterapkan ke API, path, dan metode ini.  
Lingkup yang tercantum di sini akan membatalkan setiap cakupan yang diterapkan oleh `DefaultAuthorizer` jika ada.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Authorizer`   <a name="sam-function-httpapifunctionauth-authorizer"></a>
`Authorizer`Untuk Fungsi tertentu. Untuk menggunakan otorisasi IAM, tentukan `AWS_IAM` dan tentukan `true` untuk `EnableIamAuthorizer` di `Globals` bagian template Anda.  
Jika Anda telah menentukan Otorisasi Global pada API dan ingin membuat Fungsi tertentu terbuka untuk publik, batalkan dengan mengatur `Authorizer` menjadi `NONE`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-httpapifunctionauth--examples"></a>

### Function-Auth
<a name="sam-property-function-httpapifunctionauth--examples--function-auth"></a>

Menentukan Otorisasi di tingkat Fungsi

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

```
Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2
```

### Otorisasi IAM
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization"></a>

Menentukan otorisasi IAM di tingkat acara. Untuk menggunakan `AWS_IAM` otorisasi di tingkat acara, Anda juga harus menentukan `true` untuk `EnableIamAuthorizer` di `Globals` bagian template Anda. Untuk informasi selengkapnya, lihat [Bagian global dari template AWS SAM](sam-specification-template-anatomy-globals.md).

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

```
Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9
```

# IoTRule
<a name="sam-property-function-iotrule"></a>

Objek yang menggambarkan tipe sumber peristiwa `IoTRule`.

Membuat sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)daya untuk mendeklarasikan aturan. AWS IoT Untuk informasi selengkapnya, lihat [dokumentasi CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)

## Sintaksis
<a name="sam-property-function-iotrule-syntax"></a>

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

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

```
  [AwsIotSqlVersion](#sam-function-iotrule-awsiotsqlversion): String
  [Sql](#sam-function-iotrule-sql): String
```

## Sifat-sifat
<a name="sam-property-function-iotrule-properties"></a>

 `AwsIotSqlVersion`   <a name="sam-function-iotrule-awsiotsqlversion"></a>
Versi mesin aturan SQL yang harus digunakan saat mengevaluasi aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AwsIotSqlVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion)` properti `AWS::IoT::TopicRule TopicRulePayload` sumber daya.

 `Sql`   <a name="sam-function-iotrule-sql"></a>
Pernyataan SQL yang digunakan untuk mengkuerikan topik. Untuk informasi selengkapnya, lihat [Referensi SQL AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) di *Panduan Developer AWS IoT *.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Sql](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql)` properti `AWS::IoT::TopicRule TopicRulePayload` sumber daya.

## Contoh
<a name="sam-property-function-iotrule--examples"></a>

### Aturan IOT
<a name="sam-property-function-iotrule--examples--iot-rule"></a>

Contoh Aturan IOT

#### YAML
<a name="sam-property-function-iotrule--examples--iot-rule--yaml"></a>

```
IoTRule:
  Type: IoTRule
  Properties:
    Sql: SELECT * FROM 'topic/test'
```

# Kinesis
<a name="sam-property-function-kinesis"></a>

Objek yang menggambarkan tipe sumber peristiwa `Kinesis`. Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda dengan Amazon Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) di Panduan *AWS Lambda Pengembang*.

AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)daya saat jenis acara ini disetel.

## Sintaksis
<a name="sam-property-function-kinesis-syntax"></a>

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

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

```
  [BatchSize](#sam-function-kinesis-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-kinesis-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-kinesis-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-kinesis-enabled): Boolean
  [FilterCriteria](#sam-function-kinesis-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-kinesis-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-kinesis-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-kinesis-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-kinesis-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-kinesis-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-kinesis-parallelizationfactor): Integer
  [StartingPosition](#sam-function-kinesis-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-kinesis-stream): String
  [TumblingWindowInSeconds](#sam-function-kinesis-tumblingwindowinseconds): Integer
```

## Sifat-sifat
<a name="sam-property-function-kinesis-properties"></a>

 `BatchSize`   <a name="sam-function-kinesis-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-kinesis-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-kinesis-destinationconfig"></a>
Antrean Amazon Simple Queue Service (Amazon SQS) atau tujuan topik Amazon Simple Notification Service (Amazon SNS) untuk catatan yang dibuang.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-kinesis-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-kinesis-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-kinesis-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-batchfailurereporting) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-kinesis-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-kinesis-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-kinesis-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-kinesis-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-kinesis-metricsconfig"></a>
Konfigurasi keikutsertaan untuk mendapatkan metrik yang disempurnakan untuk pemetaan sumber peristiwa yang menangkap setiap tahap pemrosesan. Sebagai contoh, lihat [MetricsConfig acara](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ParallelizationFactor`   <a name="sam-function-kinesis-parallelizationfactor"></a>
Jumlah batch yang akan diproses dari tiap serpihan secara bersamaan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-kinesis-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-kinesis-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Stream`   <a name="sam-function-kinesis-stream"></a>
Amazon Resource Name (ARN) dari aliran data atau konsumen pengaliran.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `TumblingWindowInSeconds`   <a name="sam-function-kinesis-tumblingwindowinseconds"></a>
Durasi dalam detik dari periode pemrosesan. Kisaran yang valid adalah 1 sampai 900 (15 menit).  
Untuk informasi selengkapnya, lihat [Periode Jatuh](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#streams-tumbling) di *Panduan Developer AWS Lambda *.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-kinesis--examples"></a>

### MetricsConfig acara
<a name="sam-property-function-kinesis-example-metricsconfigevent"></a>

Berikut ini adalah contoh sumber daya yang menggunakan `MetricsConfig` properti untuk menangkap setiap tahap pemrosesan untuk pemetaan sumber peristiwa mereka.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Sumber peristiwa Kinesis
<a name="sam-property-function-kinesis--examples--kinesis-event-source"></a>

Berikut ini adalah contoh sumber peristiwa Kinesis.

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

```
Events:
  KinesisEvent:
    Type: Kinesis
    Properties:
      Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'
```

# MQ
<a name="sam-property-function-mq"></a>

Objek yang menggambarkan tipe sumber peristiwa `MQ`. Untuk informasi lebih lanjut, lihat [Menggunakan Lambda dengan Amazon MQ](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html) dalam *Panduan Developer AWS Lambda *.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)sumber daya saat jenis acara ini disetel.

**catatan**  
Untuk memiliki antrian Amazon MQ di cloud pribadi virtual (VPC) yang terhubung ke fungsi Lambda di jaringan publik, peran eksekusi fungsi Anda harus menyertakan izin berikut:   
`ec2:CreateNetworkInterface`
`ec2:DeleteNetworkInterface`
`ec2:DescribeNetworkInterfaces`
`ec2:DescribeSecurityGroups`
`ec2:DescribeSubnets`
`ec2:DescribeVpcs`
Untuk informasi selengkapnya, lihat [Izin peran eksekusi](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions) di *Panduan Developer AWS Lambda *.

## Sintaksis
<a name="sam-property-function-mq-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

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

```
  [BatchSize](#sam-function-mq-batchsize): Integer
  [Broker](#sam-function-mq-broker): String
  DynamicPolicyName: Boolean
  [Enabled](#sam-function-mq-enabled): Boolean
  [FilterCriteria](#sam-function-mq-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  KmsKeyArn: String 
  [MaximumBatchingWindowInSeconds](#sam-function-mq-maximumbatchingwindowinseconds): Integer
  [Queues](#sam-function-mq-queues): List
  [SecretsManagerKmsKeyId](#sam-function-mq-secretsmanagerkmskeyid): String
  [SourceAccessConfigurations](#sam-function-mq-sourceaccessconfigurations): List
```

## Sifat-sifat
<a name="sam-property-function-mq-properties"></a>

 `BatchSize`   <a name="sam-function-mq-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `Broker`   <a name="sam-function-mq-broker"></a>
Amazon Resource Name (ARN) broker Amazon MQ.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DynamicPolicyName`   <a name="sam-function-mq-dynamicpolicyname"></a>
Secara default, nama kebijakan AWS Identity and Access Management (IAM) adalah `SamAutoGeneratedAMQPolicy` untuk kompatibilitas mundur. Tentukan `true` untuk menggunakan nama yang dibuat secara otomatis untuk kebijakan IAM Anda. Nama ini akan menyertakan ID logis sumber peristiwa Amazon MQ.  
Saat menggunakan lebih dari satu sumber peristiwa Amazon MQ, tentukan `true` untuk menghindari duplikat nama kebijakan IAM.
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Enabled`   <a name="sam-function-mq-enabled"></a>
Jika`true`, pemetaan sumber peristiwa aktif. Untuk menjeda polling dan pemanggilan, atur ke `false`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-mq-filtercriteria"></a>
Objek yang mendefinisikan kriteria yang menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-mq-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-mq-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Queues`   <a name="sam-function-mq-queues"></a>
Nama antrean tujuan broker Amazon MQ yang akan digunakan.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Queues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SecretsManagerKmsKeyId`   <a name="sam-function-mq-secretsmanagerkmskeyid"></a>
ID kunci AWS Key Management Service (AWS KMS) kunci kunci yang dikelola pelanggan dari AWS Secrets Manager. Diperlukan saat Anda menggunakan kunci terkelola pelanggan dari Secrets Manager dengan peran eksekusi Lambda yang tidak menyertakan izin. `kms:Decrypt`  
Nilai properti ini adalah UUID. Sebagai contoh: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceAccessConfigurations`   <a name="sam-function-mq-sourceaccessconfigurations"></a>
Array dari protokol autentikasi atau host vitual. Tentukan ini menggunakan tipe [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)data.  
Untuk tipe sumber `MQ` acara, satu-satunya tipe konfigurasi yang valid adalah `BASIC_AUTH` dan`VIRTUAL_HOST`.  
+ **`BASIC_AUTH`**Rahasia Secrets Manager yang menyimpan kredensi broker Anda. Untuk tipe ini, kredensialnya harus dalam format berikut: `{"username": "your-username", "password": "your-password"}`. Hanya satu objek dari tipe `BASIC_AUTH` diizinkan.
+ **`VIRTUAL_HOST`**— Nama host virtual di broker RabbitMQ Anda. Lambda akan menggunakan host Rabbit MQ ini sebagai sumber peristiwa. Hanya satu objek dari tipe `VIRTUAL_HOST` diizinkan.
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-mq--examples"></a>

### Sumber peristiwa Amazon MQ
<a name="sam-property-function-mq--examples--amazon-mq-event-source"></a>

Berikut ini adalah contoh tipe sumber peristiwa `MQ` untuk broker Amazon MQ.

#### YAML
<a name="sam-property-function-mq--examples--amazon-mq-event-source--yaml"></a>

```
Events:
  MQEvent:
    Type: MQ
    Properties:
      Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
      Queues: List of queues
      SourceAccessConfigurations:
        - Type: BASIC_AUTH
          URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName
      BatchSize: 200
      Enabled: true
```

# MSK
<a name="sam-property-function-msk"></a>

Objek yang menggambarkan tipe sumber peristiwa `MSK`. Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda MSK Amazon](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) di *Panduan AWS Lambda Pengembang*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)sumber daya saat jenis acara ini disetel.

Untuk menggunakan Schema Registry, Anda perlu menentukan izin peran IAM tertentu untuk fungsi Anda. Lihat [Penyiapan lengkap dengan peran IAM](#sam-property-function-msk-example-complete) untuk contoh konfigurasi yang diperlukan.

## Sintaksis
<a name="sam-property-function-msk-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

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

```
  [BatchSize](#sam-function-msk-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-msk-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-msk-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-msk-enabled): Boolean
  [FilterCriteria](#sam-function-msk-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-msk-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-msk-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-msk-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-msk-maximumretryattempts): Integer
  [LoggingConfig](#sam-function-msk-loggingconfig): [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)
  [MetricsConfig](#sam-function-msk-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)
  [ProvisionedPollerConfig](#sam-function-msk-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-msk-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  SourceAccessConfigurations: [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  [StartingPosition](#sam-function-msk-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-msk-stream): String
  [Topics](#sam-function-msk-topics): List
```

## Sifat-sifat
<a name="sam-property-function-msk-properties"></a>

 `BatchSize`   <a name="sam-function-msk-batchsize"></a>
Jumlah maksimum rekaman di setiap batch yang Lambda tarik dari aliran atau antrian Anda dan dikirim ke fungsi Anda. Lambda meneruskan semua catatan dalam batch ke fungsi dalam satu panggilan, hingga batas payload untuk pemanggilan sinkron (6 MB).  
*Default*: 100  
*Rentang Valid*: Nilai minimum 1. Nilai maksimum 10.000.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `BisectBatchOnFunctionError`   <a name="sam-function-msk-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ConsumerGroupId`   <a name="sam-function-msk-consumergroupid"></a>
String yang mengonfigurasi bagaimana acara akan dibaca dari topik Kafka.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AmazonManagedKafkaConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-msk-destinationconfig"></a>
Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.  
Gunakan properti ini untuk menentukan tujuan pemanggilan gagal dari sumber peristiwa MSK Amazon.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-msk-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-msk-filtercriteria"></a>
Objek yang mendefinisikan kriteria yang menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-msk-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-msk-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-msk-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-msk-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-msk-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `LoggingConfig`   <a name="sam-function-msk-loggingconfig"></a>
Objek konfigurasi yang menentukan konfigurasi logging untuk pemetaan sumber peristiwa.  
*Jenis*: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-msk-metricsconfig"></a>
Objek konfigurasi yang menentukan konfigurasi metrik untuk pemetaan sumber peristiwa.  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ProvisionedPollerConfig`   <a name="sam-function-msk-provisionedpollerconfig"></a>
Konfigurasi untuk meningkatkan jumlah poller yang digunakan untuk menghitung pemetaan sumber peristiwa. Konfigurasi ini memungkinkan minimal 1 poller dan maksimum 2000 poller. Sebagai contoh, lihat[ProvisionedPollerConfig contoh](#sam-property-function-msk-example-provisionedpollerconfig).  
*Jenis*: [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

`SchemaRegistryConfig`  <a name="sam-function-msk-schemaregistryconfig"></a>
Konfigurasi untuk menggunakan registri skema dengan sumber acara Kafka.  
Fitur ini `ProvisionedPollerConfig` perlu dikonfigurasi.
*Jenis*: SchemaRegistryConfig  
*Wajib*: Tidak  
*CloudFormation kompatibilitas:* Properti ini diteruskan langsung ke `[AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SourceAccessConfigurations`   <a name="sam-function-msk-sourceaccessconfigurations"></a>
Susunan protokol autentikasi, komponen VPC, atau host virtual untuk mengamankan dan menentukan sumber peristiwa Anda.  
*Nilai yang valid*: `CLIENT_CERTIFICATE_TLS_AUTH`  
*Jenis*: Daftar [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas:* Properti ini adalah bagian dari [AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)properti sumber daya. `AWS::Lambda::EventSourceMapping`

 `StartingPosition`   <a name="sam-function-msk-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-msk-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Stream`   <a name="sam-function-msk-stream"></a>
Amazon Resource Name (ARN) dari aliran data atau konsumen pengaliran.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Topics`   <a name="sam-function-msk-topics"></a>
Nama topik Kafka.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-msk--examples"></a>

### Penyiapan lengkap dengan peran IAM
<a name="sam-property-function-msk-example-complete"></a>

Contoh berikut menunjukkan penyiapan lengkap termasuk konfigurasi peran IAM yang diperlukan untuk menggunakan Schema Registry:

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String
  MskClusterName4:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaClusterPermissions
        PolicyDocument:
          Statement:
          - Action: [kafka:DescribeClusterV2, kafka:GetBootstrapBrokers]
            Effect: Allow
            Resource: 'arn:aws:kafka:us-east-1:123456789012:cluster/*'
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyMskCluster:
    Type: AWS::MSK::Cluster
    Properties:
      BrokerNodeGroupInfo:
        ClientSubnets:
        - Ref: PreCreatedSubnetOne
        - Ref: PreCreatedSubnetTwo
        InstanceType: kafka.t3.small
        StorageInfo:
          EBSStorageInfo:
            VolumeSize: 1
      ClusterName:
        Ref: MskClusterName4
      KafkaVersion: 3.8.x
      NumberOfBrokerNodes: 2

  MyMskStreamProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        MyMskEvent:
          Type: MSK
          Properties:
            StartingPosition: LATEST
            Stream:
              Ref: MyMskCluster
            SourceAccessConfigurations:
            - Type: SASL_SCRAM_512_AUTH
              URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            Topics:
            - SchemaRegistryTestTopic
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig contoh
<a name="sam-property-function-msk-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Contoh Amazon MSK untuk Klaster yang ada
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster"></a>

Berikut ini adalah contoh jenis sumber `MSK` peristiwa untuk kluster MSK Amazon yang sudah ada di file Akun AWS.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2
      Topics:
        - MyTopic
```

### Amazon MSK contoh untuk Klaster yang dinyatakan dalam Templat yang sama
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template"></a>

Berikut ini adalah contoh tipe sumber peristiwa `MSK` untuk klaster Amazon MSK yang dinyatakan dalam file templat yang sama.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster   # This must be the name of an MSK cluster declared in the same template file
      Topics:
        - MyTopic
```

#### Sumber Acara MSK dengan Registri Skema
<a name="sam-property-function-msk-example-schemaregistry"></a>

Berikut ini adalah contoh dari jenis sumber `MSK` peristiwa dikonfigurasi dengan registri skema.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

#### Sumber Acara MSK dengan Registri Skema Konfluen
<a name="sam-property-function-msk-example-schemaregistry-confluent"></a>

Berikut ini adalah contoh dari jenis sumber `MSK` peristiwa dikonfigurasi dengan Confluent Schema Registry.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

# S3
<a name="sam-property-function-s3"></a>

Objek yang menggambarkan tipe sumber peristiwa `S3`.

## Sintaksis
<a name="sam-property-function-s3-syntax"></a>

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

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

```
  [Bucket](#sam-function-s3-bucket): String
  [Events](#sam-function-s3-events): String | List
  [Filter](#sam-function-s3-filter): [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)
```

## Sifat-sifat
<a name="sam-property-function-s3-properties"></a>

 `Bucket`   <a name="sam-function-s3-bucket"></a>
Nama bucket S3. Bucket ini harus ada dalam templat yang sama.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BucketName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name)` properti `AWS::S3::Bucket` sumber daya. Ini adalah bidang yang diperlukan dalam SAM. Bidang ini hanya menerima referensi ke bucket S3 yang dibuat dalam templat ini

 `Events`   <a name="sam-function-s3-events"></a>
Peristiwa bucket Amazon S3 yang akan dipanggilkan fungsi Lambda. Lihat [Tipe peristiwa yang didukung Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types) untuk daftar nilai yang valid.  
*Tipe*: String \$1 Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Event](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event)` properti tipe `AWS::S3::Bucket` `LambdaConfiguration` data.

 `Filter`   <a name="sam-function-s3-filter"></a>
Aturan pemfilteran yang menentukan objek Amazon S3 yang memanggil fungsi Lambda. Untuk informasi tentang pemfilteran nama kunci Amazon S3, lihat Mengonfigurasi [Pemberitahuan Acara Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) di Panduan Pengguna Layanan Penyimpanan Sederhana *Amazon*.  
*Jenis*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)` properti tipe `AWS::S3::Bucket` `LambdaConfiguration` data.

## Contoh
<a name="sam-property-function-s3--examples"></a>

### S3-Event
<a name="sam-property-function-s3--examples--s3-event"></a>

Contoh peristiwa S3.

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

```
Events:
  S3Event:
    Type: S3
    Properties:
      Bucket:
        Ref: ImagesBucket     # This must be the name of an S3 bucket declared in the same template file
      Events: s3:ObjectCreated:*
      Filter:
        S3Key:
          Rules:
          - Name: prefix      # or "suffix"
            Value: value      # The value to search for in the S3 object key names
```

# Schedule
<a name="sam-property-function-schedule"></a>

Objek yang menjelaskan jenis sumber `Schedule` peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target EventBridge aturan Amazon yang dipicu pada jadwal. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) di *Panduan EventBridge Pengguna Amazon*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)sumber daya saat jenis acara ini disetel.

**catatan**  
EventBridge sekarang menawarkan kemampuan penjadwalan baru, [Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html). Amazon EventBridge Scheduler adalah penjadwal tanpa server yang memungkinkan Anda membuat, menjalankan, dan mengelola tugas dari satu layanan terpusat dan terkelola. EventBridge Schedulersangat dapat disesuaikan, dan menawarkan skalabilitas yang ditingkatkan dibandingkan aturan EventBridge terjadwal, dengan serangkaian operasi API target yang lebih luas dan. Layanan AWS  
Kami merekomendasikan Anda menggunakan EventBridge Scheduler untuk menginvokasi target sesuai jadwal. Untuk menentukan jenis sumber acara ini di AWS SAM templat Anda, lihat[ScheduleV2](sam-property-function-schedulev2.md).

## Sintaksis
<a name="sam-property-function-schedule-syntax"></a>

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

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

```
  [DeadLetterConfig](#sam-function-schedule-deadletterconfig): DeadLetterConfig
  [Description](#sam-function-schedule-description): String
  [Enabled](#sam-function-schedule-enabled): Boolean
  [Input](#sam-function-schedule-input): String
  [Name](#sam-function-schedule-name): String
  [RetryPolicy](#sam-function-schedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  [Schedule](#sam-function-schedule-schedule): String
  [State](#sam-function-schedule-state): String
```

## Sifat-sifat
<a name="sam-property-function-schedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedule-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa`DeadLetterQueue`, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Jenis*: [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` properti tipe `AWS::Events::Rule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `Description`   <a name="sam-function-schedule-description"></a>
Deskripsi aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` properti `AWS::Events::Rule` sumber daya.

 `Enabled`   <a name="sam-function-schedule-enabled"></a>
Menunjukkan apakah aturan diaktifkan.  
Untuk menonaktifkan aturan, tetapkan properti ini ke `false`.  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya. Jika properti ini diatur untuk `true` kemudian AWS SAM lolos`ENABLED`, jika tidak maka akan lewat`DISABLED`.

 `Input`   <a name="sam-function-schedule-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `Name`   <a name="sam-function-schedule-name"></a>
Nama aturan . Jika Anda tidak menentukan nama, CloudFormation buat ID fisik unik dan gunakan ID tersebut untuk nama aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` properti `AWS::Events::Rule` sumber daya.

 `RetryPolicy`   <a name="sam-function-schedule-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` properti tipe `AWS::Events::Rule` `Target` data.

 `Schedule`   <a name="sam-function-schedule-schedule"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering aturan dijalankan. Untuk informasi lebih lanjut, lihat [Ekspresi Jadwal untuk Aturan](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` properti `AWS::Events::Rule` sumber daya.

 `State`   <a name="sam-function-schedule-state"></a>
Keadaan aturan.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya.

## Contoh
<a name="sam-property-function-schedule--examples"></a>

### CloudWatch Jadwal Acara
<a name="sam-property-function-schedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Jadwal Contoh Acara

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

```
CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false
```

# DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Permintaan dapat gagal, misalnya, ketika mengirim peristiwa ke fungsi Lambda yang tidak ada, atau izin tidak cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *

**catatan**  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa, `DeadLetterQueue` yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *

## Sintaksis
<a name="sam-property-function-scheduledeadletterconfig-syntax"></a>

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

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

```
  [Arn](#sam-function-scheduledeadletterconfig-arn): String
  [QueueLogicalId](#sam-function-scheduledeadletterconfig-queuelogicalid): String
  [Type](#sam-function-scheduledeadletterconfig-type): String
```

## Sifat-sifat
<a name="sam-property-function-scheduledeadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-scheduledeadletterconfig-arn"></a>
Amazon Resource Name (ARN) dari antrean Amazon SQS yang ditetapkan sebagai target antrean surat mati.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` properti tipe `AWS::Events::Rule` `DeadLetterConfig` data.

 `QueueLogicalId`   <a name="sam-function-scheduledeadletterconfig-queuelogicalid"></a>
Nama kustom antrian huruf mati yang AWS SAM menciptakan if `Type` ditentukan.  
Jika `Type` properti tidak disetel, properti ini diabaikan.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-function-scheduledeadletterconfig-type"></a>
Tipe antrean. Ketika properti ini disetel, AWS SAM secara otomatis membuat [antrean huruf mati dan melampirkan kebijakan berbasis sumber daya yang diperlukan untuk memberikan izin untuk mengatur sumber daya](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) untuk mengirim peristiwa ke antrian.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Nilai yang valid*: `SQS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-scheduledeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

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

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# ScheduleV2
<a name="sam-property-function-schedulev2"></a>

Objek yang menjelaskan jenis sumber `ScheduleV2` peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target peristiwa Amazon EventBridge Scheduler yang dipicu pada jadwal. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge Scheduler?](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html) di *Panduan Pengguna EventBridge Penjadwal*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html)sumber daya saat jenis acara ini disetel.

## Sintaksis
<a name="sam-property-function-schedulev2-syntax"></a>

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

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

```
[DeadLetterConfig](#sam-function-schedulev2-deadletterconfig): DeadLetterConfig
[Description](#sam-function-schedulev2-description): String
[EndDate](#sam-function-schedulev2-enddate): String
[FlexibleTimeWindow](#sam-function-schedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-function-schedulev2-groupname): String
[Input](#sam-function-schedulev2-input): String
[KmsKeyArn](#sam-function-schedulev2-kmskeyarn): String
[Name](#sam-function-schedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-function-schedulev2-permissionsboundary): String
[RetryPolicy](#sam-function-schedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-function-schedulev2-rolearn): String
[ScheduleExpression](#sam-function-schedulev2-schedule): String
[ScheduleExpressionTimezone](#sam-function-schedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-function-schedulev2-startdate): String
[State](#sam-function-schedulev2-state): String
```

## Sifat-sifat
<a name="sam-property-function-schedulev2-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedulev2-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Mengonfigurasi antrian huruf mati untuk EventBridge Penjadwal di Panduan Pengguna Penjadwal](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html). EventBridge *  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa`DeadLetterQueue`, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Jenis*: [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)` properti tipe `AWS::Scheduler::Schedule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `Description`   <a name="sam-function-schedulev2-description"></a>
Deskripsi jadwal.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)` properti `AWS::Scheduler::Schedule` sumber daya.

 `EndDate`   <a name="sam-function-schedulev2-enddate"></a>
Tanggal, di UTC, sebelum jadwal dapat memanggil targetnya. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin berhenti, atau sebelum, yang Anda tentukan**EndDate**.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` properti `AWS::Scheduler::Schedule` sumber daya.

 `FlexibleTimeWindow`   <a name="sam-function-schedulev2-flexibletimewindow"></a>
Mengizinkan konfigurasi jendela di mana jadwal dapat dipanggil.  
*Jenis*: [FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)` properti `AWS::Scheduler::Schedule` sumber daya.

 `GroupName`   <a name="sam-function-schedulev2-groupname"></a>
Nama grup jadwal untuk dikaitkan dengan jadwal ini. Jika tidak ditentukan, grup default digunakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` properti `AWS::Scheduler::Schedule` sumber daya.

 `Input`   <a name="sam-function-schedulev2-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` properti `AWS::Scheduler::Schedule Target` sumber daya.

 `KmsKeyArn`   <a name="sam-function-schedulev2-kmskeyarn"></a>
ARN untuk Kunci KMS yang akan digunakan untuk mengenkripsi data pelanggan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` properti `AWS::Scheduler::Schedule` sumber daya.

 `Name`   <a name="sam-function-schedulev2-name"></a>
Nama jadwal. Jika Anda tidak menentukan nama, AWS SAM buat nama dalam format `Function-Logical-IDEvent-Source-Name` dan gunakan ID tersebut untuk nama jadwal.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` properti `AWS::Scheduler::Schedule` sumber daya.

`OmitName`  <a name="sam-function-schedulev2-omitname"></a>
Secara default, AWS SAM menghasilkan dan menggunakan nama jadwal dalam format*<Function-logical-ID><event-source-name>*. Tetapkan properti ini `true` agar CloudFormation menghasilkan ID fisik yang unik dan gunakan itu untuk nama jadwal sebagai gantinya.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PermissionsBoundary`   <a name="sam-function-schedulev2-permissionsboundary"></a>
ARN kebijakan yang digunakan untuk mengatur batas izin untuk peran.  
Jika `PermissionsBoundary` didefinisikan, AWS SAM akan menerapkan batasan yang sama untuk peran IAM target jadwal penjadwal.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` properti `AWS::IAM::Role` sumber daya.

 `RetryPolicy`   <a name="sam-function-schedulev2-retrypolicy"></a>
Objek **RetryPolicy** yang menyertakan informasi tentang pengaturan kebijakan coba lagi.  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `RoleArn`   <a name="sam-function-schedulev2-rolearn"></a>
ARN dari peran IAM yang akan digunakan EventBridge Scheduler untuk target saat jadwal dipanggil.  
*Jenis*: [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `ScheduleExpression`   <a name="sam-function-schedulev2-scheduleexpression"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering acara jadwal penjadwal berjalan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` properti `AWS::Scheduler::Schedule` sumber daya.

 `ScheduleExpressionTimezone`   <a name="sam-function-schedulev2-scheduleexpressiontimezone"></a>
Zona waktu di mana ekspresi penjadwalan dievaluasi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` properti `AWS::Scheduler::Schedule` sumber daya.

 `StartDate`   <a name="sam-function-schedulev2-startdate"></a>
Tanggal, di UTC, setelah itu jadwal dapat mulai memanggil target. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin terjadi pada, atau setelah, yang Anda tentukan**StartDate**.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` properti `AWS::Scheduler::Schedule` sumber daya.

 `State`   <a name="sam-function-schedulev2-state"></a>
Keadaan jadwal Scheduler.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)` properti `AWS::Scheduler::Schedule` sumber daya.

## Contoh
<a name="sam-property-function-schedulev2--examples"></a>

### Contoh dasar mendefinisikan sumber daya ScheduleV2
<a name="sam-property-function-schedulev2--examples--example1"></a>

```
Resources:
  Function:
    Properties:
      ...
      Events:
        ScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: "rate(1 minute)"
        ComplexScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: rate(1 minute)
            FlexibleTimeWindow:
              Mode: FLEXIBLE
              MaximumWindowInMinutes: 5
            StartDate: '2022-12-28T12:00:00.000Z'
            EndDate: '2023-01-28T12:00:00.000Z'
            ScheduleExpressionTimezone: UTC
            RetryPolicy:
              MaximumRetryAttempts: 5
              MaximumEventAgeInSeconds: 300
            DeadLetterConfig:
              Type: SQS
```

**catatan**  
ID fisik yang dihasilkan dari ScheduleV2 tidak menyertakan nama tumpukan.

# SelfManagedKafka
<a name="sam-property-function-selfmanagedkafka"></a>

Objek yang menggambarkan tipe sumber peristiwa `SelfManagedKafka`. *Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Apache Kafka yang dikelola sendiri di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html) Pengembang.AWS Lambda *

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)sumber daya saat jenis acara ini disetel.

Untuk menggunakan Schema Registry, Anda perlu menentukan izin peran IAM tertentu untuk fungsi Anda. Lihat [Penyiapan lengkap dengan peran IAM](sam-property-function-msk.md#sam-property-function-msk-example-complete) untuk contoh konfigurasi yang diperlukan.

## Sintaksis
<a name="sam-property-function-selfmanagedkafka-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

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

```
  [BatchSize](#sam-function-selfmanagedkafka-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-selfmanagedkafka-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-selfmanagedkafka-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-selfmanagedkafka-enabled): Boolean
  [FilterCriteria](#sam-function-selfmanagedkafka-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [KafkaBootstrapServers](#sam-function-selfmanagedkafka-kafkabootstrapservers): List
  [FunctionResponseTypes](#sam-function-selfmanagedkafka-functionresponsetypes): List
  KmsKeyArn: String
  [LoggingConfig](#sam-function-selfmanagedkafka-loggingconfig): LoggingConfig
  [MaximumRecordAgeInSeconds](#sam-function-selfmanagedkafka-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-selfmanagedkafka-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-selfmanagedkafka-metricsconfig): MetricsConfig
  [ProvisionedPollerConfig](#sam-function-selfmanagedkafka-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-selfmanagedkafka-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  [SourceAccessConfigurations](#sam-function-selfmanagedkafka-sourceaccessconfigurations): [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  StartingPosition: String
  StartingPositionTimestamp: Double
  [Topics](#sam-function-selfmanagedkafka-topics): List
```

## Sifat-sifat
<a name="sam-property-function-selfmanagedkafka-properties"></a>

 `BatchSize`   <a name="sam-function-selfmanagedkafka-batchsize"></a>
Jumlah maksimum rekaman di setiap batch yang Lambda tarik dari aliran Anda dan dikirim ke fungsi Anda.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-selfmanagedkafka-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ConsumerGroupId`   <a name="sam-function-selfmanagedkafka-consumergroupid"></a>
String yang mengonfigurasi bagaimana acara akan dibaca dari topik Kafka.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-selfmanagedkafka-destinationconfig"></a>
Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.  
Gunakan properti ini untuk menentukan tujuan pemanggilan gagal dari sumber acara Kafka yang dikelola sendiri.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-selfmanagedkafka-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-selfmanagedkafka-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KafkaBootstrapServers`   <a name="sam-function-selfmanagedkafka-kafkabootstrapservers"></a>
Daftar server bootstrap untuk broker Kafka Anda. Sertakan port, misalnya `broker.example.com:xxxx`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionResponseTypes`   <a name="sam-function-selfmanagedkafka-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-selfmanagedkafka-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `LoggingConfig`   <a name="sam-function-selfmanagedkafka-loggingconfig"></a>
Konfigurasi logging untuk sumber acara Anda.  
*Jenis*: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-selfmanagedkafka-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-selfmanagedkafka-metricsconfig"></a>
Konfigurasi metrik untuk sumber acara Anda.  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-selfmanagedkafka-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ProvisionedPollerConfig`   <a name="sam-function-selfmanagedkafka-provisionedpollerconfig"></a>
Konfigurasi untuk meningkatkan jumlah poller yang digunakan untuk menghitung pemetaan sumber peristiwa. Konfigurasi ini memungkinkan minimal 1 poller dan maksimum 2000 poller. Sebagai contoh, lihat [ProvisionedPollerConfig contoh](#sam-property-function-selfmanagedkafka-example-provisionedpollerconfig)  
*Jenis*: [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

`SchemaRegistryConfig`  <a name="sam-function-selfmanagedkafka-schemaregistryconfig"></a>
Konfigurasi untuk menggunakan registri skema dengan sumber acara Kafka yang dikelola sendiri.  
Fitur ini `ProvisionedPollerConfig` perlu dikonfigurasi.
*Jenis*: [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas:* Properti ini diteruskan langsung ke `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SourceAccessConfigurations`   <a name="sam-function-selfmanagedkafka-sourceaccessconfigurations"></a>
Susunan protokol autentikasi, komponen VPC, atau host virtual untuk mengamankan dan menentukan sumber peristiwa Anda.  
*Nilai yang valid*: `BASIC_AUTH | CLIENT_CERTIFICATE_TLS_AUTH | SASL_SCRAM_256_AUTH | SASL_SCRAM_512_AUTH | SERVER_ROOT_CA_CERTIFICATE`  
*Jenis*: Daftar [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration)  
*Wajib*: Ya  
*CloudFormation kompatibilitas:* Properti ini adalah bagian dari `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-selfmanagedkafka-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-selfmanagedkafka-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Topics`   <a name="sam-function-selfmanagedkafka-topics"></a>
Nama topik Kafka.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-selfmanagedkafka--examples"></a>

### Pengaturan lengkap dengan peran IAM
<a name="sam-property-function-selfmanagedkafka-example-complete"></a>

Contoh berikut menunjukkan penyiapan lengkap termasuk konfigurasi peran IAM yang diperlukan untuk menggunakan Schema Registry:

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyKafkaProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        SelfManagedKafkaEvent:
          Type: SelfManagedKafka
          Properties:
            KafkaBootstrapServers:
              - my-kafka-broker-1:9092
              - my-kafka-broker-2:9092
            Topics:
              - SchemaRegistryTestTopic
            StartingPosition: LATEST
            SourceAccessConfigurations:
              - Type: VPC_SUBNET
                URI: subnet:subnet-12345678
              - Type: VPC_SECURITY_GROUP
                URI: security_group:sg-12345678
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig contoh
<a name="sam-property-function-selfmanagedkafka-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Sumber acara Kafka yang dikelola sendiri
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source"></a>

Berikut adalah contoh peristiwa dari tipe sumber peristiwa `SelfManagedKafka`.

#### YAML
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source--yaml"></a>

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      BatchSize: 1000
      Enabled: true
      KafkaBootstrapServers:
        - abc.xyz.com:xxxx
      SourceAccessConfigurations:
        -  Type: BASIC_AUTH
           URI: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
      Topics:
        - MyKafkaTopic
```

### Sumber Acara Kafka yang dikelola sendiri dengan AWS Glue Schema Registry
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry"></a>

Berikut ini adalah contoh dari jenis sumber `SelfManagedKafka` peristiwa dikonfigurasi dengan AWS Glue Schema Registry.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
```

### Sumber Acara Kafka yang dikelola sendiri dengan Registri Skema Konfluen
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry-confluent"></a>

Berikut ini adalah contoh dari jenis sumber `SelfManagedKafka` peristiwa dikonfigurasi dengan Confluent Schema Registry.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
        - Type: BASIC_AUTH
          URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:kafka-secret
```

# SNS
<a name="sam-property-function-sns"></a>

Objek yang menggambarkan tipe sumber peristiwa `SNS`.

SAM menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html)sumber daya saat jenis acara ini disetel

## Sintaksis
<a name="sam-property-function-sns-syntax"></a>

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

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

```
  [FilterPolicy](#sam-function-sns-filterpolicy): [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)
  FilterPolicyScope: String
  RedrivePolicy: Json
  [Region](#sam-function-sns-region): String
  [SqsSubscription](#sam-function-sns-sqssubscription): Boolean | SqsSubscriptionObject
  [Topic](#sam-function-sns-topic): String
```

## Sifat-sifat
<a name="sam-property-function-sns-properties"></a>

 `FilterPolicy`   <a name="sam-function-sns-filterpolicy"></a>
Kebijakan filter JSON yang ditetapkan untuk langganan. Untuk informasi selengkapnya, lihat [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)di Referensi API Layanan Pemberitahuan Sederhana Amazon.  
*Jenis*: [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)` properti `AWS::SNS::Subscription` sumber daya.

 `FilterPolicyScope`   <a name="sam-function-sns-filterpolicyscope"></a>
Atribut ini memungkinkan Anda memilih lingkup penyaringan dengan menggunakan salah satu jenis nilai string berikut:  
+ `MessageAttributes`— Filter diterapkan pada atribut pesan.
+ `MessageBody`— Filter diterapkan pada badan pesan.
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `MessageAttributes`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke ` [ FilterPolicyScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope)` properti `AWS::SNS::Subscription` sumber daya.

 `RedrivePolicy`   <a name="sam-function-sns-redrivepolicy"></a>
Bila ditentukan, kirim pesan yang tidak terkirim ke antrean surat mati Amazon SQS yang ditentukan. Pesan yang tidak dapat dikirim karena kesalahan klien (misalnya, ketika titik akhir berlangganan tidak terjangkau) atau kesalahan server (misalnya, ketika layanan yang mendorong titik akhir langganan menjadi tidak tersedia) diadakan di antrean surat mati untuk analisis lebih lanjut atau pemrosesan ulang.  
*Untuk informasi selengkapnya tentang kebijakan redrive dan antrian surat mati, lihat antrian surat [mati Amazon SQS di Panduan Pengembang Layanan Antrian](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) Sederhana Amazon.*  
*Jenis*: Json  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ RedrivePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy)` properti `AWS::SNS::Subscription` sumber daya.

 `Region`   <a name="sam-function-sns-region"></a>
Untuk langganan lintas region, region tempat topik berada.  
Jika tidak ada wilayah yang ditentukan, CloudFormation gunakan wilayah pemanggil sebagai default.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region)` properti `AWS::SNS::Subscription` sumber daya.

 `SqsSubscription`   <a name="sam-function-sns-sqssubscription"></a>
Atur properti ini menjadi BETUL, atau tentukan `SqsSubscriptionObject` untuk mengaktifkan batching notifikasi topik SNS dalam antrean SQS. Mengatur properti ini menjadi `true` membuat antrean SQS baru, sedangkan menentukan `SqsSubscriptionObject` menggunakan antrean SQS yang ada.  
*Jenis*: Boolean \$1 [SqsSubscriptionObject](sam-property-function-sqssubscriptionobject.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Topic`   <a name="sam-function-sns-topic"></a>
ARN dari topik untuk dilanggan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TopicArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn)` properti `AWS::SNS::Subscription` sumber daya.

## Contoh
<a name="sam-property-function-sns--examples"></a>

### Contoh Sumber Peristiwa SNS
<a name="sam-property-function-sns--examples--sns-event-source-example"></a>

Contoh Sumber Peristiwa SNS

#### YAML
<a name="sam-property-function-sns--examples--sns-event-source-example--yaml"></a>

```
Events:
  SNSEvent:
    Type: SNS
    Properties:
      Topic: arn:aws:sns:us-east-1:123456789012:my_topic
      SqsSubscription: true
      FilterPolicy:
        store:
          - example_corp
        price_usd:
          - numeric:
              - ">="
              - 100
```

# SqsSubscriptionObject
<a name="sam-property-function-sqssubscriptionobject"></a>

Tentukan opsi antrean SQS yang ada untuk peristiwa SNS

## Sintaksis
<a name="sam-property-function-sqssubscriptionobject-syntax"></a>

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

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

```
  [BatchSize](#sam-function-sqssubscriptionobject-batchsize): String
  [Enabled](#sam-function-sqssubscriptionobject-enabled): Boolean
  [QueueArn](#sam-function-sqssubscriptionobject-queuearn): String
  [QueuePolicyLogicalId](#sam-function-sqssubscriptionobject-queuepolicylogicalid): String
  [QueueUrl](#sam-function-sqssubscriptionobject-queueurl): String
```

## Sifat-sifat
<a name="sam-property-function-sqssubscriptionobject-properties"></a>

 `BatchSize`   <a name="sam-function-sqssubscriptionobject-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch untuk antrean SQS.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: 10  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Enabled`   <a name="sam-function-sqssubscriptionobject-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa SQS untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: BETUL  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueueArn`   <a name="sam-function-sqssubscriptionobject-queuearn"></a>
Tentukan arn antrean SQS yang ada.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueuePolicyLogicalId`   <a name="sam-function-sqssubscriptionobject-queuepolicylogicalid"></a>
Berikan nama LogicaLid kustom untuk sumber daya. [AWS::SQS::QueuePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html)  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueueUrl`   <a name="sam-function-sqssubscriptionobject-queueurl"></a>
Tentukan URL antrean yang terkait dengan properti `QueueArn`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-sqssubscriptionobject--examples"></a>

### SQS yang ada untuk peristiwa SNS
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event"></a>

Contoh untuk menambahkan antrean SQS yang ada untuk melanggan topik SNS.

#### YAML
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event--yaml"></a>

```
QueuePolicyLogicalId: CustomQueuePolicyLogicalId
QueueArn:
  Fn::GetAtt: MyCustomQueue.Arn
QueueUrl:
  Ref: MyCustomQueue
BatchSize: 5
```

# SQS
<a name="sam-property-function-sqs"></a>

Objek yang menggambarkan tipe sumber peristiwa `SQS`. Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Amazon SQS di Panduan AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) *Pengembang*.

SAM menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)sumber daya saat jenis acara ini disetel

## Sintaksis
<a name="sam-property-function-sqs-syntax"></a>

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

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

```
  [BatchSize](#sam-function-sqs-batchsize): Integer
  [Enabled](#sam-function-sqs-enabled): Boolean
  [FilterCriteria](#sam-function-sqs-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-sqs-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-sqs-maximumbatchingwindowinseconds): Integer
  [MetricsConfig](#sam-function-sqs-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ProvisionedPollerConfig](#sam-function-sqs-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [Queue](#sam-function-sqs-queue): String
  ScalingConfig: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)
```

## Sifat-sifat
<a name="sam-property-function-sqs-properties"></a>

 `BatchSize`   <a name="sam-function-sqs-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 10  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `Enabled`   <a name="sam-function-sqs-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-sqs-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-sqs-functionresponsetypes"></a>
 Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting) di *Panduan AWS Lambda Pengembang*.   
 *Nilai yang valid*: `ReportBatchItemFailures`   
 *Tipe*: Daftar   
 *Wajib*: Tidak   
 *CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya. 

 `KmsKeyArn`   <a name="sam-function-sqs-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-sqs-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan catatan sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-sqs-metricsconfig"></a>
Konfigurasi keikutsertaan untuk mendapatkan metrik yang disempurnakan untuk pemetaan sumber peristiwa yang menangkap setiap tahap pemrosesan. Sebagai contoh, lihat [MetricsConfig acara](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ProvisionedPollerConfig`   <a name="sam-function-sqs-provisionedpollerconfig"></a>
Konfigurasi untuk meningkatkan jumlah poller yang digunakan untuk menghitung pemetaan sumber peristiwa. Konfigurasi ini memungkinkan minimal 2 poller dan maksimum 2000 poller. Sebagai contoh, lihat[ProvisionedPollerConfig contoh](#sam-property-function-sqs-example-provisionedpollerconfig).  
*Jenis*: [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Queue`   <a name="sam-function-sqs-queue"></a>
ARN antrean.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ScalingConfig`   <a name="sam-function-sqs-scalingconfig"></a>
Konfigurasi penskalaan poller SQS untuk mengontrol laju pemanggilan dan menetapkan pemanggilan bersamaan maksimum.  
*Jenis*: `[ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)`  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-sqs--examples"></a>

### MetricsConfig acara
<a name="sam-property-function-sqs-example-metricsconfigevent"></a>

Berikut ini adalah contoh sumber daya yang menggunakan `MetricsConfig` properti untuk menangkap setiap tahap pemrosesan untuk pemetaan sumber peristiwa mereka.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Acara SQS dasar
<a name="sam-property-function-sqs--examples--sqs-event"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Queue: arn:aws:sqs:us-west-2:012345678901:my-queue
      BatchSize: 10
      Enabled: false
      FilterCriteria:
        Filters:
          - Pattern: '{"key": ["val1", "val2"]}'
```

### Konfigurasikan pelaporan batch sebagian untuk antrian SQS Anda
<a name="sam-property-function-sqs--examples--sqs-partial-batch"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Enabled: true
      FunctionResponseTypes:
        - ReportBatchItemFailures
      Queue: !GetAtt MySqsQueue.Arn
      BatchSize: 10
```

### Fungsi Lambda dengan acara SQS yang telah dikonfigurasi penskalaan
<a name="sam-property-function-sqs--examples--sqs-event-scaling"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MySQSEvent:
        Type: SQS
        Properties:
          ...
          ScalingConfig:
            MaximumConcurrency: 10
```

### ProvisionedPollerConfig contoh
<a name="sam-property-function-sqs-example-provisionedpollerconfig"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    Handler: index.handler
    Runtime: nodejs18.x
    Timeout: 30
    Events:
      SQSEvent:
        Type: SQS
        Properties:
          Queue: !GetAtt MyQueue.Arn
          BatchSize: 10
          Enabled: True
          ProvisionedPollerConfig:
            MaximumPollers: 300
            MinimumPollers: 10
```

# FunctionCode
<a name="sam-property-function-functioncode"></a>

[Paket deployment](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html) untuk fungsi Lambda.

## Sintaksis
<a name="sam-property-function-functioncode-syntax"></a>

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

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

```
  [Bucket](#sam-function-functioncode-bucket): String
  [Key](#sam-function-functioncode-key): String
  [Version](#sam-function-functioncode-version): String
```

## Sifat-sifat
<a name="sam-property-function-functioncode-properties"></a>

 `Bucket`   <a name="sam-function-functioncode-bucket"></a>
Bucket Amazon S3 di AWS Wilayah yang sama dengan fungsi Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket)` properti tipe `AWS::Lambda::Function` `Code` data.

 `Key`   <a name="sam-function-functioncode-key"></a>
Kunci Amazon S3 dari paket deployment.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key)` properti tipe `AWS::Lambda::Function` `Code` data.

 `Version`   <a name="sam-function-functioncode-version"></a>
Untuk objek berversi, versi objek paket deployment yang digunakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion)` properti tipe `AWS::Lambda::Function` `Code` data.

## Contoh
<a name="sam-property-function-functioncode--examples"></a>

### FunctionCode
<a name="sam-property-function-functioncode--examples--functioncode"></a>

`CodeUri`: Contoh Kode Fungsi

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

```
CodeUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# FunctionUrlConfig
<a name="sam-property-function-functionurlconfig"></a>

Membuat URL AWS Lambda fungsi dengan parameter konfigurasi yang ditentukan. URL fungsi Lambda adalah titik akhir HTTPS yang dapat Anda gunakan untuk menjalankan fungsi Anda.

Secara default, URL fungsi yang Anda buat menggunakan `$LATEST` versi fungsi Lambda Anda. Jika Anda menentukan `AutoPublishAlias` untuk fungsi Lambda Anda, titik akhir terhubung ke alias fungsi yang ditentukan.

Untuk informasi selengkapnya, lihat [fungsi Lambda URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) di Panduan *AWS Lambda Pengembang*.

## Sintaksis
<a name="sam-property-function-functionurlconfig-syntax"></a>

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

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

```
[AuthType](#sam-function-functionurlconfig-authtype): String
[Cors](#sam-function-functionurlconfig-cors): [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)
[InvokeMode](#sam-function-functionurlconfig-invokemode): String
```

## Sifat-sifat
<a name="sam-property-function-functionurlconfig-properties"></a>

 `AuthType`   <a name="sam-function-functionurlconfig-authtype"></a>
Jenis otorisasi untuk URL fungsi Anda. Untuk menggunakan AWS Identity and Access Management (IAM) untuk mengotorisasi permintaan, setel ke. `AWS_IAM` Untuk akses terbuka, atur ke`NONE`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AuthType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype)` properti `AWS::Lambda::Url` sumber daya.

 `Cors`   <a name="sam-function-functionurlconfig-cors"></a>
Pengaturan berbagi sumber daya lintas asal (CORS) untuk URL fungsi Anda.  
*Jenis*: [Cor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)` properti `AWS::Lambda::Url` sumber daya.

 `InvokeMode`  <a name="sam-function-functionurlconfig-invokemode"></a>
Mode URL fungsi Anda akan dipanggil. Agar fungsi Anda mengembalikan respons setelah pemanggilan selesai, setel ke. `BUFFERED` Agar fungsi Anda mengalirkan respons, setel ke`RESPONSE_STREAM`. Nilai default-nya adalah `BUFFERED`.  
*Nilai yang valid*: `BUFFERED` atau `RESPONSE_STREAM`  
*Tipe*: String  
*Wajib*: Tidak  
*AWS CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode)properti `AWS::Lambda::Url` sumber daya.

## Contoh
<a name="sam-property-function-functionurlconfig--examples"></a>

### URL fungsi
<a name="sam-property-function-functionurlconfig--examples--function-url"></a>

Contoh berikut membuat fungsi Lambda dengan URL fungsi. URL fungsi menggunakan otorisasi IAM.

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

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    CodeUri: hello_world/
    Handler: index.handler
    Runtime: nodejs20.x
    FunctionUrlConfig:
      AuthType: AWS_IAM
      InvokeMode: RESPONSE_STREAM

Outputs:
  MyFunctionUrlEndpoint:
      Description: "My Lambda Function URL Endpoint"
      Value:
        Fn::GetAtt: HelloWorldFunctionUrl.FunctionUrl
```

# CapacityProviderConfig
<a name="sam-property-function-capacityproviderconfig"></a>

Mengkonfigurasi penyedia kapasitas tempat versi fungsi yang diterbitkan akan dilampirkan. Ini memungkinkan fungsi berjalan pada EC2 instance milik pelanggan yang dikelola oleh Lambda.

**catatan**  
Konfigurasi ini menentukan jenis komputasi fungsi dan perlu ditentukan selama penerapan fungsi pertama. Itu tidak dapat ditambahkan atau dihapus setelah sumber daya fungsi dibuat.

## Sintaksis
<a name="sam-property-function-capacityproviderconfig-syntax"></a>

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

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

```
[Arn](#sam-function-capacityproviderconfig-arn): String
[ExecutionEnvironmentMemoryGiBPerVCpu](#sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu): Float
[PerExecutionEnvironmentMaxConcurrency](#sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency): Integer
```

## Sifat-sifat
<a name="sam-property-function-capacityproviderconfig-properties"></a>

 `Arn`   <a name="sam-function-capacityproviderconfig-arn"></a>
ARN dari penyedia kapasitas untuk digunakan untuk fungsi ini.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik untuk SAM.

 `ExecutionEnvironmentMemoryGiBPerVCpu`   <a name="sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu"></a>
Rasio memori (dalam GiB) ke vCPU untuk setiap lingkungan eksekusi.  
Rasio memori per CPU tidak dapat melebihi memori total fungsi 2048MB. memory-to-CPURasio yang didukung adalah 2GB, 4GB, atau 8GB per CPU.
*Jenis*: Mengapung  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ExecutionEnvironmentMemoryGiBPerVCpu](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` properti `AWS::Lambda::Function` sumber daya.

 `PerExecutionEnvironmentMaxConcurrency`   <a name="sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency"></a>
Jumlah maksimum eksekusi bersamaan per lingkungan eksekusi (sandbox).  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PerExecutionEnvironmentMaxConcurrency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` properti `AWS::Lambda::Function` sumber daya.

## Contoh
<a name="sam-property-function-capacityproviderconfig-examples"></a>

### Konfigurasi penyedia kapasitas
<a name="sam-property-function-capacityproviderconfig-examples-basic"></a>

Contoh berikut menunjukkan konfigurasi penyedia kapasitas yang mereferensikan sumber daya penyedia kapasitas.

```
CapacityProviderConfig:
  Arn: !GetAtt MyCapacityProvider.Arn
  ExecutionEnvironmentMemoryGiBPerVCpu: 4.0
  PerExecutionEnvironmentMaxConcurrency: 100
```

# FunctionScalingConfig
<a name="sam-property-function-functionscalingconfig"></a>

Mengonfigurasi perilaku penskalaan untuk versi fungsi Lambda, mengontrol jumlah lingkungan eksekusi (kotak pasir) yang dapat dibuat. Konfigurasi ini berlaku untuk versi fungsi \$1LATEST.PUBLISED dan numerik.

## Sintaksis
<a name="sam-property-function-functionscalingconfig-syntax"></a>

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

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

```
[MinExecutionEnvironments](#sam-function-functionscalingconfig-minexecutionenvironments): Integer
[MaxExecutionEnvironments](#sam-function-functionscalingconfig-maxexecutionenvironments): Integer
```

## Sifat-sifat
<a name="sam-property-function-functionscalingconfig-properties"></a>

 `MinExecutionEnvironments`   <a name="sam-function-functionscalingconfig-minexecutionenvironments"></a>
Jumlah minimum lingkungan eksekusi yang harus dipertahankan untuk versi fungsi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: `3`  
*Minimal*: `0`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MinExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-minexecutionenvironments)` properti `AWS::Lambda::Function` sumber daya.

 `MaxExecutionEnvironments`   <a name="sam-function-functionscalingconfig-maxexecutionenvironments"></a>
Jumlah maksimum lingkungan eksekusi yang dapat dibuat untuk versi fungsi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: `3`  
*Minimal*: `0`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaxExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-maxexecutionenvironments)` properti `AWS::Lambda::Function` sumber daya.

## Contoh
<a name="sam-property-function-functionscalingconfig-examples"></a>

### Konfigurasi penskalaan fungsi
<a name="sam-property-function-functionscalingconfig-examples-basic"></a>

Contoh berikut menunjukkan konfigurasi penskalaan fungsi dengan lingkungan eksekusi minimum dan maksimum.

```
FunctionScalingConfig:
  MinExecutionEnvironments: 5
  MaxExecutionEnvironments: 100
```

# AWS::Serverless::GraphQLApi
<a name="sam-resource-graphqlapi"></a>

Gunakan tipe `AWS::Serverless::GraphQLApi` sumber daya AWS Serverless Application Model (AWS SAM) untuk membuat dan mengonfigurasi AWS AppSync GraphQL API untuk aplikasi tanpa server Anda.

Untuk mempelajari lebih lanjut tentang AWS AppSync, lihat [Apa itu AWS AppSync?](https://docs.aws.amazon.com/appsync/latest/devguide/what-is-appsync.html) di *Panduan AWS AppSync Pengembang*.

## Sintaksis
<a name="sam-resource-graphqlapi-syntax"></a>

### YAML
<a name="sam-resource-graphqlapi-syntax-yaml"></a>

```
LogicalId:
  Type: AWS::Serverless::GraphQLApi
  Properties:
    ApiKeys: ApiKeys
    Auth: Auth
    Cache: [AWS::AppSync::ApiCache](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html)
    DataSources: DataSource
    DomainName: [AWS::AppSync::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)
    Functions: Function
    Logging: [LogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html)
    Name: String
    Resolvers: Resolver
    SchemaInline: String
    SchemaUri: String
    Tags:
    - [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
    XrayEnabled: Boolean
```

## Sifat-sifat
<a name="sam-resource-graphqlapi-properties"></a>

`ApiKeys`  <a name="sam-graphqlapi-apikeys"></a>
Buat kunci unik yang dapat digunakan untuk melakukan GraphQL operasi yang membutuhkan kunci API.  
*Jenis*: [ApiKeys](sam-property-graphqlapi-apikeys.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Auth`  <a name="sam-graphqlapi-auth"></a>
Konfigurasikan autentikasi untuk GraphQL API Anda.  
*Jenis*: [Auth](sam-property-graphqlapi-auth.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Cache`  <a name="sam-graphqlapi-cache"></a>
Input dari suatu `CreateApiCache` operasi.  
*Jenis*: [AWS::AppSync::ApiCache](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [AWS::AppSync::ApiCache](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html)sumber daya.

`DataSources`  <a name="sam-graphqlapi-datasources"></a>
Buat sumber data untuk fungsi AWS AppSync yang terhubung ke. AWS SAM mendukung Amazon DynamoDB AWS Lambda dan sumber data.  
*Jenis*: [DataSource](sam-property-graphqlapi-datasource.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`DomainName`  <a name="sam-graphqlapi-domainname"></a>
Nama domain khusus untuk GraphQL API Anda.  
*Jenis*: [AWS::AppSync::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [AWS::AppSync::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)sumber daya. AWS SAM secara otomatis menghasilkan [AWS::AppSync::DomainNameApiAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainnameapiassociation.html)sumber daya.

`Functions`  <a name="sam-graphqlapi-functions"></a>
Konfigurasikan fungsi GraphQL APIs untuk melakukan operasi tertentu.  
*Jenis*: [Fungsi](sam-property-graphqlapi-function.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Logging`  <a name="sam-graphqlapi-logging"></a>
Mengonfigurasi CloudWatch pencatatan Amazon untuk GraphQL API Anda.  
Jika Anda tidak menentukan properti ini, AWS SAM akan menghasilkan `CloudWatchLogsRoleArn` dan menetapkan nilai-nilai berikut:  
+ `ExcludeVerboseContent: true`
+ `FieldLogLevel: ALL`
Untuk memilih keluar dari logging, tentukan yang berikut ini:  

```
Logging: false
```
*Jenis*: [LogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`LogicalId`  <a name="sam-graphqlapi-logicalid"></a>
Nama unik GraphQL API Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`Name`  <a name="sam-graphqlapi-name"></a>
Nama GraphQL API Anda. Tentukan properti ini untuk mengganti `LogicalId` nilainya.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`Resolvers`  <a name="sam-graphqlapi-resolvers"></a>
Konfigurasikan resolver untuk bidang API AndaGraphQL. AWS SAM mendukung [resolver JavaScript pipa](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-reference-overview-js.html#anatomy-of-a-pipeline-resolver-js).  
*Jenis*: [Resolver](sam-property-graphqlapi-resolver.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`SchemaInline`  <a name="sam-graphqlapi-schemainline"></a>
Representasi teks dari GraphQL skema dalam SDL format.  
*Tipe*: String  
*Diperlukan*: Bersyarat. Anda harus menentukan `SchemaInline` atau `SchemaUri`.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition)` properti `AWS::AppSync::GraphQLSchema` sumber daya.

`SchemaUri`  <a name="sam-graphqlapi-schemauri"></a>
URI bucket Amazon Simple Storage Service (Amazon S3) skema atau path ke folder lokal.  
Jika Anda menentukan jalur ke folder lokal, CloudFormation mengharuskan file tersebut diunggah terlebih dahulu ke Amazon S3 sebelum penerapan. Anda dapat menggunakan AWS SAMCLI untuk memfasilitasi proses ini. Untuk informasi selengkapnya, lihat [Cara AWS SAM mengunggah file lokal saat penerapan](deploy-upload-local-files.md).  
*Tipe*: String  
*Diperlukan*: Bersyarat. Anda harus menentukan `SchemaInline` atau `SchemaUri`.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DefinitionS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location)` properti `AWS::AppSync::GraphQLSchema` sumber daya.

`Tags`  <a name="sam-graphqlapi-tags"></a>
Tag (pasangan nilai kunci) untuk API iniGraphQL. Gunakan tag untuk mengidentifikasi dan mengkategorikan sumber daya.  
*Jenis:* Daftar [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-tags)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`XrayEnabled`  <a name="sam-graphqlapi-xrayenabled"></a>
Tunjukkan apakah akan menggunakan [penelusuran AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html) untuk sumber daya ini.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[XrayEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled)` properti `AWS::AppSync::GraphQLApi` sumber daya.

## Nilai Pengembalian
<a name="sam-resource-graphqlapi-return-values"></a>

Untuk daftar nilai yang dikembalikan, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#aws-resource-appsync-graphqlapi-return-values.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#aws-resource-appsync-graphqlapi-return-values.html)di [Panduan CloudFormation Pengguna](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

## Contoh
<a name="sam-resource-graphqlapi-examples"></a>

### GraphQL APIdengan sumber data DynamoDB
<a name="sam-resource-graphqlapi-examples-example1"></a>

Dalam contoh ini, kita membuat GraphQL API yang menggunakan tabel DynamoDB sebagai sumber data.

**schema.graphql**

```
schema {
  query: Query
  mutation: Mutation
}

type Query {
  getPost(id: String!): Post
}

type Mutation {
  addPost(author: String!, title: String!, content: String!): Post!
}

type Post {
  id: String!
  author: String
  title: String
  content: String
  ups: Int!
  downs: Int!
  version: Int!
}
```

**template.yaml**

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  DynamoDBPostsTable:
    Type: AWS::Serverless::SimpleTable

  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      SchemaUri: ./sam_graphql_api/schema.graphql
      Auth:
        Type: AWS_IAM
      DataSources:
        DynamoDb:
          PostsDataSource:
            TableName: !Ref DynamoDBPostsTable
            TableArn: !GetAtt DynamoDBPostsTable.Arn
      Functions:
        preprocessPostItem:
          Runtime:
            Name: APPSYNC_JS
            Version: 1.0.0
          DataSource: NONE
          CodeUri: ./sam_graphql_api/preprocessPostItem.js
        createPostItem:
          Runtime:
            Name: APPSYNC_JS
            Version: "1.0.0"
          DataSource: PostsDataSource
          CodeUri: ./sam_graphql_api/createPostItem.js
        getPostFromTable:
          Runtime:
            Name: APPSYNC_JS
            Version: "1.0.0"
          DataSource: PostsDataSource
          CodeUri: ./sam_graphql_api/getPostFromTable.js
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: "1.0.0"
            Pipeline:
            - preprocessPostItem
            - createPostItem
        Query:
          getPost:
            CodeUri: ./sam_graphql_api/getPost.js
            Runtime:
              Name: APPSYNC_JS
              Version: "1.0.0"
            Pipeline:
            - getPostFromTable
```

**createPostItem.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const { key, values } = ctx.prev.result;
  return {
    operation: "PutItem",
    key: util.dynamodb.toMapValues(key),
    attributeValues: util.dynamodb.toMapValues(values),
  };
}

export function response(ctx) {
  return ctx.result;
}
```

**getPostFromTable.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  return dynamoDBGetItemRequest({ id: ctx.args.id });
}

export function response(ctx) {
  return ctx.result;
}

/**
 * A helper function to get a DynamoDB item
 */
function dynamoDBGetItemRequest(key) {
  return {
    operation: "GetItem",
    key: util.dynamodb.toMapValues(key),
  };
}
```

**preprocessPostItem.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const id = util.autoId();
  const { ...values } = ctx.args;
  values.ups = 1;
  values.downs = 0;
  values.version = 1;
  return { payload: { key: { id }, values: values } };
}

export function response(ctx) {
  return ctx.result;
}
```

Berikut adalah kode resolver kami:

**getPost.js**

```
export function request(ctx) {
  return {};
}

export function response(ctx) {
  return ctx.prev.result;
}
```

### GraphQLAPI dengan fungsi Lambda sebagai sumber data
<a name="sam-resource-graphqlapi-examples-example2"></a>

Dalam contoh ini, kita membuat GraphQL API yang menggunakan fungsi Lambda sebagai sumber data.

**template.yaml**

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyLambdaFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: index.handler
      Runtime: nodejs20.x
      CodeUri: ./lambda

  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Name: MyApi
      SchemaUri: ./gql/schema.gql
      Auth:
        Type: API_KEY
      ApiKeys:
        MyApiKey:
          Description: my api key
      DataSources:
        Lambda:
          MyLambdaDataSource:
            FunctionArn: !GetAtt MyLambdaFunction.Arn
      Functions:
        lambdaInvoker:
          Runtime:
            Name: APPSYNC_JS
            Version: 1.0.0
          DataSource: MyLambdaDataSource
          CodeUri: ./gql/invoker.js
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - lambdaInvoker
        Query:
          getPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - lambdaInvoker

Outputs:
  MyGraphQLAPI:
    Description: AppSync API
    Value: !GetAtt MyGraphQLAPI.GraphQLUrl
  MyGraphQLAPIMyApiKey:
    Description: API Key for authentication
    Value: !GetAtt MyGraphQLAPIMyApiKey.ApiKey
```

**schema.graphql**

```
schema {
  query: Query
  mutation: Mutation
}
type Query {
  getPost(id: ID!): Post
}
type Mutation {
  addPost(id: ID!, author: String!, title: String, content: String): Post!
}
type Post {
  id: ID!
  author: String!
  title: String
  content: String
  ups: Int
  downs: Int
}
```

Berikut adalah fungsi kami:

**lambda/index.js**

```
exports.handler = async (event) => {
  console.log("Received event {}", JSON.stringify(event, 3));

  const posts = {
    1: {
      id: "1",
      title: "First book",
      author: "Author1",
      content: "Book 1 has this content",
      ups: "100",
      downs: "10",
    },
  };

  console.log("Got an Invoke Request.");
  let result;
  switch (event.field) {
    case "getPost":
      return posts[event.arguments.id];
    case "addPost":
      // return the arguments back
      return event.arguments;
    default:
      throw new Error("Unknown field, unable to resolve " + event.field);
  }
};
```

**invoker.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const { source, args } = ctx;
  return {
    operation: "Invoke",
    payload: { field: ctx.info.fieldName, arguments: args, source },
  };
}

export function response(ctx) {
  return ctx.result;
}
```

# ApiKeys
<a name="sam-property-graphqlapi-apikeys"></a>

Buat kunci unik yang dapat digunakan untuk melakukan GraphQL operasi yang membutuhkan kunci API.

## Sintaksis
<a name="sam-property-graphqlapi-apikeys-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-apikeys-syntax-yaml"></a>

```
LogicalId:
  ApiKeyId: String
  Description: String
  ExpiresOn: Double
```

## Sifat-sifat
<a name="sam-property-graphqlapi-apikeys-properties"></a>

`ApiKeyId`  <a name="sam-graphqlapi-apikeys-apikeyid"></a>
Nama unik kunci API Anda. Tentukan untuk mengganti `LogicalId` nilainya.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ApiKeyId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid)` properti `AWS::AppSync::ApiKey` sumber daya.

`Description`  <a name="sam-graphqlapi-apikeys-description"></a>
Deskripsi kunci API Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description)` properti `AWS::AppSync::ApiKey` sumber daya.

`ExpiresOn`  <a name="sam-graphqlapi-apikeys-expireson"></a>
Waktu setelah kunci API berakhir. Tanggal direpresentasikan sebagai detik sejak jangka waktu, dibulatkan ke bawah ke waktu jam terdekat.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Expires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires)` properti `AWS::AppSync::ApiKey` sumber daya.

`LogicalId`  <a name="sam-graphqlapi-apikeys-logicalid"></a>
Nama unik kunci API Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ApiKeyId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid)` properti `AWS::AppSync::ApiKey` sumber daya.

# Auth
<a name="sam-property-graphqlapi-auth"></a>

Konfigurasikan otorisasi untuk GraphQL API Anda.

## Sintaksis
<a name="sam-property-graphqlapi-auth-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-auth-syntax-yaml"></a>

```
Additional:
- AuthProvider
LambdaAuthorizer: [LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)
OpenIDConnect: [OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)
Type: String
UserPool: [UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)
```

## Sifat-sifat
<a name="sam-property-graphqlapi-auth-properties"></a>

`Additional`  <a name="sam-graphqlapi-auth-additional"></a>
Daftar jenis otorisasi tambahan untuk GraphQL API Anda.  
*Jenis*: Daftar [AuthProvider](sam-property-graphqlapi-auth-authprovider.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`LambdaAuthorizer`  <a name="sam-graphqlapi-auth-lambdaauthorizer"></a>
Tentukan konfigurasi otorisasi opsional untuk otorisasi fungsi Lambda Anda. Anda dapat mengkonfigurasi properti opsional ini ketika `Type` ditentukan sebagai`AWS_LAMBDA`.  
*Jenis*: [LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`OpenIDConnect`  <a name="sam-graphqlapi-auth-openidconnect"></a>
Tentukan konfigurasi otorisasi opsional untuk layanan yang OpenID Connect sesuai. Anda dapat mengkonfigurasi properti opsional ini ketika `Type` ditentukan sebagai`OPENID_CONNECT`.  
*Jenis*: [Buka IDConnect Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`Type`  <a name="sam-graphqlapi-auth-type"></a>
Jenis otorisasi default antara aplikasi dan AWS AppSync GraphQL API Anda.  
Untuk daftar dan deskripsi nilai yang diizinkan, lihat [Otorisasi dan otentikasi di Panduan AWS AppSync](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) *Pengembang*.  
Saat Anda menentukan Lambda authorizer (`AWS_LAMBDA`), AWS SAM buat kebijakan AWS Identity and Access Management (IAM) untuk menyediakan izin antara API GraphQL dan fungsi Lambda Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AuthenticationType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype)` properti `AWS::AppSync::GraphQLApi` sumber daya.

`UserPool`  <a name="sam-graphqlapi-auth-userpool"></a>
Tentukan konfigurasi otorisasi opsional untuk menggunakan kumpulan pengguna Amazon Cognito. Anda dapat mengkonfigurasi properti opsional ini ketika `Type` ditentukan sebagai`AMAZON_COGNITO_USER_POOLS`.  
*Jenis*: [UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)` properti `AWS::AppSync::GraphQLApi` sumber daya.

## Contoh
<a name="sam-property-graphqlapi-auth-examples"></a>

### Konfigurasikan jenis otorisasi default dan tambahan
<a name="sam-property-graphqlapi-auth-examples-example1"></a>

Dalam contoh ini, kita mulai dengan mengonfigurasi otorisasi Lambda sebagai jenis otorisasi default untuk API kita. GraphQL

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello
```

Selanjutnya, kami mengonfigurasi jenis otorisasi tambahan untuk GraphQL API kami dengan menambahkan yang berikut ke AWS SAM template kami:

```
        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod
```

Ini menghasilkan AWS SAM template berikut:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello
        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod
```

# AuthProvider
<a name="sam-property-graphqlapi-auth-authprovider"></a>

Konfigurasi otorisasi opsional untuk jenis otorisasi GraphQL API tambahan Anda.

## Sintaksis
<a name="sam-property-graphqlapi-auth-authprovider-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-auth-authprovider-syntax-yaml"></a>

```
LambdaAuthorizer: [LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)
OpenIDConnect: [OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)
Type: String
UserPool: [UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)
```

## Sifat-sifat
<a name="sam-property-graphqlapi-auth-authprovider-properties"></a>

`LambdaAuthorizer`  <a name="sam-graphqlapi-auth-authprovider-lambdaauthorizer"></a>
Tentukan konfigurasi otorisasi opsional untuk otorisasi AWS Lambda fungsi Anda. Anda dapat mengkonfigurasi properti opsional ini ketika `Type` ditentukan sebagai`AWS_LAMBDA`.  
*Jenis*: [ LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)` properti `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` objek.

`OpenIDConnect`  <a name="sam-graphqlapi-auth-authprovider-openidconnect"></a>
Tentukan konfigurasi otorisasi opsional untuk layanan yang OpenID Connect sesuai. Anda dapat mengkonfigurasi properti opsional ini ketika `Type` ditentukan sebagai`OPENID_CONNECT`.  
*Jenis*: [Buka IDConnect Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)` properti `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` objek.

`Type`  <a name="sam-graphqlapi-auth-authprovider-type"></a>
Jenis otorisasi default antara aplikasi dan AWS AppSync GraphQL API Anda.  
Untuk daftar dan deskripsi nilai yang diizinkan, lihat [Otorisasi dan otentikasi di Panduan AWS AppSync](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) *Pengembang*.  
Saat Anda menentukan Lambda authorizer (`AWS_LAMBDA`), AWS SAM buat kebijakan AWS Identity and Access Management (IAM) untuk menyediakan izin antara API GraphQL dan fungsi Lambda Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ AuthenticationType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html#cfn-appsync-graphqlapi-additionalauthenticationprovider-authenticationtype)` properti `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` objek.

`UserPool`  <a name="sam-graphqlapi-auth-authprovider-userpool"></a>
Tentukan konfigurasi otorisasi opsional untuk menggunakan kumpulan pengguna Amazon Cognito. Anda dapat mengkonfigurasi properti opsional ini ketika `Type` ditentukan sebagai`AMAZON_COGNITO_USER_POOLS`.  
*Jenis*: [ UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)` properti `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` objek.

# DataSource
<a name="sam-property-graphqlapi-datasource"></a>

Konfigurasikan sumber data yang dapat disambungkan oleh penyelesai GraphQL API Anda. Anda dapat menggunakan AWS Serverless Application Model (AWS SAM) template untuk mengonfigurasi koneksi ke sumber data berikut:
+ Amazon DynamoDB
+ AWS Lambda

Untuk mempelajari lebih lanjut tentang sumber data, lihat [Melampirkan sumber data](https://docs.aws.amazon.com/appsync/latest/devguide/attaching-a-data-source.html) di *Panduan AWS AppSync Pengembang*.

## Sintaksis
<a name="sam-property-graphqlapi-datasource-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-datasource-syntax-yaml"></a>

```
DynamoDb: DynamoDb
Lambda: Lambda
```

## Sifat-sifat
<a name="sam-property-graphqlapi-datasource-properties"></a>

`DynamoDb`  <a name="sam-graphqlapi-datasource-dynamodb"></a>
Konfigurasikan tabel DynamoDB sebagai sumber data untuk GraphQL resolver API Anda.  
*Jenis*: [DynamoDb](sam-property-graphqlapi-datasource-dynamodb.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Lambda`  <a name="sam-graphqlapi-datasource-lambda"></a>
Konfigurasikan fungsi Lambda sebagai sumber data untuk resolver GraphQL API Anda.  
*Jenis*: [Lambda](sam-property-graphqlapi-datasource-lambda.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

# DynamoDb
<a name="sam-property-graphqlapi-datasource-dynamodb"></a>

Konfigurasikan tabel Amazon DynamoDB sebagai sumber data untuk GraphQL resolver API Anda.

## Sintaksis
<a name="sam-property-graphqlapi-datasource-dynamodb-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-datasource-dynamodb-syntax-yaml"></a>

```
LogicalId:
  DeltaSync: [DeltaSyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html)
  Description: String
  Name: String
  Permissions: List
  Region: String
  ServiceRoleArn: String
  TableArn: String
  TableName: String
  UseCallerCredentials: Boolean
  Versioned: Boolean
```

## Sifat-sifat
<a name="sam-property-graphqlapi-datasource-dynamodb-properties"></a>

`DeltaSync`  <a name="sam-graphqlapi-datasource-dynamodb-deltasync"></a>
Menjelaskan konfigurasi Delta Sync.  
*Jenis*: [DeltaSyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DeltaSyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-deltasyncconfig)` properti `AWS::AppSync::DataSource DynamoDBConfig` objek.

`Description`  <a name="sam-graphqlapi-datasource-dynamodb-description"></a>
Deskripsi sumber data Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description)` properti `AWS::AppSync::DataSource` sumber daya.

`LogicalId`  <a name="sam-graphqlapi-datasource-dynamodb-logicalid"></a>
Nama unik sumber data Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` properti `AWS::AppSync::DataSource` sumber daya.

`Name`  <a name="sam-graphqlapi-datasource-dynamodb-name"></a>
Nama sumber data Anda. Tentukan properti ini untuk mengganti `LogicalId` nilainya.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` properti `AWS::AppSync::DataSource` sumber daya.

`Permissions`  <a name="sam-graphqlapi-datasource-dynamodb-permissions"></a>
Menyediakan izin ke sumber data Anda menggunakan[AWS SAM konektor](managing-permissions-connectors.md). Anda dapat memberikan salah satu nilai berikut dalam daftar:  
+ `Read`— Izinkan resolver Anda membaca sumber data Anda.
+ `Write`— Izinkan resolver Anda untuk menulis ke sumber data Anda.
AWS SAM menggunakan `AWS::Serverless::Connector` sumber daya yang diubah saat penerapan untuk memberikan izin Anda. Untuk mempelajari tentang sumber daya yang dihasilkan, lihat[CloudFormation sumber daya yang dihasilkan saat Anda menentukan AWS::Serverless::Connector](sam-specification-generated-resources-connector.md).  
Anda dapat menentukan `Permissions` atau `ServiceRoleArn`, tapi tidak keduanya. Jika tidak ada yang ditentukan, AWS SAM akan menghasilkan nilai default `Read` dan`Write`. Untuk mencabut akses ke sumber data Anda, hapus objek DynamoDB dari template Anda. AWS SAM 
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. Ini mirip dengan `Permissions` properti sumber `AWS::Serverless::Connector` daya.

`Region`  <a name="sam-graphqlapi-datasource-dynamodb-region"></a>
Tabel Wilayah AWS DynamoDB Anda. Jika Anda tidak menentukannya, AWS SAM gunakan`[AWS::Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-region)`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AwsRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-awsregion)` properti `AWS::AppSync::DataSource DynamoDBConfig` objek.

`ServiceRoleArn`  <a name="sam-graphqlapi-datasource-dynamodb-servicerolearn"></a>
Peran layanan AWS Identity and Access Management (IAM) ARN untuk sumber data. Sistem mengasumsikan peran ini saat mengakses sumber data.  
Anda dapat menentukan `Permissions` atau `ServiceRoleArn`, tapi tidak keduanya.  
*Tipe*: String  
*Diperlukan*: Tidak. Jika tidak ditentukan, AWS SAM menerapkan nilai default untuk`Permissions`.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ServiceRoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn)` properti `AWS::AppSync::DataSource` sumber daya.

`TableArn`  <a name="sam-graphqlapi-datasource-dynamodb-tablearn"></a>
ARN untuk tabel DynamoDB.  
*Tipe*: String  
*Diperlukan*: Bersyarat. Jika Anda tidak menentukan`ServiceRoleArn`, `TableArn` diperlukan.  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`TableName`  <a name="sam-graphqlapi-datasource-dynamodb-tablename"></a>
Nama tabel.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TableName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-tablename)` properti `AWS::AppSync::DataSource DynamoDBConfig` objek.

`UseCallerCredentials`  <a name="sam-graphqlapi-datasource-dynamodb-usecallercredentials"></a>
Setel `true` untuk menggunakan IAM dengan sumber data ini.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[UseCallerCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-usecallercredentials)` properti `AWS::AppSync::DataSource DynamoDBConfig` objek.

`Versioned`  <a name="sam-graphqlapi-datasource-dynamodb-versioned"></a>
Setel `true` untuk menggunakan [Deteksi Konflik, Resolusi Konflik, dan Sinkronisasi](https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html) dengan sumber data ini.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Versioned](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-versioned)` properti `AWS::AppSync::DataSource DynamoDBConfig` objek.

# Lambda
<a name="sam-property-graphqlapi-datasource-lambda"></a>

Konfigurasikan AWS Lambda fungsi sebagai sumber data untuk resolver GraphQL API Anda.

## Sintaksis
<a name="sam-property-graphqlapi-datasource-lambda-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-datasource-lambda-syntax-yaml"></a>

```
LogicalId:
  Description: String
  FunctionArn: String
  Name: String
  ServiceRoleArn: String
```

## Sifat-sifat
<a name="sam-property-graphqlapi-datasource-lambda-properties"></a>

`Description`  <a name="sam-graphqlapi-datasource-lambda-description"></a>
Deskripsi sumber data Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description)` properti `AWS::AppSync::DataSource` sumber daya.

`FunctionArn`  <a name="sam-graphqlapi-datasource-lambda-functionarn"></a>
ARN untuk fungsi Lambda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LambdaFunctionArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-lambdaconfig.html#cfn-appsync-datasource-lambdaconfig-lambdafunctionarn)` properti `AWS::AppSync::DataSource LambdaConfig` objek.

`LogicalId`  <a name="sam-graphqlapi-datasource-lambda-logicalid"></a>
Nama unik sumber data Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` properti `AWS::AppSync::DataSource` sumber daya.

`Name`  <a name="sam-graphqlapi-datasource-lambda-name"></a>
Nama sumber data Anda. Tentukan properti ini untuk mengganti `LogicalId` nilainya.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` properti `AWS::AppSync::DataSource` sumber daya.

`ServiceRoleArn`  <a name="sam-graphqlapi-datasource-lambda-servicerolearn"></a>
Peran layanan AWS Identity and Access Management (IAM) ARN untuk sumber data. Sistem mengasumsikan peran ini saat mengakses sumber data.  
Untuk mencabut akses ke sumber data Anda, hapus objek Lambda dari template Anda. AWS SAM 
*Tipe*: String  
*Diperlukan*: Tidak. Jika tidak ditentukan, AWS SAM akan memberikan `Write` izin menggunakan[AWS SAM konektor](managing-permissions-connectors.md).  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ServiceRoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn)` properti `AWS::AppSync::DataSource` sumber daya.

# Fungsi
<a name="sam-property-graphqlapi-function"></a>

Konfigurasikan fungsi GraphQL APIs untuk melakukan operasi tertentu.

## Sintaksis
<a name="sam-property-graphqlapi-function-syntax"></a>

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

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

```
LogicalId:
  CodeUri: String
  DataSource: String
  Description: String
  Id: String
  InlineCode: String
  MaxBatchSize: Integer
  Name: String
  Runtime: Runtime
  Sync: [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-syncconfig.html)
```

## Sifat-sifat
<a name="sam-property-graphqlapi-function-properties"></a>

`CodeUri`  <a name="sam-graphqlapi-function-codeuri"></a>
Kode fungsi Amazon Simple Storage Service (Amazon S3) URI atau path ke folder lokal.  
Jika Anda menentukan jalur ke folder lokal, CloudFormation mengharuskan file tersebut diunggah terlebih dahulu ke Amazon S3 sebelum penerapan. Anda dapat menggunakan AWS SAMCLI untuk memfasilitasi proses ini. Untuk informasi selengkapnya, lihat [Cara AWS SAM mengunggah file lokal saat penerapan](deploy-upload-local-files.md).  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CodeS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-codes3location)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`DataSource`  <a name="sam-graphqlapi-function-datasource"></a>
Nama sumber data yang akan dilampirkan fungsi ini.  
+ Untuk mereferensikan sumber data dalam `AWS::Serverless::GraphQLApi` sumber daya, tentukan ID logisnya.
+ Untuk mereferensikan sumber data di luar `AWS::Serverless::GraphQLApi` sumber daya, berikan `Name` atributnya menggunakan fungsi `Fn::GetAtt` intrinsik. Misalnya, `!GetAtt MyLambdaDataSource.Name`.
+ Untuk mereferensikan sumber data dari tumpukan yang berbeda, gunakan`[Fn::ImportValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html)`.
Jika variasi `[NONE | None | none]` ditentukan, AWS SAM akan menghasilkan `None` nilai untuk `AWS::AppSync::DataSource` `[Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type)` objek.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DataSourceName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-datasourcename)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`Description`  <a name="sam-graphqlapi-function-description"></a>
Deskripsi fungsi Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-description)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`Id`  <a name="sam-graphqlapi-function-id"></a>
ID Fungsi untuk fungsi yang terletak di luar `AWS::Serverless::GraphQLApi` sumber daya.  
+ Untuk mereferensikan fungsi dalam AWS SAM template yang sama, gunakan fungsi `Fn::GetAtt` intrinsik. Sebagai contoh, `Id: !GetAtt createPostItemFunc.FunctionId`.
+ Untuk mereferensikan fungsi dari tumpukan yang berbeda, gunakan`[Fn::ImportValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html)`.
Saat menggunakan`Id`, semua properti lainnya tidak diperbolehkan. AWS SAM akan secara otomatis melewati ID Fungsi dari fungsi yang direferensikan Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`InlineCode`  <a name="sam-graphqlapi-function-inlinecode"></a>
Kode fungsi yang berisi fungsi permintaan dan respons.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-code)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`LogicalId`  <a name="sam-graphqlapi-function-logicalid"></a>
Nama unik dari fungsi Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`MaxBatchSize`  <a name="sam-graphqlapi-function-maxbatchsize"></a>
Jumlah maksimum input permintaan resolver yang akan dikirim ke satu AWS Lambda fungsi dalam operasi. `BatchInvoke`  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [MaxBatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-maxbatchsize)properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`Name`  <a name="sam-graphqlapi-function-name"></a>
Nama fungsi. Tentukan untuk mengganti `LogicalId` nilainya.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

`Runtime`  <a name="sam-graphqlapi-function-runtime"></a>
Menjelaskan runtime yang digunakan oleh resolver atau fungsi AWS AppSync pipeline. AWS AppSync Menentukan nama dan versi runtime yang akan digunakan.  
*Jenis*: [Runtime](sam-property-graphqlapi-function-runtime.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. Ini mirip dengan `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-runtime)` properti sumber `AWS::AppSync::FunctionConfiguration` daya.

`Sync`  <a name="sam-graphqlapi-function-sync"></a>
Menjelaskan konfigurasi Sinkronisasi untuk suatu fungsi.  
Menentukan strategi Deteksi Konflik dan strategi Resolusi mana yang akan digunakan saat fungsi dipanggil.  
*Jenis*: [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-syncconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-syncconfig)` properti `AWS::AppSync::FunctionConfiguration` sumber daya.

# Waktu Aktif
<a name="sam-property-graphqlapi-function-runtime"></a>

Runtime resolver atau fungsi pipeline Anda. Menentukan nama dan versi yang akan digunakan.

## Sintaksis
<a name="sam-property-graphqlapi-function-runtime-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-function-runtime-syntax-yaml"></a>

```
Name: String
Version: String
```

## Sifat-sifat
<a name="sam-property-graphqlapi-function-runtime-properties"></a>

`Name`  <a name="sam-graphqlapi-function-runtime-name"></a>
Nama runtime yang akan digunakan. Saat ini, satu-satunya nilai yang diizinkan adalah`APPSYNC_JS`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-appsyncruntime.html#cfn-appsync-functionconfiguration-appsyncruntime-name)` properti `AWS::AppSync::FunctionConfiguration AppSyncRuntime` objek.

`Version`  <a name="sam-graphqlapi-function-runtime-version"></a>
Versi runtime yang akan digunakan. Saat ini, satu-satunya versi yang diizinkan adalah`1.0.0`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RuntimeVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-appsyncruntime.html#cfn-appsync-functionconfiguration-appsyncruntime-runtimeversion)` properti `AWS::AppSync::FunctionConfiguration AppSyncRuntime` objek.

# Penyelesai
<a name="sam-property-graphqlapi-resolver"></a>

Konfigurasikan resolver untuk bidang API AndaGraphQL. AWS Serverless Application Model (AWS SAM) mendukung [JavaScript resolver pipa](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-reference-overview-js.html).

## Sintaksis
<a name="sam-property-graphqlapi-resolver-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-resolver-syntax-yaml"></a>

```
OperationType:
  LogicalId:
    Caching: [CachingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html)
    CodeUri: String
    FieldName: String
    InlineCode: String 
    MaxBatchSize: Integer
    Pipeline: List
    Runtime: Runtime
    Sync: [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html)
```

## Sifat-sifat
<a name="sam-property-graphqlapi-resolver-properties"></a>

`Caching`  <a name="sam-graphqlapi-resolver-caching"></a>
Konfigurasi caching untuk resolver yang telah caching diaktifkan.  
*Jenis*: [CachingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CachingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-cachingconfig)` properti `AWS::AppSync::Resolver` sumber daya.

`CodeUri`  <a name="sam-graphqlapi-resolver-codeuri"></a>
Kode fungsi resolver adalah Amazon Simple Storage Service (Amazon S3) URI atau path ke folder lokal.  
Jika Anda menentukan jalur ke folder lokal, CloudFormation mengharuskan file tersebut diunggah terlebih dahulu ke Amazon S3 sebelum penerapan. Anda dapat menggunakan AWS SAMCLI untuk memfasilitasi proses ini. Untuk informasi selengkapnya, lihat [Cara AWS SAM mengunggah file lokal saat penerapan](deploy-upload-local-files.md).  
Jika tidak `InlineCode` ada `CodeUri` atau disediakan, AWS SAM akan menghasilkan `InlineCode` yang mengalihkan permintaan ke fungsi pipeline pertama dan menerima respons dari fungsi pipeline terakhir.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CodeS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-codes3location)` properti `AWS::AppSync::Resolver` sumber daya.

`FieldName`  <a name="sam-graphqlapi-resolver-fieldname"></a>
Nama resolver Anda. Tentukan properti ini untuk mengganti `LogicalId` nilainya.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FieldName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-fieldname)` properti `AWS::AppSync::Resolver` sumber daya.

`InlineCode`  <a name="sam-graphqlapi-resolver-inlinecode"></a>
Kode resolver yang berisi fungsi permintaan dan respons.  
Jika tidak `InlineCode` ada `CodeUri` atau disediakan, AWS SAM akan menghasilkan `InlineCode` yang mengalihkan permintaan ke fungsi pipeline pertama dan menerima respons dari fungsi pipeline terakhir.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-code)` properti `AWS::AppSync::Resolver` sumber daya.

`LogicalId`  <a name="sam-graphqlapi-resolver-logicalid"></a>
Nama unik untuk resolver Anda. Dalam GraphQL skema, nama resolver Anda harus cocok dengan nama bidang yang digunakan. Gunakan nama bidang yang sama untuk`LogicalId`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`MaxBatchSize`  <a name="sam-graphqlapi-resolver-maxbatchsize"></a>
Jumlah maksimum input permintaan resolver yang akan dikirim ke satu AWS Lambda fungsi dalam operasi. `BatchInvoke`  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaxBatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-maxbatchsize)` properti `AWS::AppSync::Resolver` sumber daya.

`OperationType`  <a name="sam-graphqlapi-resolver-operationtype"></a>
Jenis GraphQL operasi yang terkait dengan resolver Anda. Sebagai contoh, `Query`, `Mutation`, atau `Subscription`. Anda dapat membuat sarang beberapa resolver `LogicalId` dalam satu. `OperationType`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TypeName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-typename)` properti `AWS::AppSync::Resolver` sumber daya.

`Pipeline`  <a name="sam-graphqlapi-resolver-pipeline"></a>
Fungsi yang terkait dengan penyelesai alur. Tentukan fungsi dengan ID logis dalam daftar.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. Ini mirip dengan `[PipelineConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-pipelineconfig)` properti sumber `AWS::AppSync::Resolver` daya.

`Runtime`  <a name="sam-graphqlapi-resolver-runtime"></a>
Runtime resolver atau fungsi pipeline Anda. Menentukan nama dan versi yang akan digunakan.  
*Jenis*: [Runtime](sam-property-graphqlapi-resolver-runtime.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. Ini mirip dengan `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-runtime)` properti sumber `AWS::AppSync::Resolver` daya.

`Sync`  <a name="sam-graphqlapi-resolver-sync"></a>
Menjelaskan konfigurasi Sinkronisasi untuk penyelesai.  
Menentukan strategi Deteksi Konflik dan strategi Resolusi mana yang akan digunakan saat resolver dipanggil.  
*Jenis*: [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-syncconfig)` properti `AWS::AppSync::Resolver` sumber daya.

## Contoh
<a name="sam-property-graphqlapi-resolver-examples"></a>

### Gunakan kode fungsi resolver yang AWS SAM dihasilkan dan simpan bidang sebagai variabel
<a name="sam-property-graphqlapi-resolver-examples-example1"></a>

Berikut adalah GraphQL skema untuk contoh kita:

```
schema {
  query: Query
  mutation: Mutation
}

type Query {
  getPost(id: ID!): Post
}

type Mutation {
  addPost(author: String!, title: String!, content: String!): Post!
}

type Post {
  id: ID!
  author: String
  title: String
  content: String
}
```

Berikut adalah cuplikan template kami AWS SAM :

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLApi:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      ...
      Functions:
        preprocessPostItem:
          ...
        createPostItem:
          ...
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - preprocessPostItem
            - createPostItem
```

Dalam AWS SAM template kami, kami tidak menentukan `CodeUri` atau`InlineCode`. Saat penerapan, AWS SAM secara otomatis menghasilkan kode inline berikut untuk resolver kami:

```
export function request(ctx) {
  return {};
}

export function response(ctx) {
  return ctx.prev.result;
}
```

Kode resolver default ini mengalihkan permintaan ke fungsi pipeline pertama dan menerima respons dari fungsi pipeline terakhir.

Dalam fungsi pipeline pertama kita, kita dapat menggunakan `args` bidang yang disediakan untuk mengurai objek permintaan dan membuat variabel kita. Kita kemudian dapat menggunakan variabel-variabel ini dalam fungsi kita. Berikut adalah contoh `preprocessPostItem` fungsi kami:

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const author = ctx.args.author;
  const title = ctx.args.title;
  const content = ctx.args.content;
  
  // Use variables to process data
  
}

export function response(ctx) {
  return ctx.result;
}
```

# Waktu Aktif
<a name="sam-property-graphqlapi-resolver-runtime"></a>

Runtime resolver atau fungsi pipeline Anda. Menentukan nama dan versi yang akan digunakan.

## Sintaksis
<a name="sam-property-graphqlapi-resolver-runtime-syntax"></a>

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

### YAML
<a name="sam-property-graphqlapi-resolver-runtime-syntax-yaml"></a>

```
Name: String
Version: String
```

## Sifat-sifat
<a name="sam-property-graphqlapi-resolver-runtime-properties"></a>

`Name`  <a name="sam-graphqlapi-resolver-runtime-name"></a>
Nama runtime yang akan digunakan. Saat ini, satu-satunya nilai yang diizinkan adalah`APPSYNC_JS`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-appsyncruntime.html#cfn-appsync-resolver-appsyncruntime-name)` properti `AWS::AppSync::Resolver AppSyncRuntime` objek.

`Version`  <a name="sam-graphqlapi-resolver-runtime-version"></a>
Versi runtime yang akan digunakan. Saat ini, satu-satunya versi yang diizinkan adalah`1.0.0`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RuntimeVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-appsyncruntime.html#cfn-appsync-resolver-appsyncruntime-runtimeversion)` properti `AWS::AppSync::Resolver AppSyncRuntime` objek.

# AWS::Serverless::HttpApi
<a name="sam-resource-httpapi"></a>

Membuat API HTTP Amazon API Gateway, yang memungkinkan Anda membuat RESTful APIs dengan latensi lebih rendah dan biaya lebih rendah daripada REST APIs. Untuk informasi selengkapnya, lihat [Bekerja dengan HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) di *Panduan Pengembang API Gateway*.

Kami menyarankan Anda menggunakan CloudFormation kait atau kebijakan IAM untuk memverifikasi bahwa sumber daya API Gateway memiliki otorisasi yang melekat padanya untuk mengontrol akses ke sumber daya tersebut.

Untuk informasi selengkapnya tentang penggunaan CloudFormation kait, lihat [Mendaftarkan kait](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/registering-hook-python.html) di *panduan pengguna CloudFormation CLI* dan repositori. [apigw-enforce-authorizer](https://github.com/aws-cloudformation/aws-cloudformation-samples/tree/main/hooks/python-hooks/apigw-enforce-authorizer/) GitHub 

Untuk informasi selengkapnya tentang penggunaan kebijakan IAM, lihat [Mengharuskan rute API memiliki otorisasi dalam Panduan](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-require-authorization) *Pengembang API Gateway*.

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaks
<a name="sam-resource-httpapi-syntax"></a>

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

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

```
Type: AWS::Serverless::HttpApi
Properties:
  [AccessLogSettings](#sam-httpapi-accesslogsettings): [AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)
  [Auth](#sam-httpapi-auth): HttpApiAuth
  [CorsConfiguration](#sam-httpapi-corsconfiguration): String | HttpApiCorsConfiguration
  [DefaultRouteSettings](#sam-httpapi-defaultroutesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [DefinitionBody](#sam-httpapi-definitionbody): JSON
  [DefinitionUri](#sam-httpapi-definitionuri): String | HttpApiDefinition
  [Description](#sam-httpapi-description): String
  [DisableExecuteApiEndpoint](#sam-httpapi-disableexecuteapiendpoint): Boolean
  [Domain](#sam-httpapi-domain): HttpApiDomainConfiguration
  [FailOnWarnings](#sam-httpapi-failonwarnings): Boolean
  Name: String
  PropagateTags: Boolean
  [RouteSettings](#sam-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [StageName](#sam-httpapi-stagename): String
  [StageVariables](#sam-httpapi-stagevariables): [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)
  [Tags](#sam-httpapi-tags): Map
```

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

 `AccessLogSettings`   <a name="sam-httpapi-accesslogsettings"></a>
Pengaturan untuk log akses dalam tahap.  
*Jenis*: [AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `Auth`   <a name="sam-httpapi-auth"></a>
Mengonfigurasikan otorisasi untuk mengendalikan akses ke API HTTP API Gateway Anda.  
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*.  
*Jenis*: [HttpApiAuth](sam-property-httpapi-httpapiauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CorsConfiguration`   <a name="sam-httpapi-corsconfiguration"></a>
Mengelola berbagi sumber daya lintas asal (CORS) untuk semua HTTP API Gateway Anda. APIs Tentukan domain untuk diizinkan sebagai string, atau menentukan objek `HttpApiCorsConfiguration`. Perhatikan bahwa CORS AWS SAM perlu memodifikasi definisi OpenAPI Anda, jadi CORS hanya berfungsi jika properti ditentukan`DefinitionBody`.  
Untuk informasi selengkapnya, lihat [Mengonfigurasi CORS untuk API HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) di *Panduan Developer API Gateway*.  
Jika `CorsConfiguration` disetel baik dalam definisi OpenAPI maupun di tingkat properti, maka AWS SAM gabungkan kedua sumber konfigurasi dengan properti yang diutamakan. Jika properti ini disetel ke`true`, maka semua asal diizinkan.
*Jenis*: String \$1 [HttpApiCorsConfiguration](sam-property-httpapi-httpapicorsconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `DefaultRouteSettings`   <a name="sam-httpapi-defaultroutesettings"></a>
Pengaturan rute default untuk API HTTP ini. Pengaturan ini berlaku untuk semua rute kecuali dibatalkan oleh properti `RouteSettings` untuk rute tertentu.  
*Jenis*: [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `DefinitionBody`   <a name="sam-httpapi-definitionbody"></a>
Ketentuan OpenAPI yang menjelaskan API HTTP Anda. Jika Anda tidak menentukan a `DefinitionUri` atau a `DefinitionBody` AWS SAM , `DefinitionBody` buat untuk Anda berdasarkan konfigurasi template Anda.  
*Tipe*: JSON  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` properti `AWS::ApiGatewayV2::Api` sumber daya. Jika properti tertentu disediakan, AWS SAM dapat memasukkan konten ke dalam atau memodifikasi `DefinitionBody` sebelum diteruskan ke CloudFormation. Properti termasuk `Auth` dan `EventSource` tipe HttpApi untuk `AWS::Serverless::Function` sumber daya yang sesuai.

 `DefinitionUri`   <a name="sam-httpapi-definitionuri"></a>
URI Amazon Simple Storage Service (Amazon S3), jalur file lokal, atau objek lokasi ketentuan OpenAPI yang menentukan API HTTP. Objek Amazon S3 yang merujuk properti ini harus menjadi file ketentuan OpenAPI yang valid. Jika Anda tidak menentukan `DefinitionUri` atau `DefinitionBody` ditentukan, buat AWS SAM `DefinitionBody` untuk Anda berdasarkan konfigurasi template Anda.  
Jika Anda menyediakan jalur file lokal, templat harus melalui alur kerja yang mencakup perintah `sam deploy` atau `sam package` untuk ketentuan agar berubah dengan benar.  
Fungsi intrinsik tidak didukung dalam file OpenApi definisi eksternal yang Anda referensikan. `DefinitionUri` Untuk mengimpor OpenApi definisi ke dalam template, gunakan `DefinitionBody` properti dengan [transformasi Sertakan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html).  
*Jenis*: String \$1 [HttpApiDefinition](sam-property-httpapi-httpapidefinition.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location)` properti `AWS::ApiGatewayV2::Api` sumber daya. Properti Amazon S3 nest diberi nama berbeda.

 `Description`   <a name="sam-httpapi-description"></a>
Deskripsi sumber daya HTTP API.  
Saat Anda menentukan`Description`, AWS SAM akan memodifikasi OpenApi definisi sumber daya HTTP API dengan menyetel `description` bidang. Skenario berikut akan menghasilkan kesalahan:  
+ `DefinitionBody`Properti ditentukan dengan `description` bidang yang disetel dalam definisi Open API — Ini menghasilkan konflik `description` bidang yang tidak AWS SAM akan diselesaikan.
+ `DefinitionUri`Properti ditentukan — tidak AWS SAM akan mengubah definisi Open API yang diambil dari Amazon S3.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `DisableExecuteApiEndpoint`   <a name="sam-httpapi-disableexecuteapiendpoint"></a>
Menentukan apakah klien dapat memanggil API HTTP Anda dengan menggunakan `https://{api_id}.execute-api.{region}.amazonaws.com` titik akhir `execute-api` default. Secara default, klien dapat memanggil API Anda dengan titik akhir default. Untuk meminta agar klien hanya menggunakan nama domain kustom untuk memanggil API Anda, nonaktifkan titik akhir default.  
Untuk menggunakan properti ini, Anda harus menentukan `DefinitionBody` properti alih-alih `DefinitionUri` properti atau menentukan `x-amazon-apigateway-endpoint-configuration` dengan `disableExecuteApiEndpoint` definisi OpenAPI Anda.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint)` properti `AWS::ApiGatewayV2::Api` sumber daya. Itu diteruskan langsung ke `disableExecuteApiEndpoint` properti `[ x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)` ekstensi, yang akan ditambahkan ke ` [ Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` properti `AWS::ApiGatewayV2::Api` sumber daya.

 `Domain`   <a name="sam-httpapi-domain"></a>
Mengonfigurasi domain kustom untuk API HTTP API Gateway ini.  
*Jenis*: [HttpApiDomainConfiguration](sam-property-httpapi-httpapidomainconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FailOnWarnings`   <a name="sam-httpapi-failonwarnings"></a>
Menentukan apakah akan memutar kembali pembuatan API HTTP (`true`) atau tidak (`false`) saat peringatan ditemui. Nilai default-nya adalah `false`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings)` properti `AWS::ApiGatewayV2::Api` sumber daya.

`Name`  <a name="sam-httpapi-name"></a>
Nama sumber daya HTTP API.  
Saat Anda menentukan`Name`, AWS SAM akan memodifikasi definisi OpenAPI sumber daya HTTP API dengan menyetel bidang. `title` Skenario berikut akan menghasilkan kesalahan:  
+ `DefinitionBody`Properti ditentukan dengan `title` bidang yang disetel dalam definisi Open API — Ini menghasilkan konflik `title` bidang yang tidak AWS SAM akan diselesaikan.
+ `DefinitionUri`Properti ditentukan — tidak AWS SAM akan mengubah definisi Open API yang diambil dari Amazon S3.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`PropagateTags`  <a name="sam-httpapi-propagatetags"></a>
Tunjukkan apakah akan meneruskan tag dari `Tags` properti ke sumber daya yang Anda [AWS::Serverless::HttpApi](sam-specification-generated-resources-httpapi.md) hasilkan atau tidak. Tentukan `True` untuk menyebarkan tag di sumber daya yang Anda hasilkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RouteSettings`   <a name="sam-httpapi-routesettings"></a>
Pengaturan rute, per rute, untuk API HTTP ini. Untuk informasi selengkapnya, lihat [Bekerja dengan rute untuk HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) di *Panduan Pengembang API Gateway*.  
*Jenis*: [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `StageName`   <a name="sam-httpapi-stagename"></a>
Nama tahap API. Jika tidak ada nama yang ditentukan, AWS SAM gunakan `$default` stage dari API Gateway.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: \$1default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `StageVariables`   <a name="sam-httpapi-stagevariables"></a>
Sebuah peta yang menentukan variabel panggung. Nama variabel dapat memiliki karakter alfanumerik dan garis bawah. Nilai-nilai harus sesuai dengan [A-Za-z0-9-.\$1\$1:/? \$1&=,] \$1.  
*Tipe*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StageVariables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `Tags`   <a name="sam-httpapi-tags"></a>
Sebuah peta (string ke string) yang menentukan tanda untuk ditambahkan ke tahap API Gateway ini. Kunci dapat berupa 1 hingga 128 karakter Unicode dan tidak dapat menyertakan awalan`aws:`. Anda dapat menggunakan salah satu karakter berikut: set huruf Unicode, angka, spasi putih, `_`, `.`, `/`, `=`, `+`, dan `-`. Nilai dapat berupa 1 hingga 256 karakter Unicode panjangnya.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: `Tags` Properti AWS SAM harus mengubah definisi OpenAPI Anda, sehingga tag ditambahkan hanya jika `DefinitionBody` properti ditentukan—tidak ada tag yang ditambahkan jika properti ditentukan. `DefinitionUri` AWS SAM secara otomatis menambahkan `httpapi:createdBy:SAM` tag. Tanda juga ditambahkan ke sumber daya `AWS::ApiGatewayV2::Stage` dan sumber daya `AWS::ApiGatewayV2::DomainName` (jika `DomainName` ditentukan).

## Nilai Pengembalian
<a name="sam-resource-httpapi-return-values"></a>

### Ref
<a name="sam-resource-httpapi-return-values-ref"></a>

Bila Anda melewati ID logis dari sumber daya ini ke fungsi `Ref` intrinsik, `Ref` mengembalikan ID API dari sumber daya `AWS::ApiGatewayV2::Api` utama, misalnya, `a1bcdef2gh`.

Untuk informasi lebih lanjut tentang penggunaan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

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

### Sederhana HttpApi
<a name="sam-resource-httpapi--examples--simple-httpapi"></a>

Contoh berikut menunjukkan minimum yang diperlukan untuk mengatur titik akhir HTTP API yang didukung oleh fungsi Lambda. Contoh ini menggunakan HTTP API default yang AWS SAM membuat.

#### YAML
<a name="sam-resource-httpapi--examples--simple-httpapi--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Description: AWS SAM template with a simple API definition
Resources:
  ApiFunction:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
      Runtime: python3.7
Transform: AWS::Serverless-2016-10-31
```

### HttpApi dengan Auth
<a name="sam-resource-httpapi--examples--httpapi-with-auth"></a>

Contoh berikut menunjukkan cara mengatur otorisasi di titik akhir HTTP API.

#### YAML
<a name="sam-resource-httpapi--examples--httpapi-with-auth--yaml"></a>

```
Properties:
  FailOnWarnings: true
  Auth:
    DefaultAuthorizer: OAuth2
    Authorizers:
      OAuth2:
        AuthorizationScopes:
          - scope4
        JwtConfiguration:
          issuer: "https://www.example.com/v1/connect/oauth2"
          audience:
            - MyApi
        IdentitySource: "$request.querystring.param"
```

### HttpApi dengan definisi OpenAPI
<a name="sam-resource-httpapi--examples--httpapi-with-openapi-definition"></a>

Contoh berikut menunjukkan cara menambahkan ketentuan OpenAPI ke templat.

Perhatikan bahwa AWS SAM mengisi integrasi Lambda yang hilang HttpApi untuk peristiwa yang mereferensikan API HTTP ini. AWS SAM juga menambahkan jalur yang hilang yang menjadi referensi HttpApi acara.

#### YAML
<a name="sam-resource-httpapi--examples--httpapi-with-openapi-definition--yaml"></a>

```
Properties:
  FailOnWarnings: true
  DefinitionBody:
    info:
      version: '1.0'
      title:
        Ref: AWS::StackName
    paths:
      "/":
        get:
          security:
          - OpenIdAuth:
            - scope1
            - scope2
          responses: {}
    openapi: 3.0.1
    securitySchemes:
      OpenIdAuth:
        type: openIdConnect
        x-amazon-apigateway-authorizer:
          identitySource: "$request.querystring.param"
          type: jwt
          jwtConfiguration:
            audience:
            - MyApi
            issuer: https://www.example.com/v1/connect/oidc
          openIdConnectUrl: https://www.example.com/v1/connect/oidc/.well-known/openid-configuration
```

### HttpApi dengan pengaturan konfigurasi
<a name="sam-resource-httpapi--examples--httpapi-with-configuration-settings"></a>

Contoh berikut menunjukkan cara menambahkan API HTTP dan konfigurasi persiapan ke templat.

#### YAML
<a name="sam-resource-httpapi--examples--httpapi-with-configuration-settings--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Parameters:
  StageName:
    Type: String
    Default: Prod
    
Resources:
  HttpApiFunction:
    Type: AWS::Serverless::Function
    Properties:
      InlineCode: |
          def handler(event, context):
              import json
              return {
                  "statusCode": 200,
                  "body": json.dumps(event),
              }
      Handler: index.handler
      Runtime: python3.7
      Events:
        ExplicitApi: # warning: creates a public endpoint
          Type: HttpApi
          Properties:
            ApiId: !Ref HttpApi
            Method: GET
            Path: /path
            TimeoutInMillis: 15000
            PayloadFormatVersion: "2.0"
            RouteSettings:
              ThrottlingBurstLimit: 600

  HttpApi:
    Type: AWS::Serverless::HttpApi
    Properties:
      StageName: !Ref StageName
      Tags:
        Tag: Value
      AccessLogSettings:
        DestinationArn: !GetAtt AccessLogs.Arn
        Format: $context.requestId
      DefaultRouteSettings:
        ThrottlingBurstLimit: 200
      RouteSettings:
        "GET /path":
          ThrottlingBurstLimit: 500 # overridden in HttpApi Event
      StageVariables:
        StageVar: Value
      FailOnWarnings: true

  AccessLogs:
    Type: AWS::Logs::LogGroup

Outputs:
  HttpApiUrl:
    Description: URL of your API endpoint
    Value:
      Fn::Sub: 'https://${HttpApi}.execute-api.${AWS::Region}.${AWS::URLSuffix}/${StageName}/'
  HttpApiId:
    Description: Api id of HttpApi
    Value:
      Ref: HttpApi
```

# 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
```

# HttpApiCorsConfiguration
<a name="sam-property-httpapi-httpapicorsconfiguration"></a>

Kelola berbagi sumber daya lintas asal (CORS) untuk HTTP Anda. APIs Tentukan domain untuk diizinkan sebagai string atau tentukan kamus dengan konfigurasi Cors tambahan. CATATAN: Cor membutuhkan SAM untuk memodifikasi definisi OpenAPI Anda, sehingga hanya berfungsi dengan OpenApi sebaris yang ditentukan di properti. `DefinitionBody`

Untuk informasi lebih lanjut tentang CORS, lihat [Mengonfigurasi CORS untuk API HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) di *Panduan Developer API Gateway*.

Catatan: Jika HttpApiCorsConfiguration disetel baik di OpenAPI maupun di tingkat properti, AWS SAM gabungkan mereka dengan properti yang diutamakan.

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

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

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

```
  [AllowCredentials](#sam-httpapi-httpapicorsconfiguration-allowcredentials): Boolean
  [AllowHeaders](#sam-httpapi-httpapicorsconfiguration-allowheaders): List
  [AllowMethods](#sam-httpapi-httpapicorsconfiguration-allowmethods): List
  [AllowOrigins](#sam-httpapi-httpapicorsconfiguration-alloworigins): List
  [ExposeHeaders](#sam-httpapi-httpapicorsconfiguration-exposeheaders): List
  [MaxAge](#sam-httpapi-httpapicorsconfiguration-maxage): Integer
```

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

 `AllowCredentials`   <a name="sam-httpapi-httpapicorsconfiguration-allowcredentials"></a>
Menentukan apakah kredensial termasuk dalam permintaan CORS.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AllowHeaders`   <a name="sam-httpapi-httpapicorsconfiguration-allowheaders"></a>
Merupakan kumpulan header yang diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AllowMethods`   <a name="sam-httpapi-httpapicorsconfiguration-allowmethods"></a>
Merupakan kumpulan metode HTTP yang diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AllowOrigins`   <a name="sam-httpapi-httpapicorsconfiguration-alloworigins"></a>
Merupakan kumpulan asal yang diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ExposeHeaders`   <a name="sam-httpapi-httpapicorsconfiguration-exposeheaders"></a>
Merupakan kumpulan header yang terekspos.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `MaxAge`   <a name="sam-httpapi-httpapicorsconfiguration-maxage"></a>
Jumlah detik ketika peramban harus men-cache hasil permintaan penerbangan awal.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### HttpApiCorsConfiguration
<a name="sam-property-httpapi-httpapicorsconfiguration--examples--httpapicorsconfiguration"></a>

Contoh Konfigurasi Cors API HTTP.

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

```
CorsConfiguration:
  AllowOrigins:
    - "https://example.com"
  AllowHeaders:
    - x-apigateway-header
  AllowMethods:
    - GET
  MaxAge: 600
  AllowCredentials: true
```

# HttpApiDefinition
<a name="sam-property-httpapi-httpapidefinition"></a>

Dokumen OpenAPI yang menentukan API.

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

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

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

```
  [Bucket](#sam-httpapi-httpapidefinition-bucket): String
  [Key](#sam-httpapi-httpapidefinition-key): String
  [Version](#sam-httpapi-httpapidefinition-version): String
```

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

 `Bucket`   <a name="sam-httpapi-httpapidefinition-bucket"></a>
Nama bucket Amazon S3 tempat file OpenAPI disimpan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket)` properti tipe `AWS::ApiGatewayV2::Api` `BodyS3Location` data.

 `Key`   <a name="sam-httpapi-httpapidefinition-key"></a>
Kunci Amazon S3 dari file OpenAPI.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key)` properti tipe `AWS::ApiGatewayV2::Api` `BodyS3Location` data.

 `Version`   <a name="sam-httpapi-httpapidefinition-version"></a>
Untuk objek berversi, versi file OpenAPI.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version)` properti tipe `AWS::ApiGatewayV2::Api` `BodyS3Location` data.

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

### Contoh Uri Ketentuan
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example"></a>

Contoh ketentuan API

#### YAML
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example--yaml"></a>

```
DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# HttpApiDomainConfiguration
<a name="sam-property-httpapi-httpapidomainconfiguration"></a>

Mengonfigurasi domain kustom untuk API.

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

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

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

```
  [BasePath](#sam-httpapi-httpapidomainconfiguration-basepath): List
  [CertificateArn](#sam-httpapi-httpapidomainconfiguration-certificatearn): String
  [DomainName](#sam-httpapi-httpapidomainconfiguration-domainname): String
  [EndpointConfiguration](#sam-httpapi-httpapidomainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)
  [OwnershipVerificationCertificateArn](#sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn): String
  [Route53](#sam-httpapi-httpapidomainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-httpapi-httpapidomainconfiguration-securitypolicy): String
```

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

 `BasePath`   <a name="sam-httpapi-httpapidomainconfiguration-basepath"></a>
Daftar basepaths untuk mengonfigurasi dengan nama domain Amazon API Gateway.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*:/  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[ApiMappingKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey)` properti `AWS::ApiGatewayV2::ApiMapping` sumber daya. AWS SAM menciptakan beberapa `AWS::ApiGatewayV2::ApiMapping` sumber daya, satu per nilai yang ditentukan dalam properti ini.

 `CertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-certificatearn"></a>
Nama Sumber Daya Amazon (ARN) dari sertifikat AWS terkelola untuk titik akhir nama domain ini. AWS Certificate Manager adalah satu-satunya sumber yang didukung.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn)` properti `AWS::ApiGateway2::DomainName DomainNameConfiguration` sumber daya.

 `DomainName`   <a name="sam-httpapi-httpapidomainconfiguration-domainname"></a>
Nama domain khusus untuk API dari API Gateway Anda. Tidak didukung huruf besar.  
AWS SAM menghasilkan sumber `AWS::ApiGatewayV2::DomainName` daya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat [DomainName properti ditentukan](sam-specification-generated-resources-httpapi.md#sam-specification-generated-resources-httpapi-domain-name). Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname)` properti `AWS::ApiGateway2::DomainName` sumber daya.

 `EndpointConfiguration`   <a name="sam-httpapi-httpapidomainconfiguration-endpointconfiguration"></a>
Menentukan tipe titik akhir API Gateway untuk memetakan ke domain kustom. Nilai properti ini menentukan bagaimana `CertificateArn` properti dipetakan. CloudFormation  
Satu-satunya nilai yang valid untuk HTTP APIs adalah`REGIONAL`.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `REGIONAL`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `MutualTlsAuthentication`   <a name="sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication"></a>
Konfigurasi autentikasi Keamanan Lapisan Pengangkutan (TLS) bersama untuk nama domain kustom.  
*Jenis*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)` properti `AWS::ApiGatewayV2::DomainName` sumber daya.

 `OwnershipVerificationCertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn"></a>
ARN sertifikat publik yang dikeluarkan oleh ACM untuk memvalidasi kepemilikan domain kustom Anda. Diperlukan hanya ketika Anda mengonfigurasi TLS timbal balik dan Anda menentukan ARN sertifikat CA yang diimpor atau pribadi ACM untuk ARN. `CertificateArn`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn)` properti tipe `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` data.

 `Route53`   <a name="sam-httpapi-httpapidomainconfiguration-route53"></a>
Menentukan konfigurasi Amazon Route 53.  
*Tipe*: [Route53Configuration](sam-property-httpapi-route53configuration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SecurityPolicy`   <a name="sam-httpapi-httpapidomainconfiguration-securitypolicy"></a>
Versi TLS kebijakan keamanan untuk nama domain ini.  
Satu-satunya nilai yang valid untuk HTTP APIs adalah`TLS_1_2`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy)` properti tipe `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` data.

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

### DomainName
<a name="sam-property-httpapi-httpapidomainconfiguration--examples--domainname"></a>

DomainName contoh

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

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```

# Route53Configuration
<a name="sam-property-httpapi-route53configuration"></a>

Mengonfigurasi set catatan Route53 untuk API.

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

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

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

```
  [DistributionDomainName](#sam-httpapi-route53configuration-distributiondomainname): String
  [EvaluateTargetHealth](#sam-httpapi-route53configuration-evaluatetargethealth): Boolean
  [HostedZoneId](#sam-httpapi-route53configuration-hostedzoneid): String
  [HostedZoneName](#sam-httpapi-route53configuration-hostedzonename): String
  [IpV6](#sam-httpapi-route53configuration-ipv6): Boolean
  Region: String
  SetIdentifier: String
```

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

 `DistributionDomainName`   <a name="sam-httpapi-route53configuration-distributiondomainname"></a>
Mengonfigurasi distribusi kustom nama domain kustom API.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Gunakan distribusi API Gateway.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname)` properti `AWS::Route53::RecordSetGroup AliasTarget` sumber daya.  
*Catatan tambahan*: Nama domain [CloudFrontdistribusi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).

 `EvaluateTargetHealth`   <a name="sam-httpapi-route53configuration-evaluatetargethealth"></a>
Kapan EvaluateTargetHealth benar, catatan alias mewarisi kesehatan AWS sumber daya yang direferensikan, seperti penyeimbang beban Elastic Load Balancing atau catatan lain di zona yang dihosting.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)` properti `AWS::Route53::RecordSetGroup AliasTarget` sumber daya.  
*Catatan tambahan*: Anda tidak dapat mengatur EvaluateTargetHealth ke true ketika target alias adalah CloudFront distribusi.

 `HostedZoneId`   <a name="sam-httpapi-route53configuration-hostedzoneid"></a>
ID zona yang di-hosting tempat Anda ingin membuat catatan.  
Tentukan `HostedZoneName` atau `HostedZoneId`, tapi tidak keduanya. Jika Anda memiliki beberapa zona yang di-hosting dengan nama domain yang sama, Anda harus menentukan zona yang di-hosting menggunakan `HostedZoneId`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid)` properti `AWS::Route53::RecordSetGroup RecordSet` sumber daya.

 `HostedZoneName`   <a name="sam-httpapi-route53configuration-hostedzonename"></a>
Nama zona yang di-hosting tempat Anda ingin membuat catatan. Anda harus menyertakan titik beruntun (misalnya, `www.example.com.`) sebagai bagian dari `HostedZoneName`.  
Tentukan `HostedZoneName` atau `HostedZoneId`, tapi tidak keduanya. Jika Anda memiliki beberapa zona yang di-hosting dengan nama domain yang sama, Anda harus menentukan zona yang di-hosting menggunakan `HostedZoneId`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename)` properti `AWS::Route53::RecordSetGroup RecordSet` sumber daya.

 `IpV6`   <a name="sam-httpapi-route53configuration-ipv6"></a>
Saat properti ini disetel, AWS SAM buat `AWS::Route53::RecordSet` sumber daya dan set [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type) `AAAA` untuk yang disediakan HostedZone.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`Region`  <a name="sam-httpapi-route53configuration-region"></a>
*Hanya set catatan sumber daya berbasis latensi*: EC2 Wilayah Amazon tempat Anda membuat sumber daya yang dirujuk oleh kumpulan catatan sumber daya ini. Sumber daya biasanya adalah AWS sumber daya, seperti EC2 instance atau penyeimbang beban ELB, dan dirujuk oleh alamat IP atau nama domain DNS, tergantung pada jenis catatan.  
Saat Amazon Route 53 menerima kueri DNS untuk nama domain dan jenis yang telah Anda buat set catatan sumber daya latensi, Route 53 memilih kumpulan catatan sumber daya latensi yang memiliki latensi terendah antara pengguna akhir dan Wilayah Amazon terkait. EC2 Route 53 kemudian mengembalikan nilai yang terkait dengan set catatan sumber daya yang dipilih.  
Perhatikan hal-hal berikut:  
+ Anda hanya dapat menentukan satu `ResourceRecord` per set catatan sumber daya latensi.
+ Anda hanya dapat membuat satu set catatan sumber daya latensi untuk setiap EC2 Wilayah Amazon.
+ Anda tidak diharuskan membuat kumpulan rekaman sumber daya latensi untuk semua EC2 Wilayah Amazon. Route 53 akan memilih wilayah dengan latensi terbaik dari antara wilayah yang Anda buat set catatan sumber daya latensi.
+ Anda tidak dapat membuat set catatan sumber daya non-latensi yang memiliki nilai yang sama untuk elemen `Name` dan `Type` sebagai set catatan sumber daya latensi.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-region)` properti tipe `AWS::Route53::RecordSetGroup` `RecordSet` data.

`SetIdentifier`  <a name="sam-httpapi-route53configuration-setidentifier"></a>
*Set catatan sumber daya yang memiliki kebijakan perutean selain sederhana:* Pengenal yang membedakan antara beberapa set catatan sumber daya yang memiliki kombinasi nama dan jenis yang sama, seperti beberapa set catatan sumber daya tertimbang bernama acme.example.com yang memiliki tipe A. Dalam grup set catatan sumber daya yang memiliki nama dan tipe yang sama, nilai `SetIdentifier` harus unik untuk setiap set catatan sumber daya.  
Untuk informasi tentang kebijakan perutean, lihat [Memilih kebijakan perutean di Panduan](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) *Pengembang Amazon Route 53*.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ SetIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-setidentifier)` properti tipe `AWS::Route53::RecordSetGroup` `RecordSet` data.

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

### Contoh Konfigurasi Route 53
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example"></a>

Contoh ini menunjukkan cara mengonfigurasi Route 53.

#### YAML
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
    EvaluateTargetHealth: true
    DistributionDomainName: xyz
```

# AWS::Serverless::LayerVersion
<a name="sam-resource-layerversion"></a>

Membuat Lambda LayerVersion yang berisi pustaka atau kode runtime yang dibutuhkan oleh Fungsi Lambda.

[AWS::Serverless::LayerVersion](#sam-resource-layerversion)Resource juga mendukung atribut `Metadata` resource, sehingga Anda dapat menginstruksikan AWS SAM untuk membangun layer yang disertakan dalam aplikasi Anda. Untuk informasi selengkapnya tentang membangun lapisan, lihat [Membangun lapisan Lambda di AWS SAM](building-layers.md).

**Catatan Penting**: Karena rilis atribut [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)resource di CloudFormation, [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html)(disarankan) menawarkan manfaat yang sama seperti[AWS::Serverless::LayerVersion](#sam-resource-layerversion).

Ketika Tanpa Server LayerVersion diubah, SAM juga mengubah id logis sumber daya sehingga yang lama LayerVersions tidak dihapus secara otomatis CloudFormation ketika sumber daya diperbarui.

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaksis
<a name="sam-resource-layerversion-syntax"></a>

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

### YAML
<a name="sam-resource-layerversion-syntax.yaml"></a>

```
Type: AWS::Serverless::LayerVersion
Properties:
  [CompatibleArchitectures](#sam-layerversion-compatiblearchitectures): List
  [CompatibleRuntimes](#sam-layerversion-compatibleruntimes): List
  [ContentUri](#sam-layerversion-contenturi): String | LayerContent
  [Description](#sam-layerversion-description): String
  [LayerName](#sam-layerversion-layername): String
  [LicenseInfo](#sam-layerversion-licenseinfo): String
  [PublishLambdaVersion](#sam-layerversion-PublishLambdaVersion): Boolean
  [RetentionPolicy](#sam-layerversion-retentionpolicy): String
```

## Sifat-sifat
<a name="sam-resource-layerversion-properties"></a>

 `CompatibleArchitectures`   <a name="sam-layerversion-compatiblearchitectures"></a>
Menentukan arsitektur set instruksi yang didukung untuk versi lapisan.  
*Untuk informasi selengkapnya tentang properti ini, lihat [Arsitektur set instruksi Lambda di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) Pengembang.AWS Lambda *  
*Nilai valid:* `x86_64`, `arm64`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*: `x86_64`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CompatibleArchitectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures)` properti `AWS::Lambda::LayerVersion` sumber daya.

 `CompatibleRuntimes`   <a name="sam-layerversion-compatibleruntimes"></a>
Daftar runtime yang kompatibel dengan ini LayerVersion.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CompatibleRuntimes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes)` properti `AWS::Lambda::LayerVersion` sumber daya.

 `ContentUri`   <a name="sam-layerversion-contenturi"></a>
Amazon S3 Uri, jalur ke folder lokal, atau LayerContent objek kode lapisan.  
[Jika Uri atau objek Amazon S3 disediakan, LayerContent Objek Amazon S3 yang direferensikan harus berupa arsip ZIP yang valid yang berisi konten lapisan Lambda.](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)  
Jika jalur ke folder lokal disediakan, untuk konten yang akan diubah dengan benar templat harus melalui alur kerja yang mencakup [sam build](sam-cli-command-reference-sam-build.md) diikuti oleh salah satu [sam deploy](sam-cli-command-reference-sam-deploy.md) atau [sam package](sam-cli-command-reference-sam-package.md). Secara default, jalur relatif diselesaikan sehubungan dengan lokasi AWS SAM template.  
*Jenis*: String \$1 [LayerContent](sam-property-layerversion-layercontent.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Content](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content)` properti `AWS::Lambda::LayerVersion` sumber daya. Properti Amazon S3 nest diberi nama berbeda.

 `Description`   <a name="sam-layerversion-description"></a>
Deskripsi dari lapisan ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description)` properti `AWS::Lambda::LayerVersion` sumber daya.

 `LayerName`   <a name="sam-layerversion-layername"></a>
Amazon Resource Name (ARN) dari pengguna.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Sumber daya id logis  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[LayerName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername)` properti `AWS::Lambda::LayerVersion` sumber daya. Jika Anda tidak menentukan nama, id logis dari sumber daya akan digunakan sebagai nama.

 `LicenseInfo`   <a name="sam-layerversion-licenseinfo"></a>
Informasi tentang lisensi untuk ini LayerVersion.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LicenseInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo)` properti `AWS::Lambda::LayerVersion` sumber daya.

 `PublishLambdaVersion`   <a name="sam-layerversion-PublishLambdaVersion"></a>
Properti opt-in yang membuat versi Lambda baru setiap kali ada perubahan dalam sumber daya yang direferensikan`LayerVersion`. Ketika diaktifkan dengan `AutoPublishAlias` dan `AutoPublishAliasAllProperties` dalam fungsi Lambda yang terhubung, akan ada versi Lambda baru yang dibuat untuk setiap perubahan yang dilakukan pada sumber daya. `LayerVersion`  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RetentionPolicy`   <a name="sam-layerversion-retentionpolicy"></a>
Properti ini menentukan apakah versi lama Anda `LayerVersion` dipertahankan atau dihapus saat Anda menghapus sumber daya. Jika Anda perlu mempertahankan versi lama `LayerVersion` saat memperbarui atau mengganti sumber daya, Anda harus mengaktifkan `UpdateReplacePolicy` atribut tersebut. Untuk informasi tentang melakukan hal ini, lihat [`UpdateReplacePolicy`atribut](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) dalam *Panduan AWS CloudFormation Pengguna*.  
*Nilai yang valid*: `Retain` atau `Delete`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: Saat Anda menentukan`Retain`, AWS SAM tambahkan a [Atribut sumber daya yang didukung oleh AWS SAM](sam-specification-resource-attributes.md) dari `DeletionPolicy: Retain` ke `AWS::Lambda::LayerVersion` sumber daya yang diubah.

## Nilai Pengembalian
<a name="sam-resource-layerversion-return-values"></a>

### Ref
<a name="sam-resource-layerversion-return-values-ref"></a>

Ketika ID logis dari sumber daya ini disediakan untuk fungsi `Ref` intrinsik, ia mengembalikan ARN sumber daya dari Lambda yang mendasarinya. LayerVersion

Untuk informasi lebih lanjut tentang menggunakan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

## Contoh
<a name="sam-resource-layerversion--examples"></a>

### LayerVersionExample
<a name="sam-resource-layerversion--examples--layerversionexample"></a>

Contoh dari LayerVersion

#### YAML
<a name="sam-resource-layerversion--examples--layerversionexample--yaml"></a>

```
Properties:
  LayerName: MyLayer
  Description: Layer description
  ContentUri: 's3://sam-s3-demo-bucket/my-layer.zip'
  CompatibleRuntimes:
    - nodejs10.x
    - nodejs12.x
  LicenseInfo: 'Available under the MIT-0 license.'
  RetentionPolicy: Retain
```

# LayerContent
<a name="sam-property-layerversion-layercontent"></a>

Arsip ZIP yang berisi konten lapisan [lapisan Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).

## Sintaksis
<a name="sam-property-layerversion-layercontent-syntax"></a>

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

### YAML
<a name="sam-property-layerversion-layercontent-syntax.yaml"></a>

```
  [Bucket](#sam-layerversion-layercontent-bucket): String
  [Key](#sam-layerversion-layercontent-key): String
  [Version](#sam-layerversion-layercontent-version): String
```

## Sifat-sifat
<a name="sam-property-layerversion-layercontent-properties"></a>

 `Bucket`   <a name="sam-layerversion-layercontent-bucket"></a>
Bucket Amazon S3 dari arsip lapisan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3bucket)` properti tipe `AWS::Lambda::LayerVersion` `Content` data.

 `Key`   <a name="sam-layerversion-layercontent-key"></a>
Kunci Amazon S3 dari arsip lapisan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3key)` properti tipe `AWS::Lambda::LayerVersion` `Content` data.

 `Version`   <a name="sam-layerversion-layercontent-version"></a>
Untuk objek berversi, versi objek arsip lapisan yang digunakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion)` properti tipe `AWS::Lambda::LayerVersion` `Content` data.

## Contoh
<a name="sam-property-layerversion-layercontent--examples"></a>

### LayerContent
<a name="sam-property-layerversion-layercontent--examples--layercontent"></a>

Contoh konten lapisan

#### YAML
<a name="sam-property-layerversion-layercontent--examples--layercontent--yaml"></a>

```
LayerContent:
  Bucket: amzn-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# AWS::Serverless::SimpleTable
<a name="sam-resource-simpletable"></a>

Membuat tabel DynamoDB dengan kunci primer atribut tunggal. Hal ini berguna ketika data hanya perlu diakses melalui kunci primer.

Untuk fitur yang lebih canggih, gunakan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html)sumber daya di CloudFormation. Sumber daya ini dapat digunakan di. AWS SAM Mereka komprehensif dan memberikan kustomisasi lebih lanjut, termasuk [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html)dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html)kustomisasi.

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaks
<a name="sam-resource-simpletable-syntax"></a>

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

### YAML
<a name="sam-resource-simpletable-syntax.yaml"></a>

```
Type: AWS::Serverless::SimpleTable
Properties:
  PointInTimeRecoverySpecification: [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html)
  [PrimaryKey](#sam-simpletable-primarykey): PrimaryKeyObject
  [ProvisionedThroughput](#sam-simpletable-provisionedthroughput): ProvisionedThroughputObject
  [SSESpecification](#sam-simpletable-ssespecification): [SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html)
  [TableName](#sam-simpletable-tablename): String
  [Tags](#sam-simpletable-tags): Map
```

## Sifat-sifat
<a name="sam-resource-simpletable-properties"></a>

 `PointInTimeRecoverySpecification`   <a name="sam-simpletable-pointintimerecoveryspecification"></a>
Pengaturan yang digunakan untuk mengaktifkan pemulihan titik waktu.  
*Jenis*: [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html)` properti `AWS::DynamoDB::Table` sumber daya.

 `PrimaryKey`   <a name="sam-simpletable-primarykey"></a>
Nama dan tipe atribut yang akan digunakan sebagai kunci primer tabel. Jika tidak tersedia, kunci primer akan menjadi `String` dengan nilai `id`.  
Nilai properti ini tidak dapat diubah setelah sumber daya ini dibuat.
*Jenis*: [PrimaryKeyObject](sam-property-simpletable-primarykeyobject.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ProvisionedThroughput`   <a name="sam-simpletable-provisionedthroughput"></a>
Baca dan tulis informasi penyediaan throughput.  
Jika `ProvisionedThroughput` tidak ditentukan `BillingMode` akan ditentukan sebagai `PAY_PER_REQUEST`.  
*Jenis*: [ProvisionedThroughputObject](sam-property-simpletable-provisionedthroughputobject.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html)` properti `AWS::DynamoDB::Table` sumber daya.

 `SSESpecification`   <a name="sam-simpletable-ssespecification"></a>
Menentukan pengaturan untuk mengaktifkan enkripsi sisi server.  
*Jenis*: [SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html)` properti `AWS::DynamoDB::Table` sumber daya.

 `TableName`   <a name="sam-simpletable-tablename"></a>
Nama untuk tabel DynamoDB.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TableName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename)` properti `AWS::DynamoDB::Table` sumber daya.

 `Tags`   <a name="sam-simpletable-tags"></a>
Sebuah peta (string ke string) yang menentukan tag yang akan ditambahkan ke ini SimpleTable. Untuk detail tentang kunci dan nilai tag yang valid, lihat [Tag sumber daya](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) di *Panduan AWS CloudFormation Pengguna*.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags)` properti `AWS::DynamoDB::Table` sumber daya. Properti Tags di SAM terdiri dari pasangan Key:Value; di CloudFormation dalamnya terdiri dari daftar objek Tag.

## Nilai Pengembalian
<a name="sam-resource-simpletable-return-values"></a>

### Ref
<a name="sam-resource-simpletable-return-values-ref"></a>

Bila ID logis dari sumber daya ini disediakan untuk fungsi intrinsik Ref, ID mengembalikan nama sumber daya dari tabel DynamoDB utama.

Untuk informasi lebih lanjut tentang menggunakan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

## Contoh
<a name="sam-resource-simpletable--examples"></a>

### SimpleTableExample
<a name="sam-resource-simpletable--examples--simpletableexample"></a>

Contoh dari SimpleTable

#### YAML
<a name="sam-resource-simpletable--examples--simpletableexample--yaml"></a>

```
Properties:
  TableName: my-table
  PrimaryKey:
    Name: MyPrimaryKey
    Type: String
  ProvisionedThroughput:
    ReadCapacityUnits: 5
    WriteCapacityUnits: 5
  Tags:
    Department: Engineering
    AppType: Serverless
```

# PrimaryKeyObject
<a name="sam-property-simpletable-primarykeyobject"></a>

Objek yang menggambarkan properti kunci primer.

## Sintaksis
<a name="sam-property-simpletable-primarykeyobject-syntax"></a>

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

### YAML
<a name="sam-property-simpletable-primarykeyobject-syntax.yaml"></a>

```
  [Name](#sam-simpletable-primarykeyobject-name): String
  [Type](#sam-simpletable-primarykeyobject-type): String
```

## Sifat-sifat
<a name="sam-property-simpletable-primarykeyobject-properties"></a>

 `Name`   <a name="sam-simpletable-primarykeyobject-name"></a>
Nama atribut dari kunci primer.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AttributeName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename)` properti tipe `AWS::DynamoDB::Table` `AttributeDefinition` data.  
*Catatan tambahan*: Properti ini juga diteruskan ke [AttributeName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-attributename)properti tipe `AWS::DynamoDB::Table KeySchema` data.

 `Type`   <a name="sam-simpletable-primarykeyobject-type"></a>
Tipe data untuk kunci primer.  
*Nilai yang valid*:`String`,`Number`, `Binary`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AttributeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename-attributetype)` properti tipe `AWS::DynamoDB::Table` `AttributeDefinition` data.

## Contoh
<a name="sam-property-simpletable-primarykeyobject--examples"></a>

### PrimaryKey
<a name="sam-property-simpletable-primarykeyobject--examples--primarykey"></a>

Contoh kunci primer.

#### YAML
<a name="sam-property-simpletable-primarykeyobject--examples--primarykey--yaml"></a>

```
Properties:
  PrimaryKey:
    Name: MyPrimaryKey
    Type: String
```

# ProvisionedThroughputObject
<a name="sam-property-simpletable-provisionedthroughputobject"></a>

Objek yang menggambarkan sifat-sifat throughput yang disediakan.

## Sintaksis
<a name="sam-property-simpletable-provisionedthroughputobject-syntax"></a>

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

### YAML
<a name="w2aac13c22c41c19b5b5"></a>

```
  [ReadCapacityUnits](#sam-simpletable-provisionedthroughputobject-readcapacityunits): Integer
  [WriteCapacityUnits](#sam-simpletable-provisionedthroughputobject-writecapacityunits): Integer
```

## Sifat-sifat
<a name="sam-property-simpletable-provisionedthroughputobject-properties"></a>

 `ReadCapacityUnits`   <a name="sam-simpletable-provisionedthroughputobject-readcapacityunits"></a>
Jumlah maksimum pembacaan yang sangat konsisten yang dikonsumsi per detik sebelum DynamoDB mengembalikan `ThrottlingException`.  
*Tipe*: Integer  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ReadCapacityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html#aws-properties-dynamodb-table-provisionedthroughput-properties)` properti tipe `AWS::DynamoDB::Table` `ProvisionedThroughput` data.

 `WriteCapacityUnits`   <a name="sam-simpletable-provisionedthroughputobject-writecapacityunits"></a>
Jumlah penulisan maksimum yang dikonsumsi per detik sebelum DynamoDB mengembalikan `ThrottlingException`.  
*Tipe*: Integer  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[WriteCapacityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html#aws-properties-dynamodb-table-provisionedthroughput-properties)` properti tipe `AWS::DynamoDB::Table` `ProvisionedThroughput` data.

## Contoh
<a name="sam-property-simpletable-provisionedthroughputobject--examples"></a>

### ProvisionedThroughput
<a name="sam-property-simpletable-provisionedthroughputobject--examples--provisionedthroughput"></a>

Contoh throughput yang disediakan.

#### YAML
<a name="sam-property-simpletable-provisionedthroughputobject--examples--provisionedthroughput--yaml"></a>

```
Properties:
   ProvisionedThroughput:
     ReadCapacityUnits: 5
     WriteCapacityUnits: 5
```

# AWS::Serverless::StateMachine
<a name="sam-resource-statemachine"></a>

Membuat mesin AWS Step Functions status, yang dapat Anda gunakan untuk mengatur AWS Lambda fungsi dan AWS sumber daya lainnya untuk membentuk alur kerja yang kompleks dan kuat.

Untuk informasi selengkapnya, lihat Step Functions dalam [Panduan Developer AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html).

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaks
<a name="sam-resource-statemachine-syntax"></a>

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

### YAML
<a name="sam-resource-statemachine-syntax.yaml"></a>

```
Type: AWS::Serverless::StateMachine
Properties:
  AutoPublishAlias: String
  UseAliasAsEventTarget: Boolean
  [Definition](#sam-statemachine-definition): Map
  [DefinitionSubstitutions](#sam-statemachine-definitionsubstitutions): Map
  [DefinitionUri](#sam-statemachine-definitionuri): String | [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)
  DeploymentPreference: [DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)
  [Events](#sam-statemachine-events): EventSource
  [Logging](#sam-statemachine-logging): [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)
  [Name](#sam-statemachine-name): String
  [PermissionsBoundary](#sam-statemachine-permissionsboundary): String
  [Policies](#sam-statemachine-policies): String | List | Map
  PropagateTags: Boolean
  [RolePath](#sam-statemachine-rolepath): String
  [Role](#sam-statemachine-role): String
  [Tags](#sam-statemachine-tags): Map
  [Tracing](#sam-statemachine-tracing): [TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)
  [Type](#sam-statemachine-type): String
```

## Sifat-sifat
<a name="sam-resource-statemachine-properties"></a>

 `AutoPublishAlias`   <a name="sam-statemachine-autopublishalias"></a>
Nama alias mesin negara. *Untuk mempelajari selengkapnya tentang penggunaan alias mesin status Step Functions, lihat [Mengelola penerapan berkelanjutan dengan versi dan alias](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) di Panduan Pengembang.AWS Step Functions *  
Gunakan `DeploymentPreference` untuk mengonfigurasi preferensi penerapan untuk alias Anda. Jika Anda tidak menentukan`DeploymentPreference`, AWS SAM akan mengkonfigurasi lalu lintas untuk beralih ke versi mesin status yang lebih baru sekaligus.  
AWS SAM menetapkan versi `DeletionPolicy` dan `UpdateReplacePolicy` ke secara `Retain` default. Versi sebelumnya tidak akan dihapus secara otomatis.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke ` [ Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-name)` properti `AWS::StepFunctions::StateMachineAlias` sumber daya.

 `UseAliasAsEventTarget`   <a name="sam-statemachine-usealiasaseventtarget"></a>
Tunjukkan apakah akan meneruskan alias, yang dibuat dengan menggunakan `AutoPublishAlias` properti, ke target sumber peristiwa yang ditentukan dengan [Peristiwa](#sam-statemachine-events).  
Tentukan `True` untuk menggunakan alias sebagai target acara.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Definition`   <a name="sam-statemachine-definition"></a>
Definisi mesin status adalah objek, di mana format objek cocok dengan format file AWS SAM template Anda, misalnya, JSON atau YAMAL. Ketentuan mesin status mematuhi [Bahasa Status Amazon](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).  
Untuk contoh ketentuan mesin status inline, lihat [Contoh](#sam-resource-statemachine--examples).  
Anda harus menyediakan `Definition` atau `DefinitionUri`.  
*Tipe*: Peta  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `DefinitionSubstitutions`   <a name="sam-statemachine-definitionsubstitutions"></a>
 string-to-stringPeta yang menentukan pemetaan untuk variabel placeholder dalam definisi mesin status. Hal ini memungkinkan Anda untuk memasukkan nilai-nilai yang diperoleh pada saat waktu aktif (misalnya, dari fungsi intrinsik) ke dalam ketentuan mesin status.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DefinitionSubstitutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions)` properti `AWS::StepFunctions::StateMachine` sumber daya. Jika ada fungsi intrinsik yang ditentukan dalam definisi mesin status inline, AWS SAM tambahkan entri ke properti ini untuk menyuntikkannya ke dalam definisi mesin status.

 `DefinitionUri`   <a name="sam-statemachine-definitionuri"></a>
URI Amazon Simple Storage Service (Amazon S3) atau jalur file lokal dari ketentuan mesin status yang ditulis di [Bahasa Status Amazon](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).  
Jika Anda memberikan jalur file lokal, templat harus melalui alur kerja yang mencakup perintah `sam deploy` atau `sam package` untuk mengubah ketentuan dengan benar. Untuk melakukannya, Anda harus menggunakan CLI AWS SAM versi 0.52.0 atau yang lebih baru.  
Anda harus memberikan `Definition` atau `DefinitionUri`.  
*Tipe*: String \$1 [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DefinitionS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `DeploymentPreference`   <a name="sam-statemachine-deploymentpreference"></a>
Pengaturan yang mengaktifkan dan mengonfigurasi penerapan mesin status bertahap. *Untuk mempelajari selengkapnya tentang penerapan bertahap Step Functions, lihat [Mengelola penerapan berkelanjutan dengan versi dan alias](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) di Panduan Pengembang.AWS Step Functions *  
Tentukan `AutoPublishAlias` sebelum mengkonfigurasi properti ini. `DeploymentPreference`Pengaturan Anda akan diterapkan ke alias yang ditentukan dengan`AutoPublishAlias`.  
Saat Anda menentukan`DeploymentPreference`, AWS SAM menghasilkan nilai `StateMachineVersionArn` sub-properti secara otomatis.  
*Jenis*: [DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: AWS SAM menghasilkan dan melampirkan nilai `StateMachineVersionArn` properti ke `DeploymentPreference` dan meneruskan `DeploymentPreference` ke `[DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-deploymentpreference)` properti `AWS::StepFunctions::StateMachineAlias` sumber daya. 

 `Events`   <a name="sam-statemachine-events"></a>
Menentukan peristiwa yang memicu mesin status ini. Peristiwa terdiri dari tipe dan satu set properti yang bergantung pada tipenya.  
*Jenis*: [EventSource](sam-property-statemachine-statemachineeventsource.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Logging`   <a name="sam-statemachine-logging"></a>
Menentukan peristiwa riwayat eksekusi mana yang dicatat dan tempatnya dicatat.  
*Jenis*: [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `Name`   <a name="sam-statemachine-name"></a>
Nama mesin status.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StateMachineName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `PermissionsBoundary`   <a name="sam-statemachine-permissionsboundary"></a>
ARN batas izin untuk digunakan untuk peran eksekusi mesin status ini. Properti ini hanya bekerja jika peran tersebut dibuat untuk Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` properti `AWS::IAM::Role` sumber daya.

 `Policies`   <a name="sam-statemachine-policies"></a>
Kebijakan izin untuk mesin negara bagian ini. Kebijakan akan ditambahkan ke peran eksekusi default mesin negara AWS Identity and Access Management (IAM).  
Properti ini menerima satu nilai atau daftar nilai. Nilai yang diizinkan meliputi:  
+ [AWS SAM templat kebijakan](serverless-policy-templates.md).
+ Kebijakan ARN [AWS terkelola atau kebijakan](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) yang [dikelola pelanggan](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ Nama kebijakan AWS terkelola dari [daftar](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json) berikut.
+ [Kebijakan IAM sebaris](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies) yang diformat YAML sebagai peta.
Jika Anda menyetel `Role` properti, properti ini diabaikan.
*Tipe*: String \$1 Daftar \$1 Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`PropagateTags`  <a name="sam-statemachine-propagatetags"></a>
Tunjukkan apakah akan meneruskan tag dari `Tags` properti ke sumber daya yang Anda [AWS::Serverless::StateMachine](sam-specification-generated-resources-statemachine.md) hasilkan atau tidak. Tentukan `True` untuk menyebarkan tag di sumber daya yang Anda hasilkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Role`   <a name="sam-statemachine-role"></a>
ARN IAM role untuk digunakan sebagai peran eksekusi mesin status ini.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `RolePath`   <a name="sam-statemachine-rolepath"></a>
Jalur ke peran eksekusi IAM mesin negara.  
Gunakan properti ini saat peran dibuat untuk Anda. Jangan gunakan saat peran ditentukan dengan `Role` properti.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` properti `AWS::IAM::Role` sumber daya.

 `Tags`   <a name="sam-statemachine-tags"></a>
 string-to-stringPeta yang menentukan tag yang ditambahkan ke mesin status dan peran eksekusi yang sesuai. Untuk informasi tentang kunci dan nilai tag yang valid, lihat properti [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags) dari [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html)sumber daya.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags)` properti `AWS::StepFunctions::StateMachine` sumber daya. AWS SAM secara otomatis menambahkan `stateMachine:createdBy:SAM` tag ke sumber daya ini, dan ke peran default yang dihasilkan untuknya.

 `Tracing`   <a name="sam-statemachine-tracing"></a>
Memilih apakah diaktifkan atau AWS X-Ray tidak untuk mesin status. Untuk informasi lebih lanjut tentang menggunakan X-Ray dengan Step Function, lihat [AWS X-Ray dan Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-xray-tracing.html) di *Panduan Developer AWS Step Functions *.  
*Jenis*: [TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `Type`   <a name="sam-statemachine-type"></a>
Tipe mesin status.  
*Nilai yang valid*: `STANDARD` atau `EXPRESS`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `STANDARD`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StateMachineType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype)` properti `AWS::StepFunctions::StateMachine` sumber daya.

## Nilai Pengembalian
<a name="sam-resource-statemachine-return-values"></a>

### Ref
<a name="sam-resource-statemachine-return-values-ref"></a>

Bila Anda memberikan ID logis dari sumber daya ini ke fungsi intrinsik Ref, Ref mengembalikan Amazon Resource Name (ARN) dari sumber daya `AWS::StepFunctions::StateMachine`utama.

Untuk informasi lebih lanjut tentang penggunaan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

### Fn:: GetAtt
<a name="sam-resource-statemachine-return-values-fn--getatt"></a>

`Fn::GetAtt` mengembalikan nilai untuk atribut yang ditentukan dari jenis ini. Berikut ini adalah atribut yang tersedia dan nilai-nilai kembali sampel. 

Untuk informasi lebih lanjut cara menggunakan `Fn::GetAtt`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) di *Panduan Pengguna AWS CloudFormation * 

`Name`  <a name="Name-fn::getatt"></a>
Mengembalikan nama mesin status, seperti `HelloWorld-StateMachine`.

## Contoh
<a name="sam-resource-statemachine--examples"></a>

### File Ketentuan Mesin Status
<a name="sam-resource-statemachine--examples--state-machine-definition-file"></a>

Berikut ini adalah contoh definisi mesin status inline yang memungkinkan fungsi lambda untuk memanggil mesin status. Perhatikan bahwa contoh ini mengharapkan `Role` properti untuk mengonfigurasi kebijakan yang tepat untuk mengizinkan pemanggilan. File `my_state_machine.asl.json` harus ditulis dalam [Bahasa Status Amazon](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).

Dalam contoh ini, `DefinitionSubstitution` entri memungkinkan mesin negara untuk menyertakan sumber daya yang dideklarasikan dalam file AWS SAM template.

#### YAML
<a name="sam-resource-statemachine--examples--state-machine-definition-file--yaml"></a>

```
MySampleStateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    DefinitionUri: statemachine/my_state_machine.asl.json
    Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
    Tracing:
      Enabled: true
    DefinitionSubstitutions:
      MyFunctionArn: !GetAtt MyFunction.Arn
      MyDDBTable: !Ref TransactionTable
```

### Ketentuan Mesin Status Inline
<a name="sam-resource-statemachine--examples--inline-state-machine-definition"></a>

Berikut ini adalah contoh dari ketentuan mesin status inline.

Dalam contoh ini, file AWS SAM template ditulis dalam YAMAL, sehingga definisi mesin status juga dalam YAMAL. Untuk mendeklarasikan definisi mesin status inline di JSON, tulis file AWS SAM template Anda di JSON.

#### YAML
<a name="sam-resource-statemachine--examples--inline-state-machine-definition--yaml"></a>

```
MySampleStateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Definition:
      StartAt: MyLambdaState
      States:
        MyLambdaState:
          Type: Task
          Resource: arn:aws:lambda:us-east-1:123456123456:function:my-sample-lambda-app
          End: true
    Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
    Tracing:
      Enabled: true
```

# EventSource
<a name="sam-property-statemachine-statemachineeventsource"></a>

Objek yang menggambarkan sumber peristiwa yang memicu mesin status. Setiap peristiwa terdiri dari tipe dan satu set properti yang bergantung pada tipe itu. Untuk informasi lebih lanjut tentang properti dari setiap sumber peristiwa, lihat subtopik yang sesuai dengan tipe tersebut.

## Sintaksis
<a name="sam-property-statemachine-statemachineeventsource-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineeventsource-syntax.yaml"></a>

```
  [Properties](#sam-statemachine-statemachineeventsource-properties): Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | Api
  [Type](#sam-statemachine-statemachineeventsource-type): String
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachineeventsource-properties"></a>

 `Properties`   <a name="sam-statemachine-statemachineeventsource-properties"></a>
Sebuah objek yang menggambarkan properti pemetaan peristiwa ini. Set properti harus sesuai dengan `Type` yang ditentukan.  
*Jenis*[: [Jadwal](sam-property-statemachine-statemachineschedule.md) \$1 [ScheduleV2 \$1](sam-property-statemachine-statemachineschedulev2.md) \$1 \$1 Api [CloudWatchEvent[EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md)](sam-property-statemachine-statemachinecloudwatchevent.md)](sam-property-statemachine-statemachineapi.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-statemachine-statemachineeventsource-type"></a>
Jenis peristiwa.  
*Nilai yang valid*:`Api`,`Schedule`,`ScheduleV2`,`CloudWatchEvent`, `EventBridgeRule`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-statemachineeventsource--examples"></a>

### API
<a name="sam-property-statemachine-statemachineeventsource--examples--api"></a>

Berikut adalah contoh peristiwa dari tipe `API` ini.

#### YAML
<a name="sam-property-statemachine-statemachineeventsource--examples--api--yaml"></a>

```
ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi
```

# Api
<a name="sam-property-statemachine-statemachineapi"></a>

Objek yang menggambarkan tipe sumber peristiwa `Api`. Jika sumber daya [AWS::Serverless::Api](sam-resource-api.md) didefinisikan, nilai jalur dan metode harus sesuai dengan operasi dalam ketentuan OpenAPI API. 

## Sintaksis
<a name="sam-property-statemachine-statemachineapi-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineapi-syntax.yaml"></a>

```
  [Auth](#sam-statemachine-statemachineapi-auth): ApiStateMachineAuth
  [Method](#sam-statemachine-statemachineapi-method): String
  [Path](#sam-statemachine-statemachineapi-path): String
  [RestApiId](#sam-statemachine-statemachineapi-restapiid): String
  UnescapeMappingTemplate: Boolean
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachineapi-properties"></a>

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
Konfigurasi otorisasi untuk API, jalur, dan metode ini.  
Gunakan properti ini untuk membatalkan pengaturan `DefaultAuthorizer` API untuk jalur individu, ketika `DefaultAuthorizer` tidak ditentukan, atau untuk membatalkan pengaturan `ApiKeyRequired` default.  
*Jenis*: [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
Metode HTTP yang membuat fungsi ini dipanggil.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
Jalur URI yang membuat fungsi ini dipanggil. Nilai harus dimulai dengan `/`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
Pengenal sumber daya `RestApi`, yang harus berisi operasi dengan jalur dan metode yang diberikan. Biasanya, ini diatur untuk merujuk sumber daya [AWS::Serverless::Api](sam-resource-api.md) yang ditentukan dalam templat ini.  
Jika Anda tidak mendefinisikan properti ini, AWS SAM buat [AWS::Serverless::Api](sam-resource-api.md) sumber daya default menggunakan `OpenApi` dokumen yang dihasilkan. Sumber daya tersebut berisi penyatuan dari semua jalur dan metode yang ditentukan oleh peristiwa `Api` dalam templat yang sama yang tidak menentukan `RestApiId`.  
Properti ini tidak dapat merujuk sumber daya [AWS::Serverless::Api](sam-resource-api.md) yang ditentukan dalam templat lain.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Menghapus tanda kutip tunggal, dengan mengganti `\'` dengan`'`, pada input yang diteruskan ke mesin status. Gunakan saat masukan Anda berisi tanda kutip tunggal.  
Jika disetel ke `False` dan input Anda berisi tanda kutip tunggal, kesalahan akan terjadi.
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: Salah  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-statemachineapi--examples"></a>

### ApiEvent
<a name="sam-property-statemachine-statemachineapi--examples--apievent"></a>

Berikut adalah contoh peristiwa dari tipe `Api` ini.

#### YAML
<a name="sam-property-statemachine-statemachineapi--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
```

# ApiStateMachineAuth
<a name="sam-property-statemachine-apistatemachineauth"></a>

Mengonfigurasi otorisasi di tingkat peristiwa, untuk API, jalur, dan metode tertentu.

## Sintaksis
<a name="sam-property-statemachine-apistatemachineauth-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-apistatemachineauth-syntax.yaml"></a>

```
  [ApiKeyRequired](#sam-statemachine-apistatemachineauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-statemachine-apistatemachineauth-authorizationscopes): List
  [Authorizer](#sam-statemachine-apistatemachineauth-authorizer): String
  [ResourcePolicy](#sam-statemachine-apistatemachineauth-resourcepolicy): ResourcePolicyStatement
```

## Sifat-sifat
<a name="sam-property-statemachine-apistatemachineauth-properties"></a>

 `ApiKeyRequired`   <a name="sam-statemachine-apistatemachineauth-apikeyrequired"></a>
Memerlukan kunci API untuk API, jalur, dan metode ini.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AuthorizationScopes`   <a name="sam-statemachine-apistatemachineauth-authorizationscopes"></a>
Cakupan otorisasi yang akan diterapkan ke API, path, dan metode ini.  
Cakupan yang Anda tentukan akan membatalkan setiap cakupan yang diterapkan oleh properti `DefaultAuthorizer` jika Anda telah menentukannya.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Authorizer`   <a name="sam-statemachine-apistatemachineauth-authorizer"></a>
`Authorizer` untuk mesin status tertentu.  
Jika Anda telah menentukan otorisasi global untuk API dan ingin membuat mesin status ini menjadi publik, batalkan otoritas global dengan menetapkan `Authorizer` ke `NONE`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ResourcePolicy`   <a name="sam-statemachine-apistatemachineauth-resourcepolicy"></a>
Konfigurasikan kebijakan sumber daya untuk API dan jalur ini.  
*Jenis*: [ResourcePolicyStatement](sam-property-statemachine-resourcepolicystatement.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-apistatemachineauth--examples"></a>

### StateMachine-Auth
<a name="sam-property-statemachine-apistatemachineauth--examples--statemachine-auth"></a>

Contoh berikut menentukan otorisasi di tingkat mesin status.

#### YAML
<a name="sam-property-statemachine-apistatemachineauth--examples--statemachine-auth--yaml"></a>

```
Auth:
  ApiKeyRequired: true
  Authorizer: NONE
```

# ResourcePolicyStatement
<a name="sam-property-statemachine-resourcepolicystatement"></a>

Mengonfigurasi kebijakan sumber daya untuk semua metode dan jalur API. Untuk informasi selengkapnya tentang kebijakan sumber daya, lihat [Mengendalikan akses ke API dengan kebijakan sumber daya API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) di *Panduan Developer API Gateway*.

## Sintaksis
<a name="sam-property-statemachine-resourcepolicystatement-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-resourcepolicystatement-syntax.yaml"></a>

```
  [AwsAccountBlacklist](#sam-statemachine-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-statemachine-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-statemachine-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-statemachine-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-statemachine-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-statemachine-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-statemachine-resourcepolicystatement-sourcevpcwhitelist): List
```

## Sifat-sifat
<a name="sam-property-statemachine-resourcepolicystatement-properties"></a>

 `AwsAccountBlacklist`   <a name="sam-statemachine-resourcepolicystatement-awsaccountblacklist"></a>
 AWS Akun yang akan diblokir.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AwsAccountWhitelist`   <a name="sam-statemachine-resourcepolicystatement-awsaccountwhitelist"></a>
 AWS Akun untuk memungkinkan. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CustomStatements`   <a name="sam-statemachine-resourcepolicystatement-customstatements"></a>
Daftar pernyataan kebijakan sumber daya kustom untuk diterapkan ke API ini. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcBlacklist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist"></a>
Daftar virtual private cloud (VPCs) yang akan diblokir, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcWhitelist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Daftar VPCs to allow, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceBlacklist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist"></a>
Daftar VPC endpoint yang akan diblokir, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceWhitelist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist"></a>
Daftar VPC endpoint yang akan diizinkan, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeBlacklist`   <a name="sam-statemachine-resourcepolicystatement-iprangeblacklist"></a>
Alamat IP atau jangkauan alamat yang akan diblokir. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeWhitelist`   <a name="sam-statemachine-resourcepolicystatement-iprangewhitelist"></a>
Alamat IP atau jangkauan alamat yang akan diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcBlacklist`   <a name="sam-statemachine-resourcepolicystatement-sourcevpcblacklist"></a>
Sumber VPC atau VPC endpoint yang akan diblokir. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcWhitelist`   <a name="sam-statemachine-resourcepolicystatement-sourcevpcwhitelist"></a>
VPC sumber atau VPC endpoint yang akan diizinkan. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-resourcepolicystatement--examples"></a>

### Contoh Kebijakan Sumber Daya
<a name="sam-property-statemachine-resourcepolicystatement--examples--resource-policy-example"></a>

Contoh berikut memblokir dua alamat IP dan VPC sumber, dan memungkinkan akun AWS .

#### YAML
<a name="sam-property-statemachine-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# CloudWatchEvent
<a name="sam-property-statemachine-statemachinecloudwatchevent"></a>

Objek yang menggambarkan tipe sumber peristiwa `CloudWatchEvent`.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)sumber daya saat jenis acara ini disetel.

**Catatan Penting**: [EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md) adalah jenis sumber acara yang disukai untuk digunakan, bukan`CloudWatchEvent`. `EventBridgeRule`dan `CloudWatchEvent` menggunakan layanan, API, dan CloudFormation sumber daya dasar yang sama. Namun, AWS SAM akan menambahkan dukungan untuk fitur baru hanya untuk`EventBridgeRule`.

## Sintaksis
<a name="sam-property-statemachine-statemachinecloudwatchevent-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachinecloudwatchevent-syntax.yaml"></a>

```
  [EventBusName](#sam-statemachine-statemachinecloudwatchevent-eventbusname): String
  [Input](#sam-statemachine-statemachinecloudwatchevent-input): String
  [InputPath](#sam-statemachine-statemachinecloudwatchevent-inputpath): String
  [Pattern](#sam-statemachine-statemachinecloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachinecloudwatchevent-properties"></a>

 `EventBusName`   <a name="sam-statemachine-statemachinecloudwatchevent-eventbusname"></a>
Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Bus peristiwa default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` properti `AWS::Events::Rule` sumber daya.

 `Input`   <a name="sam-statemachine-statemachinecloudwatchevent-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `InputPath`   <a name="sam-statemachine-statemachinecloudwatchevent-inputpath"></a>
Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti `InputPath` untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` properti `AWS::Events::Rule Target` sumber daya.

 `Pattern`   <a name="sam-statemachine-statemachinecloudwatchevent-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [Peristiwa dan Pola Peristiwa EventBridge di](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` properti `AWS::Events::Rule` sumber daya.

## Contoh
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples"></a>

### CloudWatchEvent
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples--cloudwatchevent"></a>

Berikut adalah contoh peristiwa dari tipe sumber peristiwa `CloudWatchEvent`.

#### YAML
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples--cloudwatchevent--yaml"></a>

```
CWEvent:
  Type: CloudWatchEvent
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running
```

# EventBridgeRule
<a name="sam-property-statemachine-statemachineeventbridgerule"></a>

Objek yang menjelaskan jenis sumber `EventBridgeRule` peristiwa, yang menetapkan mesin status Anda sebagai target untuk EventBridge aturan Amazon. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) di *Panduan EventBridge Pengguna Amazon*.

AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)daya saat jenis acara ini disetel.

## Sintaksis
<a name="sam-property-statemachine-statemachineeventbridgerule-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineeventbridgerule-syntax.yaml"></a>

```
  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  Pattern: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  RetryPolicy: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String
  State: String
  Target: Target
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachineeventbridgerule-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineeventbridgerule-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [DeadLetterConfig](sam-property-statemachine-statemachinedeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` properti tipe `AWS::Events::Rule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `EventBusName`   <a name="sam-statemachine-statemachineeventbridgerule-eventbusname"></a>
Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Bus peristiwa default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` properti `AWS::Events::Rule` sumber daya.

 `Input`   <a name="sam-statemachine-statemachineeventbridgerule-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `InputPath`   <a name="sam-statemachine-statemachineeventbridgerule-inputpath"></a>
Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti `InputPath` untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` properti `AWS::Events::Rule Target` sumber daya.

`InputTransformer`  <a name="sam-statemachine-statemachineeventbridgerule-inputtransformer"></a>
Pengaturan untuk memungkinkan Anda memberikan input kustom ke target berdasarkan data peristiwa tertentu. Anda dapat mengekstrak satu atau beberapa pasangan nilai kunci dari peristiwa dan kemudian menggunakan data tersebut untuk mengirim input yang disesuaikan ke target. Untuk informasi selengkapnya, lihat [Transformasi EventBridge input Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) *di Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html) ` properti tipe `AWS::Events::Rule` `Target` data.

 `Pattern`   <a name="sam-statemachine-statemachineeventbridgerule-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [Peristiwa dan Pola Peristiwa EventBridge di](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` properti `AWS::Events::Rule` sumber daya.

 `RetryPolicy`   <a name="sam-statemachine-statemachineeventbridgerule-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` properti tipe `AWS::Events::Rule` `Target` data.

 `RuleName`   <a name="sam-statemachine-statemachineeventbridgerule-rulename"></a>
Nama aturan .  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` properti `AWS::Events::Rule` sumber daya.

`State`  <a name="sam-statemachine-statemachineeventbridgerule-state"></a>
Keadaan aturan.  
*Nilai yang valid*: `[ DISABLED | ENABLED ]`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya.

 `Target`   <a name="sam-statemachine-statemachineeventbridgerule-target"></a>
Sumber AWS daya yang EventBridge dipanggil ketika aturan dipicu. Anda dapat menggunakan properti ini untuk menentukan ID logis dari target. Jika properti ini tidak ditentukan, maka AWS SAM menghasilkan ID logis dari target.  
*Tipe*: [Target](sam-property-statemachine-statemachinetarget.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` properti `AWS::Events::Rule` sumber daya. Versi AWS SAM properti ini hanya mengizinkan Anda untuk menentukan ID logis dari satu target.

## Contoh
<a name="sam-property-statemachine-statemachineeventbridgerule--examples"></a>

### EventBridgeRule
<a name="sam-property-statemachine-statemachineeventbridgerule--examples--eventbridgerule"></a>

Berikut adalah contoh tipe sumber peristiwa `EventBridgeRule`.

#### YAML
<a name="sam-property-statemachine-statemachineeventbridgerule--examples--eventbridgerule--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
```

# DeadLetterConfig
<a name="sam-property-statemachine-statemachinedeadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Ininvokasi dapat gagal, misalnya, ketika mengirim sebuah peristiwa ke status mesin yang tidak ada, izin yang tidak mencukupi untuk memanggil status mesin. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *

## Sintaksis
<a name="sam-property-statemachine-statemachinedeadletterconfig-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachinedeadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-statemachine-statemachinedeadletterconfig-arn): String
  [QueueLogicalId](#sam-statemachine-statemachinedeadletterconfig-queuelogicalid): String
  [Type](#sam-statemachine-statemachinedeadletterconfig-type): String
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachinedeadletterconfig-properties"></a>

 `Arn`   <a name="sam-statemachine-statemachinedeadletterconfig-arn"></a>
Amazon Resource Name (ARN) dari antrean Amazon SQS yang ditetapkan sebagai target antrean surat mati.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` properti tipe `AWS::Events::Rule` `DeadLetterConfig` data.

 `QueueLogicalId`   <a name="sam-statemachine-statemachinedeadletterconfig-queuelogicalid"></a>
Nama kustom antrian huruf mati yang AWS SAM menciptakan if `Type` ditentukan.  
Jika `Type` properti tidak disetel, properti ini diabaikan.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-statemachine-statemachinedeadletterconfig-type"></a>
Tipe antrean. Ketika properti ini disetel, AWS SAM secara otomatis membuat [antrean huruf mati dan melampirkan kebijakan berbasis sumber daya yang diperlukan untuk memberikan izin untuk mengatur sumber daya](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) untuk mengirim peristiwa ke antrian.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Nilai yang valid*: `SQS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-statemachine-statemachinetarget"></a>

Mengkonfigurasi AWS sumber daya yang EventBridge dipanggil ketika aturan dipicu.

## Sintaksis
<a name="sam-property-statemachine-statemachinetarget-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachinetarget-syntax.yaml"></a>

```
  [Id](#sam-statemachine-statemachinetarget-id): String
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachinetarget-properties"></a>

 `Id`   <a name="sam-statemachine-statemachinetarget-id"></a>
ID logis dari target.  
Nilai dari `Id` dapat mencakup karakter alfanumerik, titik (`.`), tanda hubung (`-`), dan garis bawah (`_`).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` properti tipe `AWS::Events::Rule` `Target` data.

## Contoh
<a name="sam-property-statemachine-statemachinetarget--examples"></a>

### Target
<a name="sam-property-statemachine-statemachinetarget--examples--target"></a>

#### YAML
<a name="sam-property-statemachine-statemachinetarget--examples--target--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```

# Schedule
<a name="sam-property-statemachine-statemachineschedule"></a>

Objek yang menjelaskan jenis sumber `Schedule` peristiwa, yang menetapkan mesin status Anda sebagai target EventBridge aturan yang memicu jadwal. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) di *Panduan EventBridge Pengguna Amazon*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)sumber daya saat jenis acara ini disetel.

## Sintaksis
<a name="sam-property-statemachine-statemachineschedule-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineschedule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-statemachine-statemachineschedule-deadletterconfig): DeadLetterConfig
  [Description](#sam-statemachine-statemachineschedule-description): String
  [Enabled](#sam-statemachine-statemachineschedule-enabled): Boolean
  [Input](#sam-statemachine-statemachineschedule-input): String
  [Name](#sam-statemachine-statemachineschedule-name): String
  [RetryPolicy](#sam-statemachine-statemachineschedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  [RoleArn](#sam-statemachine-statemachineschedulev-rolearn): String
  [Schedule](#sam-statemachine-statemachineschedule-schedule): String
  [State](#sam-statemachine-statemachineschedule-state): String
  Target: Target
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachineschedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedule-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` properti tipe `AWS::Events::Rule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `Description`   <a name="sam-statemachine-statemachineschedule-description"></a>
Deskripsi aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` properti `AWS::Events::Rule` sumber daya.

 `Enabled`   <a name="sam-statemachine-statemachineschedule-enabled"></a>
Menunjukkan apakah aturan diaktifkan.  
Untuk menonaktifkan aturan, tetapkan properti ini ke `false`.  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya. Jika properti ini diatur untuk `true` kemudian AWS SAM lolos`ENABLED`, jika tidak maka akan lewat`DISABLED`.

 `Input`   <a name="sam-statemachine-statemachineschedule-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `Name`   <a name="sam-statemachine-statemachineschedule-name"></a>
Nama aturan . Jika Anda tidak menentukan nama, CloudFormation buat ID fisik unik dan gunakan ID tersebut untuk nama aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` properti `AWS::Events::Rule` sumber daya.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedule-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` properti tipe `AWS::Events::Rule` `Target` data.

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev-rolearn"></a>
ARN dari peran IAM yang akan digunakan EventBridge Scheduler untuk target saat jadwal dipanggil.  
*Jenis*: [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Diperlukan*: Tidak. Jika tidak disediakan, peran baru akan dibuat dan digunakan.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `Schedule`   <a name="sam-statemachine-statemachineschedule-schedule"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering aturan dijalankan. Untuk informasi lebih lanjut, lihat [Ekspresi Jadwal untuk Aturan](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` properti `AWS::Events::Rule` sumber daya.

 `State`   <a name="sam-statemachine-statemachineschedule-state"></a>
Keadaan aturan.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya.

 `Target`   <a name="sam-statemachine-statemachineschedule-target"></a>
Sumber AWS daya yang EventBridge dipanggil ketika aturan dipicu. Anda dapat menggunakan properti ini untuk menentukan ID logis dari target. Jika properti ini tidak ditentukan, maka AWS SAM menghasilkan ID logis dari target.  
*Tipe*: [Target](sam-property-statemachine-statemachinetarget.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` properti `AWS::Events::Rule` sumber daya. AWS SAM Versi properti ini hanya memungkinkan Anda untuk menentukan ID logis dari satu target.

## Contoh
<a name="sam-property-statemachine-statemachineschedule--examples"></a>

### CloudWatch Jadwal Acara
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Jadwal Contoh Acara

#### YAML
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event--yaml"></a>

```
CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false
```

# DeadLetterConfig
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Ininvokasi dapat gagal, misalnya, ketika mengirim sebuah peristiwa ke status mesin yang tidak ada, izin yang tidak mencukupi untuk memanggil status mesin. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *

## Sintaksis
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-statemachine-statemachinescheduledeadletterconfig-arn): String
  [QueueLogicalId](#sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid): String
  [Type](#sam-statemachine-statemachinescheduledeadletterconfig-type): String
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig-properties"></a>

 `Arn`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-arn"></a>
Amazon Resource Name (ARN) dari antrean Amazon SQS yang ditetapkan sebagai target antrean surat mati.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` properti tipe `AWS::Events::Rule` `DeadLetterConfig` data.

 `QueueLogicalId`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid"></a>
Nama kustom antrian huruf mati yang AWS SAM menciptakan if `Type` ditentukan.  
Jika `Type` properti tidak disetel, properti ini diabaikan.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-type"></a>
Tipe antrean. Ketika properti ini disetel, AWS SAM secara otomatis membuat [antrean huruf mati dan melampirkan kebijakan berbasis sumber daya yang diperlukan untuk memberikan izin untuk mengatur sumber daya](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) untuk mengirim peristiwa ke antrian.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Nilai yang valid*: `SQS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-statemachine-statemachinescheduletarget"></a>

Mengkonfigurasi AWS sumber daya yang EventBridge dipanggil ketika aturan dipicu.

## Sintaksis
<a name="sam-property-statemachine-statemachinescheduletarget-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachinescheduletarget-syntax.yaml"></a>

```
  [Id](#sam-statemachine-statemachinescheduletarget-id): String
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachinescheduletarget-properties"></a>

 `Id`   <a name="sam-statemachine-statemachinescheduletarget-id"></a>
ID logis dari target.  
Nilai dari `Id` dapat mencakup karakter alfanumerik, titik (`.`), tanda hubung (`-`), dan garis bawah (`_`).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` properti tipe `AWS::Events::Rule` `Target` data.

## Contoh
<a name="sam-property-statemachine-statemachinescheduletarget--examples"></a>

### Target
<a name="sam-property-statemachine-statemachinescheduletarget--examples--target"></a>

#### YAML
<a name="sam-property-statemachine-statemachinescheduletarget--examples--target--yaml"></a>

```
EBRule:
  Type: Schedule
  Properties:
    Target:
      Id: MyTarget
```

# ScheduleV2
<a name="sam-property-statemachine-statemachineschedulev2"></a>

Objek yang menjelaskan jenis sumber `ScheduleV2` peristiwa, yang menetapkan mesin status Anda sebagai target peristiwa Amazon EventBridge Scheduler yang dipicu pada jadwal. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge Scheduler?](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html) di *Panduan Pengguna EventBridge Penjadwal*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html)sumber daya saat jenis acara ini disetel.

## Sintaksis
<a name="sam-property-statemachine-statemachineschedulev2-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineschedulev2-syntax.yaml"></a>

```
DeadLetterConfig: DeadLetterConfig
[Description](#sam-statemachine-statemachineschedulev2-description): String
[EndDate](#sam-statemachine-statemachineschedulev2-enddate): String
[FlexibleTimeWindow](#sam-statemachine-statemachineschedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-statemachine-statemachineschedulev2-groupname): String
[Input](#sam-statemachine-statemachineschedulev2-input): String
[KmsKeyArn](#sam-statemachine-statemachineschedulev2-kmskeyarn): String
[Name](#sam-statemachine-statemachineschedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-statemachine-statemachineschedulev2-permissionsboundary): String
[RetryPolicy](#sam-statemachine-statemachineschedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-statemachine-statemachineschedulev2-rolearn): String
[ScheduleExpression](#sam-statemachine-statemachineschedulev2-scheduleexpression): String
[ScheduleExpressionTimezone](#sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-statemachine-statemachineschedulev2-startdate): String
[State](#sam-statemachine-statemachineschedulev2-state): String
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachineschedulev2-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedulev2-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Mengonfigurasi antrian huruf mati untuk EventBridge Penjadwal di Panduan Pengguna Penjadwal](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html). EventBridge *  
*Jenis*: [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)` properti tipe `AWS::Scheduler::Schedule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `Description`   <a name="sam-statemachine-statemachineschedulev2-description"></a>
Deskripsi jadwal.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)` properti `AWS::Scheduler::Schedule` sumber daya.

 `EndDate`   <a name="sam-statemachine-statemachineschedulev2-enddate"></a>
Tanggal, di UTC, sebelum jadwal dapat memanggil targetnya. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin berhenti, atau sebelum, yang Anda tentukan**EndDate**.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` properti `AWS::Scheduler::Schedule` sumber daya.

 `FlexibleTimeWindow`   <a name="sam-statemachine-statemachineschedulev2-flexibletimewindow"></a>
Mengizinkan konfigurasi jendela di mana jadwal dapat dipanggil.  
*Jenis*: [FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler.html#cfn-scheduler-schedule-flexibletimewindow)` properti `AWS::Scheduler::Schedule` sumber daya.

 `GroupName`   <a name="sam-statemachine-statemachineschedulev2-groupname"></a>
Nama grup jadwal untuk dikaitkan dengan jadwal ini. Jika tidak ditentukan, grup default digunakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` properti `AWS::Scheduler::Schedule` sumber daya.

 `Input`   <a name="sam-statemachine-statemachineschedulev2-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` properti `AWS::Scheduler::Schedule Target` sumber daya.

 `KmsKeyArn`   <a name="sam-statemachine-statemachineschedulev2-kmskeyarn"></a>
ARN untuk Kunci KMS yang akan digunakan untuk mengenkripsi data pelanggan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` properti `AWS::Scheduler::Schedule` sumber daya.

 `Name`   <a name="sam-statemachine-statemachineschedulev2-name"></a>
Nama jadwal. Jika Anda tidak menentukan nama, AWS SAM buat nama dalam format `StateMachine-Logical-IDEvent-Source-Name` dan gunakan ID tersebut untuk nama jadwal.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` properti `AWS::Scheduler::Schedule` sumber daya.

`OmitName`  <a name="sam-statemachine-statemachineschedulev2-omitname"></a>
Secara default, AWS SAM menghasilkan dan menggunakan nama jadwal dalam format*<State-machine-logical-ID><event-source-name>*. Tetapkan properti ini `true` agar CloudFormation menghasilkan ID fisik yang unik dan gunakan itu untuk nama jadwal sebagai gantinya.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PermissionsBoundary`   <a name="sam-statemachine-statemachineschedulev2-permissionsboundary"></a>
ARN kebijakan yang digunakan untuk mengatur batas izin untuk peran.  
Jika `PermissionsBoundary` didefinisikan, AWS SAM akan menerapkan batasan yang sama untuk peran IAM target jadwal penjadwal.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` properti `AWS::IAM::Role` sumber daya.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedulev2-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi.  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev2-rolearn"></a>
ARN dari peran IAM yang akan digunakan EventBridge Scheduler untuk target saat jadwal dipanggil.  
*Jenis*: [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `ScheduleExpression`   <a name="sam-statemachine-statemachineschedulev2-scheduleexpression"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering jadwal berjalan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` properti `AWS::Scheduler::Schedule` sumber daya.

 `ScheduleExpressionTimezone`   <a name="sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone"></a>
Zona waktu di mana ekspresi penjadwalan dievaluasi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` properti `AWS::Scheduler::Schedule` sumber daya.

 `StartDate`   <a name="sam-statemachine-statemachineschedulev2-startdate"></a>
Tanggal, di UTC, setelah itu jadwal dapat mulai memanggil target. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin terjadi pada, atau setelah, yang Anda tentukan**StartDate**.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` properti `AWS::Scheduler::Schedule` sumber daya.

 `State`   <a name="sam-statemachine-statemachineschedulev2-state"></a>
Status jadwal.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)` properti `AWS::Scheduler::Schedule` sumber daya.

## Contoh
<a name="sam-property-statemachine-statemachineschedulev2--examples"></a>

### Contoh dasar mendefinisikan sumber daya ScheduleV2
<a name="sam-property-statemachine-statemachineschedulev2--examples--example1"></a>

```
StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    Events:
      ScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: "rate(1 minute)"
      ComplexScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: rate(1 minute)
          FlexibleTimeWindow:
            Mode: FLEXIBLE
            MaximumWindowInMinutes: 5
          StartDate: '2022-12-28T12:00:00.000Z'
          EndDate: '2023-01-28T12:00:00.000Z'
          ScheduleExpressionTimezone: UTC
          RetryPolicy:
            MaximumRetryAttempts: 5
            MaximumEventAgeInSeconds: 300
          DeadLetterConfig:
            Type: SQS
    DefinitionUri:
      Bucket: sam-sam-s3-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction
```

# CloudFormation Sumber daya yang dihasilkan untuk AWS SAM
<a name="sam-specification-generated-resources"></a>

Bagian ini memberikan rincian tentang CloudFormation sumber daya yang dibuat saat AWS SAM memproses AWS template Anda. Kumpulan CloudFormation sumber daya yang AWS SAM menghasilkan berbeda tergantung pada skenario yang Anda tentukan. *Skenario* adalah kombinasi dari sumber daya AWS SAM dan properti yang ditentukan dalam file templat Anda. Anda dapat mereferensikan sumber daya CloudFormation yang dibuat di tempat lain dalam file templat Anda, mirip dengan cara Anda mereferensikan sumber daya yang Anda deklarasikan secara eksplisit dalam file templat Anda.

Misalnya, jika Anda menentukan sumber daya `AWS::Serverless::Function` di file templat AWS SAM Anda, AWS SAM selalu membuat sebuah sumber daya dasar `AWS::Lambda::Function`. Jika Anda juga menentukan `AutoPublishAlias` properti opsional, AWS SAM juga menghasilkan `AWS::Lambda::Alias` dan `AWS::Lambda::Version` sumber daya.

Bagian ini mencantumkan skenario dan CloudFormation sumber daya yang dihasilkannya, dan menunjukkan cara mereferensikan CloudFormation sumber daya yang dihasilkan dalam file AWS SAM templat Anda.

## Referensi sumber daya yang dihasilkan CloudFormation
<a name="sam-specification-generated-resources-referencing"></a>

Anda memiliki dua opsi untuk mereferensikan CloudFormation sumber daya yang dihasilkan dalam file AWS SAM template Anda, oleh `LogicalId` atau dengan properti yang dapat direferensikan.

### Referensi CloudFormation sumber daya yang dihasilkan oleh LogicalId
<a name="sam-specification-generated-resources-referencing-logicalid"></a>

 CloudFormation Sumber daya yang AWS SAM menghasilkan masing-masing memiliki`[LogicalId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-logicalid)`, yang merupakan pengidentifikasi alfanumerik (A-Z, a-z, 0-9) yang unik dalam file template. AWS SAM menggunakan AWS SAM sumber `LogicalIds` daya dalam file template Anda untuk membangun CloudFormation sumber daya `LogicalIds` yang dihasilkannya. Anda dapat menggunakan sumber daya yang dihasilkan untuk mengakses properti CloudFormation sumber daya tersebut dalam file template Anda, seperti yang Anda lakukan untuk CloudFormation sumber daya yang telah Anda deklarasikan secara eksplisit. `LogicalId` Untuk informasi selengkapnya tentang `LogicalIds` di CloudFormation dan AWS SAM templat, lihat [Sumber daya](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html) di *Panduan AWS CloudFormation Pengguna*.

**catatan**  
Parameter `LogicalIds` dari beberapa sumber daya yang dibuat mencakup nilai hash unik untuk menghindari konflik namespace. Parameter `LogicalIds` dari sumber daya ini berasal ketika tumpukan dibuat. Anda dapat mengambilnya hanya setelah tumpukan dibuat menggunakan Konsol Manajemen AWS, AWS CLI, atau salah satu. AWS SDKs Kami tidak menyarankan mereferensikan sumber daya ini dengan `LogicalId` karena nilai hash mungkin berubah.

### Merujuk CloudFormation sumber daya yang dihasilkan oleh properti yang dapat direferensikan
<a name="sam-specification-generated-resources-referencing-referenceable-property"></a>

Untuk beberapa sumber daya yang dihasilkan, AWS SAM sediakan properti sumber daya yang dapat direferensikan. AWS SAM Anda dapat menggunakan properti ini untuk mereferensikan CloudFormation sumber daya yang dihasilkan dan propertinya dalam file AWS SAM template Anda.

**catatan**  
Tidak semua CloudFormation sumber daya yang dihasilkan memiliki properti yang dapat direferensikan. Untuk sumber daya tersebut, Anda harus menggunakan `LogicalId`.

## Skenario CloudFormation sumber daya yang dihasilkan
<a name="sam-specification-generated-resources-scenarios"></a>

Tabel berikut merangkum AWS SAM sumber daya dan properti yang membentuk skenario yang menghasilkan CloudFormation sumber daya. Topik di kolom **Skenario** memberikan rincian tentang CloudFormation sumber daya tambahan yang AWS SAM dihasilkan untuk skenario itu.


| AWS SAM sumber daya |  CloudFormation Sumber daya dasar | Skenario | 
| --- | --- | --- | 
| AWS::Serverless::Api  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::Application  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::CapacityProvider  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::Function | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::HttpApi | [AWS::ApiGatewayV2::Api](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::LayerVersion  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::SimpleTable  | [AWS::DynamoDB::Table](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::StateMachine  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 

**Topics**
+ [Referensi sumber daya yang dihasilkan CloudFormation](#sam-specification-generated-resources-referencing)
+ [Skenario CloudFormation sumber daya yang dihasilkan](#sam-specification-generated-resources-scenarios)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Api ditentukan](sam-specification-generated-resources-api.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Application ditentukan](sam-specification-generated-resources-application.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::CapacityProvider ditentukan](sam-specification-generated-resources-capacityprovider.md)
+ [CloudFormation sumber daya yang dihasilkan saat Anda menentukan AWS::Serverless::Connector](sam-specification-generated-resources-connector.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Function ditentukan](sam-specification-generated-resources-function.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::GraphQLApi ditentukan](sam-specification-generated-resources-graphqlapi.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::HttpApi ditentukan](sam-specification-generated-resources-httpapi.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::LayerVersion ditentukan](sam-specification-generated-resources-layerversion.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::SimpleTable ditentukan](sam-specification-generated-resources-simpletable.md)
+ [CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::StateMachine ditentukan](sam-specification-generated-resources-statemachine.md)

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Api ditentukan
<a name="sam-specification-generated-resources-api"></a>

Ketika `AWS::Serverless::Api` ditentukan, AWS Serverless Application Model (AWS SAM) selalu menghasilkan CloudFormation sumber daya `AWS::ApiGateway::RestApi` dasar. Selain itu, ini juga selalu membuat `AWS::ApiGateway::Stage` dan sebuah sumber daya `AWS::ApiGateway::Deployment`.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`<api‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::ApiGateway::Stage`**  
*`LogicalId`: *`<api‑LogicalId><stage‑name>Stage`  
`<stage‑name>` adalah string dari properti `StageName` yang diatur kepadanya. Misalnya, jika Anda mengatur `StageName` ke `Gamma`, sehingga `LogicalId` adalah `MyRestApiGammaStage`.  
*Properti yang dapat direferensikan: *`<api‑LogicalId>.Stage`

**`AWS::ApiGateway::Deployment`**  
*`LogicalId`: *`<api‑LogicalId>Deployment<sha>`  
`<sha>` adalah nilai hash unik yang dibuat ketika tumpukan dibuat. Misalnya, `MyRestApiDeployment926eeb5ff1`.  
*Properti yang dapat direferensikan: *`<api‑LogicalId>.Deployment`

Selain CloudFormation sumber daya ini, ketika `AWS::Serverless::Api` ditentukan, AWS SAM menghasilkan CloudFormation sumber daya tambahan untuk skenario berikut.

**Topics**
+ [DomainName properti ditentukan](#sam-specification-generated-resources-api-domain-name)
+ [UsagePlan properti ditentukan](#sam-specification-generated-resources-api-usage-plan)

## DomainName properti ditentukan
<a name="sam-specification-generated-resources-api-domain-name"></a>

Ketika `DomainName` properti `Domain` properti `AWS::Serverless::Api` ditentukan, AWS SAM menghasilkan `AWS::ApiGateway::DomainName` CloudFormation sumber daya.

**`AWS::ApiGateway::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainName<sha>`  
`<sha>` adalah nilai hash unik yang dibuat ketika tumpukan dibuat. Sebagai contoh: `ApiGatewayDomainName926eeb5ff1`.  
*Properti yang dapat direferensikan: *`<api‑LogicalId>.DomainName`

## UsagePlan properti ditentukan
<a name="sam-specification-generated-resources-api-usage-plan"></a>

Ketika `UsagePlan` properti properti `AWS::Serverless::Api` ditentukan, AWS SAM menghasilkan CloudFormation sumber daya berikut:`AWS::ApiGateway::UsagePlan`,`AWS::ApiGateway::UsagePlanKey`, dan`AWS::ApiGateway::ApiKey`. `Auth`

**`AWS::ApiGateway::UsagePlan`**  
*`LogicalId`: *`<api‑LogicalId>UsagePlan`  
*Properti yang dapat direferensikan: *`<api‑LogicalId>.UsagePlan`

**`AWS::ApiGateway::UsagePlanKey`**  
*`LogicalId`: *`<api‑LogicalId>UsagePlanKey`  
*Properti yang dapat direferensikan: *`<api‑LogicalId>.UsagePlanKey`

**`AWS::ApiGateway::ApiKey`**  
*`LogicalId`: *`<api‑LogicalId>ApiKey`  
*Properti yang dapat direferensikan: *`<api‑LogicalId>.ApiKey`

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Application ditentukan
<a name="sam-specification-generated-resources-application"></a>

Ketika `AWS::Serverless::Application` ditentukan, AWS Serverless Application Model (AWS SAM) menghasilkan sumber CloudFormation daya `AWS::CloudFormation::Stack` dasar.

**`AWS::CloudFormation::Stack`**  
*`LogicalId`: *`<application‑LogicalId>`   
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::CapacityProvider ditentukan
<a name="sam-specification-generated-resources-capacityprovider"></a>

Saat `AWS::Serverless::CapacityProvider` ditentukan, AWS Serverless Application Model (AWS SAM) membuat sebuah `AWS::Lambda::CapacityProvider` dari sumber daya CloudFormation dasar.

**`AWS::Lambda::CapacityProvider`**  
*`LogicalId`: *`<capacityprovider‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Selain CloudFormation sumber daya ini, ketika `AWS::Serverless::CapacityProvider` ditentukan, AWS SAM juga menghasilkan CloudFormation sumber daya untuk skenario berikut:

**Topics**
+ [OperatorRole properti tidak ditentukan](#sam-specification-generated-resources-capacityprovider-iam-role)

## OperatorRole properti tidak ditentukan
<a name="sam-specification-generated-resources-capacityprovider-iam-role"></a>

Ketika `OperatorRole` properti dari sebuah *tidak `AWS::Serverless::CapacityProvider`* ditentukan, AWS SAM menghasilkan `AWS::IAM::Role` CloudFormation sumber daya dengan kebijakan `AWSLambdaManagedEC2ResourceOperator` terkelola terlampir.

**`AWS::IAM::Role`**  
*`LogicalId`: *`<capacityprovider‑LogicalId>OperatorRole`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

# CloudFormation sumber daya yang dihasilkan saat Anda menentukan AWS::Serverless::Connector
<a name="sam-specification-generated-resources-connector"></a>

**catatan**  
Ketika Anda mendefinisikan konektor melalui `Connectors` properti tertanam, pertama-tama diubah menjadi `AWS::Serverless::Connector` sumber daya sebelum menghasilkan sumber daya ini.

Saat Anda menentukan `AWS::Serverless::Connector` sumber daya dalam AWS SAM templat, AWS SAM hasilkan AWS CloudFormation sumber daya berikut sesuai kebutuhan.

**`AWS::IAM::ManagedPolicy`**  
 *`LogicalId`:*`<connector‑LogicalId>Policy`   
 *Properti yang dapat direferensikan:* N/A (Untuk mereferensikan CloudFormation sumber daya ini, Anda harus menggunakan.) `LogicalId` 

**`AWS::SNS::TopicPolicy`**  
 *`LogicalId`:*`<connector‑LogicalId>TopicPolicy`   
 *Properti yang dapat direferensikan:* N/A (Untuk mereferensikan CloudFormation sumber daya ini, Anda harus menggunakan.) `LogicalId` 

**`AWS::SQS::QueuePolicy`**  
 *`LogicalId`:*`<connector‑LogicalId>QueuePolicy`   
 *Properti yang dapat direferensikan:* N/A (Untuk mereferensikan CloudFormation sumber daya ini, Anda harus menggunakan.) `LogicalId` 

**`AWS::Lambda::Permission`**  
 *`LogicalId`:*`<connector‑LogicalId><permission>LambdaPermission`   
 `<permission>`adalah izin yang ditentukan oleh `Permissions` properti. Misalnya, `Write`.   
*Properti yang dapat direferensikan:* N/A (Untuk mereferensikan CloudFormation sumber daya ini, Anda harus menggunakan.) `LogicalId` 

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::Function ditentukan
<a name="sam-specification-generated-resources-function"></a>

Ketika `AWS::Serverless::Function` ditentukan, AWS Serverless Application Model (AWS SAM) selalu membuat CloudFormation sumber daya `AWS::Lambda::Function` dasar.

**`AWS::Lambda::Function`**  
*`LogicalId`: *`<function‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Selain CloudFormation sumber daya ini, ketika `AWS::Serverless::Function` ditentukan, AWS SAM juga menghasilkan CloudFormation sumber daya untuk skenario berikut.

**Topics**
+ [Properti fungsi inti](#sam-specification-generated-resources-function-core-properties)
+ [Sumber kejadian](#sam-specification-generated-resources-function-event-sources)
+ [Konfigurasi acara](#sam-specification-generated-resources-function-event-configuration)

## Properti fungsi inti
<a name="sam-specification-generated-resources-function-core-properties"></a>

Skenario berikut menghasilkan CloudFormation sumber daya berdasarkan properti fungsi inti:

### Properti peran tidak ditentukan
<a name="sam-specification-generated-resources-function-not-role"></a>

Ketika `Role` properti dari sebuah *tidak `AWS::Serverless::Function`* ditentukan, AWS SAM menghasilkan `AWS::IAM::Role` CloudFormation sumber daya.

**`AWS::IAM::Role`**  
*`LogicalId`: *`<function‑LogicalId>Role`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

### AutoPublishAlias properti ditentukan
<a name="sam-specification-generated-resources-function-autopublishalias"></a>

Ketika `AutoPublishAlias` properti `AWS::Serverless::Function` ditentukan, AWS SAM menghasilkan CloudFormation sumber daya berikut: `AWS::Lambda::Alias` dan`AWS::Lambda::Version`.

**`AWS::Lambda::Alias`**  
*`LogicalId`: *`<function‑LogicalId>Alias<alias‑name>`  
`<alias‑name>` adalah string dari `AutoPublishAlias` yang diatur kepadanya. Misalnya, jika Anda mengatur `AutoPublishAlias` ke`live`, `LogicalId` adalah: *MyFunction* Alias*live*.  
*Properti yang dapat direferensikan: *`<function‑LogicalId>.Alias`

**`AWS::Lambda::Version`**  
*`LogicalId`: *`<function‑LogicalId>Version<sha>`  
`<sha>` adalah nilai hash unik yang dibuat ketika tumpukan dibuat. Misalnya, *MyFunction* Versi*926eeb5ff1*.  
*Properti yang dapat direferensikan: *`<function‑LogicalId>.Version`

Untuk informasi tambahan tentang `AutoPublishAlias` properti, lihat [bagian Properti di AWS::Serverless::Function](sam-resource-function.md#sam-resource-function-properties).

### DeploymentPreference properti ditentukan
<a name="sam-specification-generated-resources-function-deploymentpreference"></a>

Ketika `DeploymentPreference` properti `AWS::Serverless::Function` ditentukan, AWS SAM menghasilkan sumber CloudFormation daya berikut: `AWS::CodeDeploy::Application` dan`AWS::CodeDeploy::DeploymentGroup`. Selain itu, jika `Role` properti `DeploymentPreference` objek *tidak* ditentukan, AWS SAM juga menghasilkan `AWS::IAM::Role` CloudFormation sumber daya.

**`AWS::CodeDeploy::Application`**  
*`LogicalId`: *`ServerlessDeploymentApplication`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::CodeDeploy::DeploymentGroup`**  
*`LogicalId`: *`<function‑LogicalId>DeploymentGroup`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::IAM::Role`**  
*`LogicalId`: *`CodeDeployServiceRole`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

### FunctionUrlConfig properti ditentukan
<a name="sam-specification-generated-resources-function-functionurlconfig"></a>

Ketika `FunctionUrlConfig` properti ditentukan, AWS SAM menghasilkan CloudFormation sumber daya yang berbeda berdasarkan`AuthType`.

Kapan `AuthType: NONE` ditentukan, AWS SAM menghasilkan CloudFormation sumber daya berikut:

**`AWS::Lambda::Permission`(Memanggil Akses)**  
*`LogicalId`: *`<function‑LogicalId>URLInvokeAllowPublicAccess`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::Lambda::Permission`(Akses Publik)**  
*`LogicalId`: *`<function‑LogicalId>UrlPublicPermissions`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::Lambda::Url`**  
*`LogicalId`: *`<function‑LogicalId>Url`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Kapan `AuthType: AWS_IAM` ditentukan, hanya AWS SAM menghasilkan:

**`AWS::Lambda::Url`**  
*`LogicalId`: *`<function‑LogicalId>Url`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Untuk informasi tambahan tentang `FunctionUrlConfig` properti, lihat [FunctionUrlConfig](sam-property-function-functionurlconfig.md).

## Sumber kejadian
<a name="sam-specification-generated-resources-function-event-sources"></a>

Skenario berikut menghasilkan CloudFormation sumber daya berdasarkan sumber acara:

### Sumber peristiwa Api ditentukan
<a name="sam-specification-generated-resources-function-api"></a>

Ketika `Event` properti `AWS::Serverless::Function` diatur ke`Api`, tetapi `RestApiId` properti *tidak* ditentukan, AWS SAM menghasilkan `AWS::ApiGateway::RestApi` CloudFormation sumber daya.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`ServerlessRestApi`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

### Sumber HttpApi acara ditentukan
<a name="sam-specification-generated-resources-function-httpapi"></a>

Ketika `Event` properti `AWS::Serverless::Function` diatur ke`HttpApi`, tetapi `ApiId` properti *tidak* ditentukan, AWS SAM menghasilkan `AWS::ApiGatewayV2::Api` CloudFormation sumber daya.

**`AWS::ApiGatewayV2::Api`**  
*`LogicalId`: *`ServerlessHttpApi`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

### Sumber peristiwa streaming ditentukan
<a name="sam-specification-generated-resources-function-streaming"></a>

Ketika `Event` properti `AWS::Serverless::Function` diatur ke salah satu jenis streaming, AWS SAM menghasilkan `AWS::Lambda::EventSourceMapping` CloudFormation sumber daya. Ini berlaku untuk jenis berikut: `DynamoDB`, `Kinesis`, `MQ`, `MSK`, dan `SQS`.

**`AWS::Lambda::EventSourceMapping`**  
*`LogicalId`: *`<function‑LogicalId><event‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

### Sumber event bridge (atau bus peristiwa) ditentukan
<a name="sam-specification-generated-resources-function-eventbridge"></a>

Ketika `Event` properti `AWS::Serverless::Function` disetel ke salah satu jenis jembatan peristiwa (atau bus acara), AWS SAM menghasilkan `AWS::Events::Rule` CloudFormation sumber daya. Ini berlaku untuk tipe berikut: `EventBridgeRule`, `Schedule`, dan `CloudWatchEvents`.

**`AWS::Events::Rule`**  
*`LogicalId`: *`<function‑LogicalId><event‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

### Sumber IotRule acara ditentukan
<a name="sam-specification-generated-resources-function-iotrule"></a>

Ketika `Event` properti dari `AWS::Serverless::Function` diatur ke IoTRule, AWS SAM menghasilkan `AWS::IoT::TopicRule` CloudFormation sumber daya.

**`AWS::IoT::TopicRule`**  
*`LogicalId`: *`<function‑LogicalId><event‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

## Konfigurasi acara
<a name="sam-specification-generated-resources-function-event-configuration"></a>

Skenario berikut menghasilkan CloudFormation sumber daya berdasarkan konfigurasi acara:

### OnSuccess (atau OnFailure) properti ditentukan untuk acara Amazon SNS
<a name="sam-specification-generated-resources-function-sns-onsuccess"></a>

Ketika `OnSuccess` (atau`OnFailure`) properti `DestinationConfig` properti properti ditentukan, dan jenis tujuan `AWS::Serverless::Function` adalah `SNS` tetapi ARN tujuan *tidak* ditentukan, AWS SAM menghasilkan CloudFormation sumber daya berikut: `AWS::Lambda::EventInvokeConfig` dan. `EventInvokeConfig` `AWS::SNS::Topic`

**`AWS::Lambda::EventInvokeConfig`**  
*`LogicalId`: *`<function‑LogicalId>EventInvokeConfig`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::SNS::Topic`**  
*`LogicalId`:* `<function‑LogicalId>OnSuccessTopic` (atau`<function‑LogicalId>OnFailureTopic`)  
*Properti yang dapat direferensikan: *`<function‑LogicalId>.DestinationTopic`  
Jika `OnSuccess` dan `OnFailure` telah ditentukan untuk peristiwa Amazon SNS, agar membedakan antara sumber daya yang dibuat, Anda harus menggunakan `LogicalId`.

### OnSuccess (atau OnFailure) properti ditentukan untuk peristiwa Amazon SQS
<a name="sam-specification-generated-resources-function-sqs-onsuccess"></a>

Ketika `OnSuccess` (atau`OnFailure`) properti `DestinationConfig` properti properti ditentukan, dan jenis tujuan `AWS::Serverless::Function` adalah `SQS` tetapi ARN tujuan *tidak* ditentukan, AWS SAM menghasilkan CloudFormation sumber daya berikut: `AWS::Lambda::EventInvokeConfig` dan. `EventInvokeConfig` `AWS::SQS::Queue`

**`AWS::Lambda::EventInvokeConfig`**  
*`LogicalId`: *`<function‑LogicalId>EventInvokeConfig`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::SQS::Queue`**  
*`LogicalId`:* `<function‑LogicalId>OnSuccessQueue` (atau`<function‑LogicalId>OnFailureQueue`)  
*Properti yang dapat direferensikan: *`<function‑LogicalId>.DestinationQueue`  
Jika `OnSuccess` dan `OnFailure` telah ditentukan untuk peristiwa Amazon SQS, agar membedakan antara sumber daya yang dibuat, Anda harus menggunakan `LogicalId`.

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::GraphQLApi ditentukan
<a name="sam-specification-generated-resources-graphqlapi"></a>

Saat Anda menentukan `AWS::Serverless::GraphQLApi` sumber daya dalam templat AWS Serverless Application Model (AWS SAM), AWS SAM selalu buat AWS CloudFormation sumber daya dasar berikut.

**`AWS::AppSync::DataSource`**  
*`LogicalId`: *`<graphqlapi-LogicalId><datasource-RelativeId><datasource-Type>DataSource`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::AppSync::FunctionConfiguration`**  
*`LogicalId`: *`<graphqlapi-LogicalId><function-RelativeId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::AppSync::GraphQLApi`**  
*`LogicalId`: *`<graphqlapi-LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::AppSync::GraphQLSchema`**  
*`LogicalId`: *`<graphqlapi-LogicalId>Schema`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

**`AWS::AppSync::Resolver`**  
*`LogicalId`: *`<graphqlapi-LogicalId><OperationType><resolver-RelativeId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Selain CloudFormation sumber daya ini, ketika `AWS::Serverless::GraphQLApi` ditentukan, juga AWS SAM dapat menghasilkan CloudFormation sumber daya berikut.

`AWS::AppSync::ApiCache`  
*`LogicalId`: *`<graphqlapi-LogicalId>ApiCache`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

`AWS::AppSync::ApiKey`  
*`LogicalId`: *`<graphqlapi-LogicalId><apikey-RelativeId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

`AWS::AppSync::DomainName`  
*`LogicalId`: *`<graphqlapi-LogicalId>DomainName`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

`AWS::AppSync::DomainNameApiAssociation`  
*`LogicalId`: *`<graphqlapi-LogicalId>DomainNameApiAssociation`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

AWS SAM juga dapat menggunakan `AWS::Serverless::Connector` sumber daya untuk memberikan izin. Lihat informasi yang lebih lengkap di [CloudFormation sumber daya yang dihasilkan saat Anda menentukan AWS::Serverless::Connector](sam-specification-generated-resources-connector.md).

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::HttpApi ditentukan
<a name="sam-specification-generated-resources-httpapi"></a>

Ketika `AWS::Serverless::HttpApi` ditentukan, AWS Serverless Application Model (AWS SAM) menghasilkan sumber CloudFormation daya `AWS::ApiGatewayV2::Api` dasar.

**`AWS::ApiGatewayV2::Api`**  
*`LogicalId`: *`<httpapi‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Selain CloudFormation sumber daya ini, ketika `AWS::Serverless::HttpApi` ditentukan, AWS SAM juga menghasilkan CloudFormation sumber daya untuk skenario berikut:

**Topics**
+ [StageName properti ditentukan](#sam-specification-generated-resources-httpapi-stage-name)
+ [StageName properti *tidak* ditentukan](#sam-specification-generated-resources-httpapi-not-stage-name)
+ [DomainName properti ditentukan](#sam-specification-generated-resources-httpapi-domain-name)

## StageName properti ditentukan
<a name="sam-specification-generated-resources-httpapi-stage-name"></a>

Ketika `StageName` properti `AWS::Serverless::HttpApi` ditentukan, AWS SAM menghasilkan `AWS::ApiGatewayV2::Stage` CloudFormation sumber daya.

**`AWS::ApiGatewayV2::Stage`**  
*`LogicalId`: *`<httpapi‑LogicalId><stage‑name>Stage`  
`<stage‑name>` adalah string dari properti `StageName` yang diatur kepadanya. Misalnya, jika Anda mengatur `StageName` ke`Gamma`, `LogicalId` adalah: *MyHttpApiGamma* Tahap.  
*Properti yang dapat direferensikan: *`<httpapi‑LogicalId>.Stage`

## StageName properti *tidak* ditentukan
<a name="sam-specification-generated-resources-httpapi-not-stage-name"></a>

Ketika `StageName` properti dari sebuah *tidak `AWS::Serverless::HttpApi`* ditentukan, AWS SAM menghasilkan `AWS::ApiGatewayV2::Stage` CloudFormation sumber daya.

**`AWS::ApiGatewayV2::Stage`**  
*`LogicalId`: *`<httpapi‑LogicalId>ApiGatewayDefaultStage`  
*Properti yang dapat direferensikan: *`<httpapi‑LogicalId>.Stage`

## DomainName properti ditentukan
<a name="sam-specification-generated-resources-httpapi-domain-name"></a>

Ketika `DomainName` properti `Domain` properti `AWS::Serverless::HttpApi` ditentukan, AWS SAM menghasilkan `AWS::ApiGatewayV2::DomainName` CloudFormation sumber daya.

**`AWS::ApiGatewayV2::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainNameV2<sha>`  
`<sha>` adalah nilai hash unik yang dibuat ketika tumpukan dibuat. Misalnya, `ApiGatewayDomainNameV2`*926eeb5ff1*.  
*Properti yang dapat direferensikan: *`<httpapi‑LogicalId>.DomainName`

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::LayerVersion ditentukan
<a name="sam-specification-generated-resources-layerversion"></a>

Ketika `AWS::Serverless::LayerVersion` ditentukan, AWS Serverless Application Model (AWS SAM) menghasilkan sumber CloudFormation daya `AWS::Lambda::LayerVersion` dasar.

**`AWS::Lambda::LayerVersion`**  
*`LogicalId`: *`<layerversion‑LogicalId>`   
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::SimpleTable ditentukan
<a name="sam-specification-generated-resources-simpletable"></a>

Ketika `AWS::Serverless::SimpleTable` ditentukan, AWS Serverless Application Model (AWS SAM) menghasilkan sumber CloudFormation daya `AWS::DynamoDB::Table` dasar.

**`AWS::DynamoDB::Table`**  
*`LogicalId`: *`<simpletable‑LogicalId>`   
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

# CloudFormation sumber daya yang dihasilkan saat AWS::Serverless::StateMachine ditentukan
<a name="sam-specification-generated-resources-statemachine"></a>

Saat `AWS::Serverless::StateMachine` ditentukan, AWS Serverless Application Model (AWS SAM) membuat sebuah `AWS::StepFunctions::StateMachine` dari sumber daya CloudFormation dasar.

**`AWS::StepFunctions::StateMachine`**  
*`LogicalId`: *`<statemachine‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

Selain CloudFormation sumber daya ini, ketika `AWS::Serverless::StateMachine` ditentukan, AWS SAM juga menghasilkan CloudFormation sumber daya untuk skenario berikut:

**Topics**
+ [Properti peran tidak ditentukan](#sam-specification-generated-resources-statemachine-not-role)
+ [Sumber peristiwa API ditentukan](#sam-specification-generated-resources-statemachine-api)
+ [Sumber event bridge (atau bus peristiwa) ditentukan](#sam-specification-generated-resources-statemachine-eventbridge)

## Properti peran tidak ditentukan
<a name="sam-specification-generated-resources-statemachine-not-role"></a>

Ketika `Role` properti dari sebuah *tidak `AWS::Serverless::StateMachine`* ditentukan, AWS SAM menghasilkan `AWS::IAM::Role` CloudFormation sumber daya.

**`AWS::IAM::Role`**  
*`LogicalId`: *`<statemachine‑LogicalId>Role`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

## Sumber peristiwa API ditentukan
<a name="sam-specification-generated-resources-statemachine-api"></a>

Ketika `Event` properti `AWS::Serverless::StateMachine` diatur ke`Api`, tetapi `RestApiId` properti *tidak* ditentukan, AWS SAM menghasilkan `AWS::ApiGateway::RestApi` CloudFormation sumber daya.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`ServerlessRestApi`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

## Sumber event bridge (atau bus peristiwa) ditentukan
<a name="sam-specification-generated-resources-statemachine-eventbridge"></a>

Ketika `Event` properti `AWS::Serverless::StateMachine` disetel ke salah satu jenis jembatan peristiwa (atau bus acara), AWS SAM menghasilkan `AWS::Events::Rule` CloudFormation sumber daya. Ini berlaku untuk tipe berikut: `EventBridgeRule`, `Schedule`, dan `CloudWatchEvents`.

**`AWS::Events::Rule`**  
*`LogicalId`: *`<statemachine‑LogicalId><event‑LogicalId>`  
*Properti yang dapat direferensikan:* N/A (Anda harus menggunakan `LogicalId` untuk referensi sumber daya ini) CloudFormation 

# Atribut sumber daya yang didukung oleh AWS SAM
<a name="sam-specification-resource-attributes"></a>

Atribut sumber daya adalah atribut yang dapat Anda tambahkan AWS SAM dan CloudFormation sumber daya untuk mengontrol perilaku dan hubungan tambahan. Untuk informasi selengkapnya tentang atribut sumber daya, lihat [Referensi Sumber Daya](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-product-attribute-reference.html) di *Panduan Pengguna AWS CloudFormation *.

AWS SAM mendukung subset atribut sumber daya yang didefinisikan oleh CloudFormation. Dari atribut sumber daya yang didukung, beberapa disalin hanya ke sumber daya dasar yang dihasilkan dari CloudFormation sumber daya yang sesuai AWS SAM , dan beberapa disalin ke semua CloudFormation sumber daya yang dihasilkan dari sumber daya yang sesuai AWS SAM . Untuk informasi selengkapnya tentang CloudFormation sumber daya yang dihasilkan dari AWS SAM sumber daya terkait, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

Tabel berikut merangkum dukungan atribut sumber daya oleh AWS SAM, tunduk pada [Pengecualian](#sam-specification-resource-attributes-exceptions) tercantum di bawah ini.


| Atribut sumber daya | Beberapa sumber daya yang dibuat pada tujuan | 
| --- | --- | 
|  ** [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) ** ** [Metadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html) **1, 2  |  Basis sumber daya yang CloudFormation dihasilkan saja. Untuk informasi tentang pemetaan antara AWS SAM sumber daya dan sumber CloudFormation daya dasar, lihat[Skenario CloudFormation sumber daya yang dihasilkan](sam-specification-generated-resources.md#sam-specification-generated-resources-scenarios).  | 
| **[Kondisi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html)** ** [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) ** ** [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) **  |  Semua CloudFormation sumber daya yang dihasilkan dari AWS SAM sumber daya yang sesuai. Untuk informasi tentang skenario CloudFormation sumber daya yang dihasilkan, lihat[Skenario CloudFormation sumber daya yang dihasilkan](sam-specification-generated-resources.md#sam-specification-generated-resources-scenarios).  | 

**Catatan:**

1. Untuk informasi selengkapnya tentang penggunaan atribut sumber daya `Metadata` dengan tipe sumber daya `AWS::Serverless::Function`, lihat [Membangun fungsi Lambda dengan runtime khusus di AWS SAM](building-custom-runtimes.md).

1. Untuk informasi selengkapnya tentang penggunaan atribut sumber daya `Metadata` dengan tipe sumber daya `AWS::Serverless::LayerVersion`, lihat [Membangun lapisan Lambda di AWS SAM](building-layers.md).

## Pengecualian
<a name="sam-specification-resource-attributes-exceptions"></a>

Terdapat sejumlah pengecualian untuk aturan atribut sumber daya yang dijelaskan sebelumnya:
+ Untuk`AWS::Lambda::LayerVersion`, bidang kustom AWS SAM-only `RetentionPolicy` menetapkan `DeletionPolicy` untuk CloudFormation sumber daya yang dihasilkan. Hal ini memiliki prioritas yang lebih tinggi dari `DeletionPolicy` kode itu sendiri. Jika tidak diatur, maka secara default `DeletionPolicy` diatur ke `Retain`.
+ Pada `AWS::Lambda::Version`, jika `DeletionPolicy` tidak ditentukan, default-nya adalah `Retain`.
+ Untuk skenario di mana `DeploymentPreferences` ditentukan untuk fungsi tanpa server, atribut sumber daya tidak disalin ke sumber daya yang dihasilkan berikut: CloudFormation 
  + `AWS::CodeDeploy::Application`
  + `AWS::CodeDeploy::DeploymentGroup`
  + Parameter `AWS::IAM::Role` bernama `CodeDeployServiceRole` yang dibuat untuk skenario ini
+ Jika AWS SAM template Anda berisi beberapa fungsi dengan sumber peristiwa API yang dibuat secara implisit, maka fungsi tersebut akan membagikan sumber daya yang dihasilkan`AWS::ApiGateway::RestApi`. Dalam skenario ini, jika fungsi memiliki atribut sumber daya yang berbeda, maka untuk `AWS::ApiGateway::RestApi` sumber daya yang dihasilkan AWS SAM , salin atribut sumber daya sesuai dengan daftar prioritas berikut:
  + `UpdateReplacePolicy`:

    1. `Retain`

    1. `Snapshot`

    1. `Delete`
  + `DeletionPolicy`:

    1. `Retain`

    1. `Delete`

# Ekstensi API Gateway untuk AWS SAM
<a name="sam-specification-api-gateway-extensions"></a>

Ekstensi API Gateway, yang dirancang khusus untuk AWS, menyediakan penyesuaian dan fungsionalitas tambahan untuk merancang dan mengelola. APIs Ekstensi API Gateway adalah ekstensi ke spesifikasi OpenAPI yang mendukung otorisasi khusus dan integrasi API AWS khusus API GateWay. Untuk informasi selengkapnya tentang ekstensi API Gateway, lihat [Ekstensi API Gateway ke OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html).

AWS SAM mendukung subset ekstensi API Gateway. Untuk melihat ekstensi API Gateway mana yang didukung AWS SAM, lihat tabel berikut.


|  |  | 
| --- |--- |
|  Ekstensi API Gateway  |  Didukung oleh AWS SAM  | 
| [x-amazon-apigateway-any-metode Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-any-method.html) | Ya | 
| [x-amazon-apigateway-apiProperti -key-source](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html) | Tidak | 
| [x-amazon-apigateway-auth Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-auth.html) | Ya | 
| [x-amazon-apigateway-authorizer Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html) | Ya | 
| [x-amazon-apigateway-authtype Properti](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authtype.html) | Ya | 
| [x-amazon-apigateway-binary-media-types Properti](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html) | Ya | 
| [x-amazon-apigateway-documentation Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-documentation.html) | Tidak | 
| [x-amazon-apigateway-endpoint-konfigurasi Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html) | Tidak | 
| [x-amazon-apigateway-gateway-Responses Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.html) | Ya | 
| [x-amazon-apigateway-gateway-Responses.GatewayResponse Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.gatewayResponse.html) | Ya | 
| [x-amazon-apigateway-gateway-Responses.ResponseParameters Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.responseParameters.html) | Ya | 
| [x-amazon-apigateway-gateway-Responses.ResponseTemplates Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.responseTemplates.html) | Ya | 
| [x-amazon-apigateway-integration Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html) | Ya | 
| [x-amazon-apigateway-integration.RequestTemplates Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html) | Ya | 
| [x-amazon-apigateway-integration.RequestParameters Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html) | Tidak | 
| [x-amazon-apigateway-integration.response Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html) | Ya | 
| [x-amazon-apigateway-integration.response Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-response.html) | Ya | 
| [x-amazon-apigateway-integration.ResponseTemplates Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responseTemplates.html) | Ya | 
| [x-amazon-apigateway-integration.ResponseParameters Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responseParameters.html) | Ya | 
| [x-amazon-apigateway-requestProperti -validator](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validator.html) | Tidak | 
| [x-amazon-apigateway-request-validator Obyek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.html) | Tidak | 
| [x-amazon-apigateway-request-Validators.RequestValidator Objek](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.requestValidator.html) | Tidak | 

# Fungsi intrinsik untuk AWS SAM
<a name="sam-specification-intrinsic-functions"></a>

Fungsi intrinsik adalah fungsi bawaan yang memungkinkan Anda menetapkan nilai ke properti yang hanya tersedia saat runtime. AWS SAM memiliki dukungan terbatas untuk properti fungsi intrinsik tertentu, sehingga tidak dapat menyelesaikan beberapa fungsi intrinsik. Oleh karena itu, kami sarankan untuk menambahkan `AWS::LanguageExtensions` transformasi untuk menyelesaikan ini. `AWS::LanguageExtensions`Ini adalah makro yang dihosting oleh CloudFormation yang memungkinkan Anda menggunakan fungsi intrinsik dan fungsi lain yang secara default tidak termasuk dalam. CloudFormation

```
Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31
```

**catatan**  
Jika Anda menggunakan fungsi intrinsik di CodeUri properti, tidak AWS SAM akan dapat mengurai nilai dengan benar. Pertimbangkan untuk menggunakan `AWS::LanguageExtensions` transformasi sebagai gantinya.  
Untuk informasi lebih lanjut, lihat [bagian Properti dari AWS::Serverless::Function](sam-resource-function.md#sam-resource-function-properties).

Untuk informasi selengkapnya tentang fungsi intrinsik, lihat [Referensi Fungsi Intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html) di *Panduan Pengguna AWS CloudFormation *.