Arbeiten mit Parameterbeschriftungen in Parameter Store - AWS Systems Manager
Arbeiten mit Parameterbeschriftungen mithilfe der KonsoleArbeiten Sie mit Parameterbeschriftungen unter Verwendung der AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Arbeiten mit Parameterbeschriftungen in Parameter Store

Eine Parameter-Bezeichnung ist ein benutzerdefinierter Alias, mit dem Sie verschiedene Versionen eines Parameters verwalten können. Wenn Sie einen Parameter ändern, AWS Systems Manager wird automatisch eine neue Version gespeichert und die Versionsnummer wird um eins erhöht. Dank einer Bezeichnung können Sie sich den Zweck einer Parameterversion merken, wenn mehrere Versionen vorhanden sind.

Nehmen wir beispielsweise an, Sie haben einen Parameter mit dem Namen /MyApp/DB/ConnectionString. Der Wert des Parameters ist eine Verbindungszeichenfolge zu einem SQL My-Server in einer lokalen Datenbank in einer Testumgebung. Nachdem Sie die Anwendung aktualisiert haben, möchten Sie festlegen, dass der Parameter eine Verbindungszeichenfolge für eine Produktionsdatenbank verwendet. Sie ändern den Wert von /MyApp/DB/ConnectionString. Systems Manager erstellt automatisch Version 2 mit der neuen Verbindungszeichenfolge. Damit Sie sich den Zweck der einzelnen Versionen besser merken können, fügen Sie jedem Parameter eine Bezeichnung an. Für Version eins fügen Sie die Bezeichnung Test an. Für Version zwei fügen Sie die Bezeichnung Production an.

Sie können Bezeichnungen von einer Version eines Parameters in eine andere Version verschieben. Wenn Sie beispielsweise Version drei des Parameters /MyApp/DB/ConnectionString mit einer Verbindungszeichenfolge für eine neue Produktionsdatenbank erstellen, können Sie die Bezeichnung Production von Version zwei des Parameters zu Version drei des Parameters verschieben.

Parameterbezeichnungen stellen eine einfache Alternative zu Parameter-Tags dar. Ihre Organisation verfügt u. U. über strenge Richtlinien für Tags, die auf verschiedene AWS -Ressourcen angewendet werden müssen. Im Gegensatz dazu ist eine Bezeichnung einfach eine Textzuordnung für eine bestimmte Version eines Parameters.

Ähnlich wie Tags können Sie Parameter mithilfe von Bezeichnungen abfragen. Sie können eine Liste bestimmter Parameterversionen anzeigen, die alle dieselbe Bezeichnung verwenden, wenn Sie Ihren Parametersatz mithilfe der GetParametersByPathAPIOperation abfragen, wie später in diesem Abschnitt beschrieben.

Anmerkung

Wenn Sie einen Befehl ausführen, der eine Version eines Parameters angibt, die nicht existiert, schlägt der Befehl fehl. Es greift nicht auf den letzten oder Standardwert des Parameters zurück.

Anforderungen und Einschränkungen für Bezeichnungen

Für Parameterbezeichnungen gelten die folgenden Anforderungen und Einschränkungen:

  • Für eine Version eines Parameters sind maximal 10 Bezeichnungen zulässig.

  • Es ist nicht möglich, die gleiche Bezeichnung verschiedenen Versionen desselben Parameters anzufügen. Wenn Version 1 des Parameters beispielsweise die Bezeichnung Production hat, können Sie Production nicht an Version 2 anfügen.

  • Sie können eine Bezeichnung von einer Version eines Parameters zu einer anderen Version verschieben.

  • Es ist nicht möglich, eine Bezeichnung festzulegen, wenn Sie einen Parameter erstellen. Sie müssen eine Bezeichnung einer bestimmten Version eines Parameters anfügen.

  • Wenn Sie eine Parameterbezeichnung nicht mehr verwenden möchten, können Sie sie zu einer anderen Version eines Parameters verschieben oder sie löschen.

  • Eine Bezeichnung darf höchstens 100 Zeichen lang sein.

  • Bezeichnungen können Buchstaben (Unterscheidung nach Groß- und Kleinschreibung), Ziffern, Punkte (.), Bindestriche (-) und Unterstriche (_) enthalten.

  • Bezeichnungen dürfen nicht mit einer Zahl, "aws" oder "ssm" (keine Unterscheidung nach Groß- und Kleinschreibung) beginnen. Wenn eine Bezeichnung diese Anforderungen nicht erfüllt, wird sie der Parameterversion nicht angefügt und vom System in der Liste InvalidLabels angezeigt.

