Bekerja dengan label parameter di Parameter Store - AWS Systems Manager
Bekerja dengan label parameter menggunakan konsolBekerja dengan label parameter menggunakan AWS CLI

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

Bekerja dengan label parameter di Parameter Store

Label parameter adalah alias yang ditetapkan pengguna untuk membantu Anda mengelola versi parameter yang berbeda. Saat Anda memodifikasi parameter, AWS Systems Manager secara otomatis menyimpan versi baru dan menambah nomor versi satu per satu. Label dapat membantu Anda mengingat tujuan dari sebuah versi parameter ketika ada beberapa versi.

Misalnya, katakanlah Anda memiliki parameter yang disebut/MyApp/DB/ConnectionString. Nilai parameter adalah string koneksi ke SQL server Saya di database lokal di lingkungan pengujian. Setelah Anda selesai memperbarui aplikasi, Anda ingin parameter tersebut menggunakan string koneksi untuk basis data produksi. Anda mengubah nilai/MyApp/DB/ConnectionString. Systems Manager secara otomatis membuat versi dua dengan string koneksi baru. Untuk membantu Anda mengingat tujuan setiap versi, Anda melampirkan label ke setiap parameter. Untuk versi satu, Anda melampirkan label Pengujian dan untuk versi dua Anda melampirkan label Produksi.

Anda dapat memindahkan label dari satu versi parameter ke versi lainnya. Sebagai contoh, jika Anda membuat parameter /MyApp/DB/ConnectionString versi 3 dengan string koneksi untuk basis data produksi yang baru, maka Anda dapat memindahkan label Produksi dari parameter versi 2 ke parameter versi 3.

Label parameter adalah alternatif ringan untuk tag parameter. Organisasi Anda mungkin memiliki pedoman ketat untuk tag yang harus diterapkan ke berbagai sumber daya AWS berbeda. Sebaliknya, label hanyalah sebuah asosiasi teks untuk versi parameter tertentu.

Mirip dengan tag, Anda dapat melakukan kueri untuk parameter dengan menggunakan label. Anda dapat melihat daftar versi parameter tertentu yang semuanya menggunakan label yang sama jika Anda menanyakan set parameter Anda dengan menggunakan GetParametersByPathAPIoperasi, seperti yang dijelaskan nanti di bagian ini.

catatan

Jika Anda menjalankan perintah yang menentukan versi parameter yang tidak ada, perintah gagal. Itu tidak kembali ke nilai parameter terbaru atau default.

Persyaratan dan batasan label

Label parameter memiliki persyaratan dan pembatasan berikut:

  • Versi parameter dapat memiliki maksimum 10 label.

  • Anda tidak dapat melampirkan label yang sama ke versi yang berbeda dari parameter yang sama. Sebagai contoh, jika versi 1 parameter mempunyai label Produksi, maka Anda tidak dapat melampirkan Produksi ke versi 2.

  • Anda dapat memindahkan label dari satu versi parameter ke yang lainnya.

  • Anda tidak dapat membuat label saat membuat parameter. Anda harus melampirkan label ke versi parameter tertentu.

  • Jika Anda sudah tidak ingin menggunakan label parameter, Anda dapat memindahkannya ke versi parameter yang berbeda atau menghapusnya.

  • Label dapat memiliki maksimum 100 karakter.

  • Label dapat berisi huruf (peka terhadap huruf besar-kecil), angka, titik (.), tanda hubung (-), atau garis bawah (_).

  • Label tidak dapat dimulai dengan angka, "aws", atau "ssm" (tidak peka terhadap huruf besar-kecil). Jika label tidak memenuhi persyaratan ini, maka label tidak dilampirkan ke versi parameter dan sistem menampilkannya dalam daftar InvalidLabels.

Bekerja dengan label parameter menggunakan konsol

Bagian ini menjelaskan cara untuk melakukan tugas-tugas berikut dengan menggunakan konsol Systems Manager.

Buat label parameter menggunakan konsol

Prosedur berikut ini menjelaskan cara melampirkan label ke versi tertentu dari parameter yang sudah ada dengan menggunakan konsol Systems Manager. Anda tidak dapat melampirkan label saat membuat parameter.

