Exécutez des commandes lorsque vous lancez une instance EC2 avec des données utilisateur

Lorsque vous lancez une instance Amazon EC2, vous pouvez transmettre à l’instance des données utilisateur utilisées pour effectuer des tâches de configuration automatisées ou pour exécuter des scripts après le démarrage de l’instance.

Si vous êtes intéressé par des scénarios d’automatisation plus complexes, vous pouvez envisager AWS CloudFormation. Pour plus d’informations, consultez la section Déploiement d’applications sur Amazon EC2 avec AWS CloudFormation dans le Guide de l’utilisateur AWS CloudFormation.

Sur les instances Linux, vous pouvez transmettre deux types de données utilisateur à Amazon EC2 : les scripts shell et les directives cloud-init. Vous pouvez également transmettre ces données à l’assistant de lancement d’instance sous forme de texte brut, de fichier (utile pour lancer des instances avec les outils de ligne de commande) ou de texte codé en base64 (pour les appels d’API).

Sur les instances Windows, les agents de lancement gèrent les scripts de données utilisateur. Les sections suivantes décrivent les différences dans la manière dont les données utilisateur sont gérées sur chaque système d’exploitation.

Données de l’utilisateur dans la AWS Management Console

Vous pouvez spécifier des données utilisateur d’instance lorsque vous lancez l’instance. Si le volume racine de l’instance est un volume EBS, vous pouvez également arrêter l’instance et mettre à jour ses données utilisateur.

Indiquer les données de l’utilisateur de l’instance au moment du lancement à l’aide de l’assistant de lancement

Vous pouvez indiquer les données de l’utilisateur lorsque vous lancez une instance à l’aide de l’assistant de lancement dans la console EC2. Pour indiquer les données de l’utilisateur au moment du lancement, suivez la procédure de lancement d’une instance. Le champ User data (Données utilisateur) se trouve dans la section Détails avancés de l’assistant de lancement d’instance. Saisissez votre script PowerShell dans le champ Données utilisateur, puis terminez la procédure de lancement de l’instance.

Dans la capture d’écran suivante du champ Données utilisateur, l’exemple de script crée un fichier dans le dossier temporaire Windows, en utilisant la date et l’heure actuelles dans le nom de fichier. Lorsque vous incluez <persist>true</persist>, le script est exécuté chaque fois que vous redémarrez ou démarrez l’instance. Si vous ne cochez pas la case Les données de l’utilisateur ont déjà été encodées en base64, la console Amazon EC2 effectue l’encodage en base64 pour vous.

Pour en savoir plus, consultez Indiquer les données de l’utilisateur de l’instance au moment du lancement à l’aide de l’assistant de lancement. Pour obtenir un exemple de Linux qui utilise l’AWS CLI, consultez Données utilisateur et AWS CLI. Pour obtenir un exemple Windows qui utilise les outils pour Windows PowerShell, consultez Données utilisateur et Tools for Windows PowerShell.

Affichage et mise à jour des données utilisateur d’instance

Vous pouvez afficher les données utilisateur d’instance pour n’importe quelle instance, et vous pouvez mettre à jour les données utilisateur d’instance pour une instance arrêtée.

Comment Amazon EC2 gère les données utilisateur pour les instances Linux

Dans les exemples suivants, les commandes de la section Installer un serveur LAMP sur Amazon Linux 2 sont converties en un script shell et en un ensemble de directives « cloud-init » qui s’exécutent lors du lancement de l’instance. Dans chaque exemple, les tâches suivantes sont exécutées par les données de l’utilisateur :

Prérequis

Les exemples de cette rubrique supposent ce qui suit :

Données utilisateur et scripts shell

Si vous connaissez le scripting de shell, il s’agit de la méthode la plus simple et la plus complète pour envoyer des instructions à une instance lors du lancement. L’ajout de ces tâches au moment du démarrage augmente le temps que cela prend pour démarrer l’instance. Vous devriez laisser s’écouler quelques minutes supplémentaires pour que les tâches s’effectuent avant de vérifier que le script utilisateur a fini avec succès.

Les scripts shell de données utilisateur doivent commencer par les caractères #! et le chemin vers interpréteur que vous avez choisi pour la lecture du script (généralement /bin/bash)). Pour obtenir une présentation des scripts shell, consultez le manuel de référence Bash sur le site web du système d’exploitation GNU.

Les scripts entrés en tant que données utilisateur sont exécutés en tant qu’utilisateur root, donc n’utilisez pas la commande sudo dans le script. N’oubliez pas que tous les fichiers que vous créez seront la propriété de l’utilisateur root. Si vous avez besoin qu’un utilisateur non root ait accès aux fichiers, vous devez modifier les autorisations en conséquence dans le script. Par ailleurs, étant donné que le script n’est pas exécuté de façon interactive, vous ne pouvez pas inclure des commandes qui nécessitent les réactions de l’utilisateur (comme yum update sans l’indicateur -y).

Si vous utilisez une API AWS, y compris l’interface de ligne de commande AWS, dans un script de données utilisateur, vous devez utiliser un profil d’instance lors du lancement de l’instance. Un profil d’instance fournit les informations d’identification AWS appropriées requises par le script de données utilisateur pour émettre l’appel d’API. Pour plus d’informations, consultez Utilisation de profils d’instance dans le IAM Guide de l’utilisateur. Les autorisations que vous attribuez au rôle IAM dépendent des services que vous appelez avec l’API. Pour en savoir plus, consultez Rôles IAM pour Amazon EC2.

Le fichier journal de sortie cloud-init () capture la sortie de la console, si bien que vous pouvez facilement déboguer vos scripts après un lancement si l’instance ne se comporte pas comme vous le vouliez. Pour afficher le fichier journal,connexion à l’instanceet ouvrez/var/log/cloud-init-output.log.

Lorsqu’un script de données utilisateur est traité, il est copié dans et exécuté à partir de l /var/lib/cloud/instances/instance-id/. Le script n’est pas supprimé après son exécution. Veillez à supprimer les scripts de données utilisateur dans /var/lib/cloud/instances/instance-id/ avant de créer une AMI à partir de l’instance. Dans le cas contraire, le script figurera dans ce répertoire sur toute instance lancée à partir de l’AMI.

Mettre à jour les données de l’utilisateur de l’instance

Pour mettre à jour les données de l’utilisateur de l’instance, vous devez d’abord arrêter l’instance. Si l’instance est en cours d’exécution, vous pouvez afficher les données utilisateur, mais vous ne pouvez pas les modifier.

Directives sur les données utilisateur et Cloud-Init

Le package cloud-init configure les aspects spécifiques d’une nouvelle instance Amazon Linux lorsqu’elle est lancée. Il configure plus particulièrement le fichier .ssh/authorized_keys pour l’utilisateur ec2 afin que vous puissiez vous connecter avec votre clé privée. Pour plus d’informations sur les tâches de configuration que le package cloud-init exécute pour les instances Amazon Linux, consultez la section Utilisation de cloud-init sur Amazon Linux 2 dans le Guide de l’utilisateur d’Amazon Linux 2.

Les directives d’utilisateur cloud-init peuvent être transférées vers une instance au moment du lancement tout comme un script, même si la syntaxe est différente. Pour plus d’informations sur cloud-init, consultez http://cloudinit.readthedocs.org/en/latest/index.html.

L’ajout de ces tâches au moment du démarrage augmente le temps que cela prend pour démarrer une instance. Vous devriez laisser s’écouler quelques minutes supplémentaires pour que les tâches s’effectuent avant de vérifier que vos directives sur les données utilisateur sont terminées.

Données utilisateur et AWS CLI

Vous pouvez utiliser les AWS CLI pour spécifier, modifier et afficher les données utilisateur de votre instance. Pour plus d’informations sur l’affichage des données utilisateur de votre instance à l’aide des métadonnées d’instance, consultez Accéder aux métadonnées d’une instance EC2.

Sur Windows, vous pouvez utiliser le AWS Tools for Windows PowerShell plutôt que l’AWS CLI. Pour plus d’informations, consultez Données utilisateur et Tools for Windows PowerShell.

Exemple : spécification des données utilisateur au moment du lancement

Pour spécifier les données utilisateur lorsque vous lancez l’instance, utilisez la commande run-instances avec le paramètre --user-data. Avec run-instances, l’AWS CLI effectue l’encodage base64 des données utilisateur pour vous.

L’exemple suivant montre comment définir un script en tant que chaîne sur la ligne de commande :

aws ec2 run-instances --image-id ami-abcd1234 --count 1 --instance-type m3.medium \
    --key-name my-key-pair --subnet-id subnet-abcd1234 --security-group-ids sg-abcd1234 \
    --user-data echo user data

L’exemple suivant montre comment définir un script en utilisant un fichier texte. Assurez-vous d’utiliser le préfixe file:// pour spécifier le fichier.

aws ec2 run-instances --image-id ami-abcd1234 --count 1 --instance-type m3.medium \
    --key-name my-key-pair --subnet-id subnet-abcd1234 --security-group-ids sg-abcd1234 \
    --user-data file://my_script.txt

L’exemple suivant est celui d’un fichier texte avec un script shell.

#!/bin/bash
yum update -y
service httpd start
chkconfig httpd on

Exemple : Modification des données utilisateur d’une instance arrêtée

Vous pouvez modifier les données utilisateur d’une instance arrêtée à l’aide de la commande modify-instance-attribute. Avec modify-instance-attribute, l’AWS CLI n’effectue pas l’encodage base64 des données utilisateur pour vous.

Utilisez les paramètres --attribute et --value afin d’utiliser le fichier texte encodé pour spécifier les données utilisateur. Assurez-vous d’utiliser le préfixe file:// pour spécifier le fichier.

aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --attribute userData --value file://my_script_base64.txt

Exemple : Effacer les données utilisateur d’une instance arrêtée

Pour supprimer les données utilisateur existantes, utilisez la commande modify-instance-attribute comme suit :

aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --user-data Value=

Exemple : Affichage des données utilisateur

Pour extraire les données utilisateur pour une instance, utilisez la commande describe-instance-attribute. Avec describe-instance-attribute, l’AWS CLI n’effectue pas le décodage en base64 des données utilisateur pour vous.

aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute userData

Voici un exemple de sortie avec les données utilisateur base64 encodées.

{
    "UserData": {
        "Value": "IyEvYmluL2Jhc2gKeXVtIHVwZGF0ZSAteQpzZXJ2aWNlIGh0dHBkIHN0YXJ0CmNoa2NvbmZpZyBodHRwZCBvbg=="
    },
    "InstanceId": "i-1234567890abcdef0"
}

Voici un exemple de sortie.

#!/bin/bash
yum update -y
service httpd start
chkconfig httpd on

Combiner des scripts shell et des directives cloud-init

Par défaut, vous ne pouvez inclure qu’un seul type de contenu à la fois dans les données utilisateur. Toutefois, vous pouvez utiliser les types de contenu text/cloud-config et text/x-shellscript dans un fichier MIME en plusieurs parties pour inclure à la fois un script shell et des directives cloud-init dans vos données utilisateur.

Le format MIME en plusieurs parties est représenté ci-dessous.

Content-Type: multipart/mixed; boundary="//"
MIME-Version: 1.0
	
--//
Content-Type: text/cloud-config; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="cloud-config.txt"
	
#cloud-config
cloud-init directives
	
--//
Content-Type: text/x-shellscript; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="userdata.txt"
	
#!/bin/bash
shell script commands
--//--

Par exemple, les données utilisateur suivantes incluent des directives cloud-init et un script shell bash. Les directives cloud-init créent un fichier (/test-cloudinit/cloud-init.txt) et y écrivent Created by cloud-init. Le script shell bash crée un fichier (/test-userscript/userscript.txt) et y écrit Created by bash shell script.

Content-Type: multipart/mixed; boundary="//"
MIME-Version: 1.0
	
--//
Content-Type: text/cloud-config; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="cloud-config.txt"
	
#cloud-config
runcmd:
- [ mkdir, /test-cloudinit ]
write_files:
- path: /test-cloudinit/cloud-init.txt
content: Created by cloud-init
	
--//
Content-Type: text/x-shellscript; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="userdata.txt"
	
#!/bin/bash
mkdir test-userscript
touch /test-userscript/userscript.txt
echo "Created by bash shell script" >> /test-userscript/userscript.txt
--//--

Comment Amazon EC2 gère les données utilisateur pour les instances Windows

Sur les instances Windows, l’agent de lancement effectue les tâches liées aux données de l’utilisateur. Pour plus d’informations, consultez les ressources suivantes :

Pour obtenir des exemples d’assemblage d’une propriété UserData dans un modèle AWS CloudFormation, consultez les informations sur la propriété UserData codée en Base64 et sur la propriété UserData codée en Base64 avec AccessKey et SecretKey.

Pour un exemple d’exécution de commandes sur une instance au sein d’un groupe Auto Scaling qui fonctionne avec des hooks de cycle de vie, veuillez consulter Didacticiel : configurer les données utilisateur pour récupérer l’état du cycle de vie cible via les métadonnées de l’instance dans le Guide de l’utilisateur d’Amazon EC2 Auto Scaling.

Scripts de données utilisateur

Pour que EC2Config ou EC2Launch puisse exécuter des scripts, vous devez inclure le script dans une balise spéciale lorsque vous l’ajoutez aux données utilisateur. La balise que vous utilisez diffère si les commandes s’exécutent dans une fenêtre d’invite de commande (commandes par lots) ou si elles utilisent Windows PowerShell.

Si vous spécifiez un script par lots et un script Windows PowerShell, le script par lots s’exécute en premier et le script Windows PowerShell s’exécute ensuite quel que soit l’ordre dans lequel ils apparaissent dans les données utilisateur d’instance.

Si vous utilisez une API AWS, y compris l’interface de ligne de commande AWS CLI, dans un script de données utilisateur, vous devez utiliser un profil d’instance lors du lancement de l’instance. Un profil d’instance fournit les informations d’identification AWS appropriées requises par le script de données utilisateur pour émettre l’appel d’API. Pour plus d’informations, consultez Profils d’instance. Les autorisations que vous attribuez au rôle IAM dépendent des services que vous appelez avec l’API. Pour en savoir plus, consultez Rôles IAM pour Amazon EC2.

Syntaxe des scripts par lots

Spécifiez un script par lots à l’aide de la balise script. Séparez les commandes à l’aide de sauts de ligne, comme indiqué dans l’exemple suivant.

<script>
    echo Current date and time >> %SystemRoot%\Temp\test.log
    echo %DATE% %TIME% >> %SystemRoot%\Temp\test.log
</script>

Par défaut, les scripts de données utilisateur s’exécutent une seule fois, lorsque vous lancez l’instance. Pour exécuter des scripts de données utilisateur chaque fois que vous redémarrez ou démarrez l’instance, ajoutez <persist>true</persist> aux données utilisateur.

<script>
    echo Current date and time >> %SystemRoot%\Temp\test.log
    echo %DATE% %TIME% >> %SystemRoot%\Temp\test.log
</script>
<persist>true</persist>

Agent EC2Launch v2

Pour exécuter un script XML de données utilisateur en tant que processus détaché avec la tâche EC2Launch v2 executeScript dans l’étape UserData, ajoutez <detach>true</detach> aux données utilisateur.

<script>
    echo Current date and time >> %SystemRoot%\Temp\test.log
    echo %DATE% %TIME% >> %SystemRoot%\Temp\test.log
</script>
<detach>true</detach>

Syntaxe des scripts Windows PowerShell

Les AMI AWS Windows comprennent AWS Tools for Windows PowerShell. Vous pouvez donc spécifier ces cmdlets dans les données utilisateur. Si vous associez un rôle IAM à votre instance, vous n’avez pas à spécifier d’informations d’identification dans les cmdlets, car les applications qui s’exécutent sur l’instance utilisent les informations d’identification du rôle pour accéder aux ressources AWS (par exemple, des compartiments Amazon S3).

Spécifiez un script Windows PowerShell à l’aide de la balise <powershell>. Séparez les commandes à l’aide de sauts de ligne. La balise <powershell> est sensible à la casse.

Par exemple :

<powershell>
    $file = $env:SystemRoot + "\Temp\" + (Get-Date).ToString("MM-dd-yy-hh-mm")
    New-Item $file -ItemType file
</powershell>

Par défaut, les scripts de données utilisateur sont exécutés une seule fois lorsque vous lancez l’instance. Pour exécuter des scripts de données utilisateur chaque fois que vous redémarrez ou démarrez l’instance, ajoutez <persist>true</persist> aux données utilisateur.

<powershell>
    $file = $env:SystemRoot + "\Temp\" + (Get-Date).ToString("MM-dd-yy-hh-mm")
    New-Item $file -ItemType file
</powershell>
<persist>true</persist>

Vous pouvez indiquer un ou plusieurs arguments PowerShell à l’aide de la balise <powershellArguments>. Si aucun argument n’est fourni, EC2Launch et EC2Launch v2 ajoutent l’argument suivant par défaut : -ExecutionPolicy Unrestricted.

Exemple :

<powershell>
    $file = $env:SystemRoot + "\Temp" + (Get-Date).ToString("MM-dd-yy-hh-mm")
    New-Item $file -ItemType file
</powershell>
<powershellArguments>-ExecutionPolicy Unrestricted -NoProfile -NonInteractive</powershellArguments>

Agent EC2Launch v2

Pour exécuter un script XML de données utilisateur en tant que processus détaché avec la tâche EC2Launch v2 executeScript dans l’étape UserData, ajoutez <detach>true</detach> aux données utilisateur.

<powershell>
    $file = $env:SystemRoot + "\Temp\" + (Get-Date).ToString("MM-dd-yy-hh-mm")
    New-Item $file -ItemType file
</powershell>
<detach>true</detach>

Syntaxe pour les scripts de configuration YAML

Si vous utilisez EC2Launch v2 pour exécuter des scripts, vous pouvez utiliser le format YAML. Pour afficher les tâches de configuration, les détails et les exemples pour EC2Launch v2, consultez Configuration de tâche EC2Launch v2.

Spécifiez un script YAML avec la tâche executeScript.

Exemple de syntaxe YAML pour exécuter un script PowerShell

version: 1.0
    tasks:
    - task: executeScript
      inputs:
      - frequency: always
        type: powershell
        runAs: localSystem
        content: |-
          $file = $env:SystemRoot + "\Temp\" + (Get-Date).ToString("MM-dd-yy-hh-mm")
          New-Item $file -ItemType file

Exemple de syntaxe YAML pour exécuter un script Batch

version: 1.1
    tasks:
    - task: executeScript
      inputs:
      - frequency: always
        type: batch
        runAs: localSystem
        content: |-
          echo Current date and time >> %SystemRoot%\Temp\test.log
          echo %DATE% %TIME% >> %SystemRoot%\Temp\test.log

Encodage Base64

Si vous utilisez l’API Amazon EC2 ou un outil qui n’effectue pas l’encodage base64 des données utilisateur, vous devez encoder les données utilisateur. Si ce n’est pas le cas, une erreur indiquant qu’aucune balise script ou powershell à exécuter n’a été trouvée est consignée. Voici un exemple qui encode à l’aide de Windows PowerShell.

$UserData = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($Script))

Voici un exemple qui décode à l’aide de PowerShell.

$Script = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($UserData))

Pour plus d’informations sur l’encodage base64, consultez https://www.ietf.org/rfc/rfc4648.txt.

Exécution de données utilisateur

Par défaut, l’exécution de données utilisateur est activée pour le lancement initial sur toutes les AMI AWS Windows. Vous pouvez spécifier que les scripts de données utilisateur doivent être exécutés au prochain réamorçage ou redémarrage de l’instance. Vous pouvez également spécifier que les scripts de données utilisateur doivent être exécutés chaque fois que l’instance est réamorcée ou redémarre.

Les scripts de données utilisateur sont exécutés depuis le compte de l’administrateur local quand un mot de passe aléatoire est généré. Sinon, les scripts de données utilisateur sont exécutés depuis le compte système.

Scripts de lancement de l’instance

Les scripts figurant dans les données utilisateur d’instance sont exécutés lors du lancement initial de l’instance. Si la balise persist est trouvée, l’exécution des données utilisateur est activée pour les réamorçages ou démarrages suivants. Les fichiers journaux pour EC2Launch v2, EC2Launch et EC2Config contiennent les résultats de sortie standard ainsi que les flux d’erreurs standard.

EC2Launch v2

Le fichier journal de EC2Launch v2 est C:\ProgramData\Amazon\EC2Launch\log\agent.log.

Les informations suivantes sont enregistrées lorsque les données utilisateur sont exécutées :

EC2Launch

Le fichier journal pour EC2Launch est C:\ProgramData\Amazon\EC2-Windows\Launch\Log\UserdataExecution.log.

Le dossier C:\ProgramData peut être masqué. Pour afficher le dossier, vous devez afficher les fichiers et les dossiers masqués.

Les informations suivantes sont enregistrées lorsque les données utilisateur sont exécutées :

EC2Config

Le fichier journal pour EC2Config est C:\Program Files\Amazon\Ec2ConfigService\Logs\Ec2Config.log. Les informations suivantes sont enregistrées lorsque les données utilisateur sont exécutées :

Exécuter des scripts lors des redémarrages ou démarrages suivants

Lorsque vous mettez à jour des données utilisateur d’instance, les scripts de données utilisateur sont exécutés automatiquement lorsque vous redémarrez ou démarrez l’instance. Toutefois, vous pouvez activer l’exécution des données utilisateur pour que les scripts de données utilisateur soient exécutés une seule fois lorsque vous redémarrez ou démarrez l’instance ou chaque fois que vous redémarrez ou démarrez l’instance.

Si vous choisissez l’option Arrêter avec Sysprep, les scripts de données utilisateur sont exécutés quand l’instance est redémarrée ou démarrée, même si vous n’avez pas activé l’exécution des données utilisateur pour les redémarrages ou démarrages suivants. Les scripts de données utilisateur ne seront pas exécutés lors des redémarrages ou démarrages ultérieurs.

Données utilisateur et Tools for Windows PowerShell

Vous pouvez utiliser Tools for Windows PowerShell pour spécifier, modifier et afficher les données utilisateur de votre instance. Pour plus d’informations sur l’affichage des données utilisateur de votre instance à l’aide des métadonnées d’instance, consultez Accéder aux métadonnées d’une instance EC2. Pour plus d’informations sur les données utilisateur et l’AWS CLI, consultez Données utilisateur et AWS CLI.

Exemple : Spécification des données utilisateur d’instance au moment du lancement

Créez un fichier texte avec les données utilisateur d’instance. Pour exécuter des scripts de données utilisateur chaque fois que vous redémarrez ou démarrez l’instance, ajoutez <persist>true</persist>, comme illustré dans l’exemple suivant.

<powershell>
    $file = $env:SystemRoot + "\Temp\" + (Get-Date).ToString("MM-dd-yy-hh-mm")
    New-Item $file -ItemType file
</powershell>
<persist>true</persist>

Pour spécifier les données utilisateur d’instance lorsque vous lancez l’instance, utilisez la commande New-EC2Instance. Cette commande n’effectue pas l’encodage base64 des données utilisateur pour vous. Utilisez les commandes suivantes pour encoder les données utilisateur dans un fichier texte nommé script.txt.

PS C:\> $Script = Get-Content -Raw script.txt
PS C:\> $UserData = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($Script))

Utilisez le paramètre -UserData pour transmettre les données utilisateur à la commande New-EC2Instance.

PS C:\> New-EC2Instance -ImageId ami-abcd1234 -MinCount 1 -MaxCount 1 -InstanceType m3.medium \
    -KeyName my-key-pair -SubnetId subnet-12345678 -SecurityGroupIds sg-1a2b3c4d \
    -UserData $UserData

Exemple : Mise à jour des données utilisateur d’instance pour une instance arrêtée

Vous pouvez modifier les données utilisateur d’une instance arrêtée à l’aide de la commande Edit-EC2InstanceAttribute.

Créez un fichier texte contenant le nouveau script. Utilisez les commandes suivantes pour encoder les données utilisateur dans le fichier texte nommé new-script.txt.

PS C:\> $NewScript = Get-Content -Raw new-script.txt
PS C:\> $NewUserData = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($NewScript))

Utilisez les paramètres -UserData et -Value pour spécifier les données utilisateur.

PS C:\> Edit-EC2InstanceAttribute -InstanceId i-1234567890abcdef0 -Attribute userData -Value $NewUserData

Exemple : Affichage des données utilisateur d’instance

Pour extraire les données utilisateur pour une instance, utilisez la commande Get-EC2InstanceAttribute.

PS C:\> (Get-EC2InstanceAttribute -InstanceId i-1234567890abcdef0 -Attribute userData).UserData

Voici un exemple de sortie. Notez que les données utilisateur sont encodées.

PHBvd2Vyc2hlbGw+DQpSZW5hbWUtQ29tcHV0ZXIgLU5ld05hbWUgdXNlci1kYXRhLXRlc3QNCjwvcG93ZXJzaGVsbD4=

Utilisez les commandes suivantes pour stocker les données utilisateur encodées dans une variable, puis les décoder.

PS C:\> $UserData_encoded = (Get-EC2InstanceAttribute -InstanceId i-1234567890abcdef0 -Attribute userData).UserData
PS C:\> [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($UserData_encoded))

Voici un exemple de sortie.

<powershell>
    $file = $env:SystemRoot + "\Temp\" + (Get-Date).ToString("MM-dd-yy-hh-mm")
    New-Item $file -ItemType file
</powershell>
<persist>true</persist>

Exemple : Attribution d’un nouveau nom à l’instance pour correspondre à la valeur de la balise

Vous pouvez utiliser la commande Get-EC2Tag pour lire la valeur de l’identification, renommer l’instance au premier démarrage pour que son nom corresponde à la valeur de l’identification et la redémarrer. Pour exécuter cette commande avec succès, vous devez avoir un rôle avec les autorisations ec2:DescribeTags attachées à l’instance, car les informations sur les identifications sont extraites par l’appel d’API. Pour plus d’informations sur la définition des autorisations à l’aide des rôles IAM, consultez Attacher un rôle IAM à une instance.

IMDSv2

<powershell>
    [string]$token = Invoke-RestMethod -Headers @{"X-aws-ec2-metadata-token-ttl-seconds" = "21600"} -Method PUT -Uri 'http://169.254.169.254/latest/api/token' -UseBasicParsing
    $instanceId = Invoke-RestMethod -Headers @{"X-aws-ec2-metadata-token" = $token} -Method GET -Uri 'http://169.254.169.254/latest/meta-data/instance-id' -UseBasicParsing
	$nameValue = (Get-EC2Tag -Filter @{Name="resource-id";Value=$instanceid},@{Name="key";Value="Name"}).Value
	$pattern = "^(?![0-9]{1,15}$)[a-zA-Z0-9-]{1,15}$"
	#Verify Name Value satisfies best practices for Windows hostnames
	If ($nameValue -match $pattern) 
	    {Try
	        {Rename-Computer -NewName $nameValue -Restart -ErrorAction Stop} 
	    Catch
	        {$ErrorMessage = $_.Exception.Message
	        Write-Output "Rename failed: $ErrorMessage"}}
	Else
	    {Throw "Provided name not a valid hostname. Please ensure Name value is between 1 and 15 characters in length and contains only alphanumeric or hyphen characters"}
</powershell>

IMDSv1

<powershell>
	$instanceId = (Invoke-WebRequest http://169.254.169.254/latest/meta-data/instance-id -UseBasicParsing).content
	$nameValue = (Get-EC2Tag -Filter @{Name="resource-id";Value=$instanceid},@{Name="key";Value="Name"}).Value
	$pattern = "^(?![0-9]{1,15}$)[a-zA-Z0-9-]{1,15}$"
	#Verify Name Value satisfies best practices for Windows hostnames
	If ($nameValue -match $pattern) 
	    {Try
	        {Rename-Computer -NewName $nameValue -Restart -ErrorAction Stop} 
	    Catch
	        {$ErrorMessage = $_.Exception.Message
	        Write-Output "Rename failed: $ErrorMessage"}}
	Else
	    {Throw "Provided name not a valid hostname. Please ensure Name value is between 1 and 15 characters in length and contains only alphanumeric or hyphen characters"}
</powershell>

Vous pouvez également renommer l’instance à l’aide d’identifications dans les métadonnées d’instance si votre instance est configurée pour accéder aux identifications à partir des métadonnées d’instance. Pour en savoir plus, consultez Affichez les balises pour vos instances EC2 à l'aide des métadonnées d'instance.

IMDSv2

<powershell>
    [string]$token = Invoke-RestMethod -Headers @{"X-aws-ec2-metadata-token-ttl-seconds" = "21600"} -Method PUT -Uri 'http://169.254.169.254/latest/api/token' -UseBasicParsing
	$nameValue = Invoke-RestMethod -Headers @{"X-aws-ec2-metadata-token" = $token} -Method GET -Uri 'http://169.254.169.254/latest/meta-data/tags/instance/Name' -UseBasicParsing
	$pattern = "^(?![0-9]{1,15}$)[a-zA-Z0-9-]{1,15}$"
	#Verify Name Value satisfies best practices for Windows hostnames
	If ($nameValue -match $pattern) 
	    {Try
	        {Rename-Computer -NewName $nameValue -Restart -ErrorAction Stop} 
	    Catch
	        {$ErrorMessage = $_.Exception.Message
	        Write-Output "Rename failed: $ErrorMessage"}}
	Else
	    {Throw "Provided name not a valid hostname. Please ensure Name value is between 1 and 15 characters in length and contains only alphanumeric or hyphen characters"}
</powershell>

IMDSv1

<powershell>
	$nameValue = Get-EC2InstanceMetadata -Path /tags/instance/Name
	$pattern = "^(?![0-9]{1,15}$)[a-zA-Z0-9-]{1,15}$"
	#Verify Name Value satisfies best practices for Windows hostnames
	If ($nameValue -match $pattern) 
	    {Try
	        {Rename-Computer -NewName $nameValue -Restart -ErrorAction Stop} 
	    Catch
	        {$ErrorMessage = $_.Exception.Message
	        Write-Output "Rename failed: $ErrorMessage"}}
	Else
	    {Throw "Provided name not a valid hostname. Please ensure Name value is between 1 and 15 characters in length and contains only alphanumeric or hyphen characters"}
</powershell>