@pulumi/dnsimple 4.5.0-alpha.1767073293 → 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.
@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
- * Provides a DNSimple certificate data source.
5
+ * Get information about a DNSimple SSL certificate.
6
6
  *
7
7
  * ## Example Usage
8
8
  *
@@ -10,9 +10,9 @@ import * as outputs from "./types/output";
10
10
  * import * as pulumi from "@pulumi/pulumi";
11
11
  * import * as dnsimple from "@pulumi/dnsimple";
12
12
  *
13
- * const foobar = dnsimple.getCertificate({
14
- * domain: dnsimpleDomain,
15
- * certificateId: dnsimpleCertificateId,
13
+ * const example = dnsimple.getCertificate({
14
+ * domain: "example.com",
15
+ * certificateId: 1234,
16
16
  * });
17
17
  * ```
18
18
  */
@@ -22,13 +22,16 @@ export declare function getCertificate(args: GetCertificateArgs, opts?: pulumi.I
22
22
  */
23
23
  export interface GetCertificateArgs {
24
24
  /**
25
- * The ID of the SSL Certificate
25
+ * The ID of the SSL certificate.
26
26
  */
27
27
  certificateId: number;
28
28
  /**
29
- * The domain of the SSL Certificate
29
+ * The domain name of the SSL certificate.
30
30
  */
31
31
  domain: string;
32
+ /**
33
+ * (see below for nested schema)
34
+ */
32
35
  timeouts?: inputs.GetCertificateTimeouts;
33
36
  }
34
37
  /**
@@ -36,28 +39,31 @@ export interface GetCertificateArgs {
36
39
  */
37
40
  export interface GetCertificateResult {
38
41
  /**
39
- * A list of certificates that make up the chain
42
+ * A list of certificates that make up the certificate chain.
40
43
  */
41
44
  readonly certificateChains: string[];
42
45
  readonly certificateId: number;
43
46
  readonly domain: string;
47
+ /**
48
+ * The certificate ID.
49
+ */
44
50
  readonly id: string;
45
51
  /**
46
- * The corresponding Private Key for the SSL Certificate
52
+ * The corresponding private key for the SSL certificate.
47
53
  */
48
54
  readonly privateKey: string;
49
55
  /**
50
- * The Root Certificate of the issuing CA
56
+ * The root certificate of the issuing CA.
51
57
  */
52
58
  readonly rootCertificate: string;
53
59
  /**
54
- * The SSL Certificate
60
+ * The SSL certificate.
55
61
  */
56
62
  readonly serverCertificate: string;
57
63
  readonly timeouts?: outputs.GetCertificateTimeouts;
58
64
  }
59
65
  /**
60
- * Provides a DNSimple certificate data source.
66
+ * Get information about a DNSimple SSL certificate.
61
67
  *
62
68
  * ## Example Usage
63
69
  *
@@ -65,9 +71,9 @@ export interface GetCertificateResult {
65
71
  * import * as pulumi from "@pulumi/pulumi";
66
72
  * import * as dnsimple from "@pulumi/dnsimple";
67
73
  *
68
- * const foobar = dnsimple.getCertificate({
69
- * domain: dnsimpleDomain,
70
- * certificateId: dnsimpleCertificateId,
74
+ * const example = dnsimple.getCertificate({
75
+ * domain: "example.com",
76
+ * certificateId: 1234,
71
77
  * });
72
78
  * ```
73
79
  */
@@ -77,12 +83,15 @@ export declare function getCertificateOutput(args: GetCertificateOutputArgs, opt
77
83
  */
78
84
  export interface GetCertificateOutputArgs {
79
85
  /**
80
- * The ID of the SSL Certificate
86
+ * The ID of the SSL certificate.
81
87
  */
82
88
  certificateId: pulumi.Input<number>;
83
89
  /**
84
- * The domain of the SSL Certificate
90
+ * The domain name of the SSL certificate.
85
91
  */
86
92
  domain: pulumi.Input<string>;
93
+ /**
94
+ * (see below for nested schema)
95
+ */
87
96
  timeouts?: pulumi.Input<inputs.GetCertificateTimeoutsArgs>;
88
97
  }
package/getCertificate.js CHANGED
@@ -6,7 +6,7 @@ exports.getCertificateOutput = exports.getCertificate = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Provides a DNSimple certificate data source.
9
+ * Get information about a DNSimple SSL certificate.
10
10
  *
11
11
  * ## Example Usage
12
12
  *
@@ -14,9 +14,9 @@ const utilities = require("./utilities");
14
14
  * import * as pulumi from "@pulumi/pulumi";
15
15
  * import * as dnsimple from "@pulumi/dnsimple";
16
16
  *
17
- * const foobar = dnsimple.getCertificate({
18
- * domain: dnsimpleDomain,
19
- * certificateId: dnsimpleCertificateId,
17
+ * const example = dnsimple.getCertificate({
18
+ * domain: "example.com",
19
+ * certificateId: 1234,
20
20
  * });
21
21
  * ```
22
22
  */
@@ -30,7 +30,7 @@ function getCertificate(args, opts) {
30
30
  }
31
31
  exports.getCertificate = getCertificate;
32
32
  /**
33
- * Provides a DNSimple certificate data source.
33
+ * Get information about a DNSimple SSL certificate.
34
34
  *
35
35
  * ## Example Usage
36
36
  *
@@ -38,9 +38,9 @@ exports.getCertificate = getCertificate;
38
38
  * import * as pulumi from "@pulumi/pulumi";
39
39
  * import * as dnsimple from "@pulumi/dnsimple";
40
40
  *
41
- * const foobar = dnsimple.getCertificate({
42
- * domain: dnsimpleDomain,
43
- * certificateId: dnsimpleCertificateId,
41
+ * const example = dnsimple.getCertificate({
42
+ * domain: "example.com",
43
+ * certificateId: 1234,
44
44
  * });
45
45
  * ```
46
46
  */
@@ -1 +1 @@
1
- {"version":3,"file":"getCertificate.js","sourceRoot":"","sources":["../getCertificate.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,yCAAyC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wCAOC;AA0CD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,oBAAoB,CAAC,IAA8B,EAAE,IAAiC;IAClG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,8CAA8C,EAAE;QAC/E,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,oDAOC"}
1
+ {"version":3,"file":"getCertificate.js","sourceRoot":"","sources":["../getCertificate.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,yCAAyC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wCAOC;AAgDD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,oBAAoB,CAAC,IAA8B,EAAE,IAAiC;IAClG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,8CAA8C,EAAE;QAC/E,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,oDAOC"}
@@ -5,48 +5,54 @@ import * as outputs from "./types/output";
5
5
  *
6
6
  * > **Note:** The registrant change API is currently in developer preview and is subject to change.
7
7
  *
8
- * Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
8
+ * ## Example Usage
9
+ *
10
+ * Get registrant change requirements for the `example.com` domain and the contact with ID `1234`:
9
11
  *
10
12
  * ```typescript
11
13
  * import * as pulumi from "@pulumi/pulumi";
12
14
  * import * as dnsimple from "@pulumi/dnsimple";
13
15
  *
14
16
  * const example = dnsimple.getRegistrantChangeCheck({
15
- * domainId: "dnsimple.com",
17
+ * domainId: "example.com",
16
18
  * contactId: "1234",
17
19
  * });
18
20
  * ```
19
- *
20
- * The following arguments are supported:
21
- *
22
- * * `domainId` - (Required) The name or ID of the domain.
23
- * * `contactId` - (Required) The ID of the contact you are planning to change to.
24
- *
25
- * The following additional attributes are exported:
26
- *
27
- * * `contactId` - The ID of the contact you are planning to change to.
28
- * * `domainId` - The name or ID of the domain.
29
- * * `extendedAttributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
30
- * * `registryOwnerChange` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
31
- *
32
- * <a id="nestedblock--extended_attributes"></a>
33
21
  */
34
22
  export declare function getRegistrantChangeCheck(args: GetRegistrantChangeCheckArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistrantChangeCheckResult>;
35
23
  /**
36
24
  * A collection of arguments for invoking getRegistrantChangeCheck.
37
25
  */
38
26
  export interface GetRegistrantChangeCheckArgs {
27
+ /**
28
+ * The ID of the contact you are planning to change to.
29
+ */
39
30
  contactId: string;
31
+ /**
32
+ * The name or ID of the domain.
33
+ */
40
34
  domainId: string;
41
35
  }
42
36
  /**
43
37
  * A collection of values returned by getRegistrantChangeCheck.
44
38
  */
45
39
  export interface GetRegistrantChangeCheckResult {
40
+ /**
41
+ * The ID of the contact you are planning to change to.
42
+ */
46
43
  readonly contactId: string;
44
+ /**
45
+ * The name or ID of the domain.
46
+ */
47
47
  readonly domainId: string;
48
+ /**
49
+ * (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
50
+ */
48
51
  readonly extendedAttributes: outputs.GetRegistrantChangeCheckExtendedAttribute[];
49
52
  readonly id: string;
53
+ /**
54
+ * (Boolean) Whether the registrant change is going to result in an owner change at the registry.
55
+ */
50
56
  readonly registryOwnerChange: boolean;
51
57
  }
52
58
  /**
@@ -54,37 +60,31 @@ export interface GetRegistrantChangeCheckResult {
54
60
  *
55
61
  * > **Note:** The registrant change API is currently in developer preview and is subject to change.
56
62
  *
57
- * Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
63
+ * ## Example Usage
64
+ *
65
+ * Get registrant change requirements for the `example.com` domain and the contact with ID `1234`:
58
66
  *
59
67
  * ```typescript
60
68
  * import * as pulumi from "@pulumi/pulumi";
61
69
  * import * as dnsimple from "@pulumi/dnsimple";
62
70
  *
63
71
  * const example = dnsimple.getRegistrantChangeCheck({
64
- * domainId: "dnsimple.com",
72
+ * domainId: "example.com",
65
73
  * contactId: "1234",
66
74
  * });
67
75
  * ```
68
- *
69
- * The following arguments are supported:
70
- *
71
- * * `domainId` - (Required) The name or ID of the domain.
72
- * * `contactId` - (Required) The ID of the contact you are planning to change to.
73
- *
74
- * The following additional attributes are exported:
75
- *
76
- * * `contactId` - The ID of the contact you are planning to change to.
77
- * * `domainId` - The name or ID of the domain.
78
- * * `extendedAttributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
79
- * * `registryOwnerChange` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
80
- *
81
- * <a id="nestedblock--extended_attributes"></a>
82
76
  */
83
77
  export declare function getRegistrantChangeCheckOutput(args: GetRegistrantChangeCheckOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegistrantChangeCheckResult>;
84
78
  /**
85
79
  * A collection of arguments for invoking getRegistrantChangeCheck.
86
80
  */
87
81
  export interface GetRegistrantChangeCheckOutputArgs {
82
+ /**
83
+ * The ID of the contact you are planning to change to.
84
+ */
88
85
  contactId: pulumi.Input<string>;
86
+ /**
87
+ * The name or ID of the domain.
88
+ */
89
89
  domainId: pulumi.Input<string>;
90
90
  }
@@ -10,31 +10,19 @@ const utilities = require("./utilities");
10
10
  *
11
11
  * > **Note:** The registrant change API is currently in developer preview and is subject to change.
12
12
  *
13
- * Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
13
+ * ## Example Usage
14
+ *
15
+ * Get registrant change requirements for the `example.com` domain and the contact with ID `1234`:
14
16
  *
15
17
  * ```typescript
16
18
  * import * as pulumi from "@pulumi/pulumi";
17
19
  * import * as dnsimple from "@pulumi/dnsimple";
18
20
  *
19
21
  * const example = dnsimple.getRegistrantChangeCheck({
20
- * domainId: "dnsimple.com",
22
+ * domainId: "example.com",
21
23
  * contactId: "1234",
22
24
  * });
23
25
  * ```
24
- *
25
- * The following arguments are supported:
26
- *
27
- * * `domainId` - (Required) The name or ID of the domain.
28
- * * `contactId` - (Required) The ID of the contact you are planning to change to.
29
- *
30
- * The following additional attributes are exported:
31
- *
32
- * * `contactId` - The ID of the contact you are planning to change to.
33
- * * `domainId` - The name or ID of the domain.
34
- * * `extendedAttributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
35
- * * `registryOwnerChange` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
36
- *
37
- * <a id="nestedblock--extended_attributes"></a>
38
26
  */
39
27
  function getRegistrantChangeCheck(args, opts) {
40
28
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -49,31 +37,19 @@ exports.getRegistrantChangeCheck = getRegistrantChangeCheck;
49
37
  *
50
38
  * > **Note:** The registrant change API is currently in developer preview and is subject to change.
51
39
  *
52
- * Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
40
+ * ## Example Usage
41
+ *
42
+ * Get registrant change requirements for the `example.com` domain and the contact with ID `1234`:
53
43
  *
54
44
  * ```typescript
55
45
  * import * as pulumi from "@pulumi/pulumi";
56
46
  * import * as dnsimple from "@pulumi/dnsimple";
57
47
  *
58
48
  * const example = dnsimple.getRegistrantChangeCheck({
59
- * domainId: "dnsimple.com",
49
+ * domainId: "example.com",
60
50
  * contactId: "1234",
61
51
  * });
62
52
  * ```
63
- *
64
- * The following arguments are supported:
65
- *
66
- * * `domainId` - (Required) The name or ID of the domain.
67
- * * `contactId` - (Required) The ID of the contact you are planning to change to.
68
- *
69
- * The following additional attributes are exported:
70
- *
71
- * * `contactId` - The ID of the contact you are planning to change to.
72
- * * `domainId` - The name or ID of the domain.
73
- * * `extendedAttributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
74
- * * `registryOwnerChange` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
75
- *
76
- * <a id="nestedblock--extended_attributes"></a>
77
53
  */
78
54
  function getRegistrantChangeCheckOutput(args, opts) {
79
55
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -1 +1 @@
1
- {"version":3,"file":"getRegistrantChangeCheck.js","sourceRoot":"","sources":["../getRegistrantChangeCheck.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,wBAAwB,CAAC,IAAkC,EAAE,IAA2B;IACpG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kEAAkE,EAAE;QAC7F,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4DAMC;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,8BAA8B,CAAC,IAAwC,EAAE,IAAiC;IACtH,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kEAAkE,EAAE;QACnG,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,wEAMC"}
1
+ {"version":3,"file":"getRegistrantChangeCheck.js","sourceRoot":"","sources":["../getRegistrantChangeCheck.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,wBAAwB,CAAC,IAAkC,EAAE,IAA2B;IACpG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kEAAkE,EAAE;QAC7F,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4DAMC;AAsCD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,8BAA8B,CAAC,IAAwC,EAAE,IAAiC;IACtH,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kEAAkE,EAAE;QACnG,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,wEAMC"}
package/getZone.d.ts CHANGED
@@ -1,24 +1,63 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
+ /**
3
+ * ## Example Usage
4
+ *
5
+ * ```typescript
6
+ * import * as pulumi from "@pulumi/pulumi";
7
+ * import * as dnsimple from "@pulumi/dnsimple";
8
+ *
9
+ * const example = dnsimple.getZone({
10
+ * name: "example.com",
11
+ * });
12
+ * ```
13
+ */
2
14
  export declare function getZone(args: GetZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneResult>;
3
15
  /**
4
16
  * A collection of arguments for invoking getZone.
5
17
  */
6
18
  export interface GetZoneArgs {
19
+ /**
20
+ * The name of the zone.
21
+ */
7
22
  name: string;
8
23
  }
9
24
  /**
10
25
  * A collection of values returned by getZone.
11
26
  */
12
27
  export interface GetZoneResult {
28
+ /**
29
+ * The account ID.
30
+ */
13
31
  readonly accountId: number;
32
+ /**
33
+ * The zone ID.
34
+ */
14
35
  readonly id: number;
15
36
  readonly name: string;
37
+ /**
38
+ * Whether the zone is a reverse zone (`true`) or forward zone (`false`).
39
+ */
16
40
  readonly reverse: boolean;
17
41
  }
42
+ /**
43
+ * ## Example Usage
44
+ *
45
+ * ```typescript
46
+ * import * as pulumi from "@pulumi/pulumi";
47
+ * import * as dnsimple from "@pulumi/dnsimple";
48
+ *
49
+ * const example = dnsimple.getZone({
50
+ * name: "example.com",
51
+ * });
52
+ * ```
53
+ */
18
54
  export declare function getZoneOutput(args: GetZoneOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetZoneResult>;
19
55
  /**
20
56
  * A collection of arguments for invoking getZone.
21
57
  */
22
58
  export interface GetZoneOutputArgs {
59
+ /**
60
+ * The name of the zone.
61
+ */
23
62
  name: pulumi.Input<string>;
24
63
  }
package/getZone.js CHANGED
@@ -5,6 +5,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.getZoneOutput = exports.getZone = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
+ /**
9
+ * ## Example Usage
10
+ *
11
+ * ```typescript
12
+ * import * as pulumi from "@pulumi/pulumi";
13
+ * import * as dnsimple from "@pulumi/dnsimple";
14
+ *
15
+ * const example = dnsimple.getZone({
16
+ * name: "example.com",
17
+ * });
18
+ * ```
19
+ */
8
20
  function getZone(args, opts) {
9
21
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
10
22
  return pulumi.runtime.invoke("dnsimple:index/getZone:getZone", {
@@ -12,6 +24,18 @@ function getZone(args, opts) {
12
24
  }, opts);
13
25
  }
14
26
  exports.getZone = getZone;
27
+ /**
28
+ * ## Example Usage
29
+ *
30
+ * ```typescript
31
+ * import * as pulumi from "@pulumi/pulumi";
32
+ * import * as dnsimple from "@pulumi/dnsimple";
33
+ *
34
+ * const example = dnsimple.getZone({
35
+ * name: "example.com",
36
+ * });
37
+ * ```
38
+ */
15
39
  function getZoneOutput(args, opts) {
16
40
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
17
41
  return pulumi.runtime.invokeOutput("dnsimple:index/getZone:getZone", {
package/getZone.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"getZone.js","sourceRoot":"","sources":["../getZone.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,OAAO,CAAC,IAAiB,EAAE,IAA2B;IAClE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,0BAKC;AAkBD,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAAiC;IACpF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,gCAAgC,EAAE;QACjE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,sCAKC"}
1
+ {"version":3,"file":"getZone.js","sourceRoot":"","sources":["../getZone.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;GAWG;AACH,SAAgB,OAAO,CAAC,IAAiB,EAAE,IAA2B;IAClE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,0BAKC;AA8BD;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAAiC;IACpF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,gCAAgC,EAAE;QACjE,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,sCAKC"}
@@ -8,16 +8,28 @@ import * as pulumi from "@pulumi/pulumi";
8
8
  * import * as pulumi from "@pulumi/pulumi";
9
9
  * import * as dnsimple from "@pulumi/dnsimple";
10
10
  *
11
- * const foobar = new dnsimple.LetsEncryptCertificate("foobar", {
12
- * domainId: dnsimple.domainId,
13
- * autoRenew: false,
11
+ * const example = new dnsimple.LetsEncryptCertificate("example", {
12
+ * domainId: "example.com",
14
13
  * name: "www",
14
+ * autoRenew: true,
15
15
  * alternateNames: [
16
16
  * "docs.example.com",
17
17
  * "status.example.com",
18
18
  * ],
19
19
  * });
20
20
  * ```
21
+ *
22
+ * ## Import
23
+ *
24
+ * DNSimple Let's Encrypt certificates can be imported using the domain name and certificate ID in the format `domain_name_certificate_id`.
25
+ *
26
+ * bash
27
+ *
28
+ * ```sh
29
+ * $ pulumi import dnsimple:index/letsEncryptCertificate:LetsEncryptCertificate example example.com_1234
30
+ * ```
31
+ *
32
+ * The certificate ID can be found via the [DNSimple Certificates API](https://developer.dnsimple.com/v2/certificates/#listCertificates).
21
33
  */
22
34
  export declare class LetsEncryptCertificate extends pulumi.CustomResource {
23
35
  /**
@@ -36,31 +48,31 @@ export declare class LetsEncryptCertificate extends pulumi.CustomResource {
36
48
  */
37
49
  static isInstance(obj: any): obj is LetsEncryptCertificate;
38
50
  /**
39
- * The certificate alternate names
51
+ * List of alternate names (SANs) for the certificate.
40
52
  */
41
53
  readonly alternateNames: pulumi.Output<string[] | undefined>;
42
54
  /**
43
- * The identifying certification authority (CA)
55
+ * The identifying certification authority (CA).
44
56
  */
45
57
  readonly authorityIdentifier: pulumi.Output<string>;
46
58
  /**
47
- * True if the certificate should auto-renew
59
+ * Whether the certificate should auto-renew.
48
60
  */
49
61
  readonly autoRenew: pulumi.Output<boolean>;
50
62
  /**
51
- * The datetime the certificate was created
63
+ * The datetime when the certificate was created.
52
64
  */
53
65
  readonly createdAt: pulumi.Output<string>;
54
66
  /**
55
- * The certificate signing request
67
+ * The certificate signing request.
56
68
  */
57
69
  readonly csr: pulumi.Output<string>;
58
70
  /**
59
- * The domain to be issued the certificate for
71
+ * The domain name or ID to issue the certificate for.
60
72
  */
61
73
  readonly domainId: pulumi.Output<string>;
62
74
  /**
63
- * The datetime the certificate will expire
75
+ * The datetime when the certificate will expire.
64
76
  */
65
77
  readonly expiresAt: pulumi.Output<string>;
66
78
  /**
@@ -68,19 +80,19 @@ export declare class LetsEncryptCertificate extends pulumi.CustomResource {
68
80
  */
69
81
  readonly name: pulumi.Output<string>;
70
82
  /**
71
- * The signature algorithm to use for the certificate
83
+ * The signature algorithm to use for the certificate.
72
84
  */
73
85
  readonly signatureAlgorithm: pulumi.Output<string | undefined>;
74
86
  /**
75
- * The state of the certificate
87
+ * The state of the certificate.
76
88
  */
77
89
  readonly state: pulumi.Output<string>;
78
90
  /**
79
- * The datetime the certificate was last updated
91
+ * The datetime when the certificate was last updated.
80
92
  */
81
93
  readonly updatedAt: pulumi.Output<string>;
82
94
  /**
83
- * The years the certificate will last
95
+ * The number of years the certificate will last.
84
96
  */
85
97
  readonly years: pulumi.Output<number>;
86
98
  /**
@@ -97,31 +109,31 @@ export declare class LetsEncryptCertificate extends pulumi.CustomResource {
97
109
  */
98
110
  export interface LetsEncryptCertificateState {
99
111
  /**
100
- * The certificate alternate names
112
+ * List of alternate names (SANs) for the certificate.
101
113
  */
102
114
  alternateNames?: pulumi.Input<pulumi.Input<string>[]>;
103
115
  /**
104
- * The identifying certification authority (CA)
116
+ * The identifying certification authority (CA).
105
117
  */
106
118
  authorityIdentifier?: pulumi.Input<string>;
107
119
  /**
108
- * True if the certificate should auto-renew
120
+ * Whether the certificate should auto-renew.
109
121
  */
110
122
  autoRenew?: pulumi.Input<boolean>;
111
123
  /**
112
- * The datetime the certificate was created
124
+ * The datetime when the certificate was created.
113
125
  */
114
126
  createdAt?: pulumi.Input<string>;
115
127
  /**
116
- * The certificate signing request
128
+ * The certificate signing request.
117
129
  */
118
130
  csr?: pulumi.Input<string>;
119
131
  /**
120
- * The domain to be issued the certificate for
132
+ * The domain name or ID to issue the certificate for.
121
133
  */
122
134
  domainId?: pulumi.Input<string>;
123
135
  /**
124
- * The datetime the certificate will expire
136
+ * The datetime when the certificate will expire.
125
137
  */
126
138
  expiresAt?: pulumi.Input<string>;
127
139
  /**
@@ -129,19 +141,19 @@ export interface LetsEncryptCertificateState {
129
141
  */
130
142
  name?: pulumi.Input<string>;
131
143
  /**
132
- * The signature algorithm to use for the certificate
144
+ * The signature algorithm to use for the certificate.
133
145
  */
134
146
  signatureAlgorithm?: pulumi.Input<string>;
135
147
  /**
136
- * The state of the certificate
148
+ * The state of the certificate.
137
149
  */
138
150
  state?: pulumi.Input<string>;
139
151
  /**
140
- * The datetime the certificate was last updated
152
+ * The datetime when the certificate was last updated.
141
153
  */
142
154
  updatedAt?: pulumi.Input<string>;
143
155
  /**
144
- * The years the certificate will last
156
+ * The number of years the certificate will last.
145
157
  */
146
158
  years?: pulumi.Input<number>;
147
159
  }
@@ -150,15 +162,15 @@ export interface LetsEncryptCertificateState {
150
162
  */
151
163
  export interface LetsEncryptCertificateArgs {
152
164
  /**
153
- * The certificate alternate names
165
+ * List of alternate names (SANs) for the certificate.
154
166
  */
155
167
  alternateNames?: pulumi.Input<pulumi.Input<string>[]>;
156
168
  /**
157
- * True if the certificate should auto-renew
169
+ * Whether the certificate should auto-renew.
158
170
  */
159
171
  autoRenew: pulumi.Input<boolean>;
160
172
  /**
161
- * The domain to be issued the certificate for
173
+ * The domain name or ID to issue the certificate for.
162
174
  */
163
175
  domainId: pulumi.Input<string>;
164
176
  /**
@@ -166,7 +178,7 @@ export interface LetsEncryptCertificateArgs {
166
178
  */
167
179
  name: pulumi.Input<string>;
168
180
  /**
169
- * The signature algorithm to use for the certificate
181
+ * The signature algorithm to use for the certificate.
170
182
  */
171
183
  signatureAlgorithm?: pulumi.Input<string>;
172
184
  }