DATASOURCE::DNS::DomainRecords を使用した DNS レコードのクエリ - ROS

DATASOURCE::DNS::DomainRecordsは、ドメインネームシステム（DNS）レコードを照会するために使用されます。

構文

{
  "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
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Status	String	いいえ	はい	DNSレコードのステータス。	有効な値： Enable：DNSレコードは使用可能です。 Disable：DNSレコードは使用不可です。
OrderBy	String	いいえ	はい	システムがDNSレコードをソートするために使用するメソッド。	システムは、DNSレコードが追加された時間を基準にして、逆時間順にソートします。
RRKeyWord	String	いいえ	はい	システムがDNSレコードを照会する際に基づいて使用するホスト名キーワード。	システムは、あいまい検索モードで `RRKeyWord` の値に基づいてDNSレコードを照会します。値は、文字列内の一致する部分文字列として使用され、大文字と小文字は区別されません。
DomainName	String	はい	はい	ドメイン名。	なし。
TypeKeyWord	String	いいえ	はい	システムがDNSレコードを照会する際に基づいて使用するタイプキーワード。	システムは、完全一致検索モードでこのプロパティの値に基づいてDNSレコードを照会します。値は大文字と小文字が区別されません。
Lang	String	いいえ	はい	言語。	なし。
Direction	String	いいえ	はい	システムがDNSレコードをソートする順序。	有効な値： DESC：降順 ASC：昇順
GroupId	String	いいえ	はい	ドメイン名グループのID。	なし。
Line	String	いいえ	はい	DNSライン。	デフォルト値：default。このプロパティの有効な値の詳細については、「DNS解決ライン」をご参照ください。
Type	String	いいえ	はい	DNSレコードのタイプ。	詳細については、「DNSレコードタイプ」をご参照ください。
ValueKeyWord	String	いいえ	はい	システムがDNSレコードを照会する際に基づいて使用するレコード値キーワード。	システムは、あいまい検索モードで `ValueKeyWord` の値に基づいてDNSレコードを照会します。値は、文字列内の一致する部分文字列として使用され、大文字と小文字は区別されません。
KeyWord	String	いいえ	はい	システムがDNSレコードを照会する際に基づいて使用するキーワード。	システムは、完全一致検索モードでこのプロパティの値に基づいてDNSレコードを照会します。値は大文字と小文字が区別されません。
SearchMode	String	いいえ	はい	検索モード。	有効な値： LIKE：この値を使用する場合は、KeyWordを指定する必要があります。この場合、RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、およびStatusは無視されます。 EXACT：この値を使用する場合は、KeyWordを指定する必要があります。この場合、RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、およびStatusは無視されます。 ADVANCED：この値を使用する場合は、RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、およびStatusを指定する必要があります。説明 SearchModeを空のままにすると、次のルールが適用されます。 KeyWordが指定されている場合、システムはSearchModeをLIKEに設定します。 KeyWordが空の場合、RRKeyWordとValueKeyWordはあいまい検索モードをサポートし、TypeKeyWord、Type、Line、およびStatusは完全一致検索モードをサポートします。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値： Never（デフォルト）：スタックが更新されたときにデータソースリソースを更新しません。 Always：スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

DomainRecordIds：DNSレコードのID。
DomainRecords：DNSレコードの詳細。

プロパティ	タイプ	説明	制約
DomainRecordIds	List	DNSレコードのID。	なし。
DomainRecords	List	DNSレコードの詳細。	なし。
DomainName	String	ドメイン名。	なし。
Line	String	DNSライン。	なし。
RecordId	String	DNSレコードのID。	なし。
Locked	Boolean	DNSレコードがロックされているかどうかを示します。	なし。
Priority	Number	メールエクスチェンジャー（MX）レコードの優先度。	なし。
RR	String	ホスト名。	なし。
Remark	String	備考。	なし。
Status	String	DNSレコードのステータス。	なし。
TTL	Number	有効期間（TTL）。	なし。
Type	String	DNSレコードのタイプ。	なし。
Value	String	DNSレコードの値。	なし。
Weight	Integer	負荷分散の重み。	なし。

例

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainName": {
      "Type": "String",
      "Description": "DNSレコードを照会するドメイン名。" // The domain name for which you want to query DNS records.
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DNS::DomainRecords",
      "Properties": {
        "DomainName": {
          "Ref": "DomainName"
        }
      }
    }
  },
  "Outputs": {
    "DomainRecordIds": {
      "Description": "DNSドメインレコードIDのリスト。", // The list of The DNS domain record ids.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainRecordIds"
        ]
      }
    },
    "DomainRecords": {
      "Description": "DNSレコードに関する情報。", // The information about DNS records.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainRecords"
        ]
      }
    }
  }
}

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainName:
    Type: String
    Description: DNSレコードを照会するドメイン名。 # The domain name for which you want to query DNS records.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DNS::DomainRecords
    Properties:
      DomainName:
        Ref: DomainName
Outputs:
  DomainRecordIds:
    Description: DNSドメインレコードIDのリスト。 # The list of The DNS domain record ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainRecordIds
  DomainRecords:
    Description: DNSレコードに関する情報。 # The information about DNS records.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainRecords

構文

プロパティ

戻り値 (Fn::GetAtt)

例

JSON 形式

YAML 形式

`JSON` 形式

`YAML` 形式