@pulumi/hcloud/zone.d.ts

A Pulumi package for creating and managing hcloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Provides a Hetzner Cloud Zone resource.
 *
 * This can be used to create, modify, and delete Zones.
 *
 * For Internationalized domain names (IDN), see the `provider::hcloud::idna` function.
 *
 * See the [Zones API documentation](https://docs.hetzner.cloud/reference/cloud#zones) for more details.
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * ```sh
 * $ pulumi import hcloud:index/zone:Zone example "$ZONE_ID_OR_NAME"
 * ```
 */
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;
    /**
     * Authoritative nameservers of the Zone.
     */
    readonly authoritativeNameservers: pulumi.Output<outputs.ZoneAuthoritativeNameservers>;
    /**
     * Whether delete protection is enabled.
     */
    readonly deleteProtection: pulumi.Output<boolean>;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Mode of the Zone.
     */
    readonly mode: pulumi.Output<string>;
    /**
     * Name of the Zone.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Primary nameservers of the Zone. Forbidden when mode is primary and required when mode is secondary.
     */
    readonly primaryNameservers: pulumi.Output<outputs.ZonePrimaryNameserver[]>;
    /**
     * Registrar of the Zone.
     */
    readonly registrar: pulumi.Output<string>;
    /**
     * Default Time To Live (TTL) of the Zone.
     */
    readonly ttl: pulumi.Output<number>;
    /**
     * 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 {
    /**
     * Authoritative nameservers of the Zone.
     */
    authoritativeNameservers?: pulumi.Input<inputs.ZoneAuthoritativeNameservers | undefined>;
    /**
     * Whether delete protection is enabled.
     */
    deleteProtection?: pulumi.Input<boolean | undefined>;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Mode of the Zone.
     */
    mode?: pulumi.Input<string | undefined>;
    /**
     * Name of the Zone.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Primary nameservers of the Zone. Forbidden when mode is primary and required when mode is secondary.
     */
    primaryNameservers?: pulumi.Input<pulumi.Input<inputs.ZonePrimaryNameserver>[] | undefined>;
    /**
     * Registrar of the Zone.
     */
    registrar?: pulumi.Input<string | undefined>;
    /**
     * Default Time To Live (TTL) of the Zone.
     */
    ttl?: pulumi.Input<number | undefined>;
}
/**
 * The set of arguments for constructing a Zone resource.
 */
export interface ZoneArgs {
    /**
     * Whether delete protection is enabled.
     */
    deleteProtection?: pulumi.Input<boolean | undefined>;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Mode of the Zone.
     */
    mode: pulumi.Input<string>;
    /**
     * Name of the Zone.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Primary nameservers of the Zone. Forbidden when mode is primary and required when mode is secondary.
     */
    primaryNameservers?: pulumi.Input<pulumi.Input<inputs.ZonePrimaryNameserver>[] | undefined>;
    /**
     * Default Time To Live (TTL) of the Zone.
     */
    ttl?: pulumi.Input<number | undefined>;
}
//# sourceMappingURL=zone.d.ts.map