Untuk melampirkan label ke versi parameter

  1. Buka AWS Systems Manager konsol di https://console.aws.amazon.com/systems-manager/.

  2. Di panel navigasi, pilih Parameter Store.

  3. Pilih nama parameter untuk membuka halaman detail untuk parameter tersebut.

  4. Pilih tab Riwayat.

  5. Pilih versi parameter yang ingin Anda lampirkan labelnya.

  6. Pilih Kelola label.

  7. Pilih Tambah label baru.

  8. Dalam kotak teks, masukkan nama label. Untuk menambahkan label lainnya, pilih Tambah label baru. Anda dapat melampirkan maksimal sepuluh label.

  9. Setelah Anda selesai, pilih Simpan perubahan.

Lihat label yang dilampirkan ke parameter menggunakan konsol

Sebuah versi parameter dapat memiliki maksimum sepuluh label. Prosedur berikut ini menjelaskan cara melihat semua label yang dilampirkan ke suatu versi parameter dengan menggunakan konsol Systems Manager.

Untuk melihat label yang dilampirkan ke versi parameter

  1. Buka AWS Systems Manager konsol di https://console.aws.amazon.com/systems-manager/.

  2. Di panel navigasi, pilih Parameter Store.

  3. Pilih nama parameter untuk membuka halaman detail untuk parameter tersebut.

  4. Pilih tab Riwayat.

  5. Cari versi parameter yang Anda ingin lihat semua label terlampir. Kolom Label menunjukkan semua label yang terlampir pada versi parameter.

Memindahkan label parameter menggunakan konsol

Prosedur berikut ini menjelaskan cara memindahkan sebuah label parameter ke versi yang berbeda dari parameter yang sama dengan menggunakan konsol Systems Manager.

Untuk memindahkan label ke versi parameter yang berbeda

  1. Buka AWS Systems Manager konsol di https://console.aws.amazon.com/systems-manager/.

  2. Di panel navigasi, pilih Parameter Store.

  3. Pilih nama parameter untuk membuka halaman detail untuk parameter tersebut.

  4. Pilih tab Riwayat.

  5. Pilih versi parameter yang ingin Anda pindahkan labelnya.

  6. Pilih Kelola label.

  7. Pilih Tambah label baru.

  8. Dalam kotak teks, masukkan nama label.

  9. Setelah Anda selesai, pilih Simpan perubahan.

Hapus label parameter menggunakan konsol

Prosedur berikut ini menjelaskan cara menghapus satu atau beberapa label parameter menggunakan konsol Systems Manager.

Untuk menghapus label dari parameter

  1. Buka AWS Systems Manager konsol di https://console.aws.amazon.com/systems-manager/.

  2. Di panel navigasi, pilih Parameter Store.

  3. Pilih nama parameter untuk membuka halaman detail untuk parameter tersebut.

  4. Pilih tab Riwayat.

  5. Pilih versi parameter yang ingin Anda hapus labelnya.

  6. Pilih Kelola label.

  7. Pilih Hapus. di sebelah setiap label yang ingin Anda hapus.

  8. Setelah Anda selesai, pilih Simpan perubahan.

  9. Konfirmasikan bahwa perubahan Anda sudah benar, masukkan Confirm di kotak teks, lalu pilih Konfirmasi.

Bekerja dengan label parameter menggunakan AWS CLI

Bagian ini menjelaskan cara melakukan tugas berikut ini dengan menggunakan AWS Command Line Interface (AWS CLI).

Buat label parameter baru menggunakan AWS CLI

Prosedur berikut ini menjelaskan cara melampirkan label ke versi tertentu dari parameter yang sudah ada dengan menggunakan AWS CLI. Anda tidak dapat melampirkan label saat membuat parameter.

