@pulumi/terraform 6.0.0 → 6.1.0-alpha.1745017390
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.
- package/README.md +5 -99
- package/package.json +3 -3
- package/package.json.dev +2 -2
package/README.md
CHANGED
|
@@ -1,102 +1,8 @@
|
|
|
1
1
|
# Pulumi Terraform Provider
|
|
2
2
|
|
|
3
|
-
The Terraform resource provider for Pulumi lets you consume the outputs
|
|
4
|
-
|
|
5
|
-
provides a `RemoteStateReference` resource which acts like a native Pulumi
|
|
6
|
-
[`StackReference`][stackreference].
|
|
7
|
-
|
|
8
|
-
To use this package, please [install the Pulumi CLI first][pulumicli].
|
|
9
|
-
|
|
10
|
-
## Installing
|
|
11
|
-
|
|
12
|
-
### Node.js (JavaScript/TypeScript)
|
|
13
|
-
|
|
14
|
-
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
|
|
15
|
-
|
|
16
|
-
$ npm install @pulumi/terraform
|
|
17
|
-
|
|
18
|
-
or `yarn`:
|
|
19
|
-
|
|
20
|
-
$ yarn add @pulumi/terraform
|
|
21
|
-
|
|
22
|
-
### Python
|
|
23
|
-
|
|
24
|
-
To use from Python, install using `pip`:
|
|
25
|
-
|
|
26
|
-
$ pip install pulumi-terraform
|
|
27
|
-
|
|
28
|
-
## Concepts
|
|
29
|
-
|
|
30
|
-
The `@pulumi/terraform` package provides a [resource](https://www.pulumi.com/docs/concepts/resources/) named `RemoteStateReference`
|
|
31
|
-
which is used to read outputs from a Terraform state file stored in one of the supported
|
|
32
|
-
Terraform remote state backends.
|
|
33
|
-
|
|
34
|
-
## Examples
|
|
35
|
-
|
|
36
|
-
### S3
|
|
37
|
-
|
|
38
|
-
The following program will read a Terraform state file stored in S3:
|
|
39
|
-
|
|
40
|
-
```typescript
|
|
41
|
-
import * as tf from "@pulumi/terraform";
|
|
42
|
-
|
|
43
|
-
const remoteState = new tf.state.RemoteStateReference("s3state", {
|
|
44
|
-
backendType: "s3",
|
|
45
|
-
bucket: "pulumi-terraform-state-test",
|
|
46
|
-
key: "test/terraform.tfstate",
|
|
47
|
-
region: "us-west-2"
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
// Use the getOutput function on the resource to access root outputs
|
|
51
|
-
const vpcId= remoteState.getOutput("vpc_id");
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Local file
|
|
55
|
-
|
|
56
|
-
The following program will read a Terraform state file stored locally in the
|
|
57
|
-
filesystem:
|
|
58
|
-
|
|
59
|
-
```typescript
|
|
60
|
-
import * as tf from "@pulumi/terraform";
|
|
61
|
-
|
|
62
|
-
const remotestate = new tf.state.RemoteStateReference("localstate", {
|
|
63
|
-
backendType: "local",
|
|
64
|
-
path: path.join(__dirname, "terraform.tfstate"),
|
|
65
|
-
});
|
|
66
|
-
|
|
67
|
-
// Use the getOutput function on the resource to access root outputs
|
|
68
|
-
const vpcId= remoteState.getOutput("vpc_id");
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Terraform Enterprise
|
|
72
|
-
|
|
73
|
-
For state stored in Terraform Enterprise, the authentication token must be set
|
|
74
|
-
via the Pulumi configuration system - for example, using:
|
|
75
|
-
|
|
76
|
-
pulumi config set --secret terraformEnterpriseToken <value>
|
|
77
|
-
|
|
78
|
-
The following program will read a Terraform state file stored in Terraform
|
|
79
|
-
Enterprise, using the value of `terraformEnterpriseToken` from above:
|
|
80
|
-
|
|
81
|
-
```typescript
|
|
82
|
-
import * as pulumi from "@pulumi/pulumi";
|
|
83
|
-
import * as tf from "@pulumi/terraform";
|
|
84
|
-
|
|
85
|
-
const config = new pulumi.Config();
|
|
86
|
-
|
|
87
|
-
const ref = new tf.state.RemoteStateReference("remote", {
|
|
88
|
-
backendType: "remote",
|
|
89
|
-
organization: "pulumi",
|
|
90
|
-
token: config.requireSecret("terraformEnterpriseToken"),
|
|
91
|
-
workspaces: {
|
|
92
|
-
name: "test-state-file"
|
|
93
|
-
}
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
// Use the getOutput function on the resource to access root outputs
|
|
97
|
-
const vpcId= remoteState.getOutput("vpc_id");
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
[stackreference]: https://www.pulumi.com/docs/reference/organizing-stacks-projects/#inter-stack-dependencies
|
|
101
|
-
[pulumicli]: https://pulumi.com/
|
|
3
|
+
The Terraform resource provider for Pulumi lets you consume the outputs contained in
|
|
4
|
+
Terraform state files from your Pulumi programs.
|
|
102
5
|
|
|
6
|
+
> [!IMPORTANT]
|
|
7
|
+
> For reference docs and installation instructions, please go to
|
|
8
|
+
> <https://www.pulumi.com/registry/packages/terraform/>.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pulumi/terraform",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.1.0-alpha.1745017390",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"terraform",
|
|
6
6
|
"kind/native",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"license": "Apache-2.0",
|
|
12
12
|
"scripts": {
|
|
13
13
|
"build": "tsc",
|
|
14
|
-
"install": "node scripts/install-pulumi-plugin.js resource terraform 6.0.
|
|
14
|
+
"install": "node scripts/install-pulumi-plugin.js resource terraform 6.1.0-alpha.1745017390"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@pulumi/pulumi": "^3.142.0"
|
|
@@ -23,6 +23,6 @@
|
|
|
23
23
|
"pulumi": {
|
|
24
24
|
"resource": true,
|
|
25
25
|
"name": "terraform",
|
|
26
|
-
"version": "6.0.
|
|
26
|
+
"version": "6.1.0-alpha.1745017390"
|
|
27
27
|
}
|
|
28
28
|
}
|
package/package.json.dev
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pulumi/terraform",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.1.0-alpha.1745017390",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"terraform",
|
|
6
6
|
"kind/native",
|
|
@@ -22,6 +22,6 @@
|
|
|
22
22
|
"pulumi": {
|
|
23
23
|
"resource": true,
|
|
24
24
|
"name": "terraform",
|
|
25
|
-
"version": "6.0.
|
|
25
|
+
"version": "6.1.0-alpha.1745017390"
|
|
26
26
|
}
|
|
27
27
|
}
|