This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

pvtz

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.pvtz.AwaitableGetZoneRecordsResult(id=None, ids=None, keyword=None, output_file=None, records=None, zone_id=None)
class pulumi_alicloud.pvtz.AwaitableGetZonesResult(id=None, ids=None, keyword=None, names=None, output_file=None, zones=None)
class pulumi_alicloud.pvtz.GetZoneRecordsResult(id=None, ids=None, keyword=None, output_file=None, records=None, zone_id=None)

A collection of values returned by getZoneRecords.

id = None

The provider-assigned unique ID for this managed resource.

ids = None

A list of Private Zone Record IDs.

records = None

A list of zone records. Each element contains the following attributes:

class pulumi_alicloud.pvtz.GetZonesResult(id=None, ids=None, keyword=None, names=None, output_file=None, zones=None)

A collection of values returned by getZones.

id = None

The provider-assigned unique ID for this managed resource.

ids = None

A list of zone IDs.

names = None

A list of zone names.

zones = None

A list of zones. Each element contains the following attributes:

class pulumi_alicloud.pvtz.Zone(resource_name, opts=None, lang=None, name=None, proxy_pattern=None, remark=None, resource_group_id=None, user_client_ip=None, __props__=None, __name__=None, __opts__=None)

Create a Zone resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] lang: The language. Valid values: “zh”, “en”, “jp”. :param pulumi.Input[str] name: The name of the Private Zone. :param pulumi.Input[str] proxy_pattern: The recursive DNS proxy. Valid values:

- ZONE: indicates that the recursive DNS proxy is disabled.
- RECORD: indicates that the recursive DNS proxy is enabled.
Parameters
  • remark (pulumi.Input[str]) – The remark of the Private Zone.

  • resource_group_id (pulumi.Input[str]) – The Id of resource group which the Private Zone belongs.

  • user_client_ip (pulumi.Input[str]) – The IP address of the client.

lang: pulumi.Output[str] = None

The language. Valid values: “zh”, “en”, “jp”.

name: pulumi.Output[str] = None

The name of the Private Zone.

proxy_pattern: pulumi.Output[str] = None

The recursive DNS proxy. Valid values:

  • ZONE: indicates that the recursive DNS proxy is disabled.

  • RECORD: indicates that the recursive DNS proxy is enabled.

record_count: pulumi.Output[float] = None

The count of the Private Zone Record.

remark: pulumi.Output[str] = None

The remark of the Private Zone.

resource_group_id: pulumi.Output[str] = None

The Id of resource group which the Private Zone belongs.

user_client_ip: pulumi.Output[str] = None

The IP address of the client.

static get(resource_name, id, opts=None, creation_time=None, is_ptr=None, lang=None, name=None, proxy_pattern=None, record_count=None, remark=None, resource_group_id=None, update_time=None, user_client_ip=None)

Get an existing Zone resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • lang (pulumi.Input[str]) – The language. Valid values: “zh”, “en”, “jp”.

  • name (pulumi.Input[str]) – The name of the Private Zone.

  • proxy_pattern (pulumi.Input[str]) – The recursive DNS proxy. Valid values:

- ZONE: indicates that the recursive DNS proxy is disabled.
- RECORD: indicates that the recursive DNS proxy is enabled.
Parameters
  • record_count (pulumi.Input[float]) – The count of the Private Zone Record.

  • remark (pulumi.Input[str]) – The remark of the Private Zone.

  • resource_group_id (pulumi.Input[str]) – The Id of resource group which the Private Zone belongs.

  • user_client_ip (pulumi.Input[str]) – The IP address of the client.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.pvtz.ZoneAttachment(resource_name, opts=None, lang=None, user_client_ip=None, vpc_ids=None, vpcs=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Create a ZoneAttachment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] lang: The language of code. :param pulumi.Input[str] user_client_ip: The user custom IP address. :param pulumi.Input[list] vpc_ids: The id List of the VPC with the same region, for example:[“vpc-1”,”vpc-2”]. :param pulumi.Input[list] vpcs: The List of the VPC: :param pulumi.Input[str] zone_id: The name of the Private Zone Record.

The vpcs object supports the following:

  • regionId (pulumi.Input[str]) - The region of the vpc. If not set, the current region will instead of.

  • vpc_id (pulumi.Input[str]) - The Id of the vpc.

lang: pulumi.Output[str] = None

The language of code.

user_client_ip: pulumi.Output[str] = None

The user custom IP address.

vpc_ids: pulumi.Output[list] = None

The id List of the VPC with the same region, for example:[“vpc-1”,”vpc-2”].