Untuk membuat label parameter

  1. Instal dan konfigurasikan AWS Command Line Interface (AWS CLI), jika Anda belum melakukannya.

    Untuk selengkapnya, lihat Menginstal atau memperbarui versi terbaru AWS CLI.

  2. Jalankan perintah berikut untuk melihat daftar parameter yang Anda memiliki izin untuk melampirkan label.

    catatan

    Parameter hanya tersedia di Wilayah AWS tempat mereka dibuat. Jika Anda tidak melihat parameter yang ingin Anda lampirkan labelnya, maka verifikasi Region Anda.

    aws ssm describe-parameters

    Perhatikan nama parameter yang Anda ingin melampirkan label.

  3. Jalankan perintah berikut ini untuk melihat semua versi dari parameter tersebut.

    aws ssm get-parameter-history --name "parameter-name"

    Perhatikan versi parameter yang Anda ingin melampirkan label.

  4. Jalankan perintah berikut ini untuk mengambil informasi tentang parameter berdasarkan nomor versinya.

    aws ssm get-parameters --names "parameter-name:version-number"

    Ini contohnya.

    aws ssm get-parameters --names "/Production/SQLConnectionString:3"

  5. Jalankan salah satu perintah berikut untuk melampirkan label ke sebuah versi parameter. Jika Anda melampirkan beberapa label, pisahkan nama label dengan spasi.

    Lampirkan label ke versi terbaru dari parameter

    aws ssm label-parameter-version --name parameter-name  --labels label-name

    Lampirkan label ke versi parameter tertentu

    aws ssm label-parameter-version --name parameter-name --parameter-version version-number --labels label-name

    Berikut ini adalah beberapa contoh.

    aws ssm label-parameter-version --name /config/endpoint --labels production east-region finance
    aws ssm label-parameter-version --name /config/endpoint --parameter-version 3 --labels MySQL-test
    catatan

    Jika output menunjukkan label yang Anda buat di daftar InvalidLabels, maka label tidak memenuhi persyaratan yang dijelaskan sebelumnya dalam topik ini. Tinjau persyaratan dan coba lagi. Jika daftar InvalidLabels kosong, maka label Anda berhasil diterapkan ke versi parameter.

  6. Anda dapat melihat detail parameter dengan menggunakan nomor versi atau nama label. Jalankan perintah berikut ini dan tentukan label yang Anda buat dalam langkah sebelumnya.

    aws ssm get-parameter --name parameter-name:label-name --with-decryption

    Perintah tersebut mengembalikan informasi seperti berikut.

    {
    "Parameter": {
        "Version": version-number, 
        "Type": "parameter-type", 
        "Name": "parameter-name", 
        "Value": "parameter-value", 
        "Selector": ":label-name"
    }
}
    catatan

    Pemilih dalam output adalah nomor versi atau label yang Anda tentukan dalam bidang input Name.

Lihat label untuk parameter menggunakan AWS CLI

Anda dapat menggunakan GetParameterHistoryAPIoperasi untuk melihat riwayat lengkap dan semua label yang dilampirkan ke parameter tertentu. Atau, Anda dapat menggunakan GetParametersByPathAPIoperasi untuk melihat daftar semua parameter yang diberi label tertentu.

Untuk melihat label untuk parameter dengan menggunakan GetParameterHistory API operasi

  1. Jalankan perintah berikut ini untuk melihat daftar parameter yang dapat Anda lihat labelnya.

    catatan

    Parameter hanya tersedia di Region tempat mereka dibuat. Jika Anda tidak melihat parameter yang ingin Anda pindahkan labelnya, maka verifikasi Region Anda.

    aws ssm describe-parameters

    Perhatikan nama parameter yang ingin Anda lihat labelnya.

  2. Jalankan perintah berikut ini untuk melihat semua versi dari parameter tersebut.

    aws ssm get-parameter-history --name parameter-name --with-decryption

    Sistem mengembalikan informasi seperti berikut ini.

    {
    "Parameters": [
        {
            "Name": "/Config/endpoint", 
            "LastModifiedDate": 1528932105.382, 
            "Labels": [
                "Deprecated"
            ], 
            "Value": "MyTestService-June-Release.example.com", 
            "Version": 1, 
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test", 
            "Type": "String"
        }, 
        {
            "Name": "/Config/endpoint", 
            "LastModifiedDate": 1528932111.222, 
            "Labels": [
                "Current"
            ], 
            "Value": "MyTestService-July-Release.example.com", 
            "Version": 2, 
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test", 
            "Type": "String"
        }
    ]
}

