All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::DNS::DomainGroups

    Document Center

    Resource Orchestration Service:DATASOURCE::DNS::DomainGroups

    Last Updated:Nov 01, 2024

    DATASOURCE::DNS::DomainGroups is used to query domain name groups.

    Syntax

    {
  "Type": "DATASOURCE::DNS::DomainGroups",
  "Properties": {
    "KeyWord": String,
    "Lang": String,
    "RefreshOptions": String
  }
}

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    KeyWord

    String

    No

    Yes

    The keyword that is used to search for the domain group name.

    The %KeyWord% mode is supported for searches. The keyword is case-insensitive.

    Lang

    String

    No

    Yes

    The language.

    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.

    Return values (Fn::GetAtt)

    • DomainGroupIds: the IDs of the domain name groups.

    • DomainGroups: details of the domain name groups.

    Property

    Type

    Description

    Constraint

    DomainGroupIds

    List

    The IDs of the domain name groups.

    None.

    DomainGroups

    List

    Details of the domain name groups.

    None.

    GroupName

    String

    The name of the domain name group.

    None.

    DomainCount

    Number

    The number of domain name groups.

    None.

    GroupId

    String

    The ID of the domain name group.

    None.

    Examples

    JSON format

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "KeyWord": {
      "Type": "String",
      "Description": "The keyword for searches in \"%KeyWord%\" mode. The value is not case-sensitive."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DNS::DomainGroups",
      "Properties": {
        "KeyWord": {
          "Ref": "KeyWord"
        }
      }
    }
  },
  "Outputs": {
    "DomainGroups": {
      "Description": "The information about DNS domain groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainGroups"
        ]
      }
    },
    "DomainGroupIds": {
      "Description": "The list of The DNS domain group ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainGroupIds"
        ]
      }
    }
  }
}

    YAML format

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  KeyWord:
    Type: String
    Description: The keyword for searches in "%KeyWord%" mode. The value is not case-sensitive.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DNS::DomainGroups
    Properties:
      KeyWord:
        Ref: KeyWord
Outputs:
  DomainGroups:
    Description: The information about DNS domain groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainGroups
  DomainGroupIds:
    Description: The list of The DNS domain group ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainGroupIds