DATASOURCE::APIG::Gateway - Resource Orchestration Service

The DATASOURCE::APIG::Gateway type is used to query gateway details.

Syntax

{
  "Type": "DATASOURCE::APIG::Gateway",
  "Properties": {
    "GatewayId": String,
    "RefreshOptions": String
  }
}

Properties

Property name

Type

Required

Update allowed

Description

Constraint

GatewayId

String

Yes

Cloud-native API Gateway ID

None

RefreshOptions

String

Yes

The data source resources refresh mode when the stack is updated.

Valid values:

Never (default): never refresh data source resources when the stack is updated.
Always: always refresh data source resources when the stack is updated.

Return values

Fn::GetAtt

ResourceGroupId: Resource group ID.
CreateTime: Timestamp of gateway creation.
Vpc: Virtual private cloud (VPC) associated with the gateway.
LoadBalancers: Gateway ingress addresses list.
SecurityGroup: Gateway security group.
GatewayId: Gateway ID.
Zones: The zones associated with the gateway.
Environments: The environments associated with the gateway.
VSwitch: The virtual switch associated with the gateway.
Version: Gateway version.
UpdateTime: Gateway update timestamp. Unit: milliseconds.
PaymentType: Gateway payment method.
GatewayName: Gateway name.
Spec: Gateway instance specifications.
ExpireTime: Subscription expires timestamp. Unit: milliseconds.
Tags: Gateway resource tags.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GatewayId:
    Type: String
    Description:
      en: Cloud-native API Gateway ID.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Gateway
    Properties:
      GatewayId:
        Ref: GatewayId
Outputs:
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CreateTime:
    Description: 'The creation timestamp. Unit: milliseconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  Vpc:
    Description: The VPC associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Vpc
  LoadBalancers:
    Description: The list of Gateway ingress addresses.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancers
  SecurityGroup:
    Description: The Security Group of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecurityGroup
  GatewayId:
    Description: The ID of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GatewayId
  Zones:
    Description: The List of zones associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Zones
  Environments:
    Description: The list of environments associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Environments
  VSwitch:
    Description: The virtual switch associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitch
  Version:
    Description: The gateway version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Version
  UpdateTime:
    Description: 'Update timestamp. Unit: milliseconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTime
  PaymentType:
    Description: The payment type of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  GatewayName:
    Description: The name of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GatewayName
  Spec:
    Description: Gateway instance specifications.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Spec
  ExpireTime:
    Description: 'Package year and package month expiration timestamp. Unit: milliseconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpireTime
  Tags:
    Description: The tags of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GatewayId": {
      "Type": "String",
      "Description": {
        "en": "Cloud-native API Gateway ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Gateway",
      "Properties": {
        "GatewayId": {
          "Ref": "GatewayId"
        }
      }
    }
  },
  "Outputs": {
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation timestamp. Unit: milliseconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Vpc": {
      "Description": "The VPC associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Vpc"
        ]
      }
    },
    "LoadBalancers": {
      "Description": "The list of Gateway ingress addresses.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancers"
        ]
      }
    },
    "SecurityGroup": {
      "Description": "The Security Group of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroup"
        ]
      }
    },
    "GatewayId": {
      "Description": "The ID of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GatewayId"
        ]
      }
    },
    "Zones": {
      "Description": "The List of zones associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Zones"
        ]
      }
    },
    "Environments": {
      "Description": "The list of environments associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Environments"
        ]
      }
    },
    "VSwitch": {
      "Description": "The virtual switch associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitch"
        ]
      }
    },
    "Version": {
      "Description": "The gateway version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Version"
        ]
      }
    },
    "UpdateTime": {
      "Description": "Update timestamp. Unit: milliseconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTime"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "GatewayName": {
      "Description": "The name of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GatewayName"
        ]
      }
    },
    "Spec": {
      "Description": "Gateway instance specifications.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Spec"
        ]
      }
    },
    "ExpireTime": {
      "Description": "Package year and package month expiration timestamp. Unit: milliseconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}