Referenz zum Parameterspeicher

Ein Parameter ist ein beliebiges DatenelementParameter Store, das gespeichert ist, z. B. ein Textblock, eine Namensliste, eine AMI ID, eine Händler-ID oder ein anderer Konfigurationswert. Sie können diese Daten in Ihren Skripten, Befehlen und SSM-Dokumenten zentral referenzieren.

Wenn Sie auf einen Parameter verweisen, geben Sie den Parameternamen gemäß der folgenden Konvention an.

{{ssm:parameter-name}}

Parameter Store bietet Unterstützung für drei Arten von Parametern: String, StringList und SecureString.

Mit einer Ausnahme geben Sie beim Erstellen oder Aktualisieren eines Parameters den Parameterwert als Klartext ein und Parameter Store führt keine Validierung für den eingegebenen Text aus. Bei String-Parametern können Sie jedoch den Datentyp als aws:ec2:image angeben und Parameter Store prüft , ob der eingegebene Wert das richtige Format für ein Amazon EC2 AMI aufweist. Beispiel: ami-12345abcdeEXAMPLE.

Parametertyp: String

Standardmäßig nimmt der String-Parameter jeden beliebigen Textblock auf, den Sie eingeben. Beispiel:

Typ des Parameters: StringList

Die Werte der StringList-Parameter enthalten eine kommagetrennte Liste von Werten wie in den folgenden Beispielen gezeigt.

Monday,Wednesday,Friday

CSV,TSV,CLF,ELF,JSON

Typ des Parameters: SecureString

Wird SecureString für Konfigurationswerte verwendet, die eine Verschlüsselung erfordern, z. B. Dienstendpunkte und Kontokennungen. Für geheime Daten wie Datenbankanmeldeinformationen, API-Schlüssel oder Token empfehlen wir diese Methode. Diese Option bietet speziell entwickelte Sicherheitskontrollen AWS Secrets Manager, einschließlich automatischer Rotation und regionsübergreifender Replikation.

Nur der Parameterwert ist verschlüsselt. Der Parametername, die Beschreibung und andere Metadaten sind nicht verschlüsselt.

Parameter Storeverschlüsselt und entschlüsselt SecureString Parameterwerte mithilfe eines AWS KMS Schlüssels. Sie können das Von AWS verwalteter Schlüssel Standardformular Parameter Store oder einen vom Kunden verwalteten Schlüssel verwenden. Verwenden Sie einen vom Kunden verwalteten Schlüssel, wenn Sie einschränken müssen, welche Principals bestimmte Parameter entschlüsseln können. Weitere Informationen finden Sie unter Verschlüsseln und Entschlüsseln von Parametern mit AWS KMS keys.

Sie können SecureString Parameter zusammen mit anderen verwenden AWS-Services. Die folgende Lambda-Funktion ruft eine verschlüsselte Händler-ID aus dem /myapp/dev/vendor/merchant-id Parameter ab. Die Funktion verwendet den Wert, ohne ihn in die Funktionsprotokolle zu schreiben oder ihn in der Antwort zurückzugeben.

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 Verschlüsselung und Preisgestaltung

Wenn Sie einen SecureString Parameter erstellen, verwendet Systems Manager ihn, AWS KMS um den Parameterwert zu verschlüsseln.

Für die Erstellung eines SecureString Parameters fallen keine Gebühren Parameter Store an, für die Verwendung AWS KMS können jedoch Gebühren anfallen. Weitere Informationen finden Sie unter AWS Key Management Service Preise.

Weitere Informationen zu Schlüsseln Von AWS verwaltete Schlüssel und vom Kunden verwalteten Schlüsseln finden Sie unter AWS Key Management Service Konzepte im AWS Key Management Service Entwicklerhandbuch. Weitere Informationen zur Verwendung finden Sie AWS KMS unter Parameter Store AWS Systems ManagerParameter Store Verwendungsweise AWS KMS.

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

Einschränkungen für Parameternamen

Die Informationen in diesem Thema sind hilfreich bei der Angabe gültiger Werte für Parameternamen, wenn Sie einen Parameter erstellen.

Diese Informationen ergänzen die Details im Thema PutParameter in der AWS Systems Manager API-Referenz, die auch Informationen zu den Werten Description AllowedPattern , Overwrite KeyId , Type und Value enthält.

Die Anforderungen und Einschränkungen für Parameternamen umfassen Folgendes: