DATASOURCE::PVTZ::Zone - Resource Orchestration Service

DATASOURCE::PVTZ::Zone is used to query the information about a built-in authoritative zone.

Syntax

{
  "Type": "DATASOURCE::PVTZ::Zone",
  "Properties": {
    "ZoneId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ZoneId

String

Yes

The ID of the zone.

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

SlaveDns: indicates whether the secondary Domain Name System (DNS) feature is enabled.
ZoneId: the ID of the zone.
ResourceGroupId: the ID of the resource group.
ProxyPattern: indicates whether the recursive resolution proxy for subdomain names is enabled.
CreateTime: the creation time.
Remark: the remarks on the zone.
ZoneType: the type of the zone.
ZoneName: the name of the zone.
ZoneTag: the type of the cloud product.
UpdateTime: the update time.
UpdateTimestamp: the update timestamp.
CreateTimestamp: the creation timestamp.
RecordCount: the number of DNS records.
BindVpcs: the associated virtual private clouds (VPCs).
Tags: the added custom tags.
IsPtr: indicates whether the zone is a reverse lookup zone.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      en: The zone ID.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PVTZ::Zone
    Properties:
      ZoneId:
        Ref: ZoneId
Outputs:
  SlaveDns:
    Description: Indicates whether the secondary Domain Name System (DNS) feature is enabled for the zone.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SlaveDns
  ZoneId:
    Description: 'The zone ID. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  ResourceGroupId:
    Description: The ID of the resource group to which the zone belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  ProxyPattern:
    Description: 'Indicates whether the recursive resolution proxy for subdomain names is enabled. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ProxyPattern
  CreateTime:
    Description: The time when the zone was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  Remark:
    Description: The description of the zone.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Remark
  ZoneType:
    Description: The zone type, temporarily closed to users, no need to pass values.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneType
  ZoneName:
    Description: The zone name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneName
  ZoneTag:
    Description: Not open to users for the time being, no value transfer is required.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneTag
  UpdateTime:
    Description: The time when the zone was last updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTime
  UpdateTimestamp:
    Description: The time when the zone was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTimestamp
  CreateTimestamp:
    Description: The time when the zone was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTimestamp
  RecordCount:
    Description: The total number of DNS records added in the zone.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RecordCount
  BindVpcs:
    Description: The VPCs associated with the zone.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BindVpcs
  Tags:
    Description: The tags of the zone.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  IsPtr:
    Description: Indicates whether the zone is a reverse lookup zone.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IsPtr

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "The zone ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PVTZ::Zone",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        }
      }
    }
  },
  "Outputs": {
    "SlaveDns": {
      "Description": "Indicates whether the secondary Domain Name System (DNS) feature is enabled for the zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SlaveDns"
        ]
      }
    },
    "ZoneId": {
      "Description": "The zone ID. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group to which the zone belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "ProxyPattern": {
      "Description": "Indicates whether the recursive resolution proxy for subdomain names is enabled. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ProxyPattern"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the zone was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Remark": {
      "Description": "The description of the zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Remark"
        ]
      }
    },
    "ZoneType": {
      "Description": "The zone type, temporarily closed to users, no need to pass values.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneType"
        ]
      }
    },
    "ZoneName": {
      "Description": "The zone name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneName"
        ]
      }
    },
    "ZoneTag": {
      "Description": "Not open to users for the time being, no value transfer is required.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneTag"
        ]
      }
    },
    "UpdateTime": {
      "Description": "The time when the zone was last updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTime"
        ]
      }
    },
    "UpdateTimestamp": {
      "Description": "The time when the zone was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTimestamp"
        ]
      }
    },
    "CreateTimestamp": {
      "Description": "The time when the zone was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTimestamp"
        ]
      }
    },
    "RecordCount": {
      "Description": "The total number of DNS records added in the zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RecordCount"
        ]
      }
    },
    "BindVpcs": {
      "Description": "The VPCs associated with the zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BindVpcs"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "IsPtr": {
      "Description": "Indicates whether the zone is a reverse lookup zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsPtr"
        ]
      }
    }
  }
}