Mengakses Sintaks & struktur Jenis dan parameter konfigurasi

Konfigurasi layanan untuk grup sumber daya

Grup sumber daya memungkinkan Anda mengelola koleksiAWS sumber daya Anda sebagai satu unit. BeberapaAWS layanan mendukung ini dengan melakukan operasi yang diminta pada semua anggota grup. Layanan tersebut dapat menyimpan pengaturan yang akan diterapkan ke anggota grup sebagai konfigurasi dalam bentuk struktur data JSON yang dilampirkan ke grup.

Topik ini menjelaskan setelan konfigurasi yang tersedia untukAWS layanan yang didukung.

Topik

Cara mengakses konfigurasi layanan yang dilampirkan ke grup sumber daya
sintaks JSON dari konfigurasi layanan
Jenis dan parameter konfigurasi yang didukung

Cara mengakses konfigurasi layanan yang dilampirkan ke grup sumber daya

Layanan yang mendukung grup tertaut layanan biasanya menetapkan konfigurasi untuk Anda saat Anda menggunakan alat yang disediakan oleh layanan tersebut, seperti konsol manajemen layanan tersebut atau operasinyaAWS CLI danAWS SDK. Beberapa layanan sepenuhnya mengelola grup terkait layanan mereka dan Anda tidak dapat memodifikasinya dengan cara apa pun kecuali diizinkan oleh konsol atau perintah yang disediakan olehAWS layanan kepemilikan. Namun, dalam beberapa kasus, Anda dapat berinteraksi dengan konfigurasi layanan dengan menggunakan operasi API berikut dalamAWS SDK atau yangAWS CLI setara:

Anda dapat menambahkan konfigurasi Anda sendiri ke grup saat Anda membuat grup dengan menggunakanCreateGroup operasi.
Anda dapat memodifikasi konfigurasi saat ini yang dilampirkan ke grup dengan menggunakanPutGroupConfiguration operasi.
Anda dapat melihat konfigurasi grup sumber daya saat ini dengan memanggilGetGroupConfiguration operasi.

sintaks JSON dari konfigurasi layanan

Grup sumber daya dapat berisi konfigurasi yang menentukan setelan khusus layanan yang berlaku untuk sumber daya yang merupakan anggota grup tersebut.

Sebuah konfigurasi dinyatakan sebagai objek JSON. Pada tingkat paling atas, konfigurasi adalah array item konfigurasi grup. Setiap item konfigurasi grup berisi dua elemen: aType untuk konfigurasi dan satu setParameters didefinisikan oleh jenis itu. Setiap parameter berisiName dan array dari satu atau lebihValues. Contoh berikut dengan placeholder menunjukkan sintaks dasar untuk konfigurasi untuk jenis sumber daya sampel tunggal. Contoh ini menunjukkan tipe dengan dua parameter, dan setiap parameter dengan dua nilai. Jenis, parameter, dan nilai valid yang sebenarnya dibahas di bagian berikutnya.


{
    "Configuration": [
        {
            "Type": "configuration-type",
            "Parameters": [
                {
                    "Name": "parameter1-name",
                    "Values": [
                        "value1",
                        "value2"
                    ]
                },
                {
                    "Name": "parameter2-name",
                    "Values": [
                        "value3",
                        "value4"
                    ]
                }
            ]
        }
    ]
}

Jenis dan parameter konfigurasi yang didukung

Resource Groups mendukung penggunaan jenis konfigurasi berikut. Setiap jenis konfigurasi memiliki seperangkat parameter yang valid untuk jenis itu.

Topik

AWS::ResourceGroups::Generic
AWS::AppRegistry::Application
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement

`AWS::ResourceGroups::Generic`

Jenis konfigurasi ini menetapkan pengaturan yang memberlakukan persyaratan keanggotaan pada grup sumber daya, daripada mengonfigurasi perilaku jenis sumber daya tertentu untuk suatuAWS layanan. Jenis konfigurasi ini secara otomatis ditambahkan oleh grup terkait layanan yang membutuhkannya, sepertiAWS::EC2::CapacityReservationPool danAWS::EC2::HostManagment jenis.

ParametersBerikut ini berlaku untuk grup yangAWS::ResourceGroups::Generic terhubung dengan layananType.

allowed-resource-types

Parameter ini menentukan bahwa kelompok sumber daya dapat terdiri dari sumber daya hanya jenis tertentu atau jenis.

