@pulumi/dnsimple 4.5.0-alpha.1766554702 → 5.0.0-alpha.1767113714

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/config/vars.d.ts +4 -0
  2. package/config/vars.js +6 -0
  3. package/config/vars.js.map +1 -1
  4. package/contact.d.ts +55 -166
  5. package/contact.js +13 -118
  6. package/contact.js.map +1 -1
  7. package/domain.d.ts +7 -66
  8. package/domain.js +4 -57
  9. package/domain.js.map +1 -1
  10. package/domainDelegation.d.ts +6 -15
  11. package/domainDelegation.js +3 -6
  12. package/domainDelegation.js.map +1 -1
  13. package/dsRecord.d.ts +12 -73
  14. package/dsRecord.js +5 -51
  15. package/dsRecord.js.map +1 -1
  16. package/emailForward.d.ts +16 -16
  17. package/emailForward.js +7 -7
  18. package/getCertificate.d.ts +25 -16
  19. package/getCertificate.js +8 -8
  20. package/getCertificate.js.map +1 -1
  21. package/getRegistrantChangeCheck.d.ts +32 -32
  22. package/getRegistrantChangeCheck.js +8 -32
  23. package/getRegistrantChangeCheck.js.map +1 -1
  24. package/getZone.d.ts +39 -0
  25. package/getZone.js +24 -0
  26. package/getZone.js.map +1 -1
  27. package/letsEncryptCertificate.d.ts +41 -29
  28. package/letsEncryptCertificate.js +15 -3
  29. package/letsEncryptCertificate.js.map +1 -1
  30. package/package.json +2 -2
  31. package/provider.d.ts +8 -0
  32. package/provider.js +1 -0
  33. package/provider.js.map +1 -1
  34. package/registeredDomain.d.ts +64 -47
  35. package/registeredDomain.js +38 -11
  36. package/registeredDomain.js.map +1 -1
  37. package/types/input.d.ts +10 -10
  38. package/types/output.d.ts +30 -9
  39. package/zone.d.ts +8 -45
  40. package/zone.js +5 -36
  41. package/zone.js.map +1 -1
  42. package/zoneRecord.d.ts +45 -50
  43. package/zoneRecord.js +21 -26
  44. package/zoneRecord.js.map +1 -1
package/types/output.d.ts CHANGED
@@ -1,32 +1,53 @@
1
1
  import * as outputs from "../types/output";
2
2
  export interface GetCertificateTimeouts {
3
3
  /**
4
- * (String) - The timeout for the read operation e.g. `5m`
4
+ * (String) - The timeout for the read operation, e.g., `5m`.
5
5
  */
6
6
  read?: string;
7
7
  }
8
8
  export interface GetRegistrantChangeCheckExtendedAttribute {
9
+ /**
10
+ * (String) - The description of the option.
11
+ */
9
12
  description: string;
13
+ /**
14
+ * (String) - The name of the extended attribute, e.g., `x-au-registrant-id-type`.
15
+ */
10
16
  name: string;
17
+ /**
18
+ * (List) - A list of options for the extended attribute. (see below for nested schema)
19
+ */
11
20
  options: outputs.GetRegistrantChangeCheckExtendedAttributeOption[];
21
+ /**
22
+ * (Boolean) - Whether the extended attribute is required.
23
+ */
12
24
  required: boolean;
13
25
  }
14
26
  export interface GetRegistrantChangeCheckExtendedAttributeOption {
27
+ /**
28
+ * (String) - The description of the option.
29
+ */
15
30
  description: string;
31
+ /**
32
+ * (String) - The human-readable title of the option, e.g., `Australian Company Number (ACN)`.
33
+ */
16
34
  title: string;
35
+ /**
36
+ * (String) - The value of the option.
37
+ */
17
38
  value: string;
18
39
  }
19
40
  export interface RegisteredDomainDomainRegistration {
20
41
  /**
21
- * The ID of this resource.
42
+ * (Number) - The ID of the domain registration.
22
43
  */
23
44
  id: number;
24
45
  /**
25
- * The registration period in years.
46
+ * (Number) - The registration period in years.
26
47
  */
27
48
  period: number;
28
49
  /**
29
- * The state of the domain.
50
+ * (String) - The state of the domain registration.
30
51
  */
31
52
  state: string;
32
53
  }
@@ -36,7 +57,7 @@ export interface RegisteredDomainRegistrantChange {
36
57
  */
37
58
  accountId: number;
38
59
  /**
39
- * The ID of the contact to be used for the domain registration. The contact ID can be changed after the domain has been registered. The change will result in a new registrant change this may result in a [60-day lock](https://support.dnsimple.com/articles/icann-60-day-lock-registrant-change/).
60
+ * The ID of the contact to be used for the domain registration. The contact ID can be changed after the domain has been registered. The change will result in a new registrant change, which may result in a [60-day lock](https://support.dnsimple.com/articles/icann-60-day-lock-registrant-change/).
40
61
  */
41
62
  contactId: number;
42
63
  /**
@@ -50,7 +71,7 @@ export interface RegisteredDomainRegistrantChange {
50
71
  [key: string]: string;
51
72
  };
52
73
  /**
53
- * The ID of this resource.
74
+ * (Number) - The ID of the domain registration.
54
75
  */
55
76
  id: number;
56
77
  /**
@@ -62,13 +83,13 @@ export interface RegisteredDomainRegistrantChange {
62
83
  */
63
84
  registryOwnerChange: boolean;
64
85
  /**
65
- * The state of the domain.
86
+ * (String) - The state of the domain registration.
66
87
  */
67
88
  state: string;
68
89
  }
69
90
  export interface RegisteredDomainTimeouts {
70
91
  /**
71
- * Create timeout.
92
+ * (String) - The timeout for the read operation e.g. `5m`
72
93
  */
73
94
  create?: string;
74
95
  /**
@@ -76,7 +97,7 @@ export interface RegisteredDomainTimeouts {
76
97
  */
77
98
  delete?: string;
78
99
  /**
79
- * Update timeout.
100
+ * (String) - The timeout for the read operation e.g. `5m`
80
101
  */
81
102
  update?: string;
82
103
  }
package/zone.d.ts CHANGED
@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
3
  * Provides a DNSimple zone resource.
4
4
  *
5
- * > Currently the resource creation acts as an import, so the zone must already exist in DNSimple. The only attribute that will be modified during resource creation is the `active` state of the zone. This is because our API does not allow for the creation of zones. Creation of zones happens through the purchase or creation of domains. We expect this behavior to change in the future.
5
+ * > **Note:** Currently the resource creation acts as an import, so the zone must already exist in DNSimple. The only attribute that will be modified during resource creation is the `active` state of the zone. This is because our API does not allow for the creation of zones. Creation of zones happens through the purchase or creation of domains. We expect this behavior to change in the future.
6
6
  *
7
7
  * ## Example Usage
8
8
  *
@@ -10,51 +10,20 @@ import * as pulumi from "@pulumi/pulumi";
10
10
  * import * as pulumi from "@pulumi/pulumi";
11
11
  * import * as dnsimple from "@pulumi/dnsimple";
12
12
  *
13
- * // Create a zone
14
- * const foobar = new dnsimple.Zone("foobar", {name: dnsimple.zone});
13
+ * const example = new dnsimple.Zone("example", {name: "example.com"});
15
14
  * ```
16
15
  *
17
16
  * ## Import
18
17
  *
19
- * DNSimple zones can be imported using their numeric record ID or the zone name.
18
+ * DNSimple zones can be imported using the zone name.
20
19
  *
21
20
  * bash
22
21
  *
23
22
  * ```sh
24
- * $ pulumi import dnsimple:index/zone:Zone resource_name foo.com
23
+ * $ pulumi import dnsimple:index/zone:Zone example example.com
25
24
  * ```
26
25
  *
27
- * The zone ID can be found within [DNSimple Zones API](https://developer.dnsimple.com/v2/zones/#getZone). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
28
- *
29
- * bash
30
- *
31
- * curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://api.dnsimple.com/v2/1234/zones/example.com | jq
32
- *
33
- * {
34
- *
35
- * "data": {
36
- *
37
- * "id": 1,
38
- *
39
- * "account_id": 1234,
40
- *
41
- * "name": "example.com",
42
- *
43
- * "reverse": false,
44
- *
45
- * "secondary": false,
46
- *
47
- * "last_transferred_at": null,
48
- *
49
- * "active": true,
50
- *
51
- * "created_at": "2023-04-18T04:58:01Z",
52
- *
53
- * "updated_at": "2024-01-16T15:53:18Z"
54
- *
55
- * }
56
- *
57
- * }
26
+ * The zone name can be found within the [DNSimple Zones API](https://developer.dnsimple.com/v2/zones/#getZone). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
58
27
  */
59
28
  export declare class Zone extends pulumi.CustomResource {
60
29
  /**
@@ -85,9 +54,7 @@ export declare class Zone extends pulumi.CustomResource {
85
54
  */
86
55
  readonly lastTransferredAt: pulumi.Output<string>;
87
56
  /**
88
- * The zone name
89
- *
90
- * # Attributes Reference
57
+ * The zone name.
91
58
  */
92
59
  readonly name: pulumi.Output<string>;
93
60
  /**
@@ -124,9 +91,7 @@ export interface ZoneState {
124
91
  */
125
92
  lastTransferredAt?: pulumi.Input<string>;
126
93
  /**
127
- * The zone name
128
- *
129
- * # Attributes Reference
94
+ * The zone name.
130
95
  */
131
96
  name?: pulumi.Input<string>;
132
97
  /**
@@ -147,9 +112,7 @@ export interface ZoneArgs {
147
112
  */
148
113
  active?: pulumi.Input<boolean>;
149
114
  /**
150
- * The zone name
151
- *
152
- * # Attributes Reference
115
+ * The zone name.
153
116
  */
154
117
  name: pulumi.Input<string>;
155
118
  }
package/zone.js CHANGED
@@ -8,7 +8,7 @@ const utilities = require("./utilities");
8
8
  /**
9
9
  * Provides a DNSimple zone resource.
10
10
  *
11
- * > Currently the resource creation acts as an import, so the zone must already exist in DNSimple. The only attribute that will be modified during resource creation is the `active` state of the zone. This is because our API does not allow for the creation of zones. Creation of zones happens through the purchase or creation of domains. We expect this behavior to change in the future.
11
+ * > **Note:** Currently the resource creation acts as an import, so the zone must already exist in DNSimple. The only attribute that will be modified during resource creation is the `active` state of the zone. This is because our API does not allow for the creation of zones. Creation of zones happens through the purchase or creation of domains. We expect this behavior to change in the future.
12
12
  *
13
13
  * ## Example Usage
14
14
  *
@@ -16,51 +16,20 @@ const utilities = require("./utilities");
16
16
  * import * as pulumi from "@pulumi/pulumi";
17
17
  * import * as dnsimple from "@pulumi/dnsimple";
18
18
  *
19
- * // Create a zone
20
- * const foobar = new dnsimple.Zone("foobar", {name: dnsimple.zone});
19
+ * const example = new dnsimple.Zone("example", {name: "example.com"});
21
20
  * ```
22
21
  *
23
22
  * ## Import
24
23
  *
25
- * DNSimple zones can be imported using their numeric record ID or the zone name.
24
+ * DNSimple zones can be imported using the zone name.
26
25
  *
27
26
  * bash
28
27
  *
29
28
  * ```sh
30
- * $ pulumi import dnsimple:index/zone:Zone resource_name foo.com
29
+ * $ pulumi import dnsimple:index/zone:Zone example example.com
31
30
  * ```
32
31
  *
33
- * The zone ID can be found within [DNSimple Zones API](https://developer.dnsimple.com/v2/zones/#getZone). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
34
- *
35
- * bash
36
- *
37
- * curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://api.dnsimple.com/v2/1234/zones/example.com | jq
38
- *
39
- * {
40
- *
41
- * "data": {
42
- *
43
- * "id": 1,
44
- *
45
- * "account_id": 1234,
46
- *
47
- * "name": "example.com",
48
- *
49
- * "reverse": false,
50
- *
51
- * "secondary": false,
52
- *
53
- * "last_transferred_at": null,
54
- *
55
- * "active": true,
56
- *
57
- * "created_at": "2023-04-18T04:58:01Z",
58
- *
59
- * "updated_at": "2024-01-16T15:53:18Z"
60
- *
61
- * }
62
- *
63
- * }
32
+ * The zone name can be found within the [DNSimple Zones API](https://developer.dnsimple.com/v2/zones/#getZone). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
64
33
  */
65
34
  class Zone extends pulumi.CustomResource {
66
35
  /**
package/zone.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"zone.js","sourceRoot":"","sources":["../zone.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAa,IAAK,SAAQ,MAAM,CAAC,cAAc;IAC3C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAiB,EAAE,IAAmC;QAC/G,OAAO,IAAI,IAAI,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,YAAY,CAAC;IACrD,CAAC;IAqCD,YAAY,IAAY,EAAE,WAAkC,EAAE,IAAmC;QAC7F,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAoC,CAAC;YACnD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,CAAC;YAC/C,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,EAAE,iBAAiB,CAAC;YAC/D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,CAAC;SAClD;aAAM;YACH,MAAM,IAAI,GAAG,WAAmC,CAAC;YACjD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACxD,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACnD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;;AAxFL,oBAyFC;AA3EG,gBAAgB;AACO,iBAAY,GAAG,0BAA0B,CAAC"}
1
+ {"version":3,"file":"zone.js","sourceRoot":"","sources":["../zone.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,IAAK,SAAQ,MAAM,CAAC,cAAc;IAC3C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAiB,EAAE,IAAmC;QAC/G,OAAO,IAAI,IAAI,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,YAAY,CAAC;IACrD,CAAC;IAmCD,YAAY,IAAY,EAAE,WAAkC,EAAE,IAAmC;QAC7F,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAoC,CAAC;YACnD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,CAAC;YAC/C,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,EAAE,iBAAiB,CAAC;YAC/D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,CAAC;SAClD;aAAM;YACH,MAAM,IAAI,GAAG,WAAmC,CAAC;YACjD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACxD,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACnD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;;AAtFL,oBAuFC;AAzEG,gBAAgB;AACO,iBAAY,GAAG,0BAA0B,CAAC"}
package/zoneRecord.d.ts CHANGED
@@ -9,50 +9,45 @@ import * as pulumi from "@pulumi/pulumi";
9
9
  * import * as dnsimple from "@pulumi/dnsimple";
10
10
  *
11
11
  * // Add a record to the root domain
12
- * const foobar = new dnsimple.ZoneRecord("foobar", {
13
- * zoneName: dnsimpleDomain,
12
+ * const apex = new dnsimple.ZoneRecord("apex", {
13
+ * zoneName: "example.com",
14
14
  * name: "",
15
- * value: "192.168.0.11",
15
+ * value: "192.0.2.1",
16
16
  * type: "A",
17
17
  * ttl: 3600,
18
18
  * });
19
- * ```
20
- *
21
- * ```typescript
22
- * import * as pulumi from "@pulumi/pulumi";
23
- * import * as dnsimple from "@pulumi/dnsimple";
24
- *
25
- * // Add a record to a sub-domain
26
- * const foobar = new dnsimple.ZoneRecord("foobar", {
27
- * zoneName: dnsimpleDomain,
28
- * name: "terraform",
29
- * value: "192.168.0.11",
19
+ * // Add a record to a subdomain
20
+ * const www = new dnsimple.ZoneRecord("www", {
21
+ * zoneName: "example.com",
22
+ * name: "www",
23
+ * value: "192.0.2.1",
30
24
  * type: "A",
31
25
  * ttl: 3600,
32
26
  * });
27
+ * // Add an MX record
28
+ * const mx = new dnsimple.ZoneRecord("mx", {
29
+ * zoneName: "example.com",
30
+ * name: "",
31
+ * value: "mail.example.com",
32
+ * type: "MX",
33
+ * priority: 10,
34
+ * ttl: 3600,
35
+ * });
33
36
  * ```
34
37
  *
35
38
  * ## Import
36
39
  *
37
- * DNSimple resources can be imported using their parent zone name (domain name) and numeric record ID.
38
- *
39
- * **Importing record example.com with record ID 1234**
40
- *
41
- * bash
42
- *
43
- * ```sh
44
- * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord resource_name example.com_1234
45
- * ```
40
+ * DNSimple zone records can be imported using the zone name and numeric record ID in the format `zone_name_record_id`.
46
41
  *
47
- * **Importing record www.example.com with record ID 1234**
42
+ * **Importing record for example.com with record ID 1234:**
48
43
  *
49
44
  * bash
50
45
  *
51
46
  * ```sh
52
- * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord resource_name example.com_1234
47
+ * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord example example.com_1234
53
48
  * ```
54
49
  *
55
- * The record ID can be found in the URL when editing a record on the DNSimple web dashboard.
50
+ * The record ID can be found in the URL when editing a record on the DNSimple web dashboard, or via the [DNSimple Zone Records API](https://developer.dnsimple.com/v2/zones/records/#listZoneRecords).
56
51
  */
57
52
  export declare class ZoneRecord extends pulumi.CustomResource {
58
53
  /**
@@ -71,16 +66,16 @@ export declare class ZoneRecord extends pulumi.CustomResource {
71
66
  */
72
67
  static isInstance(obj: any): obj is ZoneRecord;
73
68
  /**
74
- * The name of the record
69
+ * The name of the record. Use `""` for the root domain.
75
70
  */
76
71
  readonly name: pulumi.Output<string>;
77
72
  readonly nameNormalized: pulumi.Output<string>;
78
73
  /**
79
- * The priority of the record - only useful for some record types
74
+ * The priority of the record. Only used for certain record types (e.g., `MX`, `SRV`).
80
75
  */
81
76
  readonly priority: pulumi.Output<number>;
82
77
  /**
83
- * The FQDN of the record
78
+ * The fully qualified domain name (FQDN) of the record.
84
79
  */
85
80
  readonly qualifiedName: pulumi.Output<string>;
86
81
  /**
@@ -88,27 +83,27 @@ export declare class ZoneRecord extends pulumi.CustomResource {
88
83
  */
89
84
  readonly regions: pulumi.Output<string[] | undefined>;
90
85
  /**
91
- * The TTL of the record - defaults to 3600
86
+ * The TTL of the record. Defaults to `3600`.
92
87
  */
93
88
  readonly ttl: pulumi.Output<number>;
94
89
  /**
95
- * The type of the record
90
+ * The type of the record (e.g., `A`, `AAAA`, `CNAME`, `MX`, `TXT`). **The record type must be specified in UPPERCASE.**
96
91
  */
97
92
  readonly type: pulumi.Output<string>;
98
93
  /**
99
- * The value of the record
94
+ * The value of the record.
100
95
  */
101
96
  readonly value: pulumi.Output<string>;
102
97
  /**
103
- * The normalized value of the record
98
+ * The normalized value of the record.
104
99
  */
105
100
  readonly valueNormalized: pulumi.Output<string>;
106
101
  /**
107
- * The zone ID of the record
102
+ * The zone ID of the record.
108
103
  */
109
104
  readonly zoneId: pulumi.Output<string>;
110
105
  /**
111
- * The zone name to add the record to
106
+ * The zone name to add the record to.
112
107
  */
113
108
  readonly zoneName: pulumi.Output<string>;
114
109
  /**
@@ -125,16 +120,16 @@ export declare class ZoneRecord extends pulumi.CustomResource {
125
120
  */
126
121
  export interface ZoneRecordState {
127
122
  /**
128
- * The name of the record
123
+ * The name of the record. Use `""` for the root domain.
129
124
  */
130
125
  name?: pulumi.Input<string>;
131
126
  nameNormalized?: pulumi.Input<string>;
132
127
  /**
133
- * The priority of the record - only useful for some record types
128
+ * The priority of the record. Only used for certain record types (e.g., `MX`, `SRV`).
134
129
  */
135
130
  priority?: pulumi.Input<number>;
136
131
  /**
137
- * The FQDN of the record
132
+ * The fully qualified domain name (FQDN) of the record.
138
133
  */
139
134
  qualifiedName?: pulumi.Input<string>;
140
135
  /**
@@ -142,27 +137,27 @@ export interface ZoneRecordState {
142
137
  */
143
138
  regions?: pulumi.Input<pulumi.Input<string>[]>;
144
139
  /**
145
- * The TTL of the record - defaults to 3600
140
+ * The TTL of the record. Defaults to `3600`.
146
141
  */
147
142
  ttl?: pulumi.Input<number>;
148
143
  /**
149
- * The type of the record
144
+ * The type of the record (e.g., `A`, `AAAA`, `CNAME`, `MX`, `TXT`). **The record type must be specified in UPPERCASE.**
150
145
  */
151
146
  type?: pulumi.Input<string>;
152
147
  /**
153
- * The value of the record
148
+ * The value of the record.
154
149
  */
155
150
  value?: pulumi.Input<string>;
156
151
  /**
157
- * The normalized value of the record
152
+ * The normalized value of the record.
158
153
  */
159
154
  valueNormalized?: pulumi.Input<string>;
160
155
  /**
161
- * The zone ID of the record
156
+ * The zone ID of the record.
162
157
  */
163
158
  zoneId?: pulumi.Input<string>;
164
159
  /**
165
- * The zone name to add the record to
160
+ * The zone name to add the record to.
166
161
  */
167
162
  zoneName?: pulumi.Input<string>;
168
163
  }
@@ -171,11 +166,11 @@ export interface ZoneRecordState {
171
166
  */
172
167
  export interface ZoneRecordArgs {
173
168
  /**
174
- * The name of the record
169
+ * The name of the record. Use `""` for the root domain.
175
170
  */
176
171
  name: pulumi.Input<string>;
177
172
  /**
178
- * The priority of the record - only useful for some record types
173
+ * The priority of the record. Only used for certain record types (e.g., `MX`, `SRV`).
179
174
  */
180
175
  priority?: pulumi.Input<number>;
181
176
  /**
@@ -183,19 +178,19 @@ export interface ZoneRecordArgs {
183
178
  */
184
179
  regions?: pulumi.Input<pulumi.Input<string>[]>;
185
180
  /**
186
- * The TTL of the record - defaults to 3600
181
+ * The TTL of the record. Defaults to `3600`.
187
182
  */
188
183
  ttl?: pulumi.Input<number>;
189
184
  /**
190
- * The type of the record
185
+ * The type of the record (e.g., `A`, `AAAA`, `CNAME`, `MX`, `TXT`). **The record type must be specified in UPPERCASE.**
191
186
  */
192
187
  type: pulumi.Input<string>;
193
188
  /**
194
- * The value of the record
189
+ * The value of the record.
195
190
  */
196
191
  value: pulumi.Input<string>;
197
192
  /**
198
- * The zone name to add the record to
193
+ * The zone name to add the record to.
199
194
  */
200
195
  zoneName: pulumi.Input<string>;
201
196
  }
package/zoneRecord.js CHANGED
@@ -15,50 +15,45 @@ const utilities = require("./utilities");
15
15
  * import * as dnsimple from "@pulumi/dnsimple";
16
16
  *
17
17
  * // Add a record to the root domain
18
- * const foobar = new dnsimple.ZoneRecord("foobar", {
19
- * zoneName: dnsimpleDomain,
18
+ * const apex = new dnsimple.ZoneRecord("apex", {
19
+ * zoneName: "example.com",
20
20
  * name: "",
21
- * value: "192.168.0.11",
21
+ * value: "192.0.2.1",
22
22
  * type: "A",
23
23
  * ttl: 3600,
24
24
  * });
25
- * ```
26
- *
27
- * ```typescript
28
- * import * as pulumi from "@pulumi/pulumi";
29
- * import * as dnsimple from "@pulumi/dnsimple";
30
- *
31
- * // Add a record to a sub-domain
32
- * const foobar = new dnsimple.ZoneRecord("foobar", {
33
- * zoneName: dnsimpleDomain,
34
- * name: "terraform",
35
- * value: "192.168.0.11",
25
+ * // Add a record to a subdomain
26
+ * const www = new dnsimple.ZoneRecord("www", {
27
+ * zoneName: "example.com",
28
+ * name: "www",
29
+ * value: "192.0.2.1",
36
30
  * type: "A",
37
31
  * ttl: 3600,
38
32
  * });
33
+ * // Add an MX record
34
+ * const mx = new dnsimple.ZoneRecord("mx", {
35
+ * zoneName: "example.com",
36
+ * name: "",
37
+ * value: "mail.example.com",
38
+ * type: "MX",
39
+ * priority: 10,
40
+ * ttl: 3600,
41
+ * });
39
42
  * ```
40
43
  *
41
44
  * ## Import
42
45
  *
43
- * DNSimple resources can be imported using their parent zone name (domain name) and numeric record ID.
44
- *
45
- * **Importing record example.com with record ID 1234**
46
- *
47
- * bash
48
- *
49
- * ```sh
50
- * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord resource_name example.com_1234
51
- * ```
46
+ * DNSimple zone records can be imported using the zone name and numeric record ID in the format `zone_name_record_id`.
52
47
  *
53
- * **Importing record www.example.com with record ID 1234**
48
+ * **Importing record for example.com with record ID 1234:**
54
49
  *
55
50
  * bash
56
51
  *
57
52
  * ```sh
58
- * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord resource_name example.com_1234
53
+ * $ pulumi import dnsimple:index/zoneRecord:ZoneRecord example example.com_1234
59
54
  * ```
60
55
  *
61
- * The record ID can be found in the URL when editing a record on the DNSimple web dashboard.
56
+ * The record ID can be found in the URL when editing a record on the DNSimple web dashboard, or via the [DNSimple Zone Records API](https://developer.dnsimple.com/v2/zones/records/#listZoneRecords).
62
57
  */
63
58
  class ZoneRecord extends pulumi.CustomResource {
64
59
  /**
package/zoneRecord.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"zoneRecord.js","sourceRoot":"","sources":["../zoneRecord.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAa,UAAW,SAAQ,MAAM,CAAC,cAAc;IACjD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAuB,EAAE,IAAmC;QACrH,OAAO,IAAI,UAAU,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,UAAU,CAAC,YAAY,CAAC;IAC3D,CAAC;IAoDD,YAAY,IAAY,EAAE,WAA8C,EAAE,IAAmC;QACzG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA0C,CAAC;YACzD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,EAAE,cAAc,CAAC;YACzD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;YAC7C,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,EAAE,aAAa,CAAC;YACvD,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC;YACnC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC;YACvC,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,EAAE,eAAe,CAAC;YAC3D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;SAChD;aAAM;YACH,MAAM,IAAI,GAAG,WAAyC,CAAC;YACvD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,IAAI,EAAE,KAAK,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,IAAI,EAAE,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;YAC1C,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC;YAClC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC;YACtC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACrD,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACtD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;;AA1HL,gCA2HC;AA7GG,gBAAgB;AACO,uBAAY,GAAG,sCAAsC,CAAC"}
1
+ {"version":3,"file":"zoneRecord.js","sourceRoot":"","sources":["../zoneRecord.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAa,UAAW,SAAQ,MAAM,CAAC,cAAc;IACjD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAuB,EAAE,IAAmC;QACrH,OAAO,IAAI,UAAU,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,UAAU,CAAC,YAAY,CAAC;IAC3D,CAAC;IAoDD,YAAY,IAAY,EAAE,WAA8C,EAAE,IAAmC;QACzG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA0C,CAAC;YACzD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,EAAE,cAAc,CAAC;YACzD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;YAC7C,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,EAAE,aAAa,CAAC;YACvD,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC;YACnC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC;YACvC,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,EAAE,eAAe,CAAC;YAC3D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;SAChD;aAAM;YACH,MAAM,IAAI,GAAG,WAAyC,CAAC;YACvD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,IAAI,EAAE,KAAK,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,IAAI,IAAI,EAAE,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;YAC1C,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC;YAClC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC;YACtC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACrD,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACtD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAChD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;;AA1HL,gCA2HC;AA7GG,gBAAgB;AACO,uBAAY,GAAG,sCAAsC,CAAC"}