@pulumi/hcloud/zoneRrset.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 Record Set (RRSet) resource.
 *
 * This can be used to create, modify, and delete Zone RRSets.
 *
 * See the [Zone RRSets API documentation](https://docs.hetzner.cloud/reference/cloud#zone-rrsets) for more details.
 *
 * **RRSets of type TXT:**
 *
 * The format of TXT records must consist of one or many quoted strings of 255 characters.
 *
 * A helper function to format TXT record is available at `provider::hcloud::txt_record`.
 * See the examples for more details.
 *
 * **RRSets of type SOA:**
 *
 * SOA records are created or deleted by the Hetzner Cloud API when creating or deleting
 * the parent Zone, therefor this Terraform resource will:
 *
 * - import the RRSet in the state, instead of creating it.
 * - remove the RRSet from the state, instead of deleting it.
 * - set the SOA record SERIAL value to 0 before saving it to the state, as this value is automatically
 *   incremented by the API and would cause issues otherwise.
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * ```sh
 * $ pulumi import hcloud:index/zoneRrset:ZoneRrset example "$ZONE_ID_OR_NAME/$RRSET_NAME/$RRSET_TYPE"
 * $ pulumi import hcloud:index/zoneRrset:ZoneRrset example "$ZONE_ID_OR_NAME/$RRSET_ID"
 * ```
 */
export declare class ZoneRrset extends pulumi.CustomResource {
    /**
     * Get an existing ZoneRrset 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?: ZoneRrsetState, opts?: pulumi.CustomResourceOptions): ZoneRrset;
    /**
     * Returns true if the given object is an instance of ZoneRrset.  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 ZoneRrset;
    /**
     * Whether change protection is enabled.
     */
    readonly changeProtection: 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;
    }>;
    /**
     * Name of the Zone RRSet.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Records of the Zone RRSet.
     */
    readonly records: pulumi.Output<outputs.ZoneRrsetRecord[]>;
    /**
     * Time To Live (TTL) of the Zone RRSet.
     */
    readonly ttl: pulumi.Output<number | undefined>;
    /**
     * Type of the Zone RRSet.
     */
    readonly type: pulumi.Output<string>;
    /**
     * ID or Name of the parent Zone.
     */
    readonly zone: pulumi.Output<string>;
    /**
     * Create a ZoneRrset 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: ZoneRrsetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ZoneRrset resources.
 */
export interface ZoneRrsetState {
    /**
     * Whether change protection is enabled.
     */
    changeProtection?: 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>;
    /**
     * Name of the Zone RRSet.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Records of the Zone RRSet.
     */
    records?: pulumi.Input<pulumi.Input<inputs.ZoneRrsetRecord>[] | undefined>;
    /**
     * Time To Live (TTL) of the Zone RRSet.
     */
    ttl?: pulumi.Input<number | undefined>;
    /**
     * Type of the Zone RRSet.
     */
    type?: pulumi.Input<string | undefined>;
    /**
     * ID or Name of the parent Zone.
     */
    zone?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a ZoneRrset resource.
 */
export interface ZoneRrsetArgs {
    /**
     * Whether change protection is enabled.
     */
    changeProtection?: 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>;
    /**
     * Name of the Zone RRSet.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Records of the Zone RRSet.
     */
    records: pulumi.Input<pulumi.Input<inputs.ZoneRrsetRecord>[]>;
    /**
     * Time To Live (TTL) of the Zone RRSet.
     */
    ttl?: pulumi.Input<number | undefined>;
    /**
     * Type of the Zone RRSet.
     */
    type: pulumi.Input<string>;
    /**
     * ID or Name of the parent Zone.
     */
    zone: pulumi.Input<string>;
}
//# sourceMappingURL=zoneRrset.d.ts.map