Tipe data nilai: String

Nilai yang diizinkan:
- AWS::EC2::Host- AConfiguration dengan parameter dan nilai ini diperlukan ketika konfigurasi layanan juga berisiConfiguration tipeAWS::EC2::HostManagement. Ini memastikan bahwaHostManagement grup hanya dapat berisi host khusus Amazon EC2.
- AWS::EC2::CapacityReservation- AConfiguration dengan parameter dan nilai ini diperlukan ketika konfigurasi layanan juga berisiConfiguration item tipeAWS::EC2::CapacityReservationPool. Ini memastikan bahwaCapacityReservation grup hanya dapat berisi kapasitas reservasi kapasitas Amazon EC2.
Diperlukan: Bersyarat, berdasarkanConfiguration elemen lain yang dilampirkan ke grup sumber daya. Lihat entri sebelumnya untuk Nilai yang diizinkan.

Contoh berikut membatasi anggota grup hanya untuk instans host Amazon EC2.
```
{
    "Configuration": [
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": ["AWS::EC2::Host"]
                }
            ]
        }
    ]
}
```
deletion-protection

Parameter ini menetapkan bahwa grup sumber daya tidak dapat dihapus kecuali tidak mengandung anggota. Untuk informasi lebih lanjut, lihat Menghapus grup sumber daya host dalam Panduan Pengguna License Manager

Tipe data nilai: Array string

Nilai yang diizinkan: Satu-satunya nilai yang diizinkan adalah[ "UNLESS_EMPTY" ] (nilai harus huruf besar).

Diperlukan: Bersyarat, berdasarkanConfiguration elemen lain yang dilampirkan ke grup sumber daya. Parameter ini diperlukan hanya ketika kelompok sumber daya juga memilikiConfiguration elemen lain denganType dariAWS::EC2::HostManagement.

Contoh berikut memungkinkan perlindungan hapus untuk grup kecuali grup tidak memiliki anggota.
```
{
    "Configuration": [
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "deletion-protection",
                    "Values": [ "UNLESS_EMPTY" ]
                }
            ]
        }
    ]
}
```

`AWS::AppRegistry::Application`

ConfigurationTipe ini menentukan bahwa kelompok sumber daya mewakili aplikasi yang dibuat olehAWS Service Catalog AppRegistry.

Grup sumber daya jenis ini dikelola sepenuhnya oleh AppRegistry layanan, dan tidak dapat dibuat, diperbarui, atau dihapus oleh pengguna selain menggunakan alat yang disediakan oleh AppRegistry.

catatan

Karena grup sumber daya jenis ini secara otomatis dibuat dan dikelola olehAWS dan tidak dikelola oleh pengguna, grup sumber daya ini tidak dihitung terhadap batas kuota Anda untuk jumlah maksimum grup sumber daya yang dapat Anda buat di AndaAkun AWS.

Untuk informasi selengkapnya, lihat Menggunakan AppRegistry di PanduanService Catalog Pengguna.

Saat AppRegistry membuat grup sumber daya tertaut layanan dari jenis ini, grup ini juga secara otomatis membuat grupAWS CloudFormation terkait layanan tambahan terpisah untuk setiapAWS CloudFormation tumpukan yang terkait dengan aplikasi.

AppRegistry secara otomatis menamai grup tertaut layanan dari jenis ini yang dibuat dengan awalanAWS_AppRegistry_Application- diikuti dengan nama aplikasi:AWS_AppRegistry_Application-MyAppName

Parameter berikut didukung untuk jenis grup yangAWS::AppRegistry::Application terhubung dengan layanan.

Name

Parameter ini menentukan nama ramah aplikasi yang ditugaskan oleh pengguna ketika itu dibuat di AppRegistry.

Tipe data nilai: String

Nilai yang diizinkan: string teks apa pun yang diizinkan oleh AppRegistry layanan untuk nama aplikasi.

Wajib: Ya

Arn

Parameter ini menentukan jalur Amazon Resource Name (ARN) dari aplikasi yang ditetapkan oleh AppRegistry.

Tipe data nilai: String

Nilai yang diizinkan: ARN yang valid.

Wajib: Ya

catatan

Untuk mengubah salah satu elemen ini, Anda harus memodifikasi aplikasi menggunakan AppRegistry konsol atauAWS SDK danAWS CLI operasi layanan tersebut.

