DATASOURCE::APIG::Gateways is used to query gateways.
Syntax
{
"Type": "DATASOURCE::APIG::Gateways",
"Properties": {
"GatewayName": String,
"GatewayId": String,
"ResourceGroupId": String,
"RefreshOptions": String
}
}Properties
Property | Type | Required | Editable | Description | Constraint |
GatewayName | String | No | Yes | The name of the gateway. | None. |
GatewayId | String | No | Yes | The ID of the gateway. | None. |
ResourceGroupId | String | No | Yes | The ID of the resource group. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values
Fn::GetAtt
Gateways: details of the gateways.
GatewayIds: the IDs of the gateways.
Property | Type | Description | Constraint |
GatewayIds | List | The IDs of the gateways. | None. |
Gateways | List | Details of the gateways. | None. |
Zones | List | The zone information about the gateway. | None. |
UpdateTime | String | The update timestamp of the gateway. | None. |
GatewayName | String | The name of the gateway. | None. |
Tags | List | The tags. | None. |
LoadBalancers | List | The ingress addresses of the gateway. | None. |
SecurityGroup | List | The security group information about the gateway. | None. |
Spec | String | The specification of the gateway. | None. |
ExpireTime | String | The expiration timestamp of the subscription gateway. | None. |
PaymentType | String | The billing method of the gateway. | None. |
Version | String | The version of the gateway. | None. |
Vpc | List | The virtual private cloud (VPC) information about the gateway. | None. |
VSwitch | List | The vSwitch information. | None. |
GatewayId | String | The ID of the gateway. | None. |
ResourceGroupId | String | The ID of the resource group. | None. |
CreateTime | String | The creation timestamp of the gateway. | None. |
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GatewayId:
Type: String
Description:
en: Cloud-native API Gateway ID.
Required: false
Resources:
ExtensionDataSource:
Type: DATASOURCE::APIG::Gateways
Properties:
GatewayId:
Ref: GatewayId
Outputs:
Gateways:
Description: The list of gateways.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Gateways
GatewayIds:
Description: The list of gateway IDs.
Value:
Fn::GetAtt:
- ExtensionDataSource
- GatewayIds
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"GatewayId": {
"Type": "String",
"Description": {
"en": "Cloud-native API Gateway ID."
},
"Required": false
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::APIG::Gateways",
"Properties": {
"GatewayId": {
"Ref": "GatewayId"
}
}
}
},
"Outputs": {
"Gateways": {
"Description": "The list of gateways.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Gateways"
]
}
},
"GatewayIds": {
"Description": "The list of gateway IDs.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"GatewayIds"
]
}
}
}
}