Arbeiten mit Parameterbeschriftungen mithilfe der Konsole

In diesem Abschnitt wird beschrieben, wie Sie die folgenden Aufgaben mithilfe der Systems Manager-Konsole durchführen.

Erstellen Sie mithilfe der Konsole ein Parameterlabel

Im folgenden Verfahren wird beschrieben, wie Sie einer bestimmten Version eines vorhandenen Parameters über die Systems Manager-Konsole eine Bezeichnung anfügen. Es ist nicht möglich, eine Bezeichnung anzufügen, wenn Sie einen neuen Parameter erstellen.

Anfügen einer Bezeichnung an die aktuelle Version eines Parameters

  1. Öffnen Sie die AWS Systems Manager Konsole unter https://console.aws.amazon.com/systems-manager/.

  2. Wählen Sie im Navigationsbereich Parameter Store.

  3. Wählen Sie den Namen eines Parameters aus, um die Detailseite für diesen Parameter anzuzeigen.

  4. Wählen Sie die Registerkarte History (Verlauf) aus.

  5. Wählen Sie die Parameterversion aus, der Sie eine Bezeichnung anfügen möchten.

  6. Klicken Sie auf Verwalten von Bezeichnungen.

  7. Klicken Sie auf Hinzufügen einer neuen Bezeichnung.

  8. Geben Sie den Namen der Bezeichnung in das Textfeld ein. Wählen Sie Add new label (Neue Bezeichnung hinzufügen) aus, um weitere Bezeichnungen hinzuzufügen. Sie können maximal zehn Bezeichnungen anfügen.

  9. Wenn Sie fertig sind, wählen Sie Änderungen speichern aus.

Zeigen Sie mithilfe der Konsole Labels an, die an einen Parameter angehängt sind

Für eine Parameterversion sind maximal 10 Bezeichnungen zulässig. Im folgenden Verfahren wird beschrieben, wie Sie alle Bezeichnungen, die einer Parameterversion angefügt sind, mithilfe der Systems Manager-Konsole anzeigen.

Anzeigen von Bezeichnungen, die einer Parameterversion angefügt sind

  1. Öffnen Sie die AWS Systems Manager Konsole unter https://console.aws.amazon.com/systems-manager/.

  2. Wählen Sie im Navigationsbereich Parameter Store.

  3. Wählen Sie den Namen eines Parameters aus, um die Detailseite für diesen Parameter anzuzeigen.

  4. Wählen Sie die Registerkarte History (Verlauf) aus.

  5. Suchen Sie die Parameterversion, für die Sie die angefügten Bezeichnungen anzeigen möchten. Die Spalte Labels (Bezeichnungen) enthält alle Bezeichnungen, die der Parameterversion angefügt sind.

Verschieben Sie eine Parameterbezeichnung mithilfe der Konsole

Im folgenden Verfahren wird beschrieben, wie Sie eine Parameterbezeichnung zu einer anderen Version desselben Parameters mithilfe der Systems Manager-Konsole verschieben.

So verschieben Sie eine Bezeichnung zu einer Parameterversion

  1. Öffnen Sie die AWS Systems Manager Konsole unter https://console.aws.amazon.com/systems-manager/.

  2. Wählen Sie im Navigationsbereich Parameter Store.

  3. Wählen Sie den Namen eines Parameters aus, um die Detailseite für diesen Parameter anzuzeigen.

  4. Wählen Sie die Registerkarte History (Verlauf) aus.

  5. Wählen Sie die Parameterversion aus, deren Bezeichnung Sie verschieben möchten.

  6. Klicken Sie auf Verwalten von Bezeichnungen.

  7. Klicken Sie auf Hinzufügen einer neuen Bezeichnung.

  8. Geben Sie den Namen der Bezeichnung in das Textfeld ein.

  9. Wenn Sie fertig sind, wählen Sie Änderungen speichern aus.