Grup sumber daya aplikasi ini secara otomatis menyertakan sebagai anggota grup grup sumber daya yang dibuat untukAWS CloudFormation tumpukan yang terkait dengan AppRegistry aplikasi. Anda dapat menggunakan ListGroupResourcesoperasi untuk melihat kelompok-kelompok anak tersebut.

Contoh berikut menunjukkan seperti apa bagian konfigurasi grup yangAWS::AppRegistry::Application terhubung dengan layanan.


{
    "Configuration": [
        {
            "Type": "AWS::AppRegistry::Application",
            "Parameters":[
                {
                    "Name": "Name",
                    "Values": [
                        "MyApplication"
                    ]
                },
                {
                    "Name": "Arn",
                    "Values": [
                        "arn:aws:servicecatalog:us-east-1:123456789012:/applications/<application-id>"
                    ]
                }
            ]
        }
    ]
}

`AWS::CloudFormation::Stack`

ConfigurationTipe ini menentukan bahwa kelompok mewakiliAWS CloudFormation tumpukan dan anggotanya adalahAWS sumber daya yang dibuat oleh tumpukan itu.

Grup sumber daya jenis ini secara otomatis dibuat untuk Anda saat Anda mengaitkanAWS CloudFormation tumpukan dengan AppRegistry layanan. Anda tidak dapat membuat, memperbarui, atau menghapus grup ini kecuali dengan menggunakan alat yang disediakan oleh AppRegistry.

AppRegistry secara otomatis menamai grup tertaut layanan dari jenis ini yang dibuat dengan awalanAWS_CloudFormation_Stack- diikuti dengan nama tumpukan:AWS_CloudFormation_Stack-MyStackName

catatan

Untuk informasi selengkapnya, lihat Menggunakan AppRegistry di PanduanService Catalog Pengguna.

AppRegistry secara otomatis membuat grup sumber daya terkait layanan dari jenis ini untuk setiapAWS CloudFormation tumpukan yang Anda kaitkan dengan AppRegistry aplikasi. Kelompok sumber daya ini menjadi anggota anak dari kelompok sumber daya induk untuk AppRegistry aplikasi.

Anggota grupAWS CloudFormation sumber daya ini adalahAWS sumber daya yang dibuat sebagai bagian dari tumpukan.

Parameter berikut didukung untuk jenis grup yangAWS::CloudFormation::Stack terhubung dengan layanan.

Name

Parameter ini menentukan nama ramahAWS CloudFormation tumpukan ditugaskan oleh pengguna ketika stack dibuat.

Tipe data nilai: String

Nilai yang diizinkan: string teks apa pun yang diizinkan olehAWS CloudFormation layanan untuk nama tumpukan.

Wajib: Ya

Arn

Parameter ini menentukan jalur Amazon Resource Name (ARN) dariAWS CloudFormation tumpukan yang dilampirkan ke aplikasi AppRegistry.

Tipe data nilai: String

Nilai yang diizinkan: ARN yang valid.

Wajib: Ya

catatan

Untuk mengubah salah satu elemen ini, Anda harus memodifikasi aplikasi menggunakan AppRegistry konsol atauAWS SDK danAWS CLI operasi yang setara.

Contoh berikut menunjukkan seperti apa bagian konfigurasi grup yangAWS::CloudFormation::Stack terhubung dengan layanan.


{
    "Configuration": [
        {
            "Type": "AWS::CloudFormation::Stack",
            "Parameters":[
                {
                    "Name": "Name",
                    "Values": [
                        "MyStack"
                    ]
                },
                {
                    "Name": "Arn",
                    "Values": [
                        "arn:aws:cloudformation:us-east-1:123456789012:stack/MyStack/<stack-id>"
                    ]
                }
            ]               
        }
    ]
}

`AWS::EC2::CapacityReservationPool`

ConfigurationTipe ini menetapkan bahwa kelompok sumber daya mewakili kolam umum kapasitas yang disediakan oleh anggota kelompok. Anggota grup sumber daya ini diharuskan untuk melakukan reservasi kapasitas Amazon EC2. Hal ini memungkinkan Anda meluncurkan instans Amazon EC2 menggunakan grup ini sebagai nilai untuk parameter reservasi kapasitas. Saat Anda melakukan ini, instance menggunakan kapasitas cadangan yang tersedia dalam grup. Jika grup sumber daya tidak memiliki kapasitas yang tersedia, instans akan diluncurkan sebagai instans sesuai permintaan yang berdiri sendiri di luar pangkalan. Untuk informasi selengkapnya, lihat Bekerja dengan grup Reservasi Kapasitas dalam Panduan Pengguna Amazon EC2 untuk Instans Linux.

Jika Anda mengonfigurasi grup sumber daya tertaut layanan denganConfiguration item jenis ini, maka Anda juga harus menentukanConfiguration item terpisah dengan nilai berikut:

AWS::ResourceGroups::GenericTipe dengan satu parameter:
- Parameterallowed-resource-types dan nilai tunggalAWS::EC2::CapacityReservation. Ini memastikan bahwa hanya reservasi kapasitas Amazon EC2 yang dapat menjadi anggota grup sumber daya.

AWS::EC2::CapacityReservationPoolItem dalam konfigurasi grup tidak mendukung parameter apa pun.

Contoh berikut menunjukkan seperti apaConfiguration bagian dari kelompok semacam itu.


{
    "Configuration": [
        {
            "Type": "AWS::EC2::CapacityReservationPool"
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": [ "AWS::EC2::CapacityReservation" ]
                }
            ]
        }
    ]
}

`AWS::EC2::HostManagement`

Pengenal ini menetapkan pengaturan untuk pengelolaan host Amazon EC2 danAWS License Manager yang diberlakukan untuk anggota grup. Untuk informasi selengkapnya, lihat Meng-host grup sumber daya diAWS License Manager.

Jika Anda mengonfigurasi grup sumber daya tertaut layanan denganConfiguration item jenis ini, maka Anda juga harus menentukanConfiguration item terpisah dengan nilai berikut:

AWS::ResourceGroups::GenericJenis, dengan parameterallowed-resource-types dan nilai tunggalAWS::EC2::Host. Ini memastikan bahwa hanya host khusus Amazon EC2 yang dapat menjadi anggota grup.
AWS::ResourceGroups::GenericJenis, dengan parameterdeletion-protection dan nilai tunggalUNLESS_EMPTY. Ini memastikan bahwa grup tidak dapat dihapus kecuali grup kosong.

Parameter berikut didukung untuk jenis grup yangAWS::EC2::HostManagement terhubung dengan layanan.

auto-allocate-host

Parameter ini menentukan apakah instans diluncurkan ke host tertentu, atau ke host mana pun yang tersedia yang memiliki konfigurasi yang cocok. Untuk informasi selengkapnya, lihat Memahami penempatan otomatis dan afinitas dalam Panduan Pengguna Amazon EC2 untuk Instans Linux.

Tipe data nilai: Boolean

Nilai yang diizinkan: “true” atau “false” (harus huruf kecil).

Wajib: Tidak


{
    "Configuration": [
        {
            "Type": "AWS::EC2::HostManagement",
            "Parameters": [
                {
                    "Name": "auto-allocate-host",
                    "Values": [ "true" ]
                }
            ]
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": [ "AWS::EC2::Host" ]
                },
                {
                    "Name": "deletion-protection",
                    "Values": [ "UNLESS_EMPTY" ]
                }
            ]
        }
    ]
}

auto-release-host

Parameter ini menentukan apakah host khusus dalam grup dilepaskan secara otomatis setelah instance terakhirnya dihentikan. Untuk informasi selengkapnya, lihat Merilis Host Khusus dalam Panduan Pengguna Amazon EC2 untuk Instans Linux.

Tipe data nilai: Boolean

Nilai yang diizinkan: “true” atau “false” (harus huruf kecil).

Wajib: Tidak


{
    "Configuration": [ 
        {
            "Type": "AWS::EC2::HostManagement",
            "Parameters": [
                {
                    "Name": "auto-release-host",
                    "Values": [ "false" ]
                }
            ]
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": [ "AWS::EC2::Host" ]
                },
                {
                    "Name": "deletion-protection",
                    "Values": [ "UNLESS_EMPTY" ]
                }
            ]
        }
    ]
}

allowed-host-families

Parameter ini menentukan keluarga jenis instance mana yang dapat digunakan oleh instance yang merupakan anggota grup ini.

Tipe data nilai: Array String.

