Einen benutzerdefinierten Hook registrieren mit AWS CloudFormation

Um einen Hook zu registrieren

1. (Optional) Konfigurieren Sie Ihren AWS-Region Standardnamen aufus-west-2, indem Sie configureVorgang.

   $ aws configure
   AWS Access Key ID [None]: <Your Access Key ID>
   AWS Secret Access Key [None]: <Your Secret Key>
   Default region name [None]: us-west-2
   Default output format [None]: json

2. (Optional) Der folgende Befehl erstellt und verpackt Ihr Hook-Projekt, ohne es zu registrieren.

   $ cfn submit --dry-run

3. Registrieren Sie Ihren Hook mit dem CloudFormation CLI submitBetrieb.

   $ cfn submit --set-default

   Der Befehl gibt den folgenden Befehl zurück.

   {‘ProgressStatus’: ‘COMPLETE’}

   Ergebnisse: Sie haben Ihren Hook erfolgreich registriert.

Vergewissere dich, dass dein Hook in dir AWS-Konto und in den Regionen, in denen du ihn eingereicht hast, verfügbar ist.

1. Um deinen Hook zu verifizieren, verwende den list-typesBefehl, um Ihren neu registrierten Hook aufzulisten und eine zusammenfassende Beschreibung zurückzugeben.

   $ aws cloudformation list-types

   Der Befehl gibt die folgende Ausgabe zurück und zeigt Ihnen auch öffentlich verfügbare Hooks, die Sie in Ihren Regionen AWS-Konto und Regionen aktivieren können.

   {
       "TypeSummaries": [
           {
               "Type": "HOOK",
               "TypeName": "MyCompany::Testing::MyTestHook",
               "DefaultVersionId": "00000001",
               "TypeArn": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID/type/hook/MyCompany-Testing-MyTestHook",
               "LastUpdated": "2021-08-04T23:00:03.058000+00:00",
               "Description": "Verifies S3 bucket and SQS queues properties before creating or updating"
           }
       ]
   }

2. Rufen Sie das TypeArn aus der list-type Ausgabe für Ihren Hook ab und speichern Sie es.

   export HOOK_TYPE_ARN=arn:aws:cloudformation:us-west-2:ACCOUNT_ID/type/hook/MyCompany-Testing-MyTestHook

• Um einen Hook in Ihrem Konto zu konfigurieren, verwenden Sie SetTypeConfigurationOperation. Diese Operation aktiviert die Eigenschaften des Hooks, die im properties Schemaabschnitt des Hooks definiert sind. Im folgenden Beispiel ist die minBuckets Eigenschaft 1 in der Konfiguration auf gesetzt.

  Anmerkung

  Indem Sie Hooks in Ihrem Konto aktivieren, autorisieren Sie einen Hook, die von Ihnen AWS-Konto definierten Berechtigungen zu verwenden. CloudFormation entfernt nicht benötigte Berechtigungen, bevor du deine Berechtigungen an den Hook weitergibst. CloudFormation empfiehlt Kunden oder Hook-Benutzern, die Hook-Berechtigungen zu überprüfen und sich darüber im Klaren zu sein, welche Berechtigungen die Hooks haben dürfen, bevor Sie Hooks in Ihrem Konto aktivieren.

  Geben Sie die Konfigurationsdaten für Ihre registrierte Hook-Erweiterung im selben Konto an und AWS-Region.

  $ aws cloudformation set-type-configuration --region us-west-2 
    --configuration '{"CloudFormationConfiguration":{"HookConfiguration":{"HookInvocationStatus":"ENABLED","FailureMode":"FAIL","Properties":{"minBuckets": "1","minQueues": "1", "encryptionAlgorithm": "aws:kms"}}}}'
    --type-arn $HOOK_TYPE_ARN

  Wichtig

  Damit Ihr Hook die Konfiguration Ihres Stacks proaktiv überprüfen kann, müssen Sie ENABLED in dem HookInvocationStatus HookConfiguration Abschnitt, nachdem der Hook registriert und in Ihrem Konto aktiviert wurde, den Wert auf setzen.