@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
141 lines • 4.27 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Domain = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* 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
*
* }
*
* }
*/
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, id, state, opts) {
return new Domain(name, state, { ...opts, id: id });
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Domain.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accountId"] = state?.accountId;
resourceInputs["autoRenew"] = state?.autoRenew;
resourceInputs["name"] = state?.name;
resourceInputs["privateWhois"] = state?.privateWhois;
resourceInputs["registrantId"] = state?.registrantId;
resourceInputs["state"] = state?.state;
resourceInputs["unicodeName"] = state?.unicodeName;
}
else {
const args = argsOrState;
if (args?.name === undefined && !opts.urn) {
throw new Error("Missing required property 'name'");
}
resourceInputs["name"] = args?.name;
resourceInputs["accountId"] = undefined /*out*/;
resourceInputs["autoRenew"] = undefined /*out*/;
resourceInputs["privateWhois"] = undefined /*out*/;
resourceInputs["registrantId"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
resourceInputs["unicodeName"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Domain.__pulumiType, name, resourceInputs, opts);
}
}
exports.Domain = Domain;
/** @internal */
Domain.__pulumiType = 'dnsimple:index/domain:Domain';
//# sourceMappingURL=domain.js.map