Créer un paramètre Systems Manager (Tools for Windows PowerShell) - AWS Systems Manager

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.

Créer un paramètre Systems Manager (Tools for Windows PowerShell)

Vous pouvez utiliser AWS Tools for Windows PowerShell pour créer des types de paramètres String, StringList et SecureString. Après avoir supprimé un paramètre, attendez au moins 30 secondes avant de créer un paramètre avec le même nom.

Les paramètres ne peuvent pas être référencés ou imbriqués dans les valeurs d'autres paramètres. Vous ne pouvez pas inclure {{}} ou {{ssm:parameter-name}} dans une valeur de paramètre.

Note

Les paramètres sont uniquement disponibles dans la Région AWS où ils ont été créés.

Créer un paramètre String (Tools for Windows PowerShell)

  1. Si vous ne l'avez pas déjà fait, installez et configurez AWS Tools for PowerShell (outils pour Windows PowerShell).

    Pour plus d'informations, consultez Installation d'AWS Tools for PowerShell.

  2. Exécutez la commande suivante pour créer un paramètre contenant une valeur de texte brut. Remplacez chaque example resource placeholder (espace réservé pour les ressources) avec vos propres informations.

    Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "String"

    -ou-

    Exécutez la commande suivante pour créer un paramètre qui contient un ID d'Amazon Machine Image (AMI) comme valeur de paramètre.

    Note

    Pour créer un paramètre avec une balise, créez au préalable la service.model.tag en tant que variable. Voici un exemple.

    $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value"
    Write-SSMParameter ` -Name "parameter-name" ` -Value "an-AMI-id" ` -Type "String" ` -DataType "aws:ec2:image" ` -Tags $tag

    L'option -DataType doit être spécifiée uniquement si vous créez un paramètre contenant un ID d'AMI. Pour tous les autres paramètres, le type de données par défaut est text. Pour de plus amples informations, veuillez consulter Prise en charge de paramètres natifs pour les ID d'Amazon Machine Image.

    Voici un exemple qui utilise une hiérarchie de paramètres.

    Write-SSMParameter ` -Name "/IAD/Web/SQL/IPaddress" ` -Value "99.99.99.999" ` -Type "String" ` -Tags $tag
  3. Exécutez la commande suivante pour vérifier les détails du paramètre.

    (Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters

Créer un paramètre StringList (Tools for Windows PowerShell)

  1. Si vous ne l'avez pas déjà fait, installez et configurez AWS Tools for PowerShell (outils pour Windows PowerShell).

    Pour plus d'informations, consultez Installation d'AWS Tools for PowerShell.

  2. Exécutez la commande suivante pour créer un paramètre StringList. Remplacez chaque example resource placeholder (espace réservé pour les ressources) avec vos propres informations.

    Note

    Pour créer un paramètre avec une balise, créez au préalable la service.model.tag en tant que variable. Voici un exemple.

    $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value"
    Write-SSMParameter ` -Name "parameter-name" ` -Value "a-comma-separated-list-of-values" ` -Type "StringList" ` -Tags $tag

    En cas de réussite, la commande renvoie le numéro de version du paramètre.

    Voici un exemple.

    Write-SSMParameter ` -Name "stringlist-parameter" ` -Value "Milana,Mariana,Mark,Miguel" ` -Type "StringList" ` -Tags $tag
    Note

    Les éléments d'un StringList doivent être séparés par une virgule (,). Vous ne pouvez pas utiliser d'autres caractères de ponctuation ou spéciaux pour introduire des articles dans la liste. Si vous avez une valeur de paramètre qui nécessite une virgule, alors utilisez le type String.

  3. Exécutez la commande suivante pour vérifier les détails du paramètre.

    (Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters

Créer un paramètre SecureString (Tools for Windows PowerShell)

Avant de créer un paramètre SecureString, lisez les exigences liées à ce type de paramètre. Pour de plus amples informations, veuillez consulter Créer un paramètre SecureString (AWS CLI).

Important

Seule la valeur d'un paramètre SecureString est chiffrée. Les noms de paramètres, les descriptions et d'autres propriétés ne sont pas chiffrés.

Important

Parameter Store prend uniquement en charge des clés KMS à chiffrement symétrique. Vous ne pouvez pas utiliser une clé KMS à chiffrement asymétrique pour chiffrer vos paramètres. Pour savoir si une clés KMS est symétrique ou asymétrique, consultez Identification de clés symétriques et asymétriques dans le Guide du développeur AWS Key Management Service.

  1. Si vous ne l'avez pas déjà fait, installez et configurez AWS Tools for PowerShell (outils pour Windows PowerShell).

    Pour plus d'informations, consultez Installation d'AWS Tools for PowerShell.

  2. Exécutez la commande suivante pour créer un paramètre. Remplacez chaque example resource placeholder (espace réservé pour les ressources) avec vos propres informations.

    Note

    Pour créer un paramètre avec une balise, créez d'abord la service.model.tag en tant que variable. Voici un exemple.

    $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value"
    Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "SecureString" ` -KeyId "an AWS KMS key ID, an AWS KMS key ARN, an alias name, or an alias ARN" ` -Tags $tag

    En cas de réussite, la commande renvoie le numéro de version du paramètre.

    Note

    Pour utiliser la Clé gérée par AWS affectée à votre compte, supprimez le paramètre -KeyId de la commande.

    Voici un exemple qui utilise un nom brouillé (3l3vat3131) pour un paramètre de mot de passe et une Clé gérée par AWS.

    Write-SSMParameter ` -Name "/Finance/Payroll/3l3vat3131" ` -Value "P@sSwW)rd" ` -Type "SecureString"` -Tags $tag
  3. Exécutez la commande suivante pour vérifier les détails du paramètre.

    (Get-SSMParameterValue -Name "the-parameter-name-you-specified" –WithDecryption $true).Parameters

Par défaut, toutes les valeurs SecureString sont affichées sous forme de texte chiffré. Pour déchiffrer une valeur SecureString, un utilisateur doit avoir l'autorisation d'appeler l'opération d'API Decrypt AWS KMS. Pour obtenir des informations sur la configuration du contrôle d'accès pour une AWS KMS, consultez Authentification et contrôle d'accès pour une AWS KMS dans le Manuel du développeur AWS Key Management Service.

Important

Si vous modifiez l'alias de clé KMS pour la clé KMS utilisée pour chiffrer un paramètre, vous devez alors également mettre à jour l'alias de clé utilisé par le paramètre pour référencer la AWS KMS. Cela s'applique uniquement à l'alias de clé KMS. L'ID de clé auquel un alias s'attache ne change pas, sauf si vous supprimez la clé entière.