@pulumi/external 0.0.17 → 0.0.18

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 (4) hide show
  1. package/getExternal.d.ts +43 -0
  2. package/getExternal.js +34 -0
  3. package/getExternal.js.map +1 -1
  4. package/package.json +2 -2
package/getExternal.d.ts CHANGED
@@ -1,9 +1,29 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
+ /**
3
+ * The `external.getExternal` data source allows an external program implementing a specific protocol (defined below) to act as a data source, exposing arbitrary data for use elsewhere in the Terraform configuration.
4
+ *
5
+ * **Warning** This mechanism is provided as an "escape hatch" for exceptional situations where a first-class Terraform provider is not more appropriate. Its capabilities are limited in comparison to a true data source, and implementing a data source via an external program is likely to hurt the portability of your Terraform configuration by creating dependencies on external programs and libraries that may not be available (or may need to be used differently) on different operating systems.
6
+ *
7
+ * **Warning** Terraform Enterprise does not guarantee availability of any particular language runtimes or external programs beyond standard shell utilities, so it is not recommended to use this data source within configurations that are applied within Terraform Enterprise.
8
+ *
9
+ * ## Processing JSON in shell scripts
10
+ *
11
+ * Since the external data source protocol uses JSON, it is recommended to use
12
+ * the utility [`jq`](https://stedolan.github.io/jq/) to translate to and from
13
+ * JSON in a robust way when implementing a data source in a shell scripting
14
+ * language.
15
+ *
16
+ * The following example shows some input/output boilerplate code for a
17
+ * data source implemented in bash:
18
+ */
2
19
  export declare function getExternal(args: GetExternalArgs, opts?: pulumi.InvokeOptions): Promise<GetExternalResult>;
3
20
  /**
4
21
  * A collection of arguments for invoking getExternal.
5
22
  */
6
23
  export interface GetExternalArgs {
24
+ /**
25
+ * A list of strings, whose first element is the program to run and whose subsequent elements are optional command line arguments to the program. Terraform does not execute the program through a shell, so it is not necessary to escape shell metacharacters nor add quotes around arguments containing spaces.
26
+ */
7
27
  programs: string[];
8
28
  /**
9
29
  * A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.
@@ -24,6 +44,9 @@ export interface GetExternalResult {
24
44
  * The id of the data source. This will always be set to `-`
25
45
  */
26
46
  readonly id: string;
47
+ /**
48
+ * A list of strings, whose first element is the program to run and whose subsequent elements are optional command line arguments to the program. Terraform does not execute the program through a shell, so it is not necessary to escape shell metacharacters nor add quotes around arguments containing spaces.
49
+ */
27
50
  readonly programs: string[];
28
51
  /**
29
52
  * A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.
@@ -42,11 +65,31 @@ export interface GetExternalResult {
42
65
  */
43
66
  readonly workingDir?: string;
44
67
  }
