@pulumi/dnsimple/zoneRecord.d.ts

A Pulumi package for creating and managing dnsimple cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a DNSimple zone record resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as dnsimple from "@pulumi/dnsimple";
 *
 * // Add a record to the root domain
 * const foobar = new dnsimple.ZoneRecord("foobar", {
 *     zoneName: dnsimpleDomain,
 *     name: "",
 *     value: "192.168.0.11",
 *     type: "A",
 *     ttl: 3600,
 * });
 * ```
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as dnsimple from "@pulumi/dnsimple";
 *
 * // Add a record to a sub-domain
 * const foobar = new dnsimple.ZoneRecord("foobar", {
 *     zoneName: dnsimpleDomain,
 *     name: "terraform",
 *     value: "192.168.0.11",
 *     type: "A",
 *     ttl: 3600,
 * });
 * ```
 *
 * ## Import
 *
 * DNSimple resources can be imported using their parent zone name (domain name) and numeric record ID.
 *
 * **Importing record example.com with record ID 1234**
 *
 * bash
 *
 * ```sh
 * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord resource_name example.com_1234
 * ```
 *
 * **Importing record www.example.com with record ID 1234**
 *
 * bash
 *
 * ```sh
 * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord resource_name example.com_1234
 * ```
 *
 * The record ID can be found in the URL when editing a record on the DNSimple web dashboard.
 */
export declare class ZoneRecord extends pulumi.CustomResource {
    /**
     * Get an existing ZoneRecord 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?: ZoneRecordState, opts?: pulumi.CustomResourceOptions): 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.
     */
    static isInstance(obj: any): obj is ZoneRecord;
    /**
     * The name of the record
     */
    readonly name: pulumi.Output<string>;
    readonly nameNormalized: pulumi.Output<string>;
    /**
     * The priority of the record - only useful for some record types
     */
    readonly priority: pulumi.Output<number>;
    /**
     * The FQDN of the record
     */
    readonly qualifiedName: pulumi.Output<string>;
    /**
     * A list of regions to serve the record from. You can find a list of supported values in our [developer documentation](https://developer.dnsimple.com/v2/zones/records/).
     */
    readonly regions: pulumi.Output<string[] | undefined>;
    /**
     * The TTL of the record - defaults to 3600
     */
    readonly ttl: pulumi.Output<number>;
    /**
     * The type of the record
     */
    readonly type: pulumi.Output<string>;
    /**
     * The value of the record
     */
    readonly value: pulumi.Output<string>;
    /**
     * The normalized value of the record
     */
    readonly valueNormalized: pulumi.Output<string>;
    /**
     * The zone ID of the record
     */
    readonly zoneId: pulumi.Output<string>;
    /**
     * The zone name to add the record to
     */
    readonly zoneName: pulumi.Output<string>;
    /**
     * Create a ZoneRecord 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: ZoneRecordArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ZoneRecord resources.
 */
export interface ZoneRecordState {
    /**
     * The name of the record
     */
    name?: pulumi.Input<string>;
    nameNormalized?: pulumi.Input<string>;
    /**
     * The priority of the record - only useful for some record types
     */
    priority?: pulumi.Input<number>;
    /**
     * The FQDN of the record
     */
    qualifiedName?: pulumi.Input<string>;
    /**
     * A list of regions to serve the record from. You can find a list of supported values in our [developer documentation](https://developer.dnsimple.com/v2/zones/records/).
     */
    regions?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The TTL of the record - defaults to 3600
     */
    ttl?: pulumi.Input<number>;
    /**
     * The type of the record
     */
    type?: pulumi.Input<string>;
    /**
     * The value of the record
     */
    value?: pulumi.Input<string>;
    /**
     * The normalized value of the record
     */
    valueNormalized?: pulumi.Input<string>;
    /**
     * The zone ID of the record
     */
    zoneId?: pulumi.Input<string>;
    /**
     * The zone name to add the record to
     */
    zoneName?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ZoneRecord resource.
 */
export interface ZoneRecordArgs {
    /**
     * The name of the record
     */
    name: pulumi.Input<string>;
    /**
     * The priority of the record - only useful for some record types
     */
    priority?: pulumi.Input<number>;
    /**
     * A list of regions to serve the record from. You can find a list of supported values in our [developer documentation](https://developer.dnsimple.com/v2/zones/records/).
     */
    regions?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The TTL of the record - defaults to 3600
     */
    ttl?: pulumi.Input<number>;
    /**
     * The type of the record
     */
    type: pulumi.Input<string>;
    /**
     * The value of the record
     */
    value: pulumi.Input<string>;
    /**
     * The zone name to add the record to
     */
    zoneName: pulumi.Input<string>;
}