vpcs: pulumi.Output[list] = None

The List of the VPC:

  • regionId (str) - The region of the vpc. If not set, the current region will instead of.

  • vpc_id (str) - The Id of the vpc.

zone_id: pulumi.Output[str] = None

The name of the Private Zone Record.

static get(resource_name, id, opts=None, lang=None, user_client_ip=None, vpc_ids=None, vpcs=None, zone_id=None)

Get an existing ZoneAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • lang (pulumi.Input[str]) – The language of code.

  • user_client_ip (pulumi.Input[str]) – The user custom IP address.

  • vpc_ids (pulumi.Input[list]) – The id List of the VPC with the same region, for example:[“vpc-1”,”vpc-2”].

  • vpcs (pulumi.Input[list]) – The List of the VPC:

  • zone_id (pulumi.Input[str]) – The name of the Private Zone Record.

The vpcs object supports the following:

  • regionId (pulumi.Input[str]) - The region of the vpc. If not set, the current region will instead of.

  • vpc_id (pulumi.Input[str]) - The Id of the vpc.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.pvtz.ZoneRecord(resource_name, opts=None, priority=None, resource_record=None, ttl=None, type=None, value=None, zone_id=None, __props__=None, __name__=None, __opts__=None)

Create a ZoneRecord resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[float] priority: The priority of the Private Zone Record. At present, only can “MX” record support it. Valid values: [1-50]. Default to 1. :param pulumi.Input[str] resource_record: The resource record of the Private Zone Record. :param pulumi.Input[float] ttl: The ttl of the Private Zone Record. :param pulumi.Input[str] type: The type of the Private Zone Record. Valid values: A, CNAME, TXT, MX, PTR. :param pulumi.Input[str] value: The value of the Private Zone Record. :param pulumi.Input[str] zone_id: The name of the Private Zone Record.

priority: pulumi.Output[float] = None

The priority of the Private Zone Record. At present, only can “MX” record support it. Valid values: [1-50]. Default to 1.

record_id: pulumi.Output[float] = None

The Private Zone Record ID.

resource_record: pulumi.Output[str] = None

The resource record of the Private Zone Record.

ttl: pulumi.Output[float] = None

The ttl of the Private Zone Record.

type: pulumi.Output[str] = None

The type of the Private Zone Record. Valid values: A, CNAME, TXT, MX, PTR.

value: pulumi.Output[str] = None

The value of the Private Zone Record.

zone_id: pulumi.Output[str] = None

The name of the Private Zone Record.

static get(resource_name, id, opts=None, priority=None, record_id=None, resource_record=None, ttl=None, type=None, value=None, zone_id=None)

Get an existing ZoneRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • priority (pulumi.Input[float]) – The priority of the Private Zone Record. At present, only can “MX” record support it. Valid values: [1-50]. Default to 1.

  • record_id (pulumi.Input[float]) – The Private Zone Record ID.

  • resource_record (pulumi.Input[str]) – The resource record of the Private Zone Record.

  • ttl (pulumi.Input[float]) – The ttl of the Private Zone Record.

  • type (pulumi.Input[str]) – The type of the Private Zone Record. Valid values: A, CNAME, TXT, MX, PTR.

  • value (pulumi.Input[str]) – The value of the Private Zone Record.

  • zone_id (pulumi.Input[str]) – The name of the Private Zone Record.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_alicloud.pvtz.get_zone_records(ids=None, keyword=None, output_file=None, zone_id=None, opts=None)

This data source provides Private Zone Records resource information owned by an Alibaba Cloud account.

import pulumi
import pulumi_alicloud as alicloud

records_ds = alicloud.pvtz.get_zone_records(keyword=alicloud_pvtz_zone_record["foo"]["value"],
    zone_id=alicloud_pvtz_zone["basic"]["id"])
pulumi.export("firstRecordId", records_ds.records[0]["id"])
Parameters
  • ids (list) – A list of Private Zone Record IDs.

  • keyword (str) – Keyword for record rr and value.

  • zone_id (str) – ID of the Private Zone.

pulumi_alicloud.pvtz.get_zones(ids=None, keyword=None, output_file=None, opts=None)

This data source lists a number of Private Zones resource information owned by an Alibaba Cloud account.

import pulumi
import pulumi_alicloud as alicloud

pvtz_zones_ds = alicloud.pvtz.get_zones(keyword=alicloud_pvtz_zone["basic"]["zone_name"])
pulumi.export("firstZoneId", pvtz_zones_ds.zones[0]["id"])
Parameters
  • ids (list) – A list of zone IDs.

  • keyword (str) – keyword for zone name.