Nilai yang diizinkan: Masing-masing harus berupa pengenal keluarga jenis instans Amazon EC2 yang valid, sepertiC4,M5,P3dn, atauR5d.

Wajib: Tidak

Item konfigurasi contoh berikut menetapkan bahwa instance yang diluncurkan hanya dapat menjadi anggota keluarga tipe instans C5 atau M5.


{
    "Configuration": [
        {
            "Type": "AWS::EC2::HostManagement",
            "Parameters": [
                {
                    "Name": "allowed-host-families",
                    "Values": ["c5", "m5"]
                }
            ]
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": ["AWS::EC2::Host"]
                },
                {
                    "Name": "deletion-protection",
                    "Values": ["UNLESS_EMPTY"]
                }
            ]
        }
    ]
}

allowed-host-based-license-configurations

Parameter ini menentukan jalur Amazon Resource Name (ARN) dari satu atau beberapa konfigurasi lisensi berbasis core/socket yang ingin Anda terapkan ke anggota grup.

Tipe data nilai: Array ARN.

Nilai yang diizinkan: Masing-masing harus berupa ARN konfigurasi License Manager yang valid.

Diperlukan: Bersyarat. Anda harus menentukan parameter ini atauany-host-based-license-configuration, tapi tidak keduanya. Mereka saling eksklusif.

Item konfigurasi contoh berikut menentukan bahwa anggota grup dapat menggunakan dua konfigurasi License Manager yang ditentukan.


{
    "Configuration": [
        {
            "Type": "AWS::EC2::HostManagement",
            "Parameters": [
                {
                    "Name": "allowed-host-based-license-configurations",
                    "Values": [
                        "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111", 
                        "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-8a786a26f50ba416eb658EXAMPLE2222"
                    ]
                }
            ]
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": [ "AWS::EC2::Host" ]
                },
                {
                    "Name": "deletion-protection",
                    "Values": [ "UNLESS_EMPTY" ]
                }
            ]
        }
    ]
}

any-host-based-license-configuration

Parameter ini menetapkan bahwa Anda tidak ingin mengaitkan konfigurasi lisensi tertentu ke grup Anda. Dalam kasus ini, semua konfigurasi lisensi berbasis core/socket tersedia untuk anggota grup sumber daya host Anda. Gunakan pengaturan ini jika Anda memiliki jumlah lisensi yang tidak terbatas dan ingin mengoptimalkan pemanfaatan host.

Tipe data nilai: Boolean

Nilai yang diizinkan: “true” atau “false” (harus huruf kecil).

Diperlukan: Bersyarat. Anda harus menentukan parameter ini atauallowed-host-based-license-configurations, tapi tidak keduanya. Mereka saling eksklusif.

Item konfigurasi contoh berikut menentukan bahwa anggota kelompok dapat menggunakan inti/soket konfigurasi lisensi berbasis.


{
    "Configuration": [
        {
            "Type": "AWS::EC2::HostManagement",
            "Parameters": [
                {
                    "Name": "any-host-based-license-configuration",
                    "Values": ["true"]
                }
            ]
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": ["AWS::EC2::Host"]
                },
                {
                    "Name": "deletion-protection",
                    "Values": ["UNLESS_EMPTY"]
                }
            ]
        }
    ]
}

Contoh berikut menggambarkan cara menyertakan semua pengaturan manajemen host bersama-sama dalam satu konfigurasi.


{
    "Configuration": [
        {
            "Type": "AWS::EC2::HostManagement",
            "Parameters": [
                {
                    "Name": "auto-allocate-host",
                    "Values": ["true"]
                },
                {
                    "Name": "auto-release-host",
                    "Values": ["false"]
                },
                {
                    "Name": "allowed-host-families",
                    "Values": ["c5", "m5"]
                },
                {
                    "Name": "allowed-host-based-license-configurations",
                    "Values": [
                        "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111",
                        "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-8a786a26f50ba416eb658EXAMPLE2222"
                    ]
                }
            ]
        },
        {
            "Type": "AWS::ResourceGroups::Generic",
            "Parameters": [
                {
                    "Name": "allowed-resource-types",
                    "Values": ["AWS::EC2::Host"]
                },
                {
                    "Name": "deletion-protection",
                    "Values": ["UNLESS_EMPTY"]
                }
            ]
        }
    ]
}

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Layanan AWS yang bekerja dengan AWS Resource Groups

Jenis sumber daya yang mendukung