Memulai dengan Cloud Control API

Gunakan tutorial singkat ini untuk memulai melakukan operasi sumber daya dengan AWS Cloud Control API. Anda akan mempelajari dasar-dasar penggunaan Cloud Control API untuk membuat, membaca, memperbarui, menghapus, dan membuat daftar sumber daya.

Langkah 1: Buat sumber daya

Untuk tutorial ini, buat sumber daya tipeAWS::Logs::LogGroup. Beri nama grup log iniCloudControlExample, dan setel kebijakan penyimpanan di dalamnya menjadi 90 hari.

1. Di AWS Command Line Interface (AWS CLI), jalankan create-resource perintah dengan parameter berikut:

   • Tentukan type-name sebagaiAWS::Logs::LogGroup.

   • Tentukan desired-state sebagai string yang berisi JSON yang menetapkan properti yang diinginkan:

     {"LogGroupName": "CloudControlExample", "RetentionInDays": 90}

   $ aws cloudcontrol create-resource --type-name AWS::Logs::LogGroup \
       --desired-state '{"LogGroupName": "CloudControlExample","RetentionInDays":90}'

   Cloud Control API mengembalikan ProgressEvent objek yang berisi informasi tentang status permintaan operasi sumber daya Anda.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:07:23.347Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "IN_PROGRESS",
           "Operation": "CREATE",
           "Identifier": "CloudControlExample",
           "RequestToken": "758f4a4e-fef4-491a-9b07-00123456789"
       }
   }

2. Untuk melacak status permintaan operasi sumber daya Anda, jalankan get-resource-request-status perintah dengan parameter berikut:

   • Tentukan request-token parameter sebagai nilai RequestToken properti yang dikembalikan dalam ProgressEvent objek.

   $ aws cloudcontrol get-resource-request-status --request-token 758f4a4e-fef4-491a-9b07-00123456789

   Cloud Control API mengembalikan ProgressEvent objek yang berisi informasi tentang status permintaan operasi sumber daya Anda. Ketika Cloud Control API telah berhasil membuat sumber daya, ia menetapkan OperationStatus nilainyaSUCCESS.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:29:23.326Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "SUCCESS",
           "Operation": "CREATE",
           "Identifier": "CloudControlExample",
           "RequestToken": "758f4a4e-fef4-491a-9b07-00123456789"
       }
   }

Langkah 2: Baca (jelaskan) sumber daya

Selanjutnya, baca status sumber daya saat ini yang baru saja Anda buat.

• Dalam AWS CLI, jalankan get-resource perintah dengan parameter berikut:

  • Tentukan identifier sebagai nilai identifier properti yang dikembalikan dalam ProgressEvent objek saat Anda membuat sumber daya. Dalam hal ini, ituCloudControlExample, nama yang Anda tentukan untuk grup log.

  $ aws cloudcontrol get-resource --type-name AWS::Logs::LogGroup --identifier CloudControlExample

  Cloud Control API menampilkan informasi terperinci tentang status sumber daya saat ini, termasuk model properti dan pengaturannya. Dalam hal ini, ini termasuk properti,Arn, yang dihasilkan oleh Amazon CloudWatch Events ketika sumber daya dibuat.

  {
      "TypeName": "AWS::Logs::LogGroup", 
      "ResourceDescription": {
          "Identifier": "CloudControlExample", 
          "ResourceModel": '{"RetentionInDays": 90, "LogGroupName": "CloudControlExample", "Arn": "arn:aws:logs:us-west-2:090123456789:log-group:CloudControlExample:*"}'
      }
  }

Langkah 3: Perbarui sumber daya

Selanjutnya, perbarui grup log Anda untuk menggandakan kebijakan penyimpanan menjadi 180 hari.

1. Dalam AWS CLI, jalankan update-resource perintah dengan parameter berikut:

   • Tentukan type-name sebagaiAWS::Logs::LogGroup.

   • Tentukan identifier sebagai nilai identifier properti yang dikembalikan dalam ProgressEvent objek saat Anda membuat sumber daya. Dalam hal ini, ituCloudControlExample, nama yang Anda tentukan untuk grup log.

   • Tentukan patch-document parameter sebagai string yang berisi JSON yang mewakili operasi pengganti yang memperbarui kebijakan retensi hingga 180 hari.

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

     Untuk informasi rinci tentang menyusun dokumen tambalan, lihatMenyusun dokumen patch.

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

   Cloud Control API mengembalikan ProgressEvent objek yang berisi informasi tentang status permintaan operasi sumber daya Anda.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:29:22.547Z", 
           "ResourceModel": '{"RetentionInDays":180,"LogGroupName":"CloudControlExample"}',
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "IN_PROGRESS",
           "Operation": "UPDATE",
           "Identifier": "CloudControlExample", 
           "RequestToken": "2026055d-f21c-4b50-bd40-111111111111"
       }
   }

