Syntaxreferenz für das Hook-Konfigurationsschema - CloudFormation
Eigenschaften des Hook-KonfigurationsschemasBeispiele für die Hook-Konfiguration

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Syntaxreferenz für das Hook-Konfigurationsschema

In diesem Abschnitt wird die Schemasyntax beschrieben, die zur Konfiguration von Hooks verwendet wird. CloudFormation verwendet dieses Konfigurationsschema zur Laufzeit, wenn ein Hook in einem AWS-Konto aufgerufen wird.

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

Themen
Anmerkung

Die maximale Datenmenge, die die Konfiguration eines Hooks speichern kann, beträgt 300 KB. Dies gilt zusätzlich zu allen Einschränkungen, die dem Configuration Anforderungsparameter des SetTypeConfigurationVorgangs auferlegt werden.

Eigenschaften des Hook-Konfigurationsschemas

Das folgende Schema ist die Struktur für ein Hook-Konfigurationsschema.

{
    "CloudFormationConfiguration": {
        "HookConfiguration": {
            "HookInvocationStatus": "ENABLED",
            "TargetOperations": ["STACK"],
            "FailureMode": "FAIL",
            "EncryptionConfiguration": {
                "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abc-123"
            },
            "Properties": {
                ...
            }
        }
    }
}
HookConfiguration

Die Hook-Konfiguration unterstützt die Aktivierung oder Deaktivierung von Hooks auf Stack-Ebene, Fehlermodi und Hook-Eigenschaftswerte.

Die Hook-Konfiguration unterstützt die folgenden Eigenschaften.

HookInvocationStatus

Gibt an, ob der Hook ENABLED oder istDISABLED.

Gültige Werte: ENABLED | DISABLED

TargetOperations

Gibt die Liste der Operationen an, gegen die der Hook ausgeführt wird. Weitere Informationen finden Sie unter Hook-Ziele.

Zulässige Werte: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

TargetStacks

Aus Gründen der Abwärtskompatibilität verfügbar. Verwenden Sie HookInvocationStatus stattdessen.

Wenn der Modus auf eingestellt istALL, gilt der Hook für alle Stacks in Ihrem Konto während einesCREATE,UPDATE, oder DELETE Ressourcenvorgangs.

Wenn der Modus auf eingestellt istNONE, gilt der Hook nicht für Stacks in deinem Konto.

Gültige Werte: ALL | NONE

FailureMode

In diesem Feld wird dem Dienst mitgeteilt, wie Hook-Fehler behandelt werden sollen.

  • Wenn der Modus auf FAIL eingestellt ist und der Hook fehlschlägt, beendet die Fehlkonfiguration die Bereitstellung von Ressourcen und führt ein Rollback des Stacks durch.

  • Wenn der Modus auf eingestellt ist WARN und der Hook fehlschlägt, ermöglicht die Warnkonfiguration, dass die Bereitstellung mit einer Warnmeldung fortgesetzt wird.

Gültige Werte: FAIL | WARN

EncryptionConfiguration

Gibt Verschlüsselungseinstellungen für Hook-Annotationsdaten an.

KmsKeyId

Der Alias, Alias-ARN, die Schlüssel-ID oder der Schlüssel-ARN des symmetrischen AWS KMS Verschlüsselungsschlüssels, der zur Verschlüsselung von Hook-Annotationsdaten verwendet wird. Weitere Informationen finden Sie KeyIdin den Dokumenten. AWS KMS

Bevor Sie Hooks mit vom Kunden verwalteten AWS KMS Schlüsseln erstellen können, muss Ihr Benutzer oder Ihre Rolle über AWS KMS Berechtigungen für DescribeKey und verfügenGenerateDataKey. Weitere Informationen finden Sie unter AWS KMS wichtige Richtlinien und Berechtigungen für die Verschlüsselung von CloudFormation Hooks-Ergebnissen im Ruhezustand.

Properties

Gibt die Eigenschaften der Hook-Laufzeit an. Diese sollten der Form der Eigenschaften entsprechen, die vom Hooks-Schema unterstützt werden.

Beispiele für die Hook-Konfiguration

Beispiele für die Konfiguration von Hooks aus finden Sie in den folgenden Abschnitten: AWS CLI