@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";
 *
 * // Create a domain
 * const foobar = new dnsimple.Domain("foobar", {name: dnsimple.domain});
 * ```
 *
 * ## Import
 *
 * DNSimple domains can be imported using their numeric record ID.
 *
 * bash
 *
 * ```sh
 * $ pulumi import dnsimple:index/domain:Domain resource_name 5678
 * ```
 *
 * The record ID can be found within [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.
 *
 * bash
 *
 * curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
 *
 * {
 *
 *   "data": [
 *
 *     {
 *
 *       "id": 5678,
 *
 *       "account_id": 1234,
 *
 *       "registrant_id": null,
 *
 *       "name": "example.com",
 *
 *       "unicode_name": "example.com",
 *
 *       "state": "hosted",
 *
 *       "auto_renew": false,
 *
 *       "private_whois": false,
 *
 *       "expires_on": null,
 *
 *       "expires_at": null,
 *
 *       "created_at": "2021-10-01T00:00:00Z",
 *
 *       "updated_at": "2021-10-01T00:00:00Z"
 *
 *     }
 *
 *   ],
 *
 *   "pagination": {
 *
 *     "current_page": 1,
 *
 *     "per_page": 30,
 *
 *     "total_entries": 1,
 *
 *     "total_pages": 1
 *
 *   }
 *
 * }
 */
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
     *
     * # Attributes Reference
     */
    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>;
    /**
     * 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>;
    /**
     * Whether the domain is set to auto-renew.
     */
    autoRenew?: pulumi.Input<boolean>;
    /**
     * The domain name to be created
     *
     * # Attributes Reference
     */
    name?: pulumi.Input<string>;
    /**
     * Whether the domain has WhoIs privacy enabled.
     */
    privateWhois?: pulumi.Input<boolean>;
    /**
     * The ID of the registrant (contact) for the domain.
     */
    registrantId?: pulumi.Input<number>;
    /**
     * The state of the domain.
     */
    state?: pulumi.Input<string>;
    /**
     * The domain name in Unicode format.
     */
    unicodeName?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Domain resource.
 */
export interface DomainArgs {
    /**
     * The domain name to be created
     *
     * # Attributes Reference
     */
    name: pulumi.Input<string>;
}