Objets de requêtes de ressources personnalisées

Cette rubrique décrit les propriétés de l'objet de demande pour une ressource CloudFormation personnalisée.

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

Propriétés des requêtes du développeur de modèle

Le développeur du modèle utilise la CloudFormation ressource pour spécifier une ressource personnalisée dans un modèle. AWS::CloudFormation::CustomResource

Dans AWS::CloudFormation::CustomResource, toutes les propriétés sont définies par le custom resource provider. Une seule propriété est requise : ServiceToken.

ServiceTimeout

Durée maximale, en secondes, qui peut s'écouler avant l'expiration d'une opération sur une ressource personnalisée.

La valeur doit être un entier compris entre 1 et 3 600. La valeur par défaut est de 3 600 secondes (1 heure).

Obligatoire : non

Type : chaîne

ServiceToken

Le jeton de service, tel qu'un ARN de rubrique Amazon SNS ou un ARN de fonction Lambda. Le jeton de service doit provenir de la même région que la pile.

Obligatoire : oui

Type : chaîne

Tous les autres champs des propriétés de ressource sont facultatifs et sont envoyés, mot pour mot, au custom resource provider dans le champ ResourceProperties de la demande. Le fournisseur définit les noms et les contenus valides de ces domaines.

Champs de demande du custom resource provider

Ces champs sont envoyés dans des requêtes JSON CloudFormation au fournisseur de ressources personnalisées dans la rubrique SNS que le fournisseur a configurée à cet effet.

RequestType

Le type de demande est défini par l'opération de CloudFormation pile (create-stack, update-stack ou delete-stack) lancée par le développeur du modèle pour la pile contenant la ressource personnalisée.

Doit être : Create, Update ou Delete. Pour plus d’informations, consultez Types de demandes de ressource personnalisée.

Obligatoire : oui

Type : chaîne

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.

Obligatoire : oui

Type : chaîne

StackId

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

La combinaison de StackId avec RequestId forme une valeur que vous pouvez utiliser pour identifier de manière unique une demande sur une ressource personnalisée spécifique.

Obligatoire : oui

Type : chaîne

RequestId

Un ID unique pour la demande.

La combinaison de StackId avec RequestId forme une valeur que vous pouvez utiliser pour identifier de manière unique une demande sur une ressource personnalisée spécifique.

Obligatoire : oui

Type : chaîne

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 : _@-.

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 est fournie pour faciliter la communication entre le custom resource provider et le template developer.

Obligatoire : oui

Type : chaîne

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.

Obligatoire : toujours envoyé avec les demandes Update et Delete ; jamais envoyé avec Create.

Type : chaîne

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.

Obligatoire : non

Type : objet JSON

OldResourceProperties

Utilisé uniquement pour les demandes Update. Contient les propriétés de ressources déclarées avant la demande de mise à jour.

Obligatoire : oui

Type : objet JSON