Registrieren Sie eine private Erweiterung eines Drittanbieters in Ihrem Konto

In diesem Thema werden die Schritte zur Registrierung einer privaten Erweiterung eines Drittanbieters beschrieben, die mit Ihnen geteilt wurde, sodass sie in Ihrem Konto verwendet werden kann.

Anmerkung

Bevor Sie fortfahren, vergewissern Sie sich, dass Sie über die erforderlichen Voraussetzungen IAM-Berechtigungen für die Registrierung einer privaten Erweiterung verfügen.

Um eine private Erweiterung zu registrieren, die mit Ihnen geteilt wurde (AWS CLI)

1. Suchen Sie den Amazon S3 S3-Bucket, der das Projektpaket für die private Erweiterung enthält, die Sie in Ihrem Konto registrieren möchten.

2. Verwenden der register-typeBefehl zur Registrierung der privaten Erweiterung in Ihrem Konto.

   Mit dem folgenden Befehl wird beispielsweise der My::Resource::Example Ressourcentyp im angegebenen Verzeichnis registriert AWS-Konto.

   aws cloudformation register-type --type RESOURCE \
     --type-name My::Resource::Example \
     --schema-handler-package [s3 object path] --region us-west-2

   RegisterType ist ein asynchroner Vorgang und gibt ein Registrierungs-Token zurück, mit dem Sie den Fortschritt Ihrer Registrierungs-Anforderung verfolgen können.

   {
       "RegistrationToken": "f5525280-104e-4d35-bef5-8f1fexample"
   }

   Wenn Ihre Erweiterung im AWS APIs Rahmen ihrer Funktionalität aufgerufen wird, müssen Sie eine IAM Ausführungsrolle erstellen, die die erforderlichen Berechtigungen für deren Aufruf enthält AWS APIs, und diese Ausführungsrolle in Ihrem Konto bereitstellen. Sie können diese Ausführungsrolle dann mithilfe der --execution-role-arn Option angeben. CloudFormation geht dann davon aus, dass diese Ausführungsrolle Ihrem Ressourcentyp die entsprechenden Anmeldeinformationen zur Verfügung stellt.

   --execution-role-arn arn:aws:iam::123456789012:role/MyIAMRole

3. (Optional) Verwenden Sie das Registrierungstoken mit describe-type-registrationBefehl, um den Fortschritt Ihrer Registrierungsanfrage zu verfolgen.

   Wenn die Registrierungsanfrage CloudFormation abgeschlossen ist, wird der Fortschrittsstatus der Anfrage auf gesetztCOMPLETE.

   Im folgenden Beispiel wird das vom oben genannten describe-type-registration Befehl zurückgegebene Registrierungs-Token verwendet, um Registrierungs-Statusinformationen zurückzugeben.

   aws cloudformation describe-type-registration \
     --registration-token f5525280-104e-4d35-bef5-8f1fexample \
     --region us-west-2

   Der Befehl gibt die folgende Ausgabe zurück.

   {
       "ProgressStatus": "COMPLETE",
       "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Resource-Example",
       "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ",
       "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Resource-Example/00000001"
   }

Wichtig

Wenn es sich bei der Erweiterung, die Sie registrieren, um einen Hook handelt, ist dieser nächste Schritt erforderlich. Sie müssen ENABLED für die HookInvocationStatus-Eigenschaft angeben. Dieser Vorgang aktiviert die Eigenschaften des Hooks, die im properties Schemabereich des Hooks definiert sind. Weitere Informationen finden Sie in der Syntaxreferenz zum Hook-Konfigurationsschema im AWS CloudFormation Hooks User Guide.

Um die Konfigurationsdaten für einen Hook (AWS CLI) anzugeben

1. Holen Sie sich das ARN für Ihren Hook und speichern Sie es. Sie können den Wert ARN eines Hooks mit dem AWS Management Console oder ermitteln AWS CLI. Weitere Informationen finden Sie unter Sehen Sie sich die verfügbaren und aktivierten Erweiterungen in der CloudFormation Registrierung an.

   export HOOK_TYPE_ARN="arn:aws:cloudformation:us-west-2:123456789012:type/hook/Organization-Service-Hook/"

2. Verwenden der set-type-configurationBefehl zur Angabe der Konfigurationsdaten. DasJSON, was Sie übergeben, --configuration muss anhand des Konfigurationsschemas des Hook validiert werden. Um den Hook zu aktivieren, müssen Sie die HookInvocationStatus Eigenschaft ENABLED im HookConfiguration Abschnitt auf setzen.

   aws cloudformation set-type-configuration \
     --configuration "{"CloudFormationConfiguration":{"HookConfiguration":{"HookInvocationStatus": "ENABLED", "FailureMode": "FAIL", "Properties":{}}}}" \
     --type-arn $HOOK_TYPE_ARN --region us-west-2

   Weitere Informationen finden Sie in der Syntaxreferenz zum Hook-Konfigurationsschema im AWS CloudFormation Hooks User Guide.