Properti bagian Metadata templat AWS SAM - AWS Serverless Application Model
PropertiKasus penggunaanContoh

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

Properti bagian Metadata templat AWS SAM

AWS::ServerlessRepo::Application adalah kunci metadata yang dapat Anda gunakan untuk menentukan informasi aplikasi yang ingin Anda publikasikan ke AWS Serverless Application Repository.

catatan

AWS CloudFormation fungsi intrinsik tidak didukung oleh kunci AWS::ServerlessRepo::Application metadata.

Properti

Tabel ini memberikan informasi tentang properti Metadata bagian AWS SAM template. Bagian ini diperlukan untuk mempublikasikan aplikasi untuk AWS Serverless Application Repository menggunakan AWS SAMCLI.

Properti Tipe Diperlukan Deskripsi
Name String BENAR

Nama aplikasi.

Panjang minimum=1. Panjang maksimum=140.

Pola: "[a-zA-Z0-9\\-]+";
Description String BENAR

Deskripsi aplikasi.

Panjang minimum=1. Panjang maksimum=256.
Author String BENAR

Nama penulis yang memublikasikan aplikasi.

Panjang minimum=1. Panjang maksimum=127.

Pola: "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
SpdxLicenseId String SALAH Pengidentifikasi lisensi yang valid. Untuk menampilkan daftar pengidentifikasi lisensi yang valid, lihat Daftar Lisensi SPDX pada situs web Software Package Data Exchange (SPDX).
LicenseUrl String SALAH

Referensi ke file lisensi lokal, atau tautan Amazon S3 ke file lisensi, yang cocok dengan nilai spdxLicenseID aplikasi Anda.

File AWS SAM template yang belum dikemas menggunakan sam package perintah dapat memiliki referensi ke file lokal untuk properti ini. Namun, untuk aplikasi yang akan dipublikasikan menggunakan perintah sam publish, properti ini harus menjadi referensi ke bucket Amazon S3.

Ukuran maksimum: 5 MB.

Anda harus memberikan nilai untuk properti ini agar dapat membuat aplikasi Anda publik. Perhatikan bahwa Anda tidak dapat memperbarui properti ini setelah aplikasi Anda dipublikasikan. Jadi, untuk menambahkan lisensi ke aplikasi, Anda harus menghapusnya terlebih dahulu, atau memublikasikan aplikasi baru dengan nama yang berbeda.
ReadmeUrl String SALAH

Referensi ke file readme lokal atau tautan Amazon S3 ke file readme yang berisi deskripsi lebih detail tentang aplikasi dan cara kerjanya.

File AWS SAM template yang belum dikemas menggunakan sam package perintah dapat memiliki referensi ke file lokal untuk properti ini. Namun, untuk dipublikasikan menggunakan perintah sam publish, properti ini harus menjadi referensi ke bucket Amazon S3.

Ukuran maksimum: 5 MB.
Labels String SALAH

Label yang meningkatkan penemuan aplikasi dalam hasil pencarian.

Panjang minimum=1. Panjang maksimum=127. Jumlah maksimum label: 10.

Pola: "^[a-zA-Z0-9+\\-_:\\/@]+$";
HomePageUrl String SALAH URL dengan informasi lebih lanjut tentang aplikasi—misalnya, lokasi GitHub repositori Anda untuk aplikasi.
SemanticVersion String SALAH

Versi semantik aplikasi. Untuk spesifikasi Versioning Semantik, lihat situs web Versioning Semantik.

Anda harus memberikan nilai untuk properti ini agar dapat membuat aplikasi Anda publik.
SourceCodeUrl String SALAH Tautan ke repositori publik untuk kode sumber aplikasi Anda.

Kasus penggunaan

Bagian ini mencantumkan kasus penggunaan untuk aplikasi pemublikasian, bersama dengan properti Metadata yang diproses untuk kasus penggunaan tersebut. Properti yang tidak dicantumkan untuk kasus penggunaan yang diberikan diabaikan.

  • Membuat aplikasi baru — Aplikasi baru dibuat jika tidak ada aplikasi di AWS Serverless Application Repository dengan nama yang cocok untuk akun.

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Isi AWS SAM template (misalnya, sumber peristiwa, sumber daya, dan kode fungsi Lambda)

     

  • Membuat versi aplikasi — Versi aplikasi dibuat jika sudah ada aplikasi di AWS Serverless Application Repository dengan nama yang cocok untuk akun dan SemanticVersion sedang berubah.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Isi AWS SAM template (misalnya, sumber peristiwa, sumber daya, dan kode fungsi Lambda)

     

  • Memperbarui aplikasi — Aplikasi diperbarui jika sudah ada aplikasi di AWS Serverless Application Repository dengan nama yang cocok untuk akun dan SemanticVersion tidak berubah.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

Contoh

Berikut ini adalah contoh bagian Metadata:

Metadata:
  AWS::ServerlessRepo::Application:
    Name: my-app
    Description: hello world
    Author: user1
    SpdxLicenseId: Apache-2.0
    LicenseUrl: LICENSE.txt
    ReadmeUrl: README.md
    Labels: ['tests']
    HomePageUrl: https://github.com/user1/my-app-project
    SemanticVersion: 0.0.1
    SourceCodeUrl: https://github.com/user1/my-app-project