UNPKG

@pulumi/dnsimple

Version:

A Pulumi package for creating and managing dnsimple cloud resources.

93 lines 3.26 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides a DNSimple domain delegation resource. * * This resource allows you to control the delegation records (name servers) for a domain. * * > **Warning:** This resource currently only supports the management of domains that are registered with DNSimple. * * > **Note:** When this resource is destroyed, only the Terraform state is removed; the domain delegation is left intact and unmanaged by Terraform. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as dnsimple from "@pulumi/dnsimple"; * * const example = new dnsimple.DomainDelegation("example", { * domain: "example.com", * nameServers: [ * "ns1.example.org", * "ns2.example.com", * ], * }); * ``` * * ## Import * * DNSimple domain delegations can be imported using the domain name. * * ```sh * $ pulumi import dnsimple:index/domainDelegation:DomainDelegation example example.com * ``` */ export declare class DomainDelegation extends pulumi.CustomResource { /** * Get an existing DomainDelegation 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?: DomainDelegationState, opts?: pulumi.CustomResourceOptions): DomainDelegation; /** * Returns true if the given object is an instance of DomainDelegation. 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 DomainDelegation; /** * The domain name. */ readonly domain: pulumi.Output<string>; /** * List of name servers to delegate to. */ readonly nameServers: pulumi.Output<string[]>; /** * Create a DomainDelegation 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: DomainDelegationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DomainDelegation resources. */ export interface DomainDelegationState { /** * The domain name. */ domain?: pulumi.Input<string | undefined>; /** * List of name servers to delegate to. */ nameServers?: pulumi.Input<pulumi.Input<string>[] | undefined>; } /** * The set of arguments for constructing a DomainDelegation resource. */ export interface DomainDelegationArgs { /** * The domain name. */ domain: pulumi.Input<string>; /** * List of name servers to delegate to. */ nameServers: pulumi.Input<pulumi.Input<string>[]>; } //# sourceMappingURL=domainDelegation.d.ts.map