DATASOURCE::DNS::DomainRecords is used to query domain name system (DNS) records.

Syntax

{
  "Type": "DATASOURCE::DNS::DomainRecords",
  "Properties": {
    "Status": String,
    "OrderBy": String,
    "RRKeyWord": String,
    "DomainName": String,
    "TypeKeyWord": String,
    "Lang": String,
    "Direction": String,
    "GroupId": String,
    "Line": String,
    "Type": String,
    "ValueKeyWord": String,
    "KeyWord": String,
    "SearchMode": String
  }
}

Properties

Property Type Required Editable Description Constraint
Status String No Yes The state of the DNS record. Valid values:
  • Enable: The DNS record is available.
  • Disable: The DNS record is unavailable.
OrderBy String No Yes The method based on which the system sorts the DNS records. The system sorts the DNS records in reverse chronological order based on the time when they are added.
RRKeyWord String No Yes The resource record (RR) keyword based on which the system queries the DNS records. The system queries the DNS records based on the value of the RRKeyWord property in fuzzy match mode. The value is not case-sensitive.
DomainName String Yes Yes The domain name. None.
TypeKeyWord String No Yes The type keyword based on which the system queries the DNS records. The system queries the DNS records based on the value of this property in exact match mode. The value is not case-sensitive.
Lang String No Yes The language. None.
Direction String No Yes The order in which the system sorts the DNS records. Valid values:
  • DESC: descending order
  • ASC: ascending order
GroupId String No Yes The ID of the domain name group. None.
Line String No Yes The DNS line. Default value: default.

For more information about the valid values of this property, see DNS lines.

Type String No Yes The type of the DNS record. For more information about the valid values of this property, see DNS record types.
ValueKeyWord String No Yes The record value keyword based on which the system queries the DNS records. The system queries the DNS records based on the value of the ValueKeyWord property in fuzzy match mode. The value is not case-sensitive.
KeyWord String No Yes The keyword based on which the system queries the DNS records. The system queries the DNS records based on the value of this property in exact match mode. The value is not case-sensitive.
SearchMode String No Yes The search mode. Valid values: LIKE, EXACT, and ADVANCED.
  • If you set this property to LIKE, you must specify the KeyWord property. The RRKeyWord, TypeKeyWord, ValueKeyWord, Type, Line, and Status properties are ignored.
  • If you set this property to EXACT, you must specify the KeyWord property. The RRKeyWord, TypeKeyWord, ValueKeyWord, Type, Line, and Status properties are ignored.
  • If you set this property to ADVANCED, you must specify the RRKeyWord, TypeKeyWord, ValueKeyWord, Type, Line, and Status properties.
Note If you leave the SerachMode property empty, the system determines the search mode based on the following rules:
  • If you specify the KeyWord property, LIKE is used as the value of the SearchMode property.
  • If you leave the KeyWord property empty, the system queries the DNS records based on the value of the RRKeyWord or ValueKeyWord property in fuzzy match mode, and based on the value of the TypeKeyWord, Type, Line, or Status property in exact match mode.

Return values (Fn::GetAtt)

  • DomainRecordIds: the IDs of the DNS records.
  • DomainRecords: details of the DNS records.
Property Type Description Constraint
DomainRecordIds List The IDs of the DNS records. None.
DomainRecords List Details of the DNS records. None.
DomainName String The domain name. None.
Line String The DNS line. None.
RecordId String The ID of the DNS record. None.
Locked Boolean Indicates whether the DNS record is locked. None.
Priority Number The priority of the mail exchanger (MX) record. None.
RR String The RR value. None.
Remark String The description of the DNS record. None.
Status String The state of the DNS record. None.
TTL Number The time-to-live (TTL) of the DNS record. None.
Type String The type of the DNS record. None.
Value String The value of the DNS record. None.
Weight Integer The weight of the DNS record that is configured for load balancing. None.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainName": {
      "Type": "String",
      "Description": "The domain name for which you want to query DNS records."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DNS::DomainRecords",
      "Properties": {
        "DomainName": {
          "Ref": "DomainName"
        }
      }
    }
  },
  "Outputs": {
    "DomainRecordIds": {
      "Description": "The list of The DNS domain record ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainRecordIds"
        ]
      }
    },
    "DomainRecords": {
      "Description": "The information about DNS records.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainRecords"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainName:
    Type: String
    Description: The domain name for which you want to query DNS records.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DNS::DomainRecords
    Properties:
      DomainName:
        Ref: DomainName
Outputs:
  DomainRecordIds:
    Description: The list of The DNS domain record ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainRecordIds
  DomainRecords:
    Description: The information about DNS records.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainRecords