DATASOURCE::DirectMail::Domain - Resource Orchestration Service

DATASOURCE::DirectMail::Domain is used to query the information about a domain name.

Syntax

{
  "Type": "DATASOURCE::DirectMail::Domain",
  "Properties": {
    "DomainId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DomainId

String

Yes

The ID of the domain name.

None.

RefreshOptions

String

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

SpfRecord: the Sender Policy Framework (SPF) record.
SpfAuthStatus: the state that indicates whether the SPF record is successfully verified.
CnameAuthStatus: the state that indicates whether the canonical name (CNAME) record is successfully verified.
DomainName: the domain name.
DnsMx: the value of the mail exchanger (MX) record.
CnameRecord: the custom part in the hostname of the CNAME record.
CreateTime: the creation time.
DnsTxt: the value of the TXT record.
CnameConfirmStatus: the state that indicates whether the hostname of the CNAME record is changed.
IcpStatus: the state of Internet content provider (ICP) filing.
MxRecord: the MX record.
DnsSpf: the value of the SPF record.
DefaultDomain: the default domain name.
DomainType: the type of the domain name.
DomainId: the ID of the domain name.
MxAuthStatus: the state that indicates whether the MX record is successfully verified.
TlDomainName: the primary domain name.
TracefRecord: the CNAME record provided by the Direct Mail console.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainId:
    Type: String
    Description:
      en: The ID of the domain name.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DirectMail::Domain
    Properties:
      DomainId:
        Ref: DomainId
Outputs:
  SpfRecord:
    Description: Spf records provided by the Direct Mail console.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SpfRecord
  SpfAuthStatus:
    Description: Indicates whether the SPF record is successfully verified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SpfAuthStatus
  CnameAuthStatus:
    Description: Whether the host record of CNAME has been changed.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CnameAuthStatus
  DomainName:
    Description: The domain name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainName
  DnsMx:
    Description: MX record value resolved through public DNS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DnsMx
  CnameRecord:
    Description: Customized part of CNAME host record.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CnameRecord
  CreateTime:
    Description: The creation time of the resource.The time when the DNS record was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  DnsTxt:
    Description: TXT record value resolved through public DNS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DnsTxt
  CnameConfirmStatus:
    Description: Whether the host record of CNAME has been changed.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CnameConfirmStatus
  IcpStatus:
    Description: The status of ICP filing.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IcpStatus
  MxRecord:
    Description: MX records provided by the Direct Mail console.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MxRecord
  DnsSpf:
    Description: SPF record value resolved through public DNS.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DnsSpf
  DefaultDomain:
    Description: Is it the default domain name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DefaultDomain
  DomainType:
    Description: TXT records provided by the Direct Mail console.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainType
  DomainId:
    Description: The ID of the domain name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainId
  MxAuthStatus:
    Description: Indicates whether the MX record is successfully verified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MxAuthStatus
  TlDomainName:
    Description: The primary domain name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TlDomainName
  TracefRecord:
    Description: The CNAME verification record provided by the Direct Mail console.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TracefRecord

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the domain name."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DirectMail::Domain",
      "Properties": {
        "DomainId": {
          "Ref": "DomainId"
        }
      }
    }
  },
  "Outputs": {
    "SpfRecord": {
      "Description": "Spf records provided by the Direct Mail console.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SpfRecord"
        ]
      }
    },
    "SpfAuthStatus": {
      "Description": "Indicates whether the SPF record is successfully verified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SpfAuthStatus"
        ]
      }
    },
    "CnameAuthStatus": {
      "Description": "Whether the host record of CNAME has been changed.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CnameAuthStatus"
        ]
      }
    },
    "DomainName": {
      "Description": "The domain name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainName"
        ]
      }
    },
    "DnsMx": {
      "Description": "MX record value resolved through public DNS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DnsMx"
        ]
      }
    },
    "CnameRecord": {
      "Description": "Customized part of CNAME host record.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CnameRecord"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.The time when the DNS record was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "DnsTxt": {
      "Description": "TXT record value resolved through public DNS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DnsTxt"
        ]
      }
    },
    "CnameConfirmStatus": {
      "Description": "Whether the host record of CNAME has been changed.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CnameConfirmStatus"
        ]
      }
    },
    "IcpStatus": {
      "Description": "The status of ICP filing.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IcpStatus"
        ]
      }
    },
    "MxRecord": {
      "Description": "MX records provided by the Direct Mail console.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MxRecord"
        ]
      }
    },
    "DnsSpf": {
      "Description": "SPF record value resolved through public DNS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DnsSpf"
        ]
      }
    },
    "DefaultDomain": {
      "Description": "Is it the default domain name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DefaultDomain"
        ]
      }
    },
    "DomainType": {
      "Description": "TXT records provided by the Direct Mail console.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainType"
        ]
      }
    },
    "DomainId": {
      "Description": "The ID of the domain name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainId"
        ]
      }
    },
    "MxAuthStatus": {
      "Description": "Indicates whether the MX record is successfully verified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MxAuthStatus"
        ]
      }
    },
    "TlDomainName": {
      "Description": "The primary domain name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TlDomainName"
        ]
      }
    },
    "TracefRecord": {
      "Description": "The CNAME verification record provided by the Direct Mail console.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TracefRecord"
        ]
      }
    }
  }
}