Memperbarui sumber daya dengan AWS Cloud Control API - API Kontrol Awan
Menyusun dokumen patchBagaimana Cloud Control API memperbarui sumber dayaMelacak kemajuan permintaan sumber daya pembaruan

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

Memperbarui sumber daya dengan AWS Cloud Control API

Gunakan update-resource perintah untuk membuat pembaruan ke sumber daya yang ada. Ini termasuk sumber daya yang awalnya tidak disediakan menggunakan Cloud Control API.

penting

Kami sangat menyarankan agar tidak menggunakan Cloud Control API untuk memperbarui sumber daya yang berada di bawah pengelolaan aktif oleh layanan lain. Melakukannya dapat menyebabkan hasil yang tidak terduga. Misalnya, jangan gunakan Cloud Control API untuk memperbarui sumber daya yang saat ini merupakan bagian dari AWS CloudFormation tumpukan.

Untuk memperbarui sumber daya yang ada, Anda harus menentukan pengenal sumber daya. Untuk informasi selengkapnya tentang menentukan pengenal sumber daya, lihatMenggunakan pengenal utama sumber daya.

Memperbarui sumber daya memerlukan perubahan nilai properti sumber daya. Properti sumber daya didefinisikan dalam skema tipe sumber dayanya. Ini termasuk apakah properti diperlukan, nilai yang valid, dan kendala properti lainnya. Untuk informasi selengkapnya tentang melihat definisi properti sumber daya, lihatMelihat skema tipe sumber daya.

Menyusun dokumen patch

Untuk memperbarui sumber daya, pertama-tama Anda mendefinisikan pembaruan sebagai daftar operasi tambalan yang terdapat dalam dokumen patch JSON. Dokumen patch ini harus mematuhi standar yang ditentukan dalam RFC 6902 - JavaScript Object Notation (JSON) Patch.

Setiap operasi patch mendefinisikan pembaruan tunggal ke properti sumber daya tertentu. Properti berikut diperlukan:

  • op: Jenis operasi. Cloud Control API mendukung semua operasi yang ditentukan dalam RFC 6902:add,,,remove, replacemove, copy dan. test

  • path: Jalur ke properti sumber daya, relatif terhadap properties bagian skema sumber daya.

Tergantung pada operasi, properti tambahan mungkin diperlukan. Lihat RFC 6902 untuk spesifik.

Saat menggunakan update-resource perintah, Anda dapat menentukan dokumen patch sebaris sebagai string, atau menentukan lokasi file.

Contoh berikut memperbarui kebijakan retensi AWS::Logs::LogGroupsumber daya yang diberi nama CloudControlApiLogGroup menjadi 90 hari.

$ aws cloudcontrol update-resource --type-name AWS::Logs::LogGroup \
    --identifier CloudControlApiLogGroup \
    --patch-document '[{"op":"replace","path":"RetentionInDays","value":90}]'

Bagaimana Cloud Control API memperbarui sumber daya

Untuk memperbarui sumber daya, Cloud Control API pertama-tama mengambil status sumber daya saat ini dan kemudian memperbarui sumber daya dalam proses dua langkah:

  • Cloud Control API menggabungkan operasi tambalan yang ditentukan dalam permintaan pembaruan dengan status sumber daya saat ini, untuk menghasilkan status sumber daya yang diinginkan setelah diperbarui. Operasi diterapkan secara berurutan dalam urutan yang muncul dalam dokumen patch. Setiap operasi dalam urutan diterapkan ke status sumber daya saat ini; status sumber daya yang dihasilkan menjadi target operasi berikutnya.

    Pada titik ini, seluruh permintaan pembaruan gagal jika:

    • Operasi tambalan yang disertakan dalam permintaan tidak valid.

    • Operasi patch op tipe test gagal.

    Dalam kasus seperti itu, seluruh permintaan pembaruan gagal dan Cloud Control API tidak membuat pembaruan ke sumber daya.

  • Cloud Control API kemudian memanggil pengendali pembaruan dari jenis sumber daya untuk memperbarui sumber daya.

    Jika pengendali pembaruan gagal pada titik mana pun, Cloud Control API tidak mengembalikan sumber daya ke status sebelumnya.

Misalnya, pertimbangkan dokumen patch berikut yang didefinisikan untuk memperbarui AWS::Logs::LogGroupsumber daya. Dokumen tersebut berisi dua operasi tambalan. Operasi pertama adalah tipe test dan memeriksa untuk melihat apakah kebijakan retensi sumber daya disetel ke 3653 hari. Jika demikian, sumber daya lulus pengujian dan Cloud Control API melanjutkan ke operasi berikutnya. Operasi ini menggantikan nilai kebijakan retensi saat ini dengan 180 hari. Jika kebijakan retensi sumber daya disetel ke nilai selain 3653 hari, test operasi pertama gagal dan Cloud Control API tidak pernah menjalankan replace operasi kedua.

[
  {
    "op": "test",
    "path": "/RetentionInDays",
    "value":3653
  },
  {
    "op": "replace",
    "path": "/RetentionInDays",
    "value":180
  }
]

Melacak kemajuan permintaan sumber daya pembaruan

update-resourcePerintah mengembalikan ProgressEvent objek yang dapat Anda gunakan untuk melacak status saat ini dari permintaan operasi sumber daya Anda. Untuk informasi selengkapnya, lihat Melacak kemajuan permintaan operasi sumber daya.