68
+ /**
69
+ * The `external.getExternal` data source allows an external program implementing a specific protocol (defined below) to act as a data source, exposing arbitrary data for use elsewhere in the Terraform configuration.
70
+ *
71
+ * **Warning** This mechanism is provided as an "escape hatch" for exceptional situations where a first-class Terraform provider is not more appropriate. Its capabilities are limited in comparison to a true data source, and implementing a data source via an external program is likely to hurt the portability of your Terraform configuration by creating dependencies on external programs and libraries that may not be available (or may need to be used differently) on different operating systems.
72
+ *
73
+ * **Warning** Terraform Enterprise does not guarantee availability of any particular language runtimes or external programs beyond standard shell utilities, so it is not recommended to use this data source within configurations that are applied within Terraform Enterprise.
74
+ *
75
+ * ## Processing JSON in shell scripts
76
+ *
77
+ * Since the external data source protocol uses JSON, it is recommended to use
78
+ * the utility [`jq`](https://stedolan.github.io/jq/) to translate to and from
79
+ * JSON in a robust way when implementing a data source in a shell scripting
80
+ * language.
81
+ *
82
+ * The following example shows some input/output boilerplate code for a
83
+ * data source implemented in bash:
84
+ */
45
85
  export declare function getExternalOutput(args: GetExternalOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExternalResult>;
46
86
  /**
47
87
  * A collection of arguments for invoking getExternal.
48
88
  */
49
89
  export interface GetExternalOutputArgs {
90
+ /**
91
+ * A list of strings, whose first element is the program to run and whose subsequent elements are optional command line arguments to the program. Terraform does not execute the program through a shell, so it is not necessary to escape shell metacharacters nor add quotes around arguments containing spaces.
92
+ */
50
93
  programs: pulumi.Input<pulumi.Input<string>[]>;
51
94
  /**
52
95
  * A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.
package/getExternal.js CHANGED
@@ -5,6 +5,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.getExternalOutput = exports.getExternal = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
+ /**
9
+ * The `external.getExternal` data source allows an external program implementing a specific protocol (defined below) to act as a data source, exposing arbitrary data for use elsewhere in the Terraform configuration.
10
+ *
11
+ * **Warning** This mechanism is provided as an "escape hatch" for exceptional situations where a first-class Terraform provider is not more appropriate. Its capabilities are limited in comparison to a true data source, and implementing a data source via an external program is likely to hurt the portability of your Terraform configuration by creating dependencies on external programs and libraries that may not be available (or may need to be used differently) on different operating systems.
12
+ *
13
+ * **Warning** Terraform Enterprise does not guarantee availability of any particular language runtimes or external programs beyond standard shell utilities, so it is not recommended to use this data source within configurations that are applied within Terraform Enterprise.
14
+ *
15
+ * ## Processing JSON in shell scripts
16
+ *
17
+ * Since the external data source protocol uses JSON, it is recommended to use
18
+ * the utility [`jq`](https://stedolan.github.io/jq/) to translate to and from
19
+ * JSON in a robust way when implementing a data source in a shell scripting
20
+ * language.
21
+ *
22
+ * The following example shows some input/output boilerplate code for a
23
+ * data source implemented in bash:
24
+ */
8
25
  function getExternal(args, opts) {
9
26
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
10
27
  return pulumi.runtime.invoke("external:index/getExternal:getExternal", {
@@ -14,6 +31,23 @@ function getExternal(args, opts) {
14
31
  }, opts);
15
32
  }
16
33
  exports.getExternal = getExternal;
34
+ /**
35
+ * The `external.getExternal` data source allows an external program implementing a specific protocol (defined below) to act as a data source, exposing arbitrary data for use elsewhere in the Terraform configuration.
36
+ *
37
+ * **Warning** This mechanism is provided as an "escape hatch" for exceptional situations where a first-class Terraform provider is not more appropriate. Its capabilities are limited in comparison to a true data source, and implementing a data source via an external program is likely to hurt the portability of your Terraform configuration by creating dependencies on external programs and libraries that may not be available (or may need to be used differently) on different operating systems.
38
+ *
39
+ * **Warning** Terraform Enterprise does not guarantee availability of any particular language runtimes or external programs beyond standard shell utilities, so it is not recommended to use this data source within configurations that are applied within Terraform Enterprise.
40
+ *
41
+ * ## Processing JSON in shell scripts
42
+ *
43
+ * Since the external data source protocol uses JSON, it is recommended to use
44
+ * the utility [`jq`](https://stedolan.github.io/jq/) to translate to and from
45
+ * JSON in a robust way when implementing a data source in a shell scripting
46
+ * language.
47
+ *
48
+ * The following example shows some input/output boilerplate code for a
49
+ * data source implemented in bash:
50
+ */
17
51
  function getExternalOutput(args, opts) {
18
52
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
19
53
  return pulumi.runtime.invokeOutput("external:index/getExternal:getExternal", {
package/getExternal.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"getExternal.js","sourceRoot":"","sources":["../getExternal.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,WAAW,CAAC,IAAqB,EAAE,IAA2B;IAC1E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wCAAwC,EAAE;QACnE,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,kCAOC;AAuCD,SAAgB,iBAAiB,CAAC,IAA2B,EAAE,IAAiC;IAC5F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,wCAAwC,EAAE;QACzE,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,8CAOC"}
1
+ {"version":3,"file":"getExternal.js","sourceRoot":"","sources":["../getExternal.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,WAAW,CAAC,IAAqB,EAAE,IAA2B;IAC1E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wCAAwC,EAAE;QACnE,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,kCAOC;AA6CD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAAC,IAA2B,EAAE,IAAiC;IAC5F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,wCAAwC,EAAE;QACzE,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI,CAAC,UAAU;KAChC,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,8CAOC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/external",
3
- "version": "0.0.17",
3
+ "version": "0.0.18",
4
4
  "description": "A Pulumi package for creating and managing External cloud resources.",
5
5
  "keywords": [
6
6
  "pulumi",
@@ -22,6 +22,6 @@
22
22
  "pulumi": {
23
23
  "resource": true,
24
24
  "name": "external",
25
- "version": "0.0.17"
25
+ "version": "0.0.18"
26
26
  }
27
27
  }