Registrieren Sie eine private Erweiterung eines Drittanbieters in Ihrem Konto - AWS CloudFormation

Registrieren Sie eine private Erweiterung eines Drittanbieters in Ihrem Konto

Dieses Thema behandelt die Schritte zur Registrierung einer privaten Erweiterung eines Drittanbieters, die mit Ihnen geteilt wurde, damit sie in Ihrem Konto verwendet werden kann.

Anmerkung

Bevor Sie fortfahren, vergewissern Sie sich, dass Sie über die erforderlichen IAM-Berechtigungen zur Registrierung einer privaten Nebenstelle verfügen.

So registrieren Sie eine private Erweiterung, die für Sie freigegeben ist (AWS CLI)

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

  2. Verwenden Sie den Befehl register-type, um die private Nebenstelle in Ihrem Konto zu registrieren.

    Der folgende Befehl registriert zum Beispiel den Ressourcentyp My::Resource::Example in dem angegebenen 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 AWS-APIs als Teil ihrer Funktionalität aufruft, müssen Sie eine IAM-Ausführungsrolle erstellen, die die erforderlichen Berechtigungen zum Aufrufen dieser AWS-APIs enthält, und diese Ausführungsrolle in Ihrem Konto bereitstellen. Sie können diese Ausführungsrolle dann mit der Option --execution-role-arn angeben. CloudFormation übernimmt dann diese Ausführungsrolle, um Ihrem Ressourcentyp die entsprechenden Anmeldeinformationen bereitzustellen.

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

  3. (Optional) Verwenden Sie das Registrierungs-Token mit dem Befehl describe-type-registration um den Fortschritt Ihrer Registrierungsanfrage zu verfolgen.

    Wenn CloudFormation die Registrierungsanforderung abgeschlossen hat, wird der Fortschrittsstatus der Anforderung auf festgelegt COMPLETE.

    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 die Erweiterung, die Sie registrieren, ein Hook ist, ist dieser nächste Schritt erforderlich. Sie müssen ENABLED für die HookInvocationStatus-Eigenschaft angeben. Diese Operation aktiviert die Eigenschaften des Hooks, die im Schemaabschnitt properties des Hooks definiert sind. Weitere Informationen finden Sie unter Referenz der Syntax des Hook-Konfigurationsschemas im CloudFormation Hooks User Guide.

So geben Sie die Konfigurationsdaten für einen Hook (AWS CLI) an

  1. Besorgen Sie sich den ARN für Ihren Hook und speichern Sie ihn. Sie können den ARN eines Hooks mit AWS-Managementkonsole oder AWS CLIabrufen. Weitere Informationen finden Sie unter Anzeigen der verfügbaren und aktivierten Erweiterungen in der CloudFormation-Registrierung. 

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

  2. Verwenden Sie den Befehl set-type-configuration, um die Konfigurationsdaten anzugeben. Das JSON, das Sie für --configuration übergeben, muss gegen das Konfigurationsschema des Hooks validiert werden. Um den Hook zu aktivieren, müssen Sie die Eigenschaft HookInvocationStatus im Abschnitt HookConfiguration auf ENABLED 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 unter Referenz der Syntax des Hook-Konfigurationsschemas im CloudFormation Hooks User Guide.