View a markdown version of this page

deploy sam - AWS Serverless Application Model
PenggunaanVariabel lingkunganOpsiContoh

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

deploy sam

Halaman ini menyediakan informasi referensi untuk AWS Serverless Application Model perintah Command Line Interface (AWS SAMCLI)sam deploy.

Per sam deploy intah menyebarkan aplikasi ke AWS Cloud penggunaan AWS CloudFormation.

Penggunaan

$ <environment variables> sam deploy <options>

Variabel lingkungan

SAM_CLI_POLL_DELAY

Tetapkan variabel SAM_CLI_POLL_DELAY lingkungan dengan nilai detik di shell Anda untuk mengonfigurasi seberapa sering AWS SAM CLI memeriksa status CloudFormation tumpukan, yang berguna saat melihat throttling dari. CloudFormation Variabel env ini digunakan untuk pemungutan suara panggilan describe_stack API, yang dibuat saat berjalan. sam deploy

Berikut ini adalah contoh dari variabel ini:

$ SAM_CLI_POLL_DELAY=5 sam deploy

Opsi

--capabilities LIST

Daftar kemampuan yang harus Anda tentukan CloudFormation untuk memungkinkan membuat tumpukan tertentu. Beberapa template tumpukan mungkin menyertakan sumber daya yang memengaruhi izin di Anda Akun AWS, misalnya, dengan membuat pengguna baru AWS Identity and Access Management (IAM). Untuk tumpukan tersebut, Anda harus secara eksplisit menerima kemampuannya dengan menentukan opsi ini. Nilai yang valid adalah hanya CAPABILITY_IAM dan CAPABILITY_NAMED_IAM. Jika Anda memiliki sumber daya IAM, maka Anda dapat menentukan salah satu kemampuan. Jika Anda memiliki sumber daya IAM dengan nama khusus, maka Anda harus menentukanCAPABILITY_NAMED_IAM. Jika Anda tidak menentukan opsi ini, maka operasi mengembalikan InsufficientCapabilities kesalahan.

Saat Anda menerapkan aplikasi yang berisi aplikasi bersarang, Anda harus menggunakannya CAPABILITY_AUTO_EXPAND untuk mengetahui aplikasi berisi aplikasi bersarang. Untuk informasi selengkapnya, lihat Men-deploy aplikasi nest.

--config-env TEXT

Nama lingkungan yang menentukan nilai parameter default dalam file konfigurasi yang akan digunakan. Nilai default-nya adalah default. Untuk informasi selengkapnya tentang file konfigurasi, lihat AWS SAMCLIberkas konfigurasi.

--config-file PATH

Jalur dan nama file dari file konfigurasi yang berisi nilai parameter default yang akan digunakan. Nilai default-nya adalah samconfig.toml di root direktori proyek. Untuk informasi selengkapnya tentang file konfigurasi, lihat AWS SAMCLIberkas konfigurasi.

--confirm-changeset | --no-confirm-changeset

Minta untuk mengonfirmasi apakah menerapkan AWS SAMCLI set perubahan yang dihitung.

--debug

Aktifkan pencatatan debug untuk mencetak pesan debug yang dihasilkan dan untuk menampilkan stempel waktu. AWS SAMCLI

--disable-rollback | --no-disable-rollback

Tentukan apakah akan mengembalikan CloudFormation tumpukan Anda jika terjadi kesalahan selama penerapan. Secara default, jika ada kesalahan selama penerapan, CloudFormation tumpukan Anda akan kembali ke status stabil terakhir. Jika Anda menentukan --disable-rollback dan terjadi kesalahan selama penerapan, sumber daya yang dibuat atau diperbarui sebelum kesalahan terjadi tidak dipulihkan kembali.

--express | --no-express

Menentukan apakah akan menggunakan mode CloudFormation Ekspres. Saat aktif, operasi tumpukan selesai setelah konfigurasi sumber daya diterapkan. Sumber daya terus menjadi siap di latar belakang. Waktu penerapan dapat dikurangi hingga 4x.

