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 personnalisée CloudFormation.
Pour une présentation des ressources personnalisées et de leur fonctionnement, consultez Créer 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 lors de l'envoi du fichier JSON vers l'URL pré-signée. Pour plus d’informations sur le chargement d’objets à l’aide d’URL présignées, consultez Chargement d’objets avec des URL présignées dans le Guide de l’utilisateur 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 custom resource provider en réponse à une demande générée par CloudFormation.
Doit être
SUCCESSouFAILED.Obligatoire : oui
Type : chaîne
Reason-
Décrit le motif d'une réponse à un échec.
Obligatoire : obligatoire si
StatusestFAILED. Sinon, c'est facultatif.Type : chaîne
PhysicalResourceIdCette 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
PhysicalResourceIdpeut 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, CloudFormation reconnaît la mise à jour comme un remplacement et envoie une requête de suppression à l'ancienne ressource. Pour de plus amples informations, consultezAWS::CloudFormation::CustomResource.Obligatoire : oui
Type : chaîne
StackId-
L'Amazon Resource Name (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 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 la valeur est définie surtrue, toutes les valeurs renvoyées sont masquées par des astérisques (*****), à l'exception de celles stockées dans la sectionMetadatadu modèle. CloudFormation ne transforme pas, ne modifie pas et ne censure aucune information que vous incluez dans la sectionMetadata. La valeur par défaut estfalse.Pour plus d’informations sur l’utilisation de
NoEchopour 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
NoEchopour masquer la sortie de la ressource personnalisée. Sinon, les valeurs sont visibles via des API qui affichent des valeurs de propriétés de surface (telles queDescribeStackEvents).Obligatoire : non
Type : objet JSON
