1. Docs
  2. Reference
  3. API
  4. @pulumi/dnsimple

Package @pulumi/dnsimple

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-dnsimple repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-dnsimple repo.

var dnsimple = require("@pulumi/dnsimple");

import * as dnsimple from "@pulumi/dnsimple";

Modules

namespace RecordTypes

Resources

Others

namespace RecordTypes

const A

const A: RecordType = "A";

const AAAA

const AAAA: RecordType = "AAAA";

const ALIAS

const ALIAS: RecordType = "ALIAS";

const CAA

const CAA: RecordType = "CAA";

const CNAME

const CNAME: RecordType = "CNAME";

const HINFO

const HINFO: RecordType = "HINFO";

const MX

const MX: RecordType = "MX";

const NAPTR

const NAPTR: RecordType = "NAPTR";

const NS

const NS: RecordType = "NS";

const POOL

const POOL: RecordType = "POOL";

const PTR

const PTR: RecordType = "PTR";

const SPF

const SPF: RecordType = "SPF";

const SRV

const SRV: RecordType = "SRV";

const SSHFP

const SSHFP: RecordType = "SSHFP";

const TXT

const TXT: RecordType = "TXT";

const URL

const URL: RecordType = "URL";

Resources

Resource Provider

class Provider extends ProviderResource

The provider type for the dnsimple package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Record

class Record extends CustomResource

constructor

new Record(name: string, args: RecordArgs, opts?: pulumi.CustomResourceOptions)

Create a Record resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RecordState, opts?: pulumi.CustomResourceOptions): Record

Get an existing Record resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Record

Returns true if the given object is an instance of Record. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property domain

public domain: pulumi.Output<string>;

The domain to add the record to

property domainId

public domainId: pulumi.Output<string>;

The domain ID of the record

property hostname

public hostname: pulumi.Output<string>;

The FQDN of the record

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the record

property priority

public priority: pulumi.Output<number>;

The priority of the record - only useful for some record types

property ttl

public ttl: pulumi.Output<number | undefined>;

The TTL of the record

property type

public type: pulumi.Output<RecordType>;

The type of the record

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the record

Others

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property account

account?: pulumi.Input<string>;

The account for API operations.

property token

token?: pulumi.Input<string>;

The API v2 token for API operations.

interface RecordArgs

interface RecordArgs

The set of arguments for constructing a Record resource.

property domain

domain: pulumi.Input<string>;

The domain to add the record to

property name

name: pulumi.Input<string>;

The name of the record

property priority

priority?: pulumi.Input<number>;

The priority of the record - only useful for some record types

property ttl

ttl?: pulumi.Input<number>;

The TTL of the record

property type

type: pulumi.Input<RecordType>;

The type of the record

property value

value: pulumi.Input<string>;

The value of the record

interface RecordState

interface RecordState

Input properties used for looking up and filtering Record resources.

property domain

domain?: pulumi.Input<string>;

The domain to add the record to

property domainId

domainId?: pulumi.Input<string>;

The domain ID of the record

property hostname

hostname?: pulumi.Input<string>;

The FQDN of the record

property name

name?: pulumi.Input<string>;

The name of the record

property priority

priority?: pulumi.Input<number>;

The priority of the record - only useful for some record types

property ttl

ttl?: pulumi.Input<number>;

The TTL of the record

property type

type?: pulumi.Input<RecordType>;

The type of the record

property value

value?: pulumi.Input<string>;

The value of the record

type RecordType

type RecordType = "A" | "AAAA" | "ALIAS" | "CAA" | "CNAME" | "HINFO" | "MX" | "NAPTR" | "NS" | "POOL" | "PTR" | "SPF" | "SRV" | "SSHFP" | "TXT" | "URL";