M AWS SAMCLI eneruskan perilaku rollback ke CloudFormation DeploymentConfig parameter saat Anda juga menentukan--disable-rollback.

Nilai default-nya adalah --no-express.

--fail-on-empty-changeset | --no-fail-on-empty-changeset

Tentukan apakah akan mengembalikan kode keluar bukan nol jika tidak ada perubahan yang harus dilakukan pada tumpukan. Perilaku default-nya adalah mengembalikan kode keluar nonkosong.

--force-upload

Tentukan opsi ini untuk mengunggah artefak bahkan jika artefak itu cocok dengan artefak yang ada di bucket Amazon S3. Mencocokkan artefak dibatalkan.

--guided, -g

Tentukan opsi ini agar petunjuk AWS SAMCLI penggunaan memandu Anda melalui penerapan.

--help

Tampilkan pesan ini dan keluar.

--image-repositories TEXT

Pemetaan fungsi ke URI repositori Amazon ECR mereka. Referensi fungsi dengan ID logisnya. Berikut ini adalah contohnya:

$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

Anda dapat menentukan opsi ini beberapa kali dalam satu perintah.

--image-repository TEXT

Nama repositori Amazon ECR tempat perintah ini mengunggah gambar fungsi Anda. Opsi ini diperlukan untuk fungsi yang dideklarasikan dengan jenis Image paket.

--kms-key-id TEXT

ID kunci AWS Key Management Service (AWS KMS) yang digunakan untuk mengenkripsi artefak yang tidak ada di bucket Amazon S3. Jika Anda tidak menentukan opsi ini, gunakan AWS SAM kunci S3-managed enkripsi Amazon.

--metadata

Peta metadata untuk melampirkan ke semua artefak yang direferensikan dalam templat Anda.

--no-execute-changeset

Menunjukkan apakah akan menerapkan set perubahan. Tentukan opsi ini jika Anda ingin melihat perubahan tumpukan sebelum menerapkan set perubahan. Perintah ini membuat CloudFormation changeset dan kemudian keluar tanpa menerapkan changeset. Untuk menerapkan changeset, jalankan perintah yang sama tanpa opsi ini.

--no-progressbar

Jangan tampilkan baris progres saat mengunggah artefak ke Amazon S3.

--notification-arns LIST

Daftar ARN topik Amazon Simple Notification Service (Amazon SNS) yang terkait dengan CloudFormation tumpukan.

--on-failure [ROLLBACK | DELETE | DO_NOTHING]

Tentukan tindakan yang akan diambil ketika tumpukan gagal dibuat.

Pilihan berikut tersedia:

  • ROLLBACK— Mengembalikan tumpukan ke keadaan baik yang diketahui sebelumnya.

  • DELETE— Mengembalikan tumpukan ke keadaan baik yang diketahui sebelumnya, jika ada. Jika tidak, hapus tumpukan.

  • DO_NOTHING— Tidak memutar kembali atau menghapus tumpukan. Efeknya sama dengan efeknya--disable-rollback.

Perilaku bawaannya adalah ROLLBACK.

catatan

Anda dapat menentukan --disable-rollback opsi atau --on-failure opsi, tetapi tidak keduanya.

--output [ text | json ]

Format output perintah:

  • text- Mencetak output biasa yang dapat dibaca manusia. Ini adalah nilai default.

  • json- Mencetak output terstruktur dan dapat dibaca mesin. Gunakan format ini ketika Anda ingin menggunakan output secara terprogram, seperti di CI/CD pipeline, ekstensi IDE, dan AI-assisted alat.

Penerapan berjalan selama periode waktu tertentu. Saat Anda menentukan--output json, AWS SAMCLI akan mencetak aliran objek JSON, satu per baris, saat penerapan berlangsung. Setiap objek menyertakan type bidang yang mengidentifikasi jenis informasi yang dikandungnya, seperti changeset, peristiwa penerapan, output tumpukan, dan hasil akhir. Pada kegagalan, objek terakhir mencakup error objek yang menggambarkan apa yang salah.

catatan

--output jsonOpsi ini tidak kompatibel dengan opsi yang memerlukan petunjuk interaktif, seperti --guided dan--confirm-changeset.

--parameter-overrides LIST

String yang berisi penggantian CloudFormation parameter yang dikodekan sebagai pasangan kunci-nilai. Setiap penggantian menggunakan formatParameterKey=name,ParameterValue=value. Beberapa penggantian dipisahkan oleh spasi. Berikut adalah dua contohnya:

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana
--profile TEXT

Profil spesifik dari file kredensi Anda yang mendapatkan kreden AWS SIAL.

--region TEXT

Untuk Wilayah AWS disebarkan ke. Misalnya, us-east-1.

--resolve-image-repos

Buat repositori Amazon ECR secara otomatis untuk digunakan untuk pengemasan dan penerapan untuk penerapan tanpa panduan. Opsi ini hanya berlaku untuk fungsi dan lapisan dengan PackageType: Image ditentukan. Jika Anda menentukan --guided opsi, maka AWS SAMCLI mengabaikan--resolve-image-repos.

catatan

Jika AWS SAM secara otomatis membuat repositori Amazon ECR untuk fungsi atau lapisan dengan opsi ini, dan Anda kemudian menghapus fungsi atau lapisan tersebut dari AWS SAM template Anda, maka repositori Amazon ECR yang sesuai akan dihapus secara otomatis.

--resolve-s3

Buat bucket Amazon S3 secara otomatis untuk digunakan untuk pengemasan dan penerapan untuk penerapan tanpa panduan. Jika Anda menentukan --guided opsi, maka AWS SAM CLI mengabaikan--resolve-s3. Jika Anda menentukan --resolve-s3 opsi --s3-bucket dan, maka terjadi kesalahan.

--role-arn TEXT

Nama Sumber Daya Amazon (ARN) dari peran IAM yang di CloudFormation asumsikan saat menerapkan set perubahan.

--s3-bucket TEXT

Nama bucket Amazon S3 tempat perintah ini mengunggah CloudFormation template Anda. Jika template Anda lebih besar dari 51.200 byte, maka --s3-bucket opsi atau --resolve-s3 opsi diperlukan. Jika Anda menentukan --resolve-s3 opsi --s3-bucket dan, maka terjadi kesalahan.

--s3-prefix TEXT

Prefiks ditambahkan ke nama artefak yang diunggah ke bucket Amazon S3. Nama prefiks adalah nama jalur (nama folder) untuk bucket Amazon S3.

--save-params

Simpan parameter yang Anda berikan di baris perintah ke file AWS SAM konfigurasi.

--signing-profiles LIST

Daftar profil penandatanganan untuk menandatangani paket deployment Anda. Opsi ini mengambil daftar pasangan kunci-nilai, dengan penjelasan kunci adalah nama fungsi atau lapisan untuk menandatangani, dan nilai adalah profil penandatanganan, dengan pemilik profil opsional yang dibatasi dengan :. Misalnya, FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner.

--stack-name TEXT

(Wajib) Nama CloudFormation tumpukan yang Anda gunakan. Jika Anda menentukan tumpukan yang ada, maka perintah memperbarui tumpukan. Jika Anda menentukan tumpukan baru, maka perintah membuatnya.

--tags LIST

Daftar tag untuk dikaitkan dengan tumpukan yang dibuat atau diperbarui. CloudFormation juga menyebarkan tag ini ke sumber daya di tumpukan yang mendukungnya.

--template-file, --template, -t PATH

Path dan nama file tempat AWS SAM template Anda berada.

catatan

Jika Anda menentukan opsi ini, AWS SAM maka hanya menerapkan template dan sumber daya lokal yang ditunjuk.

--use-json

Keluaran JSON untuk CloudFormation template. Output default-nya adalah YAML.

Contoh

Untuk contoh terperinci dan panduan mendalam tentang penggunaan sam deploy subperintah, lihat. Pengantar penerapan dengan AWS SAM