DATASOURCE::ApiGateway::Groups digunakan untuk menanyakan informasi tentang grup API yang tersedia.
Sintaksis
{
"Type": "DATASOURCE::ApiGateway::Groups",
"Properties": {
"GroupName": String,
"InstanceId": String,
"Sort": String,
"GroupId": String,
"RefreshOptions": String
}
}Properti
Properti | Tipe | Diperlukan | Dapat Diedit | Deskripsi | Kendala |
GroupName | String | Tidak | Ya | Nama dari grup API. | Tidak ada. |
InstanceId | String | Tidak | Ya | ID instance. | Tidak ada. |
Sort | String | Tidak | Ya | Urutan tampilan grup API. | Nilai valid:
|
GroupId | String | Tidak | Ya | ID dari grup API. | Tidak ada. |
RefreshOptions | String | Tidak | Ya | Kebijakan refresh untuk sumber daya data ketika stack diperbarui. | Nilai valid:
|
Nilai kembali (Fn::GetAtt)
ApiGroups: Detail dari grup API.
ApiGroupIds: ID dari grup API.
Properti | Tipe | Deskripsi | Kendala |
ApiGroupIds | List | ID dari grup API. | Tidak ada. |
ApiGroups | List | Detail dari grup API. | Tidak ada. |
BillingStatus | String | Status penagihan dari grup API. | Nilai valid:
|
GroupId | String | ID dari grup API. | Tidak ada. |
CreatedTime | String | Waktu saat grup API dibuat. | Waktu ditampilkan dalam UTC. Waktu mengikuti standar ISO 8601 dalam format yy-mm-dd-hh-mm. |
Description | String | Deskripsi dari grup API. | Tidak ada. |
GroupName | String | Nama dari grup API. | Tidak ada. |
HttpsPolicy | String | Kebijakan keamanan HTTPS. | Tidak ada. |
IllegalStatus | String | Status validitas grup API. | Nilai valid:
|
InstanceId | String | ID instance. | Tidak ada. |
InstanceType | String | Tipe instance. | Tidak ada. |
ModifiedTime | String | Waktu terakhir kali grup API dimodifikasi. | Waktu ditampilkan dalam UTC. Waktu mengikuti standar ISO 8601 dalam format yy-mm-dd-hh-mm. |
RegionId | String | Wilayah dari grup API. | Tidak ada. |
SubDomain | String | Nama domain tingkat kedua yang sesuai dengan grup API. | Nama domain tingkat kedua digunakan oleh nama kanonikal (CNAME) dari nama domain kustom. |
TrafficLimit | Integer | Maksimum permintaan per detik (QPS) dari grup API. | Nilai default: 500. Catatan Anda dapat membuat permintaan untuk meningkatkan QPS maksimum. |
Tags | Map | Tag. | Tidak ada. |
Contoh
YAML format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GroupId:
Type: String
Description: ID grup API.
Resources:
ExtensionDataSource:
Type: DATASOURCE::ApiGateway::Groups
Properties:
GroupId:
Ref: GroupId
Outputs:
ApiGroups:
Description: Informasi tentang grup ApiGateway.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ApiGroups
ApiGroupIds:
Description: Daftar ID grup ApiGateway.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ApiGroupIds
JSON format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"GroupId": {
"Type": "String",
"Description": "ID grup API."
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::ApiGateway::Groups",
"Properties": {
"GroupId": {
"Ref": "GroupId"
}
}
}
},
"Outputs": {
"ApiGroups": {
"Description": "Informasi tentang grup ApiGateway.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ApiGroups"
]
}
},
"ApiGroupIds": {
"Description": "Daftar ID grup ApiGateway.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ApiGroupIds"
]
}
}
}
}