Cara membuat file konfigurasi Anda (samconfigfile)Konfigurasikan pengaturan proyek Konfigurasikan kredensil dan pengaturan dasar

Mengkonfigurasi AWS SAM CLI

Salah satu manfaatnya AWS SAM adalah mengoptimalkan waktu pengembang dengan menghapus tugas berulang. AWS SAM CLI termasuk file konfigurasi bernama samconfig untuk tujuan ini. Secara default, tidak ada konfigurasi ke AWS SAM CLI diperlukan, tetapi Anda dapat memperbarui file konfigurasi Anda untuk memungkinkan Anda menjalankan perintah dengan parameter yang lebih sedikit dengan memungkinkan AWS SAM untuk mereferensikan parameter khusus Anda dalam file konfigurasi Anda. Contoh dalam tabel berikut menunjukkan bagaimana Anda dapat mengoptimalkan perintah Anda:

Asal	Dioptimalkan dengan `samconfig`
sam build --cached --parallel --use-containers	sam build
sam local invoke --env-vars locals.json	sam local invoke
sam local start-api --env-vars locals.json --warm-containers EAGER	sam local start-api

The AWS SAM CLI menyediakan serangkaian perintah untuk membantu pengembang membuat, mengembangkan, dan menyebarkan aplikasi tanpa server. Masing-masing perintah ini dapat dikonfigurasi dengan bendera opsional berdasarkan preferensi aplikasi dan pengembang. Untuk informasi lebih lanjut, lihat AWS SAM CLI konten dalam GitHub

Topik di bagian ini menunjukkan cara membuat AWS SAM CLI berkas konfigurasi dan menyesuaikan pengaturan defaultnya untuk mengoptimalkan waktu pengembangan untuk aplikasi tanpa server Anda.

Topik

Cara membuat file konfigurasi Anda (samconfigfile)
Konfigurasikan pengaturan proyek
Konfigurasikan kredensil dan pengaturan dasar

Cara membuat file konfigurasi Anda (`samconfig`file)

The AWS SAM CLI file konfigurasi (nama filesamconfig) adalah file teks yang biasanya menggunakan struktur TOMB, tetapi juga bisa di YAMB. Saat menggunakan Template Mulai AWS Cepat, file ini dibuat saat Anda menjalankan sam init perintah. Anda dapat memperbarui file ini saat Anda menyebarkan aplikasi menggunakan sam deploy -\-guided perintah.

Setelah penyebaran selesai, samconfig file berisi profil bernama default jika Anda menggunakan nilai default. Saat Anda menjalankan kembali deploy perintah, AWS SAM terapkan pengaturan konfigurasi yang disimpan dari profil ini.

Manfaat dari samconfig file ini adalah AWS SAM menyimpan pengaturan konfigurasi untuk perintah lain yang tersedia selain perintah deploy. Di luar nilai-nilai yang dibuat pada penerapan baru, ada sejumlah atribut yang dapat Anda atur dalam samconfig file yang dapat menyederhanakan aspek lain dari alur kerja pengembang dengan AWS SAM CLI.

Konfigurasikan pengaturan proyek

Anda dapat menentukan pengaturan khusus proyek, seperti AWS SAM CLI nilai parameter perintah, dalam file konfigurasi untuk digunakan dengan AWS SAM CLI. Untuk informasi selengkapnya tentang file konfigurasi ini, lihatAWS SAM CLI berkas konfigurasi.

Menggunakan file konfigurasi

File konfigurasi disusun berdasarkan lingkungan, perintah, dan nilai parameter. Untuk informasi selengkapnya, lihat Dasar-dasar file konfigurasi.

Untuk mengkonfigurasi lingkungan baru

Tentukan lingkungan baru Anda di file konfigurasi Anda.

Berikut ini adalah contoh menentukan prod lingkungan baru:
TOML
```
[prod.global.parameters]
```
YAML
```
prod:
  global:
    parameters:
```
Tentukan nilai parameter sebagai pasangan nilai kunci di bagian parameter file konfigurasi.

Berikut ini adalah contoh menentukan nama stack aplikasi Anda untuk prod lingkungan.
TOML
```
[prod.global.parameters]
stack_name = "prod-app"
```
YAML
```
prod:
  global:
    parameters:
      stack_name: prod-app
```
Gunakan --config-env opsi untuk menentukan lingkungan yang akan digunakan.

Berikut adalah contohnya:
```
$ sam deploy --config-env "prod"
```

Untuk mengkonfigurasi nilai parameter

Tentukan AWS SAM CLI perintah yang Anda ingin mengkonfigurasi nilai parameter untuk. Untuk mengkonfigurasi nilai parameter untuk semua AWS SAM CLI perintah, gunakan global pengenal.

Berikut ini adalah contoh menentukan nilai parameter untuk sam deploy perintah default lingkungan:
TOML
```
[default.deploy.parameters]
confirm_changeset = true
```
YAML
```
default:
  deploy:
    parameters:
      confirm_changeset: true
```
Berikut ini adalah contoh menentukan nilai parameter untuk semua AWS SAM CLI perintah di default lingkungan:
TOML
```
[default.global.parameters]
stack_name = "sam-app"
```
YAML
```
default:
  global:
    parameters:
      stack_name: sam-app
```

Anda juga dapat menentukan nilai parameter dan memodifikasi file konfigurasi Anda melalui AWS SAM CLI aliran interaktif.

Berikut ini adalah contoh aliran sam deploy --guided interaktif:


$ sam deploy --guided

Configuring SAM deploy
======================

    Looking for config file [samconfig.toml] :  Found
    Reading default arguments  :  Success

    Setting default arguments for 'sam deploy'
    =========================================
    Stack Name [sam-app]: ENTER
    AWS Region [us-west-2]: ENTER
    #Shows you resources changes to be deployed and require a 'Y' to initiate deploy
    Confirm changes before deploy [Y/n]: n
    #SAM needs permission to be able to create roles to connect to the resources in your template
    Allow SAM CLI IAM role creation [Y/n]: ENTER
    #Preserves the state of previously provisioned resources when an operation fails
    Disable rollback [y/N]: ENTER
    HelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
    Save arguments to configuration file [Y/n]: ENTER
    SAM configuration file [samconfig.toml]: ENTER
    SAM configuration environment [default]: ENTER

Untuk informasi selengkapnya, lihat Membuat dan memodifikasi file konfigurasi.

Contoh

Basic TOML contoh

Berikut ini adalah contoh file samconfig.toml konfigurasi:

...
version = 0.1

[default]
[default.global]
[default.global.parameters]
stack_name = "sam-app"

[default.build.parameters]
cached = true
parallel = true

[default.deploy.parameters]
capabilities = "CAPABILITY_IAM"
confirm_changeset = true
resolve_s3 = true

[default.sync.parameters]
watch = true

[default.local_start_api.parameters]
warm_containers = "EAGER"

[prod]
[prod.sync]
[prod.sync.parameters]
watch = false

Basic YAML contoh

Berikut ini adalah contoh file samconfig.yaml konfigurasi:


version 0.1
default:
  global:
    parameters:
      stack_name: sam-app
  build:
    parameters:
      cached: true
      parallel: true
  deploy:
    parameters:
      capabilities: CAPABILITY_IAM
      confirm_changeset: true
      resolve_s3: true
  sync:
    parameters:
      watch: true
  local_start_api:
    parameters:
      warm_containers: EAGER
prod:
  sync:
    parameters:
      watch: false

Konfigurasikan kredensil dan pengaturan dasar

Gunakan AWS Command Line Interface (AWS CLI) untuk mengonfigurasi pengaturan dasar seperti AWS kredensil, nama wilayah default, dan format output default. Setelah dikonfigurasi, Anda dapat menggunakan pengaturan ini dengan AWS SAM CLI. Untuk mempelajari lebih lanjut, lihat berikut ini dari Panduan AWS Command Line Interface Pengguna:

Untuk petunjuk penyiapan cepat, lihatLangkah 5: Gunakan AWS CLI untuk mengkonfigurasi AWS kredensil.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

The AWS SAM CLI

Perintah inti