Benutzerdefinierte Ressourcenantwortobjekte

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 benutzerdefinierten Ressourcenanbieter als Antwort auf eine AWS CloudFormation-generierte Anforderung gesendet wird.

Es muss entweder SUCCESS oder FAILED sein.

Required: Yes

Typ: Zeichenfolge

Grund

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 nicht derselbe ist, erkennt AWS CloudFormation die Aktualisierung als Ersatz und sendet eine Anforderung zum Löschen an die alte Ressource. Weitere Informationen finden Sie unter AWS::CloudFormation::CustomResource.

Required: Yes

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.

Required: Yes

Typ: Zeichenfolge

RequestId

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

Required: Yes

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.

Required: Yes

Typ: Zeichenfolge

NoEcho

Optional. Gibt an, ob die Ausgabe der benutzerdefinierten Ressource maskiert wird, wenn sie mithilfe der Fn::GetAtt-Funktion abgerufen wird. Wenn diese Option auf true gesetzt ist. werden alle zurückgegebenen Werte mit Sternchen (*****) maskiert außer denen, die im Metadata Abschnitt der Vorlage gespeichert sind. AWS CloudFormation transformiert, ändert oder bearbeitet keine Informationen im Metadata Abschnitt. 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

Daten

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