Use DATASOURCE::DNS::DomainRecords in a call to query DNS records - Resource Orchestration Service

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,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Status	String	No	Yes	The status of the DNS record.	Valid values: Enable: The DNS record is available. Disable: The DNS record is unavailable.
OrderBy	String	No	Yes	The method that the system uses to sort 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 hostname keyword based on which the system queries the DNS records.	The system queries the DNS records based on the value of `RRKeyWord` in fuzzy search mode. The value is used as a substring to match inside a string, and is case-insensitive.
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 search mode. The value is case-insensitive.
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, 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 `ValueKeyWord` in fuzzy search mode. The value is used as a substring to match inside a string, and is case-insensitive.
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 search mode. The value is case-insensitive.
SearchMode	String	No	Yes	The search mode.	Valid values: LIKE: If you use this value, you must specify KeyWord. In this case, RRKeyWord, TypeKeyWord, ValueKeyWord, Type, Line, and Status are ignored. EXACT: If you use this value, you must specify KeyWord. In this case, RRKeyWord, TypeKeyWord, ValueKeyWord, Type, Line, and Status are ignored. ADVANCED: If you use this value, you must specify RRKeyWord, TypeKeyWord, ValueKeyWord, Type, Line, and Status. Note If you leave SearchMode empty, the following rules apply: If KeyWord is specified, the system sets SearchMode to LIKE. If KeyWord is left empty, RRKeyWord and ValueKeyWord support the fuzzy search mode, and TypeKeyWord, Type, Line, and Status support the exact search mode.
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)

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 hostname.	None.
Remark	String	The remarks.	None.
Status	String	The status of the DNS record.	None.
TTL	Number	The time to live (TTL).	None.
Type	String	The type of the DNS record.	None.
Value	String	The value of the DNS record.	None.
Weight	Integer	The load balancing weight.	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

Syntax

Properties

Return values (Fn::GetAtt)

Examples

JSON format

YAML format

`JSON` format

`YAML` format