Daftarkan ekstensi pribadi pihak ketiga di akun Anda - AWS CloudFormation

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Daftarkan ekstensi pribadi pihak ketiga di akun Anda

Topik ini mencakup langkah-langkah untuk mendaftarkan ekstensi pribadi pihak ketiga yang dibagikan kepada Anda sehingga tersedia untuk digunakan di akun Anda.

catatan

Sebelum melanjutkan, konfirmasikan bahwa Anda memiliki persyaratan Izin IAM untuk mendaftarkan ekstensi pribadi.

Untuk mendaftarkan ekstensi pribadi yang dibagikan dengan Anda (AWS CLI)

  1. Temukan bucket Amazon S3 yang berisi paket proyek untuk ekstensi pribadi yang ingin Anda daftarkan di akun Anda.

  2. Gunakan register-typeperintah untuk mendaftarkan ekstensi pribadi di akun Anda.

    Misalnya, perintah berikut mendaftarkan jenis My::Resource::Example sumber daya dalam yang ditentukan Akun AWS.

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

    RegisterTypeadalah operasi asinkron, dan mengembalikan token pendaftaran yang dapat Anda gunakan untuk melacak kemajuan permintaan pendaftaran Anda.

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

    Jika ekstensi Anda memanggil AWS APIs sebagai bagian dari fungsinya, Anda harus membuat peran eksekusi IAM yang mencakup izin yang diperlukan untuk memanggilnya AWS APIs, dan menyediakan peran eksekusi tersebut di akun Anda. Anda kemudian dapat menentukan peran eksekusi ini menggunakan --execution-role-arn opsi. CloudFormation kemudian mengasumsikan bahwa peran eksekusi untuk menyediakan jenis sumber daya Anda dengan kredensi yang sesuai.

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

  3. (Opsional) Gunakan token pendaftaran dengan describe-type-registrationperintah untuk melacak kemajuan permintaan pendaftaran Anda.

    Ketika CloudFormation menyelesaikan permintaan pendaftaran, itu menetapkan status kemajuan permintaan keCOMPLETE.

    Contoh berikut menggunakan token registrasi yang dikembalikan oleh describe-type-registration perintah di atas untuk mengembalikan informasi status pendaftaran.

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

    Perintah mengembalikan output berikut.

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

Jika ekstensi yang Anda daftarkan adalah Hook, langkah selanjutnya ini diperlukan. Anda harus menentukan ENABLED untuk HookInvocationStatus properti. Operasi ini memungkinkan properti Hook yang didefinisikan di properties bagian skema Hook. Untuk informasi selengkapnya, lihat Referensi sintaks skema konfigurasi Hook di Panduan Pengguna CloudFormation Hooks.

Untuk menentukan data konfigurasi untuk Hook (AWS CLI)

  1. Dapatkan ARN untuk Hook Anda dan simpan. Anda bisa mendapatkan ARN dari Hook menggunakan or. Konsol Manajemen AWS AWS CLI Untuk mengetahui informasi selengkapnya, lihat Lihat ekstensi yang tersedia dan diaktifkan di CloudFormation registri. 

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

  2. Gunakan set-type-configurationperintah untuk menentukan data konfigurasi. JSON yang Anda lewati --configuration harus memvalidasi terhadap skema konfigurasi Hook. Untuk mengaktifkan Hook, Anda harus mengatur HookInvocationStatus properti ENABLED di HookConfiguration bagian.

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

    Untuk informasi selengkapnya, lihat Referensi sintaks skema konfigurasi Hook di Panduan Pengguna CloudFormation Hooks.