@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
298 lines (297 loc) • 10.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "../types";
/**
* Manages a DNS zone resource within HuaweiCloud.
*
* ## Example Usage
* ### Create a public DNS zone
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const zoneName = config.requireObject("zoneName");
* const email = config.requireObject("email");
* const description = config.requireObject("description");
* const test = new huaweicloud.dns.Zone("test", {
* email: email,
* zoneType: "public",
* ttl: 3000,
* description: description,
* });
* ```
* ### Create a private DNS zone
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const zoneName = config.requireObject("zoneName");
* const email = config.requireObject("email");
* const description = config.requireObject("description");
* const routerId = config.requireObject("routerId");
* const test = new huaweicloud.dns.Zone("test", {
* email: email,
* zoneType: "private",
* ttl: 3000,
* description: description,
* routers: [{
* routerId: routerId,
* }],
* });
* ```
*
* ## Import
*
* This resource can be imported using the `id`, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Dns/zone:Zone test <id>
* ```
*/
export declare class Zone extends pulumi.CustomResource {
/**
* Get an existing Zone resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneState, opts?: pulumi.CustomResourceOptions): 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.
*/
static isInstance(obj: any): obj is Zone;
/**
* Specifies the description of the zone.
* A maximum of `255` characters are allowed.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies the email address of the administrator managing the zone.
*/
readonly email: pulumi.Output<string>;
/**
* Specifies the enterprise project ID of the zone.
* Changing this parameter will create a new resource.
* This parameter is only valid for enterprise users, if omitted, default enterprise project will be used.
*/
readonly enterpriseProjectId: pulumi.Output<string>;
/**
* The list of the masters of the DNS server.
*/
readonly masters: pulumi.Output<string[]>;
/**
* Specifies the name of the zone. Note the `.` at the end of the name.
* Changing this parameter will create a new resource.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the recursive resolution proxy mode for subdomains of
* the private zone.
* Defaults to **AUTHORITY**.
* Changing this parameter will create a new resource.
* The valid values are as follows:
* + **AUTHORITY**: The recursive resolution proxy is disabled for the private zone.
* + **RECURSIVE**: The recursive resolution proxy is enabled for the private zone.
*/
readonly proxyPattern: pulumi.Output<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the list of the router of the zone.
* Router configuration block which is required if zoneType is private.
* The router structure is documented below.
*/
readonly routers: pulumi.Output<outputs.Dns.ZoneRouter[] | undefined>;
/**
* Specifies the status of the zone, defaults to **ENABLE**.
* The valid values are as follows:
* + **ENABLE**
* + **DISABLE**
*/
readonly status: pulumi.Output<string>;
/**
* Specifies the key/value pairs to associate with the zone.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Specifies the time to live (TTL) of the zone, defaults to `300`.
* The valid value is range from `1` to `2,147,483,647`.
*/
readonly ttl: pulumi.Output<number | undefined>;
/**
* Specifies the type of zone, defaults to **public**.
* Changing this parameter will create a new resource.
* The valid values are as follows:
* + **public**
* + **private**
*/
readonly zoneType: pulumi.Output<string | undefined>;
/**
* Create a Zone resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ZoneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Zone resources.
*/
export interface ZoneState {
/**
* Specifies the description of the zone.
* A maximum of `255` characters are allowed.
*/
description?: pulumi.Input<string>;
/**
* Specifies the email address of the administrator managing the zone.
*/
email?: pulumi.Input<string>;
/**
* Specifies the enterprise project ID of the zone.
* Changing this parameter will create a new resource.
* This parameter is only valid for enterprise users, if omitted, default enterprise project will be used.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* The list of the masters of the DNS server.
*/
masters?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Specifies the name of the zone. Note the `.` at the end of the name.
* Changing this parameter will create a new resource.
*/
name?: pulumi.Input<string>;
/**
* Specifies the recursive resolution proxy mode for subdomains of
* the private zone.
* Defaults to **AUTHORITY**.
* Changing this parameter will create a new resource.
* The valid values are as follows:
* + **AUTHORITY**: The recursive resolution proxy is disabled for the private zone.
* + **RECURSIVE**: The recursive resolution proxy is enabled for the private zone.
*/
proxyPattern?: pulumi.Input<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the list of the router of the zone.
* Router configuration block which is required if zoneType is private.
* The router structure is documented below.
*/
routers?: pulumi.Input<pulumi.Input<inputs.Dns.ZoneRouter>[]>;
/**
* Specifies the status of the zone, defaults to **ENABLE**.
* The valid values are as follows:
* + **ENABLE**
* + **DISABLE**
*/
status?: pulumi.Input<string>;
/**
* Specifies the key/value pairs to associate with the zone.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Specifies the time to live (TTL) of the zone, defaults to `300`.
* The valid value is range from `1` to `2,147,483,647`.
*/
ttl?: pulumi.Input<number>;
/**
* Specifies the type of zone, defaults to **public**.
* Changing this parameter will create a new resource.
* The valid values are as follows:
* + **public**
* + **private**
*/
zoneType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Zone resource.
*/
export interface ZoneArgs {
/**
* Specifies the description of the zone.
* A maximum of `255` characters are allowed.
*/
description?: pulumi.Input<string>;
/**
* Specifies the email address of the administrator managing the zone.
*/
email?: pulumi.Input<string>;
/**
* Specifies the enterprise project ID of the zone.
* Changing this parameter will create a new resource.
* This parameter is only valid for enterprise users, if omitted, default enterprise project will be used.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* Specifies the name of the zone. Note the `.` at the end of the name.
* Changing this parameter will create a new resource.
*/
name?: pulumi.Input<string>;
/**
* Specifies the recursive resolution proxy mode for subdomains of
* the private zone.
* Defaults to **AUTHORITY**.
* Changing this parameter will create a new resource.
* The valid values are as follows:
* + **AUTHORITY**: The recursive resolution proxy is disabled for the private zone.
* + **RECURSIVE**: The recursive resolution proxy is enabled for the private zone.
*/
proxyPattern?: pulumi.Input<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the list of the router of the zone.
* Router configuration block which is required if zoneType is private.
* The router structure is documented below.
*/
routers?: pulumi.Input<pulumi.Input<inputs.Dns.ZoneRouter>[]>;
/**
* Specifies the status of the zone, defaults to **ENABLE**.
* The valid values are as follows:
* + **ENABLE**
* + **DISABLE**
*/
status?: pulumi.Input<string>;
/**
* Specifies the key/value pairs to associate with the zone.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Specifies the time to live (TTL) of the zone, defaults to `300`.
* The valid value is range from `1` to `2,147,483,647`.
*/
ttl?: pulumi.Input<number>;
/**
* Specifies the type of zone, defaults to **public**.
* Changing this parameter will create a new resource.
* The valid values are as follows:
* + **public**
* + **private**
*/
zoneType?: pulumi.Input<string>;
}