All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::PVTZ::Zone

Last Updated:Dec 19, 2024

ALIYUN::PVTZ::Zone is used to create a built-in authoritative zone.

For more information, see What is Alibaba Cloud DNS PrivateZone?

Syntax

{
  "Type": "ALIYUN::PVTZ::Zone",
  "Properties": {
    "ProxyPattern": String,
    "Remark": String,
    "ZoneName": String,
    "ZoneTag": String,
    "ZoneType": String,
    "ResourceGroupId": String,
    "Tags": List,
    "IgnoredStackTagKeys": List,
    "DnsGroup": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ProxyPattern

String

No

Yes

Specifies whether to enable the recursive DNS proxy.

Valid values:

  • ZONE: disables the recursive DNS proxy for the zone.

  • RECORD: enables the recursive DNS proxy for the zone.

Remark

String

No

Yes

The description of the zone.

None.

ResourceGroupId

String

No

Yes

The ID of the resource group to which the zone belongs.

None.

ZoneName

String

Yes

No

The name of the zone.

None.

ZoneTag

String

No

No

The tag of the zone.

This property is ignored when ZoneType is set to AUTH_ZONE.

ZoneType

String

No

No

The type of the zone.

Valid values:

  • AUTH_ZONE (default): the zone type from the authoritative zone list.

  • CLOUD_PRODUCT_ZONE: the zone type from the zone list of the cloud services that you use.

Tags

List

No

Yes

The custom tags.

For more information, see Tags properties.

IgnoredStackTagKeys

List

No

No

The custom tags that are ignored in the stack generated when the zone is created.

None.

DnsGroup

String

No

No

The logical location of the built-in authoritative module in which the zone is added.

Valid values:

  • NORMAL_ZONE: regular module

  • FAST_ZONE: acceleration module

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags properties

Property

Type

Required

Editable

Description

Constraint

Key

String

Yes

No

The key of the tag.

The tag key must be 1 to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:.

Value

String

No

No

The value of the tag.

The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

Return values

Fn::GetAtt

  • ZoneName: the name of the zone.

  • ZoneId: the ID of the zone.

  • ZoneType: the type of the zone.

  • ZoneTag: the tag of the zone.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Zone:
    Type: ALIYUN::PVTZ::Zone
    Properties:
      ZoneName: example.com
      ProxyPattern: ZONE
      ZoneType: AUTH_ZONE
Outputs: {}

For more information, visit pvtz.yml. In the examples, the ALIYUN::PVTZ::Zone, ALIYUN::PVTZ::ZoneRecord, and ALIYUN::PVTZ::ZoneVpcBinder resource types are used.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Zone": {
      "Type": "ALIYUN::PVTZ::Zone",
      "Properties": {
        "ZoneName": "example.com",
        "ProxyPattern": "ZONE",
        "ZoneType": "AUTH_ZONE"
      }
    }
  },
  "Outputs": {
  }
}