Suppression

Lorsque le développeur du modèle supprime la pile ou retire la ressource personnalisée de la pile, CloudFormation envoie une demande au fournisseur de ressources personnalisées avec la valeur RequestType définie sur. Delete Pour supprimer une pile avec une ressource personnalisée, le custom resource provider doit répondre avec succès à une demande de suppression.

Pour une présentation des ressources personnalisées et de leur fonctionnement, voirRessources personnalisées.

Demande

Les requêtes de suppression contiennent les champs suivants :

RequestType

Delete.

RequestId

Un ID unique pour la demande.

ResponseURL

L'URL de réponse identifie un compartiment S3 présigné qui reçoit les réponses du fournisseur de ressources personnalisées à AWS CloudFormation.

ResourceType

Type de ressource choisi par le développeur du modèle pour la ressource personnalisée dans le modèle. CloudFormation Le nom des types de ressources personnalisées ne doit pas dépasser 60 caractères. Il peut inclure des caractères alphanumériques, ainsi que les caractères suivants : _@-.

LogicalResourceId

Le nom, choisi par le développeur du modèle, (ID logique) de la ressource personnalisée dans le modèle AWS CloudFormation .

StackId

L'Amazon Resource Name (ARN) qui identifie la pile contenant la ressource personnalisée.

PhysicalResourceId

ID physique obligatoire, défini par custom resource provider, qui est unique pour ce fournisseur.

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 plus d’informations, consultez AWS::CloudFormation::CustomResource.

ResourceProperties

Ce champ contient le contenu de l'objet Properties envoyé par le développeur du modèle. Son contenu est défini par le custom resource provider.

Exemple

{
   "RequestType" : "Delete",
   "RequestId" : "unique id for this delete request",
   "ResponseURL" : "pre-signed-url-for-delete-response",
   "ResourceType" : "Custom::MyCustomResourceType",
   "LogicalResourceId" : "name of resource in template",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10",
   "PhysicalResourceId" : "custom resource provider-defined physical id",
   "ResourceProperties" : {
      "key1" : "string",
      "key2" : [ "list" ],
      "key3" : { "key4" : "map" }
   }
}

Réponses

Réussite

Lorsque la requête de suppression aboutit, une réponse doit être envoyée au compartiment S3 avec les champs suivants :

Status

Doit indiquer SUCCESS.

RequestId

Un ID unique pour la demande. Cette valeur de réponse doit être copiée exactement à partir de la demande.

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.

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.

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 plus d’informations, consultez AWS::CloudFormation::CustomResource.

Exemple

{
   "Status" : "SUCCESS",
   "RequestId" : "unique id for this delete request (copied from request)",
   "LogicalResourceId" : "name of resource in template (copied from request)",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10 (copied from request)",
   "PhysicalResourceId" : "custom resource provider-defined physical id"
}

Échec

Lorsque la requête de suppression échoue, une réponse doit être envoyée au compartiment S3 avec les champs suivants :

Status

Doit indiquer FAILED.

Reason

Raison de l'échec.

RequestId

Valeur RequestId copiée à partir de la demande de suppression.

LogicalResourceId

Valeur LogicalResourceId copiée à partir de la demande de suppression.

StackId

Valeur StackId copiée à partir de la demande de suppression.

PhysicalResourceId

ID physique obligatoire, défini par le custom resource provider, qui est unique pour ce fournisseur.

Exemple

{
  "Status" : "FAILED",
  "Reason" : "Required failure reason string",
  "RequestId" : "unique id for this delete request (copied from request)",
  "LogicalResourceId" : "name of resource in template (copied from request)",
  "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10 (copied from request)",
  "PhysicalResourceId" : "custom resource provider-defined physical id"
}