1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. pvtz

Module pvtz

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.

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.

Resources

Functions

Others

Resources

Resource Zone

class Zone extends CustomResource

constructor

new Zone(name: string, args?: ZoneArgs, opts?: pulumi.CustomResourceOptions)

Create a Zone resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneState, opts?: pulumi.CustomResourceOptions): Zone

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Zone

Returns true if the given object is an instance of Zone. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property creationTime

public creationTime: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isPtr

public isPtr: pulumi.Output<boolean>;

property lang

public lang: pulumi.Output<string | undefined>;

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

property name

public name: pulumi.Output<string>;

The name of the Private Zone.

property proxyPattern

public proxyPattern: pulumi.Output<string | undefined>;

The recursive DNS proxy. Valid values: - ZONE: indicates that the recursive DNS proxy is disabled. - RECORD: indicates that the recursive DNS proxy is enabled.

property recordCount

public recordCount: pulumi.Output<number>;

The count of the Private Zone Record.

property remark

public remark: pulumi.Output<string | undefined>;

The remark of the Private Zone.

property resourceGroupId

public resourceGroupId: pulumi.Output<string | undefined>;

The Id of resource group which the Private Zone belongs.

property updateTime

public updateTime: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userClientIp

public userClientIp: pulumi.Output<string | undefined>;

The IP address of the client.

Resource ZoneAttachment

class ZoneAttachment extends CustomResource

constructor

new ZoneAttachment(name: string, args: ZoneAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a ZoneAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneAttachmentState, opts?: pulumi.CustomResourceOptions): ZoneAttachment

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ZoneAttachment

Returns true if the given object is an instance of ZoneAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lang

public lang: pulumi.Output<string | undefined>;

The language of code.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userClientIp

public userClientIp: pulumi.Output<string | undefined>;

The user custom IP address.

property vpcIds

public vpcIds: pulumi.Output<string[]>;

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

property vpcs

public vpcs: pulumi.Output<ZoneAttachmentVpc[]>;

The List of the VPC:

property zoneId

public zoneId: pulumi.Output<string>;

The name of the Private Zone Record.

Resource ZoneRecord

class ZoneRecord extends CustomResource

constructor

new ZoneRecord(name: string, args: ZoneRecordArgs, opts?: pulumi.CustomResourceOptions)

Create a ZoneRecord resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneRecordState, opts?: pulumi.CustomResourceOptions): ZoneRecord

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ZoneRecord

Returns true if the given object is an instance of ZoneRecord. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property priority

public priority: pulumi.Output<number | undefined>;

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

property recordId

public recordId: pulumi.Output<number>;

The Private Zone Record ID.

property resourceRecord

public resourceRecord: pulumi.Output<string>;

The resource record of the Private Zone Record.

property ttl

public ttl: pulumi.Output<number | undefined>;

The ttl of the Private Zone Record.

property type

public type: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the Private Zone Record.

property zoneId

public zoneId: pulumi.Output<string>;

The name of the Private Zone Record.

Functions

Function getZoneRecords

