aws:waitForAwsResourceProperty - Attendre sur une propriété de ressource AWS

L'action aws:waitForAwsResourceProperty permet à votre automatisation d'attendre un statut de ressource ou d'événement spécifique avant de se poursuivre. Pour plus d'exemples sur l'utilisation de cette action, veuillez consulter la rubrique Exemples supplémentaires de runbook.

Note

La valeur de délai d'expiration par défaut pour cette action est de 3600 secondes (une heure). Vous pouvez limiter ou étendre le délai d'attente en spécifiant le paramètre timeoutSeconds pour une étape aws:waitForAwsResourceProperty. Pour de plus amples informations et des exemples sur l'utilisation de cette action, veuillez consulter Gestion de délais d'expiration dans des runbooks.

Entrée

Les entrées sont définies par l'opération d'API que vous sélectionnez.

YAML

action: aws:waitForAwsResourceProperty
inputs:
  Service: The official namespace of the service
  Api: The API operation or method name
  API operation inputs or parameters: A value
  PropertySelector: Response object
  DesiredValues:
  - Desired property value

JSON

{
  "action": "aws:waitForAwsResourceProperty",
  "inputs": {
    "Service":"The official namespace of the service",
    "Api":"The API operation or method name",
    "API operation inputs or parameters":"A value",
    "PropertySelector": "Response object",
    "DesiredValues": [
      "Desired property value"
    ]
  }
}

Service

L'espace de noms Service AWS qui contient l'opération d'API que vous souhaitez exécuter. Par exemple, l'espace de noms pour AWS Systems Manager est ssm. L'espace de noms pour Amazon Elastic Compute Cloud (Amazon EC2) est ec2. Vous pouvez voir la liste des espaces de noms Service AWS pris en charge dans la section Available Services (Services disponibles) de la Référence AWS CLI Command.

Type : chaîne

Obligatoire : oui

Api

Le nom de l'opération d'API que vous voulez exécuter. Vous pouvez afficher les opérations d'API (également appelées méthodes) en choisissant un service dans le panneau de navigation de gauche sur la page Services Reference (Référence des services) suivante. Sélectionnez une méthode dans la section Client pour le service que vous voulez appeler. Par exemple, toutes les opérations d'API (méthodes) pour Amazon Relational Database Service (Amazon RDS) sont répertoriées à la page suivante : Méthodes pour Amazon RDS.

Type : chaîne

Obligatoire : oui

Entrées d'opérations d'API

Une ou plusieurs entrées d'opérations d'API. Vous pouvez afficher les entrées disponibles (également appelées paramètres) en choisissant un service dans le panneau de navigation de gauche sur la page Services Reference (Référence des services) suivante. Sélectionnez une méthode dans la section Client pour le service que vous voulez appeler. Par exemple, toutes les méthodes pour Amazon RDS sont répertoriées sur la page suivante : Méthodes Amazon RDS. Sélectionnez la méthode describe_db_instances et faites défiler la page vers le bas pour voir les paramètres disponibles, tels que DBInstanceIdentifier, Name et Values.

YAML

inputs:
  Service: The official namespace of the service
  Api: The API operation name
  API input 1: A value
  API Input 2: A value
  API Input 3: A value

JSON

"inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API operation name",
      "API input 1":"A value",
      "API Input 2":"A value",
      "API Input 3":"A value"
}

Type : déterminé par l'opération d'API choisie

Obligatoire : oui

PropertySelector

Chemin JSONPath vers un attribut dans l'objet de réponse. Vous pouvez afficher les objets de réponse en choisissant un service dans le panneau de navigation de gauche sur la page Services Reference (Référence des services) suivante. Sélectionnez une méthode dans la section Client pour le service que vous voulez appeler. Par exemple, toutes les méthodes pour Amazon RDS sont répertoriées sur la page suivante : Méthodes Amazon RDS. Sélectionnez la méthode describe_db_instances et faites défiler la page jusqu'à la section Response Structure (Structure d'une réponse). DBInstances est répertorié comme objet de réponse.

Type : chaîne

Obligatoire : oui

DesiredValues

État attendu ou état à partir duquel l'automatisation se poursuit.

Type : MapList, StringList

Obligatoire : oui