Anforderungsobjekte für benutzerdefinierte Ressourcen - AWS CloudFormation

Anforderungsobjekte für benutzerdefinierte Ressourcen

Eigenschaften von Vorlagenentwickleranforderungen

template developer verwenden die AWS CloudFormation-Ressource AWS::CloudFormation::CustomResource, um in einer Vorlage benutzerdefinierte Ressourcen anzugeben.

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

ServiceToken

Gibt das Service-Token (ein Amazon SNS-Thema oder den Amazon-Ressourcennamen einer AWS Lambda-Funktion) an, das beim custom resource provider abgerufen wird, um auf den Service zugreifen zu dürfen. Das Service-Token muss in der Region sein, in der Sie den Stack erstellen.

Required: Yes

Type: String

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.

Felder in Anforderungen an Custom resource provider

Diese Felder werden in JSON-Anforderungen von AWS CloudFormation an den custom resource provider gesendet, und zwar in dem SNS-Thema, das der Anbieter hierfür konfiguriert hat.

RequestType

Der Anforderungstyp wird von der AWS CloudFormation-Stack-Operation (create-stack, update-stack oder delete-stack) festgelegt, die vom template developer 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.

Required: Yes

Type: String

ResponseURL

Die Antwort-URL gibt einen vorsignierten S3-Bucket an, der Antworten vom custom resource provider an AWS CloudFormation empfängt.

Required: Yes

Type: String

StackId

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

Durch die Kombination von StackId und RequestId entsteht ein Wert, den Sie verwenden können, um eine Anforderung für eine bestimmte benutzerdefinierte Ressource eindeutig zu bezeichnen.

Required: Yes

Type: String

RequestId

Eine eindeutige ID für die Anforderung

Durch die Kombination von StackId und RequestId entsteht ein Wert, den Sie verwenden können, um eine Anforderung für eine bestimmte benutzerdefinierte Ressource eindeutig zu bezeichnen.

Required: Yes

Type: String

ResourceType

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

Required: Yes

Type: String

LogicalResourceId

Der vom template developer gewählte Name (logische ID) der benutzerdefinierten Ressource in der AWS CloudFormation-Vorlage Er wird angegeben, um die Kommunikation zwischen dem custom resource provider und dem template developer zu erleichtern.

Required: Yes

Type: String

PhysicalResourceId

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

Required: Sie wird immer mit Anforderungen des Typs Update und Anforderungen des Typs Delete gesendet, niemals jedoch mit Anforderungen des Typs Create.

Type: String

ResourceProperties

Dieses Feld enthält die Inhalte des Properties-Objekts, das vom template developer gesendet wurde. Die Inhalte werden vom custom resource provider definiert.

Required: No

Type: JSON object

OldResourceProperties

Wird nur fürUpdate-Anforderungen verwendet. Enthält die Ressourceneigenschaften, die vor der Aktualisierungsanforderung deklariert wurden.

Required: Yes

Type: JSON object