Change set JSON data structures - ROS - Resource Orchestration Service

Les jeux de modifications contiennent des changements au format JSON qui décrivent comment ROS modifie une pile. Utilisez les jeux de modifications pour prévisualiser l'impact avant d'appliquer les modifications.

Éléments des modifications JSON

Les modifications JSON d'un jeu de modifications comprennent les éléments suivants, détaillés dans la section des structures de données ci-dessous.

Change : l'opération de modification, incluant le type de modification et l'entité cible.
ResourceChange : la ressource à modifier, incluant le nom, le type et l'opération sur la ressource.
ResourceChangeDetail : les détails de la modification de la ressource, incluant les propriétés et l'état de la ressource avant et après la modification.
ResourceTargetDefinition : la définition de la ressource cible, incluant les propriétés et les configurations.
ResourcePropertyChange : les détails de la modification au niveau des propriétés, incluant les valeurs avant et après la modification.
ModuleInfo : les informations du module pour les ressources créées à partir de modules.

Structures de données des modifications JSON

Change

Parameter

Type

Description

ResourceChange

Structure

La ressource à modifier et l'opération à effectuer.

Type

String

Le type d'entité.

Définissez sur Resource, ce qui indique que l'entité est une ressource.

ResourceChange

Parameter	Type	Description
Action	String	L'opération à effectuer sur la ressource. Valeurs valides : `Add` : crée la ressource. `Modify` : modifie la ressource. `Remove` : libère la ressource.
Details	Array	Les détails de la modification. S'applique uniquement lorsque `Action` est défini sur `Modify`. Remarque Disponible uniquement pour les piles de type ROS.
LogicalResourceId	String	L'ID logique de la ressource, correspondant au nom de la ressource défini dans le modèle.
PhysicalResourceId	String	L'ID physique de la ressource. S'applique uniquement lorsque `Action` est défini sur `Modify` ou `Remove`.
Replacement	String	Indique si ROS remplace la ressource en créant une nouvelle instance et en supprimant l'existante. S'applique uniquement lorsque `Action` est défini sur `Modify`. Valeurs valides pour les piles de type ROS : `True` : ROS remplace la ressource. Requis lorsque `RequiresRecreation` est `Always` et `Evaluation` est `Static`. `False` : ROS ne remplace pas la ressource. Requis lorsque RequiresRecreation est Never et Evaluation est Static. `Conditional` : ROS peut remplacer la ressource. Requis lorsque `RequiresRecreation` est `Always` et `Evaluation` est `Dynamic`. Remarque Lorsque plusieurs valeurs de `RequiresRecreation` s'appliquent, `Replacement` est déterminé par la valeur ayant l'impact le plus élevé. Ordre d'impact : `Always` > `Conditional` > `Never`. Valeurs valides pour les piles de type Terraform : `True` : Terraform remplace la ressource. `False` : Terraform ne remplace pas la ressource.
ResourceType	String	Le type de ressource.
Scope	Array of strings	L'attribut qui déclenche une mise à jour. S'applique uniquement lorsque `Action` est défini sur `Modify`. Valeurs valides : `Properties` : le paramètre Properties de la ressource `Metadata` : le paramètre Metadata de la ressource `DeletionPolicy` : le paramètre DeletionPolicy de la ressource Remarque Disponible uniquement pour les piles de type ROS.
PropertyChanges	Structure array of ResourcePropertyChange	Modifications au niveau des propriétés. S'applique uniquement lorsque `Action` est défini sur `Modify`. ResourcePropertyChange. Remarque Disponible uniquement pour les piles de type Terraform.
ModuleInfo	Structure array of ModuleInfo	Informations du module pour la ressource. Renvoyé uniquement si la ressource est créée à partir de modules. ModuleInfo. Remarque Disponible uniquement pour les piles de type ROS.

ResourceChangeDetail

Parameter	Type	Description
ChangeSource	String	Le déclencheur de la mise à jour. Valeurs valides : `ResourceReference` : l'ID physique de la ressource référencée peut changer. `ParameterReference` : un paramètre de modèle référencé peut changer. `ResourceAttribute` : une propriété de sortie de ressource référencée peut changer. `DirectModification` : le modèle a été directement modifié. `Automatic` : pour les piles imbriquées non modifiées (`ALIYUN::ROS::Stack`), ROS définit `ChangeSource` sur `Automatic` car le modèle imbriqué peut avoir changé. ROS ne met pas à jour le modèle imbriqué tant que la pile parent n'est pas mise à jour. `System` : des mécanismes internes (tels que `ALIYUN::ROS::WaitConditionHandle`) déclenchent une mise à jour indépendamment des modifications d'entrée.
CausingEntity	String	L'entité associée à `ChangeSource`. Correspondance entre les valeurs ChangeSource et CausingEntity : `ResourceReference` : le nom de la ressource. `ParameterReference` : le nom du paramètre. `ResourceAttribute` : au format `Resource name.Parameter name`. `DirectModification` : null. `Automatic` : le nom de la ressource. `System` : le nom de la ressource.
Evaluation	String	Indique si ROS peut déterminer la valeur cible avant l'exécution du jeu de modifications. Valeurs valides : `Static` : ROS peut déterminer la valeur cible avant l'exécution. `Dynamic` : ROS ne peut pas déterminer la valeur cible. La valeur peut dépendre de fonctions intrinsèques telles que `Ref` ou `Fn::GetAtt`.
Target	Structure	L'entité qui déclenche la mise à jour.

ResourceTargetDefinition

Parameter	Type	Description
Attribute	String	L'attribut qui déclenche la mise à jour. Valeurs valides : `Properties` : le paramètre Properties de la ressource `Metadata` : le paramètre Metadata de la ressource `DeletionPolicy` : le paramètre DeletionPolicy de la ressource
Name	String	Lorsque `Attribute` est `Properties`, Name est le nom de la propriété. Sinon, Name est `null`.
RequiresRecreation	String	Indique si la modification de cette propriété entraîne la recréation de la ressource. S'applique uniquement lorsque `Attribute` est `Properties`. Valeurs valides : `Never` : la modification de la propriété ne nécessite pas de recréation. `Conditionally` : la modification de la propriété peut nécessiter une recréation. `Always` : la modification de la propriété nécessite toujours une recréation.

ResourcePropertyChange

Parameter	Type	Description
Name	String.	Le nom de la propriété.
BeforeValue	The data type varies based on the property.	La valeur de la propriété avant la mise à jour.
AfterValue	The data type varies based on the property.	La valeur de la propriété après la mise à jour. Remarque Si la valeur est `<known_after_apply>` (type String), la valeur est disponible uniquement après la création ou la mise à jour. Si la valeur est `<sensitive>` (type String), la valeur contient des données sensibles.

ModuleInfo

Parameter

Type

Description

LogicalIdHierarchy

String

Les ID logiques des modules contenant la ressource, concaténés du plus externe au plus interne et séparés par des barres obliques (/).

Exemple : une ressource créée à partir du module B imbriqué dans le module A :

moduleA/moduleB

TypeHierarchy

String

Les types de modules contenant la ressource, concaténés du plus externe au plus interne et séparés par des barres obliques (/).

Exemple : une ressource issue de MODULE::ROS::Child::Example imbriqué dans MODULE::ROS::Parent::Example :

MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example

Références

Pour afficher les modifications JSON dans un jeu de modifications, consultez Afficher un jeu de modifications.