Enregistrez une extension privée tierce dans votre compte - AWS CloudFormation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Enregistrez une extension privée tierce dans votre compte

Cette rubrique décrit les étapes à suivre pour enregistrer une extension privée tierce partagée avec vous afin qu'elle puisse être utilisée sur votre compte.

Note

Avant de continuer, vérifiez que vous êtes en mesure Autorisations IAM d'enregistrer une extension privée.

Pour enregistrer une extension privée partagée avec vous (AWS CLI)

  1. Localisez le compartiment Amazon S3 qui contient le package de projet pour l'extension privée que vous souhaitez enregistrer dans votre compte.

  2. Utilisez la register-typecommande pour enregistrer l'extension privée dans votre compte.

    Par exemple, la commande suivante enregistre le type de My::Resource::Example ressource dans le champ spécifié Compte AWS.

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

    RegisterType est une opération asynchrone. Elle renvoie un jeton d'enregistrement que vous pouvez utiliser pour suivre la progression de votre demande d'enregistrement.

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

    Si votre extension appelle dans AWS APIs le cadre de ses fonctionnalités, vous devez créer un rôle d'exécution IAM incluant les autorisations nécessaires pour les appeler AWS APIs, et fournir ce rôle d'exécution dans votre compte. Vous pouvez ensuite spécifier ce rôle d'exécution à l'aide de l'--execution-role-arnoption. CloudFormation assume ensuite ce rôle d'exécution pour fournir à votre type de ressource les informations d'identification appropriées.

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

  3. (Facultatif) Utilisez le jeton d'enregistrement avec la describe-type-registrationcommande pour suivre la progression de votre demande d'enregistrement.

    Lorsque la demande d'enregistrement est CloudFormation terminée, l'état d'avancement de la demande est défini surCOMPLETE.

    L'exemple suivant utilise le jeton d'enregistrement renvoyé par la commande describe-type-registration ci-dessus pour renvoyer les informations relatives à l'état de l'enregistrement.

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

    La commande renvoie le résultat suivant.

    {
    "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"
}
Important

Si l'extension que vous enregistrez est un Hook, cette étape suivante est requise. Vous devez spécifier ENABLED pour la propriété HookInvocationStatus. Cette opération active les propriétés du Hook définies dans la properties section du schéma du Hook. Pour plus d'informations, consultez la référence de syntaxe du schéma de configuration Hook dans le guide de l'utilisateur de CloudFormation Hooks.

Pour spécifier les données de configuration d'un Hook (AWS CLI)

  1. Obtenez l'ARN de votre Hook et enregistrez-le. Vous pouvez obtenir l'ARN d'un Hook en utilisant le AWS Management Console ou AWS CLI. Pour de plus amples informations, veuillez consulter Afficher les extensions disponibles et activées dans le CloudFormation registre. 

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

  2. Utilisez la set-type-configurationcommande pour spécifier les données de configuration. Le JSON pour lequel vous transmettez --configuration doit être validé par rapport au schéma de configuration du Hook. Pour activer le Hook, vous devez définir la HookInvocationStatus propriété sur ENABLED dans la HookConfiguration section.

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

    Pour plus d'informations, consultez la référence de syntaxe du schéma de configuration Hook dans le guide de l'utilisateur de CloudFormation Hooks.