Utilisation des libellés de paramètres dans Parameter Store - AWS Systems Manager
Utilisation des libellés de paramètres à l'aide de la consoleUtilisation des libellés de paramètres à l'aide du AWS CLI

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation des libellés de paramètres dans Parameter Store

Une étiquette de paramètre est un alias défini par l'utilisateur pour vous aider à gérer les différentes versions d'un paramètre. Lorsque vous modifiez un paramètre, une nouvelle version est AWS Systems Manager automatiquement enregistrée et le numéro de version est incrémenté d'une unité. Une étiquette peut vous aider à vous souvenir de l'objectif d'une version de paramètre lorsqu'il existe plusieurs versions.

Par exemple, disons que vous avez un paramètre appelé /MyApp/DB/ConnectionString. La valeur du paramètre est une chaîne de connexion à un My SQL server dans une base de données locale dans un environnement de test. Une fois que vous avez terminé la mise à jour de l'application, vous souhaitez que le paramètre utilise une chaîne de connexion pour une base de données de production. Vous modifiez la valeur de /MyApp/DB/ConnectionString. Systems Manager crée automatiquement la version 2 avec la nouvelle chaîne de connexion. Pour vous aider à vous souvenir de l'objectif de chaque version, vous attachez une étiquette à chaque paramètre. Pour la version 1, vous attachez l'étiquette Test et pour la version 2, vous attachez l'étiquette Production.

Vous pouvez déplacer les étiquettes d'une version d'un paramètre à une autre version. Par exemple, si vous créez la version 3 du paramètre /MyApp/DB/ConnectionString avec une chaîne de connexion pour une nouvelle base de données de production, vous pouvez déplacer l'étiquette Production de la version 2 vers la version 3 du paramètre.

Les étiquettes de paramètre sont une alternative légère aux balises de paramètre. Votre organisation peut avoir des consignes strictes concernant les balises qui doivent être appliquées aux différentes ressources AWS . En revanche, une étiquette est une simple association de texte pour une version spécifique d'un paramètre.

À l'instar des balises, vous pouvez interroger les paramètres à l'aide des étiquettes. Vous pouvez consulter une liste de versions de paramètres spécifiques qui utilisent toutes le même libellé si vous interrogez votre ensemble de paramètres à l'aide de l'GetParametersByPathAPIopération, comme décrit plus loin dans cette section.

Note

Si vous exécutez une commande qui spécifie une version d'un paramètre qui n'existe pas, la commande échoue. Il ne revient pas à la valeur la plus récente ou à la valeur par défaut du paramètre.

Exigences et restrictions liées aux étiquettes

Les étiquettes de paramètre possèdent les exigences et les restrictions suivantes :

  • Une version d'un paramètre peut avoir un maximum de 10 étiquettes.

  • Vous ne pouvez pas attacher la même étiquette à différentes versions d'un même paramètre. Par exemple, si la version 1 du paramètre a l'étiquette Production, vous ne pouvez pas attacher Production à la version 2.

  • Vous pouvez déplacer une étiquette d'une version d'un paramètre à une autre.

  • Vous ne pouvez pas créer d'étiquette lorsque vous créez un paramètre. Vous devez attacher une étiquette à une version spécifique d'un paramètre.

  • Si vous ne souhaitez plus utiliser une étiquette de paramètre, vous pouvez la déplacer vers une autre version d'un paramètre ou la supprimer.

  • Une étiquette peut comporter un maximum de 100 caractères.

  • Les étiquettes peuvent contenir des lettres (sensibles à la casse), des chiffres, des points (.), des tirets (-) et des traits de soulignement (_).

  • Les étiquettes ne peuvent pas commencer par un chiffre, par « aws » ni par « ssm » (non sensible à la casse). Si une étiquette ne répond pas à ces exigences, elle n'est pas attachée à la version du paramètre et le système l'affiche dans la liste InvalidLabels.

Utilisation des libellés de paramètres à l'aide de la console

Cette section explique comment effectuer les tâches suivantes à l'aide de la console Systems Manager.

Création d'une étiquette de paramètre à l'aide de la console

La procédure suivante indique comment attacher une étiquette à une version spécifique d'un paramètre existant à l'aide de la console Systems Manager. Vous ne pouvez pas attacher d'étiquette lorsque vous créez un paramètre.

Pour attacher une étiquette à la version d'un paramètre

  1. Ouvrez la AWS Systems Manager console à l'adresse https://console.aws.amazon.com/systems-manager/.

  2. Dans le volet de navigation, choisissez Parameter Store.

  3. Sélectionnez le nom d'un paramètre pour ouvrir la page des détails de ce paramètre.

  4. Sélectionnez l'onglet History (Historique).

  5. Sélectionnez la version du paramètre pour laquelle vous souhaitez attacher une étiquette.

  6. Sélectionnez Manage labels (Gérer des étiquettes).

  7. Sélectionnez Add new label (Ajouter une nouvelle étiquette).

  8. Dans la zone de texte, saisissez le nom de l'étiquette. Pour ajouter d'autres étiquettes, sélectionnez Add new label (Ajouter une nouvelle étiquette). Vous pouvez attacher un maximum de dix étiquettes.

  9. Lorsque vous avez terminé, sélectionnez Enregistrer les modifications.

Afficher les étiquettes associées à un paramètre à l'aide de la console

Une version de paramètre peut avoir un maximum de dix étiquettes. La procédure suivante explique comment afficher toutes les étiquettes attachées à une version de paramètre à l'aide de la console Systems Manager.

Pour afficher les étiquettes attachées à la version d'un paramètre

  1. Ouvrez la AWS Systems Manager console à l'adresse https://console.aws.amazon.com/systems-manager/.

  2. Dans le volet de navigation, choisissez Parameter Store.

  3. Sélectionnez le nom d'un paramètre pour ouvrir la page des détails de ce paramètre.

  4. Sélectionnez l'onglet History (Historique).

  5. Localisez la version du paramètre pour laquelle vous souhaitez afficher toutes les étiquettes attachées. La colonne Labels (Étiquettes) indique toutes les étiquettes attachées à la version de paramètre.

Déplacer une étiquette de paramètre à l'aide de la console

La procédure suivante explique comment déplacer une étiquette de paramètre vers une autre version du même paramètre à l'aide de la console Systems Manager.

Pour déplacer une étiquette vers une autre version du paramètre

  1. Ouvrez la AWS Systems Manager console à l'adresse https://console.aws.amazon.com/systems-manager/.

  2. Dans le volet de navigation, choisissez Parameter Store.

  3. Sélectionnez le nom d'un paramètre pour ouvrir la page des détails de ce paramètre.

  4. Sélectionnez l'onglet History (Historique).

  5. Sélectionnez la version du paramètre pour laquelle vous souhaitez déplacer l'étiquette.

  6. Sélectionnez Manage labels (Gérer des étiquettes).

  7. Sélectionnez Add new label (Ajouter une nouvelle étiquette).

  8. Dans la zone de texte, saisissez le nom de l'étiquette.

  9. Lorsque vous avez terminé, sélectionnez Enregistrer les modifications.

Supprimer les libellés de paramètres à l'aide de la console

La procédure suivante décrit la suppression d'une ou plusieurs étiquettes de paramètres avec la console Systems Manager.

Pour supprimer des étiquettes d'un paramètre

  1. Ouvrez la AWS Systems Manager console à l'adresse https://console.aws.amazon.com/systems-manager/.

  2. Dans le volet de navigation, choisissez Parameter Store.

  3. Sélectionnez le nom d'un paramètre pour ouvrir la page des détails de ce paramètre.

  4. Sélectionnez l'onglet History (Historique).

  5. Sélectionnez la version du paramètre pour laquelle vous souhaitez supprimer les étiquettes.

  6. Sélectionnez Manage labels (Gérer des étiquettes).

  7. Sélectionnez Remove (Supprimer) en regard de chaque étiquette à supprimer.

  8. Lorsque vous avez terminé, sélectionnez Enregistrer les modifications.

  9. Confirmez l'exactitude de vos modifications, saisissez Confirm dans la zone de texte, puis sélectionnez Confirm (Confirmer).

Utilisation des libellés de paramètres à l'aide du AWS CLI

Cette section explique comment effectuer les tâches suivantes à l'aide de l' AWS Command Line Interface (AWS CLI).

Créez une nouvelle étiquette de paramètre à l'aide du AWS CLI

La procédure suivante indique comment attacher une étiquette à une version spécifique d'un paramètre existant à l'aide de l' AWS CLI. Vous ne pouvez pas attacher d'étiquette lorsque vous créez un paramètre.

Pour créer une étiquette de paramètre

  1. Installez et configurez le AWS Command Line Interface (AWS CLI), si ce n'est pas déjà fait.

    Pour de plus amples informations, consultez Installation ou mise à jour de la version la plus récente de l' AWS CLI.

  2. Exécutez la commande suivante pour afficher la liste des paramètres auxquels vous êtes autorisé à attacher une étiquette.

    Note

    Les paramètres ne sont disponibles que Région AWS là où ils ont été créés. Si vous ne trouvez pas le paramètre auquel vous souhaitez attacher une étiquette, vérifiez votre région.

    aws ssm describe-parameters

    Notez le nom d'un paramètre auquel vous souhaitez attacher une étiquette.

  3. Exécutez la commande suivante pour afficher toutes les versions du paramètre.

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

    Notez la version du paramètre à laquelle vous souhaitez attacher une étiquette.

  4. Exécutez la commande suivante pour récupérer des informations sur un paramètre par numéro de version.

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

    Voici un exemple.

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

  5. Exécutez l'une des commandes suivantes pour attacher une étiquette à une version d'un paramètre. Si vous attachez plusieurs étiquettes, séparez leurs noms par un espace.

    Attacher une étiquette à la dernière version d'un paramètre

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

    Attacher une étiquette à une version spécifique d'un paramètre

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

    Voici quelques exemples.

    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
    Note

    Si la sortie montre l'étiquette que vous avez créée dans la liste InvalidLabels, l'étiquette ne respecte pas les exigences décrites plus haut dans cette rubrique. Passez en revue les exigences et réessayez. Si la liste InvalidLabels est vide, votre étiquette a été correctement appliquée à la version du paramètre.

  6. Vous pouvez afficher les détails du paramètre en utilisant un numéro de version ou un nom d'étiquette. Exécutez la commande suivante et spécifiez l'étiquette que vous avez créée à l'étape précédente.

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

    La commande renvoie des informations telles que les suivantes.

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

    Selector dans la sortie correspond au numéro de version ou à l'étiquette que vous avez spécifiée dans le champ de saisie Name.

Afficher les libellés d'un paramètre à l'aide du AWS CLI

Vous pouvez utiliser cette GetParameterHistoryAPIopération pour afficher l'historique complet et toutes les étiquettes associées à un paramètre spécifique. Vous pouvez également utiliser cette GetParametersByPathAPIopération pour afficher la liste de tous les paramètres auxquels une étiquette spécifique est attribuée.

Pour afficher les libellés d'un paramètre à l'aide de l' GetParameterHistory APIopération

  1. Exécutez la commande suivante pour afficher la liste des paramètres dont vous pouvez afficher les étiquettes.

    Note

    Les paramètres sont uniquement disponibles dans la région où ils ont été créés. Si vous ne trouvez pas de paramètre pour lequel vous souhaitez déplacer une étiquette, vérifiez votre région.

    aws ssm describe-parameters

    Notez le nom du paramètre dont vous voulez afficher les étiquettes.

  2. Exécutez la commande suivante pour afficher toutes les versions du paramètre.

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

    Le système retourne des informations telles que les suivantes.

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

Consultez la liste des paramètres auxquels une étiquette est attribuée à l'aide du AWS CLI

Vous pouvez utiliser cette GetParametersByPathAPIopération pour afficher la liste de tous les paramètres d'un chemin auxquels une étiquette spécifique a été attribuée.

Exécutez la commande suivante pour afficher la liste des paramètres dans un chemin d'accès auxquels une étiquette spécifique est attribuée. Remplacez chacun example resource placeholder avec vos propres informations.

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

Le système retourne des informations telles que les suivantes. Pour cet exemple, l'utilisateur a recherché dans le chemin d'accès /Config.

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

Déplacez une étiquette de paramètre à l'aide du AWS CLI

La procédure suivante explique comment déplacer une étiquette de paramètre vers une autre version du même paramètre.

Pour déplacer une étiquette de paramètre

  1. Exécutez la commande suivante pour afficher toutes les versions du paramètre. Remplacez parameter name avec vos propres informations.

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

    Notez les versions des paramètres vers lesquelles, ou à partir desquelles, vous voulez déplacer l'étiquette.

  2. Exécutez la commande suivante pour affecter une étiquette existante à une autre version d'un paramètre. Remplacez chacun example resource placeholder avec vos propres informations.

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

    Si vous souhaitez déplacer une étiquette existante vers la dernière version d'un paramètre, supprimez --parameter-version de la commande.

Supprimez les étiquettes de paramètres à l'aide du AWS CLI

La procédure suivante décrit la suppression des étiquettes de paramètres à l'aide de la AWS CLI.

Pour supprimer une étiquette de paramètre

  1. Exécutez la commande suivante pour afficher toutes les versions du paramètre. Remplacez parameter name avec vos propres informations.

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

    Le système retourne des informations telles que les suivantes.

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

    Notez la version du paramètre pour laquelle vous souhaitez supprimer une ou plusieurs étiquettes.

  2. Exécutez la commande suivante pour supprimer de ce paramètre les étiquettes que vous avez choisies. Remplacez chacun example resource placeholder avec vos propres informations.

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

    Le système retourne des informations telles que les suivantes.

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