getZoneRecords(args: GetZoneRecordsArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneRecordsResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const recordsDs = pulumi.all([alicloud_pvtz_zone_record_foo.value, alicloud_pvtz_zone_basic.id]).apply(([value, id]) => alicloud.pvtz.getZoneRecords({
    keyword: value,
    zoneId: id,
}, { async: true }));

export const firstRecordId = recordsDs.records[0].id;

Function getZones

getZones(args?: GetZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetZonesResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const pvtzZonesDs = alicloud_pvtz_zone_basic.zoneName.apply(zoneName => alicloud.pvtz.getZones({
    keyword: zoneName,
}, { async: true }));

export const firstZoneId = pvtzZonesDs.zones[0].id;

Others

interface GetZoneRecordsArgs

interface GetZoneRecordsArgs

A collection of arguments for invoking getZoneRecords.

property ids

ids?: string[];

A list of Private Zone Record IDs.

property keyword

keyword?: undefined | string;

Keyword for record rr and value.

property outputFile

outputFile?: undefined | string;

property zoneId

zoneId: string;

ID of the Private Zone.

interface GetZoneRecordsResult

interface GetZoneRecordsResult

A collection of values returned by getZoneRecords.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of Private Zone Record IDs.

property keyword

keyword?: undefined | string;

property outputFile

outputFile?: undefined | string;

property records

records: GetZoneRecordsRecord[];

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

property zoneId

zoneId: string;

interface GetZonesArgs

interface GetZonesArgs

A collection of arguments for invoking getZones.

property ids

ids?: string[];

A list of zone IDs.

property keyword

keyword?: undefined | string;

keyword for zone name.

property outputFile

outputFile?: undefined | string;

interface GetZonesResult

interface GetZonesResult

A collection of values returned by getZones.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of zone IDs.

property keyword

keyword?: undefined | string;

property names

names: string[];

A list of zone names.

property outputFile

outputFile?: undefined | string;

property zones

zones: GetZonesZone[];

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

interface ZoneArgs

interface ZoneArgs

The set of arguments for constructing a Zone resource.

property lang

lang?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the Private Zone.

property proxyPattern

proxyPattern?: pulumi.Input<string>;

The recursive DNS proxy. Valid values: - ZONE: indicates that the recursive DNS proxy is disabled. - RECORD: indicates that the recursive DNS proxy is enabled.

property remark

remark?: pulumi.Input<string>;

The remark of the Private Zone.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the Private Zone belongs.

property userClientIp

userClientIp?: pulumi.Input<string>;

The IP address of the client.

interface ZoneAttachmentArgs

interface ZoneAttachmentArgs

The set of arguments for constructing a ZoneAttachment resource.

property lang

lang?: pulumi.Input<string>;

The language of code.

property userClientIp

userClientIp?: pulumi.Input<string>;

The user custom IP address.

property vpcIds

vpcIds?: pulumi.Input<pulumi.Input<string>[]>;

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

property vpcs

vpcs?: pulumi.Input<pulumi.Input<ZoneAttachmentVpc>[]>;

The List of the VPC:

property zoneId

zoneId: pulumi.Input<string>;

The name of the Private Zone Record.

interface ZoneAttachmentState

interface ZoneAttachmentState

Input properties used for looking up and filtering ZoneAttachment resources.

property lang

lang?: pulumi.Input<string>;

The language of code.

property userClientIp

userClientIp?: pulumi.Input<string>;

The user custom IP address.

property vpcIds

vpcIds?: pulumi.Input<pulumi.Input<string>[]>;

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

property vpcs

vpcs?: pulumi.Input<pulumi.Input<ZoneAttachmentVpc>[]>;

The List of the VPC:

property zoneId

zoneId?: pulumi.Input<string>;

The name of the Private Zone Record.

interface ZoneRecordArgs

interface ZoneRecordArgs

The set of arguments for constructing a ZoneRecord resource.

property priority

priority?: pulumi.Input<number>;

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

property resourceRecord

resourceRecord: pulumi.Input<string>;

The resource record of the Private Zone Record.

property ttl

ttl?: pulumi.Input<number>;

The ttl of the Private Zone Record.

property type

type: pulumi.Input<string>;

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

property value

value: pulumi.Input<string>;

The value of the Private Zone Record.

property zoneId

zoneId: pulumi.Input<string>;

The name of the Private Zone Record.

interface ZoneRecordState

interface ZoneRecordState

Input properties used for looking up and filtering ZoneRecord resources.

property priority

priority?: pulumi.Input<number>;

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

property recordId

recordId?: pulumi.Input<number>;

The Private Zone Record ID.

property resourceRecord

resourceRecord?: pulumi.Input<string>;

The resource record of the Private Zone Record.

property ttl

ttl?: pulumi.Input<number>;

The ttl of the Private Zone Record.

property type

type?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

The value of the Private Zone Record.

property zoneId

zoneId?: pulumi.Input<string>;

The name of the Private Zone Record.

interface ZoneState

interface ZoneState

Input properties used for looking up and filtering Zone resources.

property creationTime

creationTime?: pulumi.Input<string>;

property isPtr

isPtr?: pulumi.Input<boolean>;

property lang

lang?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the Private Zone.

property proxyPattern

proxyPattern?: pulumi.Input<string>;

The recursive DNS proxy. Valid values: - ZONE: indicates that the recursive DNS proxy is disabled. - RECORD: indicates that the recursive DNS proxy is enabled.

property recordCount

recordCount?: pulumi.Input<number>;

The count of the Private Zone Record.

property remark

remark?: pulumi.Input<string>;

The remark of the Private Zone.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the Private Zone belongs.

property updateTime

updateTime?: pulumi.Input<string>;

property userClientIp

userClientIp?: pulumi.Input<string>;

The IP address of the client.