Benutzerdefinierte Ressourcenantwortobjekte

In diesem Thema werden die Eigenschaften des Antwortobjekts für eine CloudFormation benutzerdefinierte Ressource beschrieben.

Eine Einführung in benutzerdefinierte Ressourcen und deren Funktionsweise finden Sie unterBenutzerdefinierte Ressourcen.

Antwort-Felder für den benutzerdefinierten Ressourcenanbieter

Die folgenden Eigenschaften werden vom benutzerdefinierten Ressourcenanbieter eingeschlossen, wenn er die JSON-Datei an die vorsignierte URL sendet. Weitere Informationen über das Hochladen von Objekten mithilfe vorsignierter URLs finden Sie unter dem entsprechenden Thema im Benutzerhandbuch für Amazon Simple Storage Service.

Anmerkung

Die Gesamtgröße des Antworttexts darf 4 096 Bytes nicht überschreiten.

Status

Der Statuswert, der vom Anbieter benutzerdefinierter Ressourcen als Antwort auf eine AWS CloudFormation-generierte Anfrage gesendet wurde.

Es muss entweder SUCCESS oder FAILED sein.

Erforderlich: Ja

Typ: Zeichenfolge

Reason

Beschreibt den Grund für eine Reaktion auf einen Fehler.

Erforderlich: Erforderlich wenn Status FAILED ist. Er ist andernfalls optional.

Typ: Zeichenfolge

PhysicalResourceId

Dieser Wert sollte eine eindeutige Kennung für den Anbieter der benutzerdefinierten Ressource sein und kann bis zu 1 KB groß sein. Der Wert muss eine nicht leere Zeichenfolge sein und muss für alle Antworten für dieselbe Ressource identisch sein.

Der für eine PhysicalResourceId zurückgegebene Wert kann benutzerdefinierte Vorgänge zur Ressourcenaktualisierung ändern. Wenn der zurückgegebene Wert derselbe ist, wird es als normale Aktualisierung betrachtet. Wenn der zurückgegebene Wert anders ist, AWS CloudFormation erkennt das Update als Ersatz und sendet eine Löschanforderung an die alte Ressource. Weitere Informationen finden Sie unter AWS::CloudFormation::CustomResource.

Erforderlich: Ja

Typ: Zeichenfolge

StackId

Der Amazon-Ressourcenname (ARN), der den Stack identifiziert, der die benutzerdefinierte Ressource enthält. Dieser Rückgabewert sollte wörtlich auf Basis der Anforderung kopiert werden.

Erforderlich: Ja

Typ: Zeichenfolge

RequestId

Eine eindeutige ID für die Anforderung. Dieser Rückgabewert sollte wörtlich auf Basis der Anforderung kopiert werden.

Erforderlich: Ja

Typ: Zeichenfolge

LogicalResourceId

Der vom Entwickler der Vorlagen gewählte Name (logische ID) der benutzerdefinierten Ressource in der AWS CloudFormation -Vorlage. Dieser Rückgabewert sollte wörtlich auf Basis der Anforderung kopiert werden.

Erforderlich: Ja

Typ: Zeichenfolge

NoEcho

Optional. Gibt an, ob die Ausgabe der benutzerdefinierten Ressource maskiert wird, wenn sie mithilfe der Fn::GetAtt-Funktion abgerufen wird. Wenn auf gesetzttrue, werden alle zurückgegebenen Werte mit Sternchen (*****) maskiert, mit Ausnahme der Werte, die im Metadata Abschnitt der Vorlage gespeichert sind. AWS CloudFormation transformiert, modifiziert oder redigiert keine Informationen, die Sie in den Abschnitt aufnehmen. Metadata Der Standardwert ist false.

Weitere Informationen zum Maskieren vertraulicher Daten mit NoEcho enthält die bewährte Methode Keine Anmeldeinformationen in Ihre Vorlagen einbetten.

Required: No

Typ: Boolesch

Data

Optional. Die vom benutzerdefinierten Ressourcenanbieter definierten Namen-Wert-Paare, die mit der Antwort gesendet werden. Sie können auf die hier namentlich angegebenen Werte in der Vorlage mit Fn::GetAtt zugreifen.

Wichtig

Wenn die Namen-Wert-Paare vertrauliche Informationen enthalten, sollten Sie das NoEcho-Feld benutzen, um die Ausgabe der benutzerdefinierten Ressource zu maskieren. Andernfalls sind die Werte durch APIs sichtbar, die Eigenschaftswerte (wie DescribeStackEvents) enthalten.

Required: No

Typ: JSON-Objekt