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.
cfn-signal
Le script d'cfn-signal
assistance indique si CloudFormation les EC2 instances Amazon ont été créées ou mises à jour avec succès. Si vous installez et configurez des applications logicielles sur des instances, vous pouvez signaler CloudFormation quand ces applications logicielles sont prêtes.
Vous utilisez le cfn-signal
script conjointement avec un Attribut CreationPolicy ou un Attribut UpdatePolicy with WaitOnResourceSignals
pour les groupes Amazon EC2 Auto Scaling. Lors de CloudFormation la création ou de la mise à jour de ressources avec ces politiques, il suspend le travail sur la pile jusqu'à ce que la ressource reçoive le nombre de signaux requis ou jusqu'à ce que le délai d'expiration soit dépassé. Pour chaque signal valide CloudFormation reçu, il publie les signaux dans la pile d'événements afin que vous puissiez suivre chaque signal.
Rubriques
Syntaxe pour le signalement des ressources (recommandée)
Si vous souhaitez signaler CloudFormation des ressources, utilisez la syntaxe suivante.
cfn-signal --success|-s
signal.to.send
\ --access-keyaccess.key
\ --credential-file|-fcredential.file
\ --exit-code|-eexit.code
\ --http-proxyHTTP.proxy
\ --https-proxyHTTPS.proxy
\ --id|-iunique.id
\ --regionAWS.region
\ --resourceresource.logical.ID
\ --roleIAM.role.name
\ --secret-keysecret.key
\ --stackstack.name.or.stack.ID
\ --urlAWS CloudFormation.endpoint
Note
cfn-signal
ne nécessite pas d'informations d'identification, vous n'avez donc pas besoin d'utiliser les --credential-file
options --access-key
--secret-key
--role
,, ou. Toutefois, si aucune information d'identification n'est spécifiée, CloudFormation vérifie l'appartenance de la pile et limite la portée de l'appel à la pile à laquelle l'instance appartient. Pour de plus amples informations, veuillez consulter Autorisations pour les scripts d'assistant.
Syntaxe à utiliser avec le descripteur de condition d'attente
Si vous souhaitez signaler un descripteur de condition d'attente, utilisez la syntaxe suivante.
cfn-signal --success|-s
signal.to.send
\ --reason|-rresource.status.reason
\ --data|-ddata
\ --id|-iunique.id
\ --exit-code|-eexit.code
\waitconditionhandle.url
Options
Les options que vous pouvez utiliser varient selon que vous signalez une politique de création ou un descripteur de condition d'attente. Les options qui s'appliquent à une politique de création ne s'appliquent pas forcément toutes au descripteur d'une condition d'attente.
Name (Nom) | Description | Obligatoire |
---|---|---|
|
AWS clé d'accès pour un compte autorisé à appeler l' CloudFormation Type : chaîne |
Non |
|
Données à envoyer avec le descripteur Type : chaîne Par défaut : vide |
Non |
|
Code d'erreur d'un processus qui peut être utilisé pour déterminer le succès ou l'échec. S'il est spécifié, l'option Type : chaîne Exemples : |
Non |
|
Fichier qui contient une clé d'accès secrète et une clé d'accès. Le paramètre du fichier d'informations d'identification supplante les paramètres --role, --access-key et --secret-key. Type : chaîne |
Non |
|
Proxy HTTP (non SSL). Utilisez le format suivant : Type : chaîne |
Non |
|
Proxy HTTPS. Utilisez le format suivant : Type : chaîne |
Non |
|
ID unique à envoyer. Type : chaîne Par défaut : ID de l' EC2 instance Amazon. Si l'ID ne peut pas être résolu, le FQDN de la machine est renvoyé. |
Non |
|
Raison du statut pour l'événement de ressource (actuellement uniquement utilisé en cas d'échec) : indique par défaut « Configuration failed » si « success » est false. Type : chaîne |
Non |
--region (signalement de ressources uniquement) |
Le point de terminaison CloudFormation régional à utiliser. Type : chaîne Par défaut : |
Non |
--resource (signalement de ressources uniquement) |
ID logique de la ressource qui contient les règles de création que vous souhaitez signaler. Type : chaîne |
Oui |
|
Nom d'un rôle IAM associé à l'instance. Type : chaîne Condition : le paramètre du fichier d'informations d'identification prévaut sur ce paramètre. |
Non |
|
Si la valeur est true, signal Type : valeur booléenne Par défaut : |
Non |
|
AWS clé d'accès secrète qui correspond à la clé AWS d'accès spécifiée. Type : chaîne |
Non |
|
Nom de la pile ou ID de la pile qui contient la ressource que vous voulez signaler. Type : chaîne |
Oui |
-u, --url (signalement de ressources uniquement) |
Le CloudFormation point de terminaison à utiliser. Type : chaîne |
Non |
|
URL pré-signée que vous pouvez utiliser pour signaler la réussite ou l'échec d'une condition Type : chaîne |
Oui |
Exemples
Exemple de Amazon Linux
Un modèle d'utilisation courant consiste à utiliser cfn-init
et cfn-signal
ensemble. L'cfn-signal
appel utilise le statut de retour de l'appel à cfn-init
(en utilisant le $ ? coque (construction). Si l'installation de l'application échoue, l'instance ne sera pas créée et la pile sera restaurée.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "Simple EC2 instance", "Resources": { "MyInstance": { "Type": "AWS::EC2::Instance", "Metadata": { "AWS::CloudFormation::Init": { "config": { "files": { "/tmp/test.txt": { "content": "Hello world!", "mode": "000755", "owner": "root", "group": "root" } } } } }, "Properties": { "ImageId": "{{resolve:ssm:/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2}}", "InstanceType": "t2.micro", "UserData": { "Fn::Base64": { "Fn::Join": [ "", [ "#!/bin/bash -x\n", "# Install the files and packages from the metadata\n", "yum install -y aws-cfn-bootstrap", "\n", "/opt/aws/bin/cfn-init -v ", " --stack ", { "Ref": "AWS::StackName" }, " --resource MyInstance ", " --region ", { "Ref": "AWS::Region" }, "\n", "# Signal the status from cfn-init\n", "/opt/aws/bin/cfn-signal -e $? ", " --stack ", { "Ref": "AWS::StackName" }, " --resource MyInstance ", " --region ", { "Ref": "AWS::Region" }, "\n" ] ] } } }, "CreationPolicy": { "ResourceSignal": { "Timeout": "PT5M" } } } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Description: Simple EC2 instance Resources: MyInstance: Type: 'AWS::EC2::Instance' Metadata: 'AWS::CloudFormation::Init': config: files: /tmp/test.txt: content: Hello world! mode: '000755' owner: root group: root Properties: ImageId: {{resolve:ssm:/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2}} InstanceType: t2.micro UserData: !Base64 'Fn::Join': - '' - - | #!/bin/bash -x - | # Install the files and packages from the metadata - yum install -y aws-cfn-bootstrap - |+ - | - '/opt/aws/bin/cfn-init -v ' - ' --stack ' - !Ref 'AWS::StackName' - ' --resource MyInstance ' - ' --region ' - !Ref 'AWS::Region' - |+ - | # Signal the status from cfn-init - '/opt/aws/bin/cfn-signal -e $? ' - ' --stack ' - !Ref 'AWS::StackName' - ' --resource MyInstance ' - ' --region ' - !Ref 'AWS::Region' - |+ CreationPolicy: ResourceSignal: Timeout: PT5M
Ressources connexes
Vous pouvez également visiter notre GitHub référentiel pour télécharger des exemples de modèles que nous utilisonscfn-signal
, notamment les modèles suivants.