How to use DATASOURCE::DirectMail::Domains to query domain name information - Resource Orchestration Service

DATASOURCE::DirectMail::Domains is used to query the information about domain names.

Syntax

{
  "Type": "DATASOURCE::DirectMail::Domains",
  "Properties": {
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

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

Domains: details of the domain names.
DomainIds: the IDs of the domain names.

Property	Type	Description	Constraint
DomainIds	List	The IDs of the domain names.	None.
Domains	List	Details of the domain names.	None.
Status	String	The status of the domain name.	Valid values: 0: The domain name passes the verification and is available. 1: The domain name failed to pass the verification and is unavailable. 2: The domain name is available, but does not have a canonical name (CNAME) record configured or Internet content provider (ICP) filing completed. 3: The domain name is available, but does not have ICP filing completed. 4: The domain name is available, but does not have a CNAME record configured.
CnameAuthStatus	String	The status of the verification that is performed by using the CNAME record.	None.
DomainId	String	The ID of the domain name.	None.
DomainName	String	The domain name.	None.
MxAuthStatus	String	The status of the verification that is performed by using the mail exchanger (MX) record.	Valid values: 0: The verification is successful. 1: The verification failed.
SpfAuthStatus	String	The status of the verification that is performed by using the Sender Policy Framework (SPF) record.	Valid values: 0: The verification is successful. 1: The verification failed.
IcpStatus	String	The status of ICP filing.	Valid values: 1: ICP filing is completed. 0: ICP filing is not completed.
CreateTime	String	The time when the domain name was created.	None.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ExtensionDataSource:
    Properties: {}
    Type: DATASOURCE::DirectMail::Domains
Outputs:
  DomainIds:
    Description: The list of domain IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DomainIds
  Domains:
    Description: The list of domains.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Domains

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DirectMail::Domains",
      "Properties": {}
    }
  },
  "Outputs": {
    "Domains": {
      "Description": "The list of domains.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Domains"
        ]
      }
    },
    "DomainIds": {
      "Description": "The list of domain IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainIds"
        ]
      }
    }
  }
}