2. Untuk melacak status permintaan operasi sumber daya Anda, jalankan get-resource-request-status perintah dengan parameter berikut:

   • Tentukan request-token parameter sebagai nilai RequestToken properti yang dikembalikan dalam ProgressEvent objek.

   $ aws cloudcontrol get-resource-request-status --request-token 2026055d-f21c-4b50-bd40-123456789012

   Cloud Control API mengembalikan ProgressEvent objek yang berisi informasi tentang status permintaan operasi sumber daya Anda. Ketika Cloud Control API telah berhasil memperbarui sumber daya, itu menetapkan OperationStatus nilainyaSUCCESS.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:29:23.326Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "SUCCESS",
           "Operation": "UPDATE",
           "Identifier": "CloudControlExample",
           "RequestToken": "2026055d-f21c-4b50-bd40-123456789012"
       }
   }

Langkah 4: Daftar semua sumber daya dari jenis tertentu

Selanjutnya, gunakan Cloud Control API untuk menemukan sumber daya di Anda Akun AWS.

• Dalam AWS CLI, jalankan list-resources perintah dengan parameter berikut:

  • Tentukan type-name sebagaiAWS::Logs::LogGroup.

  $ aws cloudcontrol list-resources --type-name AWS::Logs::LogGroup

  Cloud Control API mengembalikan daftar sumber AWS::Logs::LogGroup daya di akun Anda, berdasarkan pengenal utama. Ini termasukCloudControlExample, sumber daya yang Anda buat sebagai bagian dari tutorial ini, selain grup log lain yang sudah ada di akun Anda. Juga, untuk AWS::Logs::LogGroup sumber daya, informasi yang dikembalikan oleh list-resources menyertakan properti untuk setiap sumber daya.

  {
      "TypeName": "AWS::Logs::LogGroup",
      "ResourceDescriptions": [
          {
              "Identifier": "CloudControlExample",
              "Properties": '{"RetentionInDays":180, "LogGroupName": "CloudControlExample", "Arn":"arn:aws:logs:us-west-2:090123456789:log-group:CloudControlExample:*"}'
          },
          {
              "Identifier": "AnotherLogGroupResourceExample",
              "Properties": '{"RetentionInDays": 90, "LogGroupName": "AnotherLogGroupResourceExample", "Arn": "arn:aws:logs:us-west-2:011111111111:log-group:AnotherLogGroupResourceExample:*"}'
          },
      ]
  }

Langkah 5: Hapus sumber daya

Terakhir, hapus grup log Anda untuk membersihkan dari tutorial ini.

1. Dalam AWS CLI, jalankan delete-resource perintah dengan parameter berikut:

   • Tentukan type-name sebagaiAWS::Logs::LogGroup.

   • Tentukan identifier sebagai nilai identifier properti yang dikembalikan dalam ProgressEvent objek saat Anda membuat sumber daya. Dalam hal ini, ituCloudControlExample, nama yang Anda tentukan untuk grup log.

   $ aws cloudcontrol delete-resource --type-name AWS::Logs::LogGroup --identifier CloudControlExample

   Cloud Control API mengembalikan ProgressEvent objek yang berisi informasi tentang status permintaan operasi sumber daya Anda.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:50:20.037Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "IN_PROGRESS",
           "Operation": "DELETE",
           "Identifier": "CloudControlExample",
           "RequestToken": "bb0ed9cd-84f9-44c2-b638-000000000000"
       }
   }

2. Untuk melacak status permintaan operasi sumber daya Anda, jalankan get-resource-request-status perintah dengan parameter berikut:

   • Tentukan request-token parameter sebagai nilai RequestToken properti yang dikembalikan dalam ProgressEvent objek.

   $ aws cloudcontrol get-resource-request-status --request-token 2026055d-f21c-4b50-bd40-111111111111

   Cloud Control API mengembalikan ProgressEvent objek yang berisi informasi tentang status permintaan operasi sumber daya Anda. Ketika Cloud Control API telah berhasil menghapus sumber daya, itu menetapkan OperationStatus nilainyaSUCCESS.

   {
       "ProgressEvent": {
           "EventTime": "2021-08-26T22:50:20.831Z",
           "TypeName": "AWS::Logs::LogGroup",
           "OperationStatus": "SUCCESS",
           "Operation": "DELETE",
           "Identifier": "CloudControlExample",
           "RequestToken": "bb0ed9cd-84f9-44c2-b638-000000000000"
       }
   }

Langkah selanjutnya

Untuk informasi terperinci dan contoh tentang penggunaan Cloud Control API dengan sumber daya, lihatMelakukan operasi sumber daya.