Löschen Sie Parameterbeschriftungen mithilfe der Konsole

Im folgenden Verfahren wird beschrieben, wie Sie über die Systems Manager-Konsole eine oder mehrere Parameterbezeichnungen löschen.

So löschen Sie Bezeichnungen aus einem Parameter

  1. Öffnen Sie die AWS Systems Manager Konsole unter https://console.aws.amazon.com/systems-manager/.

  2. Wählen Sie im Navigationsbereich Parameter Store.

  3. Wählen Sie den Namen eines Parameters aus, um die Detailseite für diesen Parameter anzuzeigen.

  4. Wählen Sie die Registerkarte History (Verlauf) aus.

  5. Wählen Sie die Parameterversion aus, deren Bezeichnungen Sie löschen möchten.

  6. Klicken Sie auf Verwalten von Bezeichnungen.

  7. Klicken Sie neben jeder Bezeichnung, die Sie löschen möchten, auf Remove (Entfernen).

  8. Wenn Sie fertig sind, wählen Sie Änderungen speichern aus.

  9. Bestätigen Sie, dass Ihre Änderungen korrekt sind, geben Sie Confirm in das Textfeld ein und wählen Sie Bestätigen aus.

Arbeiten Sie mit Parameterbeschriftungen unter Verwendung der AWS CLI

In diesem Abschnitt wird beschrieben, wie Sie die folgenden Aufgaben mithilfe der AWS Command Line Interface (AWS CLI) durchführen.

Erstellen Sie ein neues Parameterlabel mit dem AWS CLI

Im folgenden Verfahren wird beschrieben, wie Sie einer bestimmten Version eines vorhandenen Parameters über die AWS CLI eine Bezeichnung anfügen. Es ist nicht möglich, eine Bezeichnung anzufügen, wenn Sie einen neuen Parameter erstellen.

So erstellen Sie eine neue Parameterbezeichnung

  1. Installieren und konfigurieren Sie AWS Command Line Interface (AWS CLI), falls Sie dies noch nicht getan haben.

    Weitere Informationen finden Sie unter Installieren oder Aktualisieren der neuesten Version von AWS CLI.

  2. Führen Sie den folgenden Befehl aus, um eine Liste der Parameter anzuzeigen, für die Sie über die Berechtigung zum Anfügen einer Bezeichnung verfügen.

    Anmerkung

    Parameter sind nur dort verfügbar AWS-Region , wo sie erstellt wurden. Falls Sie einen Parameter, dem Sie eine Bezeichnung anfügen möchten, nicht finden können, prüfen Sie Ihre Region.

    aws ssm describe-parameters

    Notieren Sie den Namen eines Parameters, dem Sie eine Bezeichnung anfügen möchten.

  3. Führen Sie den folgenden Befehl aus, um alle Versionen des Parameters anzuzeigen.

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

    Notieren Sie die Parameterversion, der Sie eine Bezeichnung anfügen möchten.

  4. Führen Sie den folgenden Befehl aus, um anhand der Versionsnummer Informationen zu einem Parameter abzurufen.

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

    Ein Beispiel.

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

  5. Führen Sie einen der folgenden Befehle aus, um einer Parameterversion eine Bezeichnung anzufügen. Wenn Sie mehrere Bezeichnungen anzufügen, müssen Sie die Namen der Bezeichnungen durch ein Leerzeichen trennen.

    Anfügen einer Bezeichnung an die aktuelle Version eines Parameters

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

    Anfügen einer Bezeichnung an eine bestimmte Version eines Parameters

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

    Hier sind einige Beispiele.

    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
    Anmerkung

    Wenn die Ausgabe die Bezeichnung zeigt, die Sie in der Liste InvalidLabels erstellt haben, entspricht die Bezeichnung nicht den weiter oben in diesem Thema beschriebenen Anforderungen. Überprüfen Sie die Anforderungen und versuchen Sie es erneut. Wenn die Liste InvalidLabels leer ist, wurde Ihre Bezeichnung der Version des Parameters erfolgreich angefügt.

  6. Sie können die Details des Parameters entweder mithilfe einer Versionsnummer oder eines Bezeichnungsnamens anzeigen. Führen Sie den folgenden Befehl aus und geben Sie die im vorherigen Schritt erstellte Bezeichnung an.

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

    Der Befehl gibt Informationen wie die folgenden zurück.

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

    Selector (Auswahl) in der Ausgabe ist entweder die Versionsnummer oder die Bezeichnung, die Sie im Eingabefeld Name angegeben haben.

