DATASOURCE::APIG::Services - Resource Orchestration Service

DATASOURCE::APIG::Services is used to query services.

Syntax

{
  "Type": "DATASOURCE::APIG::Services",
  "Properties": {
    "GatewayId": String,
    "ResourceGroupId": String,
    "RefreshOptions": String,
    "SourceType": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
GatewayId	String	No	Yes	The ID of the Cloud-native API Gateway instance.	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: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.
SourceType	String	No	Yes	The type of the service source.	None.

Return values

Fn::GetAtt

ServiceIds: the IDs of the services.
Services: details of the services.

Property	Type	Description	Constraint
ServiceIds	List	The IDs of the services.	None.
Services	List	Details of the services.	None.
AiServiceConfig	String	The AI service configurations.	None.
SourceType	String	The type of the service source.	None.
Addresses	List	Details of the addresses, such as IP addresses or domain names.	None.
GroupName	String	The name of the service group.	None.
Namespace	String	The namespace.	None.
ResourceGroupId	String	The ID of the resource group.	None.
ServiceName	String	The name of the service.	None.
ServiceId	String	The ID of the service.	None.
GatewayId	String	The ID of the Cloud-native API Gateway instance.	None.
Qualifier	String	The function qualified name.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Services
    Properties: {}
Outputs:
  ServiceIds:
    Description: The list of service IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceIds
  Services:
    Description: The list of services.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Services

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Services",
      "Properties": {
      }
    }
  },
  "Outputs": {
    "ServiceIds": {
      "Description": "The list of service IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceIds"
        ]
      }
    },
    "Services": {
      "Description": "The list of services.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Services"
        ]
      }
    }
  }
}