How to use DATASOURCE::PVTZ::Zones to query built-in authoritative zones - Resource Orchestration Service

DATASOURCE::PVTZ::Zones is used to query built-in authoritative zones.

Syntax

{
  "Type": "DATASOURCE::PVTZ::Zones",
  "Properties": {
    "ResourceGroupId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ResourceGroupId

String

Yes

The ID of the resource group.

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

ZoneIds: the IDs of the zones.
Zones: details of the zones.

Property	Type	Description	Constraint
ZoneIds	List	The IDs of the zones.	None.
Zones	List	Details of the zones.	None.
CreateTimestamp	Integer	The creation timestamp.	None.
UpdateTime	String	The update time.	None.
ZoneTag	String	The type of the cloud service.	Valid values: An empty string is returned if ZoneType is set to AUTH_ZONE. A cloud service type is returned if ZoneType is set to CLOUD_PRODUCT_ZONE.
RecordCount	Integer	The number of Domain Name System (DNS) records.	None.
Tags	List	The tags of the zone.	Example: `[{"Value": "daily","Key": "env"}]`
Remark	String	The description of the zone.	None.
ZoneId	String	The zone ID.	None.
ZoneType	String	The zone type.	Valid values: AUTH_ZONE: authoritative zone CLOUD_PRODUCT_ZONE: authoritative zone for cloud services
ResourceGroupId	String	The ID of the resource group.	None.
ProxyPattern	String	The proxy mode.	Valid values: ZONE: The recursive resolution proxy feature is disabled for the private zone. RECORD: The recursive resolution proxy is enabled for the private zone.
IsPtr	Boolean	Indicates whether the zone is a reverse lookup zone.	Valid values: true false
UpdateTimestamp	Integer	The update timestamp.	None.
CreateTime	String	The creation time.	None.
ZoneName	String	The zone name.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Description: ResourceGroupId
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      ResourceGroupId:
        Ref: ResourceGroupId
    Type: DATASOURCE::PVTZ::Zones
Outputs:
  ZoneIds:
    Description: The list of zone IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneIds
  Zones:
    Description: The list of zones.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Zones

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "Description": "ResourceGroupId"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PVTZ::Zones",
      "Properties": {
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        }
      }
    }
  },
  "Outputs": {
    "ZoneIds": {
      "Description": "The list of zone IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneIds"
        ]
      }
    },
    "Zones": {
      "Description": "The list of zones.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Zones"
        ]
      }
    }
  }
}