Anforderungsobjekte für benutzerdefinierte Ressourcen

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

Eine Einführung in benutzerdefinierte Ressourcen und deren Funktionsweise finden Sie unterErstellen Sie eine benutzerdefinierte Bereitstellungslogik mit benutzerdefinierten Ressourcen.

Eigenschaften von Vorlagenentwickleranforderungen

Der Vorlagenentwickler verwendet die CloudFormation Ressource AWS::CloudFormation::CustomResource,, um eine benutzerdefinierte Ressource in einer Vorlage anzugeben.

In AWS::CloudFormation::CustomResource werden alle Eigenschaften durch custom resource provider definiert. Es gibt nur eine erforderliche Eigenschaft: ServiceToken.

ServiceTimeout

Die maximale Zeit in Sekunden, die vergehen kann, bevor bei einem benutzerdefinierten Ressourcenvorgang ein Timeout eintritt.

Der Wert muss eine Ganzzahl zwischen 1 und 3600 sein. Der Standardwert ist 3600 Sekunden (1 Stunde).

Required: No

Typ: Zeichenfolge

ServiceToken

Das Service-Token, z. B. ein Amazon SNS SNS-Themen-ARN oder ein Lambda-Funktions-ARN. Das Service-Token muss aus derselben Region stammen wie der Stack.

Erforderlich: Ja

Typ: Zeichenfolge

Alle anderen Felder in den Ressourceneigenschaften sind optional und werden im Feld custom resource provider der Anforderung wortgetreu an den ResourceProperties gesendet. Der Anbieter definiert sowohl die Namen als auch die gültigen Inhalte für diese Felder.

Anforderungs-Felder für den benutzerdefinierten Ressourcenanbieter

Diese Felder werden in JSON-Anfragen von CloudFormation an den benutzerdefinierten Ressourcenanbieter im SNS-Thema gesendet, das der Anbieter für diesen Zweck konfiguriert hat.

RequestType

Der Anforderungstyp wird durch den CloudFormation Stack-Vorgang (Create-Stack, Update-Stack oder Delete-Stack) festgelegt, der vom Vorlagenentwickler für den Stack initiiert wurde, der die benutzerdefinierte Ressource enthält.

Zulässige Werte sind: Create, Update und Delete. Weitere Informationen finden Sie unter Anforderungstypen für benutzerdefinierte Ressourcen.

Erforderlich: Ja

Typ: Zeichenfolge

ResponseURL

Die Antwort-URL identifiziert einen vorsignierten S3-Bucket, der Antworten vom Anbieter der benutzerdefinierten Ressource auf empfängt. AWS CloudFormation

Erforderlich: Ja

Typ: Zeichenfolge

StackId

Der Amazon-Ressourcenname (ARN), der den Stack identifiziert, der die benutzerdefinierte Ressource enthält.

Kombinieren Sie StackId mit RequestId und es bildet sich ein Wert, mit dem Sie eine Anforderung für eine bestimmte benutzerdefinierte Ressource eindeutig identifizieren können.

Erforderlich: Ja

Typ: Zeichenfolge

RequestId

Eine eindeutige ID für die Anforderung.

Kombinieren Sie StackId mit RequestId und es bildet sich ein Wert, mit dem Sie eine Anforderung für eine bestimmte benutzerdefinierte Ressource eindeutig identifizieren können.

Erforderlich: Ja

Typ: Zeichenfolge

ResourceType

Der vom Vorlagenentwickler gewählte Ressourcentyp der benutzerdefinierten Ressource in der Vorlage. CloudFormation Namen für benutzerdefinierte Ressourcentypen dürfen bis zu 60 Zeichen lang sein und sowohl alphanumerische Zeichen als auch folgende Zeichen enthalten: _@-.

Erforderlich: Ja

Typ: Zeichenfolge

LogicalResourceId

Der vom Entwickler der Vorlagen gewählte Name (logische ID) der benutzerdefinierten Ressource in der AWS CloudFormation -Vorlage. Er wird angegeben, um die Kommunikation zwischen dem benutzerdefinierten Ressourcenanbieter und dem Vorlagen-Entwickler zu erleichtern.

Erforderlich: Ja

Typ: Zeichenfolge

PhysicalResourceId

Eine erforderliche, vom custom resource provider definierte physische ID, die für diesen Anbieter eindeutig ist

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: Sie wird immer mit Anforderungen des Typs Update und Anforderungen des Typs Delete gesendet, niemals jedoch mit Anforderungen des Typs Create.

Typ: Zeichenfolge

ResourceProperties

Dieses Feld enthält den Inhalt des Properties-Objekts, das vom Vorlagen-Entwickler gesendet wurde. Sein Inhalt wird durch benutzerdefinierte Ressourcenanbieter definiert.

Required: No

Typ: JSON-Objekt

OldResourceProperties

Wird nur für Update-Anforderungen verwendet. Enthält die Ressourceneigenschaften, die vor der Aktualisierungs-Anforderung deklariert wurden.

Erforderlich: Ja

Typ: JSON-Objekt