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.
Objets de réponse des ressources personnalisées
Cette rubrique décrit les propriétés de l'objet de réponse pour une ressource CloudFormation personnalisée.
Pour une présentation des ressources personnalisées et de leur fonctionnement, voirCréez une logique de provisionnement personnalisée avec des ressources personnalisées.
Champs de réponse du custom resource provider
Les propriétés suivantes sont incluses par le fournisseur de ressources personnalisées lorsqu'il envoie le JSON fichier au présignéURL. Pour plus d'informations sur le téléchargement d'objets à l'aide de PresignedURLs, consultez la rubrique correspondante dans le guide de l'utilisateur d'Amazon Simple Storage Service.
Note
La taille totale du corps de la réponse ne peut pas dépasser 4 096 octets.
Status
-
La valeur d'état envoyée par le fournisseur de ressources personnalisées en réponse à une demande AWS CloudFormation générée.
Doit être
SUCCESS
ouFAILED
.Obligatoire : oui
Type : chaîne
Reason
-
Décrit le motif d'une réponse à un échec.
Obligatoire : obligatoire si
Status
estFAILED
. Sinon, c'est facultatif.Type : chaîne
PhysicalResourceId
Cette valeur doit être un identifiant unique pour le fournisseur de ressources personnalisées et sa taille ne peut pas dépasser 1 Ko. La valeur doit être une chaîne non vide et doit être identique pour toutes les réponses pour la même ressource.
La valeur renvoyée pour un
PhysicalResourceId
peut modifier les opérations de mise à jour des ressources personnalisées. Si la valeur renvoyée est la même, on considère qu'il s'agit d'une mise à jour normale. Si la valeur renvoyée est différente, AWS CloudFormation reconnaît la mise à jour comme un remplacement et envoie une demande de suppression à l'ancienne ressource. Pour de plus amples informations, veuillez consulterAWS::CloudFormation::CustomResource
.Obligatoire : oui
Type : chaîne
StackId
-
Le nom de la ressource Amazon (ARN) qui identifie la pile contenant la ressource personnalisée. Cette valeur de réponse doit être copiée exactement à partir de la demande.
Obligatoire : oui
Type : chaîne
RequestId
-
Un ID unique pour la demande. Cette valeur de réponse doit être copiée exactement à partir de la demande.
Obligatoire : oui
Type : chaîne
LogicalResourceId
-
Le nom, choisi par le développeur du modèle, (ID logique) de la ressource personnalisée dans le modèle AWS CloudFormation . Cette valeur de réponse doit être copiée exactement à partir de la demande.
Obligatoire : oui
Type : chaîne
NoEcho
-
Facultatif. Indique s'il faut masquer la sortie de la ressource personnalisée lorsque celle-ci est récupérée à l'aide de la fonction
Fn::GetAtt
. Si ce paramètre est défini surtrue
, toutes les valeurs renvoyées sont masquées par des astérisques (*****), à l'exception de celles stockées dans laMetadata
section du modèle. AWS CloudFormation ne transforme, ne modifie ni n'expédie aucune information que vous incluez dansMetadata
cette section. La valeur par défaut estfalse
.Pour plus d’informations sur l’utilisation de
NoEcho
pour masquer des informations sensibles, consultez la documentation sur la bonne pratique consistant à ne pas intégrer les informations d’identification dans vos modèles.Obligatoire : non
Type : valeur booléenne
Data
-
Facultatif. Les paires nom-valeur définies par le custom resource provider à envoyer avec la réponse. Vous pouvez accéder aux valeurs fournies ici par nom dans le modèle avec
Fn::GetAtt
.Important
Si les paires nom-valeur contiennent des informations sensibles, vous devez utiliser le champ
NoEcho
pour masquer la sortie de la ressource personnalisée. Dans le cas contraire, les valeurs sont visibles à travers APIs les valeurs des propriétés de cette surface (telles queDescribeStackEvents
).Obligatoire : non
Type : objet JSON