Identifier les ressources avec AWS Cloud Control API - Contrôle du cloud API

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.

Identifier les ressources avec AWS Cloud Control API

Chaque type de ressource possède une propriété définie comme identifiant principal. La valeur de cette propriété doit être unique pour chaque ressource de ce type dans un Compte AWS et donné Région AWS. Par exemple, de nombreux types de ressources incluent une Name propriété qui doit être unique pour chaque ressource de ce type. Dans certains cas, l'identifiant principal est défini comme une combinaison de plusieurs propriétés qui forment ensemble un identifiant unique. En utilisant cet identifiant principal, associé au type de ressource, vous pouvez spécifier exactement sur quelle ressource vous souhaitez effectuer des opérations telles que update-resource oudelete-resource.

En outre, certains types de ressources définissent des identifiants secondaires qui peuvent également être utilisés pour identifier de manière unique les ressources de ce type.

Pour déterminer quelle propriété de ressource (ou combinaison de propriétés) est l'identifiant principal d'un type de ressource, reportez-vous à l'primaryIdentifierattribut du schéma du type de ressource. Le schéma inclut également des identifiants secondaires définis. Pour de plus amples informations, veuillez consulter Affichage des schémas de types de ressources.

Obtenir l'identifiant principal d'une ressource

Vous pouvez trouver la valeur d'identifiant d'une ressource spécifique à l'aide des API commandes Cloud Control. Chacune des commandes suivantes renvoie un ProgressEvent objet contenant l'identifiant principal des ressources spécifiées :

  • cancel-resource-request
  • create-resource
  • get-resource-request-status
  • list-resource-requests

Utilisation de l'identifiant principal d'une ressource

Lorsque vous utilisez API les commandes Cloud Control, vous pouvez spécifier l'identifiant principal ou tout identifiant secondaire défini pour le type de ressource dans son schéma de ressources. Vous ne pouvez spécifier qu'un seul identifiant. Les identifiants principaux peuvent être spécifiés sous forme de chaîne ou JSON ; les identifiants secondaires doivent être spécifiés sous forme de. JSON

Pour les identifiants principaux composés (c'est-à-dire composés de plusieurs propriétés de ressources liées ensemble), pour spécifier l'identifiant principal sous forme de chaîne, listez les valeurs des propriétés dans l'ordre dans lequel elles sont spécifiées dans la définition de l'identifiant principal, en les séparant par. |

Par exemple, l'identifiant principal de la ressource est défini comme suit :

"primaryIdentifier": [ "/properties/DatabaseName", "/properties/TableName" ]

Ainsi, pour spécifier l'identifiant principal d'une ressource sous forme de chaîne, vous devez utiliser le format suivant.

DatabaseName|TableName

Par exemple, étant donné une base de données portant le nom de base de données MyDatabase et le nom de table deMyTable, vous spécifiezMyDatabase|MyTable.

Pour les identificateurs composés spécifiés sous la formeJSON, l'ordre des propriétés n'est pas obligatoire, comme indiqué dans l'exemple suivant.

{ "TableName": "MyTable", "DatabaseName": "MyDatabase" }

Pour plus d'informations sur les identificateurs de ressources, voir primaryidentifier dans l'interface de ligne de CloudFormation commande User Move for Extension Development.