ALIYUN::PVTZ::Zone is used to create a private zone.

For more information about private zones, see What is PrivateZone?

Syntax

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

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 private zone.
  • RECORD: enables the recursive DNS proxy for the private zone.
Remark String No Yes The description of the private zone. None
ResourceGroupId String No Yes The ID of the resource group to which the private zone belongs. None
ZoneName String Yes No The name of the private zone. None
ZoneTag String No No The tag of the private zone. This property is ignored if the ZoneType property is set to AUTH_ZONE.
ZoneType String No No The type of the private zone. Valid values:
  • AUTH_ZONE: the zone type from the authoritative zone list. This is the default value.
  • 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 private zone is created. None

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:.

Response parameters

Fn::GetAtt

  • ZoneName: the name of the private zone.
  • ZoneId: the ID of the private zone.
  • ZoneType: the type of the private zone.
  • ZoneTag: the tag of the private zone.

Examples

  • YAMLformat

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

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

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