Referensi penyimpanan parameter

Parameter adalah setiap bagian data yang disimpan diParameter Store, seperti blok teks, daftar nama, AMI ID, ID pedagang, atau nilai konfigurasi lainnya. Anda dapat mereferensikan data ini secara terpusat di skrip, perintah, dan dokumen SSM Anda.

Saat Anda mereferensikan parameter, Anda menentukan nama parameter menggunakan konvensi berikut.

{{ssm:parameter-name}}

Parameter Storememberikan dukungan untuk tiga jenis parameter:String,StringList, danSecureString.

Dengan satu pengecualian, saat Anda membuat atau memperbarui parameter, Anda memasukkan nilai parameter sebagai plaintext, dan tidak Parameter Store melakukan validasi pada teks yang Anda masukkan. Namun, untuk String parameter, Anda dapat menentukan tipe data sebagaiaws:ec2:image, dan Parameter Store memvalidasi bahwa nilai yang Anda masukkan adalah format yang tepat untuk Amazon EC2AMI; misalnya:. ami-12345abcdeEXAMPLE

Jenis parameter: String

Secara default, nilai String parameter terdiri dari setiap blok teks yang Anda masukkan. Contoh:

Jenis parameter: StringList

Nilai StringList parameter berisi daftar nilai yang dipisahkan koma, seperti yang ditunjukkan dalam contoh berikut.

Monday,Wednesday,Friday

CSV,TSV,CLF,ELF,JSON

Jenis parameter: SecureString

Gunakan SecureString untuk nilai konfigurasi yang memerlukan enkripsi, seperti titik akhir layanan dan pengidentifikasi akun. Untuk rahasia seperti kredentif database, kunci API, atau token, kami sarankan AWS Secrets Manager, yang menyediakan kontrol keamanan yang dibuat khusus termasuk rotasi otomatis dan replikasi lintas wilayah.

Hanya nilai parameter yang dienkripsi. Nama parameter, deskripsi, dan metadata lainnya tidak dienkripsi.

Parameter Storemengenkripsi dan mendekripsi nilai SecureString parameter menggunakan kunci. AWS KMS Anda dapat menggunakan default Kunci yang dikelola AWS untuk Parameter Store atau kunci yang dikelola pelanggan. Gunakan kunci yang dikelola pelanggan saat Anda perlu membatasi prinsipal mana yang dapat mendekripsi parameter tertentu. Untuk informasi selengkapnya, lihat Mengenkripsi dan mendekripsi parameter menggunakan AWS KMS keys.

Anda dapat menggunakan SecureString parameter dengan yang lain Layanan AWS. Fungsi Lambda berikut mengambil ID pedagang terenkripsi dari parameter. /myapp/dev/vendor/merchant-id Fungsi menggunakan nilai tanpa menuliskannya ke log fungsi atau mengembalikannya dalam respons.

import json
import boto3

ssm = boto3.client("ssm", region_name="us-east-1")

def lambda_handler(event, context):
    response = ssm.get_parameter(
        Name="/myapp/dev/vendor/merchant-id",
        WithDecryption=True
    )

    merchant_id = response["Parameter"]["Value"]

    # Use merchant_id when communicating with the vendor system.
    # Don't write the value to logs or include it in the response.

    return {
        "statusCode": 200,
        "body": json.dumps("Vendor configuration retrieved.")
    }

AWS KMS enkripsi dan harga

Saat Anda membuat SecureString parameter, Manajer Sistem menggunakan AWS KMS untuk mengenkripsi nilai parameter.

Tidak ada biaya Parameter Store untuk membuat SecureString parameter, tetapi biaya untuk penggunaan AWS KMS dapat berlaku. Untuk informasi selengkapnya, lihat harga AWS Key Management Service.

Untuk informasi selengkapnya tentang Kunci yang dikelola AWS dan kunci yang dikelola pelanggan, lihat AWS Key Management Service Konsep di Panduan AWS Key Management Service Pengembang. Untuk informasi selengkapnya tentang cara Parameter Store menggunakan AWS KMS, lihat Cara AWS Systems ManagerParameter Store menggunakan AWS KMS.

aws kms describe-key \
    --region us-east-1 \
    --key-id alias/aws/ssm

Kendala nama parameter

Gunakan informasi dalam topik ini untuk membantu Anda menentukan nilai yang valid untuk nama parameter saat Anda membuat parameter.

Informasi ini melengkapi detail dalam topik PutParameter di Referensi AWS Systems Manager API, yang juga menyediakan informasi tentang nilai AllowedPattern, Deskripsi,, Over KeyId write, Type , dan Val ue.

Persyaratan dan kendala untuk nama parameter mencakup hal berikut: