Création et utilisation d'alias dans AWS CLI

Les alias sont des raccourcis que vous pouvez créer dans le AWS Command Line Interface (AWS CLI) pour raccourcir les commandes ou les scripts que vous utilisez fréquemment. Vous créez des alias dans le alias fichier situé dans votre dossier de configuration.

Prérequis

Pour utiliser les commandes d'alias, vous devez effectuer les opérations suivantes :

• Installation et configuration de l' AWS CLI. Pour plus d’informations, consultez Installation ou mise à jour vers la dernière version du AWS CLI et Authentification et informations d'accès pour AWS CLI.

• Utilisez une AWS CLI version minimale de 1.11.24 ou 2.0.0.

• (Facultatif) Pour utiliser des scripts AWS CLI alias bash, vous devez utiliser un terminal compatible avec bash.

Étape 1 : Création du fichier d'alias

Pour créer le alias fichier, vous pouvez utiliser la navigation dans les fichiers et un éditeur de texte, ou utiliser votre terminal préféré en suivant la step-by-step procédure. Pour créer rapidement votre fichier d'alias, utilisez le bloc de commande suivant.

Linux and macOS

$ mkdir -p ~/.aws/cli
$ echo '[toplevel]' > ~/.aws/cli/alias

Windows

C:\> md %USERPROFILE%\.aws\cli
C:\> echo [toplevel] > %USERPROFILE%/.aws/cli/alias

Pour créer le fichier d'alias

1. Créez un dossier nommé cli dans votre dossier AWS CLI de configuration. Par défaut, le dossier de configuration ~/.aws/ se trouve sous Linux ou macOS et %USERPROFILE%\.aws\ sous Windows. Vous pouvez le créer via votre navigation dans les fichiers ou à l'aide de la commande suivante.

   Linux and macOS

   $ mkdir -p ~/.aws/cli

   Windows

   C:\> md %USERPROFILE%\.aws\cli

   Le chemin par défaut du cli dossier obtenu est ~/.aws/cli/ sous Linux ou macOS et %USERPROFILE%\.aws\cli sous Windows.

2. Dans le cli dossier, créez un fichier texte alias sans extension et ajoutez-le [toplevel] à la première ligne. Vous pouvez créer ce fichier via votre éditeur de texte préféré ou utiliser la commande suivante.

   Linux and macOS

   $ echo '[toplevel]' > ~/.aws/cli/alias

   Windows

   C:\> echo [toplevel] > %USERPROFILE%/.aws/cli/alias

Étape 2 : Création d'un alias

Vous pouvez créer un alias à l'aide de commandes de base ou de scripts bash.

Création d'un alias de commande de base

Vous pouvez créer votre alias en ajoutant une commande en utilisant la syntaxe suivante dans le alias fichier que vous avez créé à l'étape précédente.

Syntaxe

aliasname = command [--options]

aliasnameC'est ce que tu appelles ton alias. commandIl s'agit de la commande que vous souhaitez appeler, qui peut inclure d'autres alias. Vous pouvez inclure des options ou des paramètres dans votre alias, ou les ajouter lorsque vous appelez votre alias.

L'exemple suivant crée un alias nommé à aws whoami l'aide de la commande. Comme cet alias appelle une AWS CLI commande existante, vous pouvez écrire la commande sans le aws préfixe.

whoami = sts get-caller-identity

L'exemple suivant reprend l'whoamiexemple précédent et ajoute les output options de Account filtre et de texte.

whoami2 = sts get-caller-identity --query Account --output text

Création d'un alias de sous-commande

Note

La fonctionnalité d'alias de sous-commande nécessite une AWS CLI version minimale de 1.11.24 ou 2.0.0

Vous pouvez créer un alias pour les sous-commandes en ajoutant une commande à l'aide de la syntaxe suivante dans le alias fichier que vous avez créé à l'étape précédente.

Syntaxe

[command commandGroup]
aliasname = command [--options]

commandGroupIl s'agit de l'espace de noms de commande, par exemple la commande aws ec2 describe-regions se trouve sous le groupe de ec2 commandes. aliasnameC'est ce que tu appelles ton alias. commandIl s'agit de la commande que vous souhaitez appeler, qui peut inclure d'autres alias. Vous pouvez inclure des options ou des paramètres dans votre alias, ou les ajouter lorsque vous appelez votre alias.

L'exemple suivant crée un alias nommé à aws ec2 regions l'aide de la commande. Comme cet alias appelle une AWS CLI commande existante sous l'espace de noms de ec2 commande, vous pouvez écrire la commande sans le aws ec2 préfixe.

[command ec2]
regions = describe-regions --query Regions[].RegionName

Pour créer des alias à partir de commandes situées en dehors de l'espace de noms des commandes, préfixez la commande complète d'un point d'exclamation. L'exemple suivant crée un alias nommé à aws ec2 instance-profiles l'aide de la commande.

[command ec2]
instance-profiles = !aws iam list-instance-profiles

Note

Les alias utilisent uniquement les espaces de noms de commande existants et vous ne pouvez pas en créer de nouveaux. Par exemple, vous ne pouvez pas créer d'alias avec la [command johnsmith] section car l'espace de noms de johnsmith commande n'existe pas déjà.

Création d'un alias de script bash

Avertissement

Pour utiliser des scripts AWS CLI alias bash, vous devez utiliser un terminal compatible avec bash

Vous pouvez créer un alias à l'aide de scripts bash pour des processus plus avancés en utilisant la syntaxe suivante.

Syntaxe

aliasname = 
    !f() {
        script content
}; f

aliasnameC'est ce que vous appelez votre alias et script content c'est le script que vous souhaitez exécuter lorsque vous appelez l'alias.

L'exemple suivant permet opendns de générer votre adresse IP actuelle. Comme vous pouvez utiliser des alias dans d'autres alias, l'myipalias suivant est utile pour autoriser ou révoquer l'accès à votre adresse IP depuis d'autres alias.

myip =
  !f() {
    dig +short myip.opendns.com @resolver1.opendns.com
  }; f

L'exemple de script suivant appelle l'aws myipalias précédent pour autoriser votre adresse IP à accéder à un groupe EC2 de sécurité Amazon.

authorize-my-ip =
  !f() {
    ip=$(aws myip)
    aws ec2 authorize-security-group-ingress --group-id ${1} --cidr $ip/32 --protocol tcp --port 22
  }; f

Lorsque vous appelez des alias utilisant des scripts bash, les variables sont toujours transmises dans l'ordre dans lequel vous les avez saisies. Dans les scripts bash, les noms des variables ne sont pas pris en compte, mais uniquement l'ordre dans lequel elles apparaissent. Dans l'exemple d'textalertalias suivant, la variable de l'--messageoption est la première et --phone-number l'option la deuxième.

textalert =
  !f() {
    aws sns publish --message "${1}" --phone-number ${2}
  }; f

Étape 3 : appeler un alias

Pour exécuter l'alias que vous avez créé dans votre alias fichier, utilisez la syntaxe suivante. Vous pouvez ajouter des options supplémentaires lorsque vous appelez votre alias.

Syntaxe

$ aws aliasname

L'exemple suivant utilise l'alias de aws whoami commande.

$ aws whoami
{
    "UserId": "A12BCD34E5FGHI6JKLM",
    "Account": "1234567890987",
    "Arn": "arn:aws:iam::1234567890987:user/userName"
}

L'exemple suivant utilise l'aws whoamialias avec des options supplémentaires pour renvoyer uniquement le Account nombre en text sortie.

$ aws whoami --query Account --output text
1234567890987

L'exemple suivant utilise l'alias de aws ec2 regions sous-commande.

