@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
97 lines (96 loc) • 2.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get information about a DNS Zone.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const foo = yandex.getDnsZone({
* dnsZoneId: yandex_dns_zone.zone1.id,
* });
* export const zone = foo.then(foo => foo.zone);
* ```
*/
export declare function getDnsZone(args?: GetDnsZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetDnsZoneResult>;
/**
* A collection of arguments for invoking getDnsZone.
*/
export interface GetDnsZoneArgs {
/**
* The ID of the DNS Zone.
*/
dnsZoneId?: string;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: string;
/**
* - Name of the DNS Zone.
*/
name?: string;
}
/**
* A collection of values returned by getDnsZone.
*/
export interface GetDnsZoneResult {
/**
* (Computed) The DNS zone creation timestamp.
*/
readonly createdAt: string;
/**
* (Computed) Description of the DNS zone.
*/
readonly description: string;
readonly dnsZoneId: string;
/**
* (Computed) The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
*/
readonly folderId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* (Computed) A set of key/value label pairs to assign to the DNS zone.
*/
readonly labels: {
[key: string]: string;
};
/**
* (Computed) User assigned name of a specific resource. Must be unique within the folder.
*/
readonly name: string;
/**
* (Computed) For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
*/
readonly privateNetworks: string[];
/**
* (Computed) The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
*/
readonly public: boolean;
/**
* (Computed) The DNS name of this zone, e.g. "example.com.". Must ends with dot.
*/
readonly zone: string;
}
export declare function getDnsZoneOutput(args?: GetDnsZoneOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDnsZoneResult>;
/**
* A collection of arguments for invoking getDnsZone.
*/
export interface GetDnsZoneOutputArgs {
/**
* The ID of the DNS Zone.
*/
dnsZoneId?: pulumi.Input<string>;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* - Name of the DNS Zone.
*/
name?: pulumi.Input<string>;
}