Melihat daftar parameter yang diberi label menggunakan AWS CLI

Anda dapat menggunakan GetParametersByPathAPIoperasi untuk melihat daftar semua parameter di jalur yang diberi label tertentu.

Jalankan perintah berikut ini untuk melihat daftar parameter di suatu jalur yang memiliki label tertentu. Ganti masing-masing example resource placeholder dengan informasi Anda sendiri.

aws ssm get-parameters-by-path \
    --path parameter-path \
    --parameter-filters Key=Label,Values=label-name,Option=Equals \
    --max-results a-number \
    --with-decryption --recursive

Sistem mengembalikan informasi seperti berikut ini. Untuk contoh ini, pengguna mencari di bawah /Config jalur.

{
    "Parameters": [
        {
            "Version": 3, 
            "Type": "SecureString", 
            "Name": "/Config/DBpwd", 
            "Value": "MyS@perGr&pass33"
        }, 
        {
            "Version": 2, 
            "Type": "String", 
            "Name": "/Config/DBusername", 
            "Value": "TestUserDB"
        }, 
        {
            "Version": 2, 
            "Type": "String", 
            "Name": "/Config/endpoint", 
            "Value": "MyTestService-July-Release.example.com"
        }
    ]
}

Memindahkan label parameter menggunakan AWS CLI

Prosedur berikut ini menjelaskan cara memindahkan sebuah label parameter ke versi yang berbeda dari parameter yang sama.

Untuk memindahkan label parameter

  1. Jalankan perintah berikut ini untuk melihat semua versi dari parameter tersebut. Ganti parameter name dengan informasi Anda sendiri.

    aws ssm get-parameter-history \
    --name "parameter name"

    Perhatikan versi parameter yang ingin Anda pindahkan labelnya yaitu sumber dan target.

  2. Jalankan perintah berikut ini untuk menetapkan label yang ada untuk versi yang berbeda dari sebuah parameter. Ganti masing-masing example resource placeholder dengan informasi Anda sendiri.

    aws ssm label-parameter-version \
    --name parameter name \
    --parameter-version version number \
    --labels name-of-existing-label
    catatan

    Jika Anda ingin memindahkan label yang ada ke versi parameter terbaru, maka hapus --parameter-version dari perintah.

Hapus label parameter menggunakan AWS CLI

Prosedur berikut ini menjelaskan cara menghapus label parameter menggunakan AWS CLI.

Untuk menghapus label parameter

  1. Jalankan perintah berikut ini untuk melihat semua versi dari parameter tersebut. Ganti parameter name dengan informasi Anda sendiri.

    aws ssm get-parameter-history \
    --name "parameter name"

    Sistem mengembalikan informasi seperti berikut ini.

    {
    "Parameters": [
        {
            "Name": "foo",
            "DataType": "text",
            "LastModifiedDate": 1607380761.11,
            "Labels": [
                "l3",
                "l2"
            ],
            "Value": "test",
            "Version": 1,
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test",
            "Policies": [],
            "Tier": "Standard",
            "Type": "String"
        },
        {
            "Name": "foo",
            "DataType": "text",
            "LastModifiedDate": 1607380763.11,
            "Labels": [
                "l1"
            ],
            "Value": "test",
            "Version": 2,
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test",
            "Policies": [],
            "Tier": "Standard",
            "Type": "String"
        }
    ]
}

    Perhatikan versi parameter yang Anda ingin hapus labelnya.

  2. Jalankan perintah berikut ini untuk menghapus label yang Anda pilih dari parameter tersebut. Ganti masing-masing example resource placeholder dengan informasi Anda sendiri.

    aws ssm unlabel-parameter-version \
    --name parameter name \
    --parameter-version version \
    --labels label 1,label 2,label 3

    Sistem mengembalikan informasi seperti berikut ini.

    {
    "InvalidLabels": ["invalid"], 
    "DeletedLabels" : ["Prod"]
 }