Zeigen Sie Beschriftungen für einen Parameter an, indem Sie den AWS CLI

Sie können den GetParameterHistoryAPIVorgang verwenden, um den vollständigen Verlauf und alle Labels anzuzeigen, die einem bestimmten Parameter zugeordnet sind. Sie können den GetParametersByPathAPIVorgang auch verwenden, um eine Liste aller Parameter anzuzeigen, denen eine bestimmte Bezeichnung zugewiesen wurde.

Um Beschriftungen für einen Parameter mithilfe der GetParameterHistory API Operation anzuzeigen

  1. Führen Sie den folgenden Befehl aus, um eine Liste der Parameter anzuzeigen, für die Sie Bezeichnungen anzeigen können.

    Anmerkung

    Parameter sind nur in den Regionen verfügbar, in denen sie erstellt wurden. Falls Sie einen Parameter, für den Sie eine Bezeichnung verschieben möchten, nicht finden können, prüfen Sie Ihre Region.

    aws ssm describe-parameters

    Notieren Sie sich den Namen des Parameters, dessen Bezeichnungen Sie anzeigen möchten.

  2. Führen Sie den folgenden Befehl aus, um alle Versionen des Parameters anzuzeigen.

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

    Das System gibt unter anderem folgende Informationen zurück

    {
    "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"
        }
    ]
}

Zeigen Sie eine Liste von Parametern an, denen eine Bezeichnung zugewiesen wurde, mithilfe der AWS CLI

Sie können den GetParametersByPathAPIVorgang verwenden, um eine Liste aller Parameter in einem Pfad anzuzeigen, denen eine bestimmte Bezeichnung zugewiesen wurde.

Führen Sie den folgenden Befehl aus, um eine Liste der Parameter in einem Pfad anzuzeigen, denen eine bestimmte Bezeichnung zugeordnet wurde. Ersetzen Sie jeden example resource placeholder mit Ihren eigenen Informationen.

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

Das System gibt unter anderem folgende Informationen zurück In diesem Beispiel durchsuchte der Benutzer den /Config-Pfad.

{
    "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"
        }
    ]
}

Verschieben Sie eine Parameterbeschriftung mit dem AWS CLI

Im folgenden Verfahren wird beschrieben, wie Sie eine Parameterbezeichnung zu einer anderen Version desselben Parameters verschieben.

So verschieben Sie eine Parameterbezeichnung

  1. Führen Sie den folgenden Befehl aus, um alle Versionen des Parameters anzuzeigen. Ersetzen parameter name mit Ihren eigenen Informationen.

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

    Beachten Sie die Parameterversionen, aus denen Sie die Bezeichnung verschieben möchten.

  2. Führen Sie den folgenden Befehl aus, um eine vorhandene Bezeichnung einer anderen Version eines Parameters zuzuweisen. Ersetze jedes example resource placeholder mit Ihren eigenen Informationen.

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

    Wenn Sie eine vorhandene Bezeichnung zur neuesten Version eines Parameters verschieben möchten, entfernen Sie --parameter-version aus dem Befehl.

Löschen Sie Parameterbeschriftungen mit dem AWS CLI

Im folgenden Verfahren wird beschrieben, wie Sie Parameterbezeichnungen mithilfe der AWS CLI löschen.

So löschen Sie eine Parameterbezeichnung

  1. Führen Sie den folgenden Befehl aus, um alle Versionen des Parameters anzuzeigen. Ersetzen parameter name mit Ihren eigenen Informationen.

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

    Das System gibt unter anderem folgende Informationen zurück

    {
    "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"
        }
    ]
}

    Notieren Sie die Parameterversion, für die Sie eine oder mehrere Bezeichnungen löschen möchten.

  2. Führen Sie den folgenden Befehl aus, um die Bezeichnungen zu löschen, die Sie aus diesem Parameter auswählen. Ersetze jedes example resource placeholder mit Ihren eigenen Informationen.

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

    Das System gibt unter anderem folgende Informationen zurück

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