eb config

Deskripsi

Kelola pengaturan konfigurasi aktif dan konfigurasi tersimpan lingkungan Anda. Anda dapat menggunakan perintah ini untuk mengunggah, mengunduh, atau mencantumkan konfigurasi tersimpan lingkungan Anda. Anda juga dapat menggunakannya untuk mengunduh, menampilkan, atau memperbarui pengaturan konfigurasi aktifnya.

Jika direktori root berisi file platform.yaml yang menentukan platform khusus, perintah ini juga mengubah pengaturan konfigurasi pembangun. Hal ini dilakukan berdasarkan nilai-nilai yang ditetapkan di platform.yaml.

catatan

eb config tidak menampilkan properti lingkungan. Untuk mengatur properti lingkungan yang dapat Anda baca dari dalam aplikasi Anda, gunakan eb setenv sebagai gantinya.

Sintaksis

Berikut ini adalah bagian dari sintaks yang digunakan untuk perintah eb config agar bekerja dengan pengaturan konfigurasi aktif lingkungan Anda. Untuk contoh spesifik, lihat bagian Contoh ini nanti di topik ini.

• eb config – Menampilkan pengaturan konfigurasi aktif lingkungan Anda di editor teks yang Anda konfigurasikan sebagai variabel lingkungan EDITOR. Ketika Anda menyimpan perubahan ke file dan menutup editor, lingkungan diperbarui dengan pengaturan opsi yang Anda simpan di file.

  catatan

  Jika Anda tidak mengonfigurasi variabel lingkungan EDITOR, EB CLI menampilkan pengaturan opsi Anda di editor default untuk file YAML.

• eb config environment-name – Menampilkan dan memperbarui konfigurasi untuk lingkungan bernama. Konfigurasi baik ditampilkan di editor teks yang Anda konfigurasikan atau file YAML editor default Anda.

• eb config save – Menyimpan pengaturan konfigurasi aktif untuk lingkungan saat ini ke .elasticbeanstalk/saved_configs/ dengan nama file [configuration-name].cfg.yml. Secara default, EB CLI menyimpan pengaturan konfigurasi dengan configuration-name berdasarkan nama lingkungan. Anda dapat menentukan nama konfigurasi yang berbeda dengan menyertakan opsi --cfg dengan nama konfigurasi yang Anda inginkan ketika Anda menjalankan perintah.

  Anda dapat memberi tanda pada konfigurasi tersimpan menggunakan opsi --tags.

• eb config --display – Menulis pengaturan konfigurasi aktif lingkungan ke stdout bukan sebuah file. Secara default ini menampilkan pengaturan konfigurasi ke terminal.

• eb config --update configuration_string | file_path – Memperbarui pengaturan konfigurasi aktif untuk lingkungan saat ini dengan informasi yang ditentukan di configuration_string atau di dalam file yang diidentifikasi oleh file_path.

catatan

Opsi --display dan --update menyediakan fleksibilitas untuk membaca dan merevisi pengaturan konfigurasi lingkungan secara terprogram.

Berikut ini menjelaskan sintaks untuk menggunakan perintah eb config untuk bekerja dengan konfigurasi tersimpan. Untuk contoh, lihat bagian Contoh ini nanti di topik ini.

• eb config get config-name – Mengunduh konfigurasi tersimpan bernama dari Amazon S3.

• eb config delete config-name – Menghapus konfigurasi tersimpan bernama dari Amazon S3. Juga hapus secara lokal, jika Anda sudah mengunduhnya.

• eb config list – Mencantumkan konfigurasi tersimpan yang Anda miliki di Amazon S3.

• eb config put filename – Mengunggah konfigurasi tersimpan bernama ke bucket Amazon S3. Nama berkas harus memiliki ekstensi file .cfg.yml. Untuk menentukan nama file tanpa jalur, Anda dapat menyimpan file ke folder .elasticbeanstalk atau ke folder .elasticbeanstalk/saved_configs/ sebelum Anda menjalankan perintah. Atau, Anda dapat menentukan nama berkas dengan menyediakan jalur lengkap.

Opsi

Nama	Deskripsi
--cfg config-name	Nama yang digunakan untuk konfigurasi tersimpan. Opsi ini bekerja dengan eb config save saja.
-d atau --display	Tampilkan pengaturan konfigurasi untuk lingkungan saat ini (menulis ke stdout). Gunakan dengan opsi --format untuk menentukan output berada di JSON atau YAML. Jika Anda tidak menentukan, output dalam format YAML. Opsi ini hanya bekerja jika Anda menggunakan perintah eb config tanpa salah satu sub perintah lainnya.
-f format_type atau --format format_type	Tentukan format tampilan. Nilai yang valid adalah JSON atau YAML. Default untuk YAML. Opsi ini bekerja dengan opsi --display saja.
--tags key1=value1[,key2=value2 ...]	Tanda untuk ditambahkan ke konfigurasi tersimpan. Saat menentukan tanda di daftar, tentukan mereka sebagai pasangan kunci=nilai dan pisahkan masing-masing dengan koma. Untuk informasi selengkapnya, lihat Menandai konfigurasi tersimpan. Opsi ini bekerja dengan eb config save saja.
--timeout timeout	Jumlah menit sebelum waktu perintah habis.
-u configuration_string | file_path atau --update configuration_string | file_path	Perbarui pengaturan konfigurasi aktif untuk lingkungan saat ini. Opsi ini hanya bekerja jika Anda menggunakan perintah eb config tanpa salah satu sub perintah lainnya. Parameter configuration_string | file_path adalah tipe string. String menyediakan daftar namespace dan opsi yang sesuai untuk menambah, memperbarui, atau menghapus dari pengaturan konfigurasi untuk lingkungan Anda. Atau, string input dapat mewakili file yang berisi informasi yang sama. Untuk menentukan nama file, string input harus mengikuti format "file://<path><filename>". Untuk menentukan nama file tanpa path, simpan file ke folder tempat Anda menjalankan perintah. Atau, tentukan nama file dengan menyediakan jalur lengkap. Informasi konfigurasi harus memenuhi syarat berikut. Setidaknya salah satu bagian, OptionSettings atau OptionsToRemove, diperlukan. Gunakan OptionSettings untuk menambah atau mengubah opsi. Gunakan OptionsToRemove untuk menghapus opsi dari namespace. Untuk contoh spesifik, lihat bagian Contoh ini nanti di topik ini. Format YAML OptionSettings: namespace1: option-name-1: option-value-1 option-name-2: option-value-2 ... OptionsToRemove: namespace1: option-name-1 option-name-2 ... Format JSON { "OptionSettings": { "namespace1": { "option-name-1": "option-value-1", "option-name-2": "option-value-2", ... } }, "OptionsToRemove": { "namespace1": { "option-name-1", "option-name-2", ... } } }
Opsi Umum

Output

Jikaperintah eb config atau eb config environment-name berhasil berjalan tanpa sub perintah atau opsi ditambahkan, perintah menampilkan pengaturan opsi Anda saat ini di editor teks yang Anda konfigurasikan sebagai variabel lingkungan EDITOR. Jika Anda tidak mengonfigurasi variabel lingkungan EDITOR, EB CLI menampilkan pengaturan opsi Anda di editor default untuk file YAML.

Ketika Anda menyimpan perubahan ke file dan menutup editor, lingkungan diperbarui dengan pengaturan opsi yang Anda simpan di file. Output berikut ditampilkan untuk mengonfirmasi pembaruan konfigurasi.

$ eb config myApp-dev
    Printing Status:
    2021-05-19 18:09:45    INFO    Environment update is starting.
    2021-05-19 18:09:55    INFO    Updating environment myApp-dev's configuration settings.
    2021-05-19 18:11:20    INFO    Successfully deployed new configuration to environment.

Jika perintah berhasil berjalan dengan opsi --display, ini menampilkan pengaturan konfigurasi untuk lingkungan saat ini (menulis ke stdout).

Jika perintah berhasil berjalan dengan parameter get, perintah menampilkan lokasi salinan lokal yang Anda unduh.

Jika perintah berhasil berjalan dengan parameter save, perintah menampilkan lokasi file tersimpan.

Contoh

Bagian ini menjelaskan cara mengubah editor teks yang Anda gunakan untuk melihat dan mengedit file pengaturan pilihan Anda.

Untuk Linux dan UNIX, contoh berikut mengubah editor menjadi vim:

$ export EDITOR=vim

Untuk Linux dan UNIX, contoh berikut mengubah editor menjadi apa pun yang dipasang di /usr/bin/kate.

$ export EDITOR=/usr/bin/kate

Untuk Windows, contoh berikut mengubah editor ke Notepad++.

> set EDITOR="C:\Program Files\Notepad++\Notepad++.exe

Bagian ini menyediakan contoh untuk perintah eb config ketika dijalankan dengan sub perintah.

Contoh berikut menghapus konfigurasi tersimpan bernama app-tmp.

$ eb config delete app-tmp

Contoh berikut mengunduh konfigurasi tersimpan dengan nama app-tmp dari bucket Amazon S3 Anda.

$ eb config get app-tmp

Contoh berikut mencantumkan nama konfigurasi tersimpan yang disimpan di bucket Amazon S3.

$ eb config list

Contoh berikut mengunduh salinan lokal konfigurasi tersimpan dengan bernama app-tmp ke bucket Amazon S3 Anda.

$ eb config put app-tmp

Contoh berikut menyimpan pengaturan konfigurasi dari lingkungan yang berjalan saat ini. Jika Anda tidak memberikan nama untuk digunakan untuk konfigurasi tersimpan, maka Elastic Beanstalk menamakan file konfigurasi sesuai dengan nama lingkungan. Sebagai contoh, sebuah lingkungan bernama tmp-dev akan disebut tmp-dev.cfg.yml. Elastic Beanstalk menyimpan file ke folder /.elasticbeanstalk/saved_configs/.

$ eb config save

Pada contoh berikut, opsi --cfg digunakan untuk menyimpan pengaturan konfigurasi dari lingkungan tmp-dev ke sebuah file bernama v1-app-tmp.cfg.yml. Elastic Beanstalk menyimpan file ke folder /.elasticbeanstalk/saved_configs/. Jika Anda tidak menentukan nama lingkungan, Elastic Beanstalk menyimpan pengaturan konfigurasi dari lingkungan yang berjalan saat ini.

$ eb config save tmp-dev --cfg v1-app-tmp

Bagian ini menyediakan contoh untuk perintah eb config ketika dijalankan tanpa sub perintah.

Perintah berikut menampilkan pengaturan opsi untuk lingkungan Anda saat ini di editor teks.

$ eb config

Perintah berikut menampilkan pengaturan opsi untuk lingkungan my-env di editor teks.

$ eb config my-env

Contoh berikut menampilkan pengaturan opsi untuk lingkungan saat ini. Ini mengeluarkan dalam format YAML karena tidak ada format spesifik yang ditentukan dengan opsi --format.

$ eb config --display

Contoh berikut memperbarui pengaturan opsi untuk lingkungan Anda saat ini dengan spesifikasi di file bernama example.txt. File ini dalam format YAML atau JSON. EB CLI secara otomatis mendeteksi format file.

• Opsi Minsize diatur ke 1 untuk namespace aws:autoscaling:asg.

• Ukuran batch untuk namespace aws:elasticbeanstalk:command diatur ke 30%.

• Ini akan menghapus pengaturan pilihanIdleTimeout: Tidak adadari namespaceAWSEBV2LoadBalancer.aws:elbv2:loadbalancer.

$ eb config --update "file://example.txt"

contoh - nama file:example.txt - Format YAML

OptionSettings:
  'aws:elasticbeanstalk:command':
    BatchSize: '30'
    BatchSizeType: Percentage
  'aws:autoscaling:asg':
    MinSize: '1'
OptionsToRemove:
  'AWSEBV2LoadBalancer.aws:elbv2:loadbalancer':
    IdleTimeout

contoh - nama file:example.txt - Format JSON

{
    "OptionSettings": {
        "aws:elasticbeanstalk:command": {
            "BatchSize": "30",
            "BatchSizeType": "Percentage"
        },
        "aws:autoscaling:asg": {
            "MinSize": "1"
        }
    },
    "OptionsToRemove": {
        "AWSEBV2LoadBalancer.aws:elbv2:loadbalancer": {
            "IdleTimeout"
        }
    }
}

Contoh berikut memperbarui pengaturan opsi untuk lingkungan Anda saat ini. Perintah mengatur opsi Minsize ke 1 untuk namespace aws:autoscaling:asg.

catatan

Contoh-contoh ini spesifik untuk WindowsPowerShell. Mereka melepaskan kejadian literal dari karakter kutipan ganda (") dengan mendahuluinya dengan karakter garis miring (\). Sistem operasi yang berbeda dan lingkungan baris perintah mungkin memiliki urutan keluar yang berbeda. Untuk alasan ini, sebaiknya gunakan opsi file yang ditampilkan di contoh sebelumnya. Menentukan opsi konfigurasi di file tidak memerlukan pengeluaran karakter dan konsisten di seluruh sistem operasi yang berbeda.

Contoh berikut dalam format JSON. EB CLI mendeteksi jika format dalam JSON atau YAML.

PS C:\Users\myUser\EB_apps\myApp-env>eb config --update '{\"OptionSettings\":{\"aws:autoscaling:asg\":{\"MaxSize\":\"1\"}}}'

Contoh berikut dalam format YAML. Untuk memasukkan string YAML dalam format yang benar, perintah termasuk spasi danend-of-linepengembalian yang diperlukan di file YAML.

• Akhiri setiap baris dengan tombol "masuk" atau "kembali".

• Mulai baris kedua dengan dua spasi, dan mulai baris ketiga dengan empat spasi.

PS C:\Users\myUser\EB_apps\myApp-env>eb config --update 'OptionSettings:
>>  aws:autoscaling:asg:
>>    MinSize: \"1\"'