@pulumi/dnsimple/domain.d.ts

A Pulumi package for creating and managing dnsimple cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a DNSimple domain resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as dnsimple from "@pulumi/dnsimple";
 *
 * const example = new dnsimple.Domain("example", {name: "example.com"});
 * ```
 *
 * ## Import
 *
 * DNSimple domains can be imported using the domain name.
 *
 * ```sh
 * $ pulumi import dnsimple:index/domain:Domain example example.com
 * ```
 *
 * The domain name can be found within the [DNSimple Domains API](https://developer.dnsimple.com/v2/domains/#listDomains). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
 */
export declare class Domain extends pulumi.CustomResource {
    /**
     * Get an existing Domain 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?: DomainState, opts?: pulumi.CustomResourceOptions): Domain;
    /**
     * Returns true if the given object is an instance of Domain.  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 Domain;
    /**
     * The account ID for the domain.
     */
    readonly accountId: pulumi.Output<number>;
    /**
     * Whether the domain is set to auto-renew.
     */
    readonly autoRenew: pulumi.Output<boolean>;
    /**
     * The domain name to be created.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Whether the domain has WhoIs privacy enabled.
     */
    readonly privateWhois: pulumi.Output<boolean>;
    /**
     * The ID of the registrant (contact) for the domain.
     */
    readonly registrantId: pulumi.Output<number>;
    /**
     * The state of the domain.
     */
    readonly state: pulumi.Output<string>;
    /**
     * Whether the domain has a [trustee](https://support.dnsimple.com/articles/what-is-domain-trustee/) enabled.
     */
    readonly trustee: pulumi.Output<boolean>;
    /**
     * The domain name in Unicode format.
     */
    readonly unicodeName: pulumi.Output<string>;
    /**
     * Create a Domain 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: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Domain resources.
 */
export interface DomainState {
    /**
     * The account ID for the domain.
     */
    accountId?: pulumi.Input<number | undefined>;
    /**
     * Whether the domain is set to auto-renew.
     */
    autoRenew?: pulumi.Input<boolean | undefined>;
    /**
     * The domain name to be created.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Whether the domain has WhoIs privacy enabled.
     */
    privateWhois?: pulumi.Input<boolean | undefined>;
    /**
     * The ID of the registrant (contact) for the domain.
     */
    registrantId?: pulumi.Input<number | undefined>;
    /**
     * The state of the domain.
     */
    state?: pulumi.Input<string | undefined>;
    /**
     * Whether the domain has a [trustee](https://support.dnsimple.com/articles/what-is-domain-trustee/) enabled.
     */
    trustee?: pulumi.Input<boolean | undefined>;
    /**
     * The domain name in Unicode format.
     */
    unicodeName?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Domain resource.
 */
export interface DomainArgs {
    /**
     * The domain name to be created.
     */
    name: pulumi.Input<string>;
}
//# sourceMappingURL=domain.d.ts.map