$ aws ec2 regions
[
    "ap-south-1",
    "eu-north-1",
    "eu-west-3",
    "eu-west-2",
...

Appel d'un alias à l'aide de variables de script bash

Lorsque vous appelez des alias utilisant des scripts bash, les variables sont transmises dans l'ordre dans lequel elles ont été saisies. Dans les scripts bash, le nom des variables n'est pas pris en compte, mais uniquement l'ordre dans lequel elles apparaissent. Par exemple, dans l'textalertalias suivant, la variable de l'option --message est première et --phone-number seconde.

textalert =
  !f() {
    aws sns publish --message "${1}" --phone-number ${2}
  }; f

Lorsque vous appelez l'textalertalias, vous devez transmettre les variables dans le même ordre que celui dans lequel elles sont exécutées dans l'alias. Dans l'exemple suivant, nous utilisons les variables $message et$phone. La $message variable est passée comme ${1} pour l'--messageoption et la $phone variable est passée comme ${2} pour l'--phone-numberoption. Cela permet d'appeler correctement l'textalertalias pour envoyer un message.

$ aws textalert $message $phone
{
    "MessageId": "1ab2cd3e4-fg56-7h89-i01j-2klmn34567"
}

Dans l'exemple suivant, l'ordre est changé lorsque l'alias est appelé vers $phone et$message. La $phone variable est passée comme ${1} pour l'--messageoption et la $message variable est passée comme ${2} pour l'--phone-numberoption. Comme les variables ne sont pas ordonnées, l'alias les transmet de manière incorrecte. Cela provoque une erreur car le contenu de $message ne correspond pas aux exigences de formatage des numéros de téléphone pour l'--phone-numberoption.

$ aws textalert $phone $message
usage: aws [options] <command> <subcommand> [<subcommand> ...] [parameters]
To see help text, you can run:

  aws help
  aws <command> help
  aws <command> <subcommand> help

Unknown options: text

Exemples de référentiels d'alias

Le référentiel d'AWS CLI alias GitHubcontient des exemples d' AWS CLI alias créés par l'équipe de AWS CLI développeurs et la communauté. Vous pouvez utiliser l'exemple de alias fichier complet ou utiliser des alias individuels pour votre propre usage.

Avertissement

L'exécution des commandes de cette section supprime votre alias fichier existant. Pour éviter de remplacer votre fichier d'alias existant, modifiez l'emplacement de votre téléchargement.

Pour utiliser les alias du référentiel

1. Installez Git. Pour les instructions d'installation, consultez Getting Started - Install Git dans la documentation Git.

2. Installez la jp commande. La jp commande est utilisée dans l'tostringalias. Pour les instructions d'installation, consultez le fichier JMESPath (jp) README.md sur. GitHub

3. Installez la jq commande. La jq commande est utilisée dans l'tostring-with-jqalias. Pour les instructions d'installation, consultez le processeur JSON (jq) activé GitHub.

4. Téléchargez le alias fichier en effectuant l'une des opérations suivantes :

   • Exécutez les commandes suivantes pour télécharger le alias fichier depuis le référentiel et le copier dans votre dossier de configuration.

     Linux and macOS

     $ git clone https://github.com/awslabs/awscli-aliases.git
     $ mkdir -p ~/.aws/cli
     $ cp awscli-aliases/alias ~/.aws/cli/alias

     Windows

     C:\> git clone https://github.com/awslabs/awscli-aliases.git
     C:\> md %USERPROFILE%\.aws\cli
     C:\> copy awscli-aliases\alias %USERPROFILE%\.aws\cli

   • Téléchargez-le directement depuis le référentiel et enregistrez-le dans le cli dossier de votre dossier AWS CLI de configuration. Par défaut, le dossier de configuration ~/.aws/ se trouve sous Linux ou macOS et %USERPROFILE%\.aws\ sous Windows.

5. Pour vérifier que les alias fonctionnent, exécutez l'alias suivant.

   $ aws whoami

   Cela affiche la même réponse que la aws sts get-caller-identity commande :

   {
       "Account": "012345678901",
       "UserId": "AIUAINBADX2VEG2TC6HD6",
       "Arn": "arn:aws:iam::012345678901:user/myuser"
   }

Ressources

• Le référentiel d'AWS CLI alias GitHubcontient des exemples d' AWS CLI alias créés par l'équipe de AWS CLI développeurs et la contribution de la AWS CLI communauté.

• L'annonce de la fonctionnalité d'alias publiée dans AWS re:Invent 2016 : The Effective AWS CLI User on. YouTube

• aws sts get-caller-identity

• aws ec2 describe-instances

• aws sns publish