diff --git a/.ci-mgmt.yaml b/.ci-mgmt.yaml index 0c0ce4d..d84e921 100644 --- a/.ci-mgmt.yaml +++ b/.ci-mgmt.yaml @@ -5,3 +5,8 @@ makeTemplate: bridged publishRegistry: false env: ARCHIVE_TOKEN: ${{ secrets.ARCHIVE_TOKEN }} +pulumiConvert: 1 +plugins: + - name: terraform + version: "1.0.16" + kind: converter diff --git a/Makefile b/Makefile index c25a871..768f1e5 100644 --- a/Makefile +++ b/Makefile @@ -11,7 +11,7 @@ VERSION := $(shell pulumictl get version) JAVA_GEN := pulumi-java-gen TESTPARALLELISM := 10 WORKING_DIR := $(shell pwd) -PULUMI_CONVERT := 0 +PULUMI_CONVERT := 1 development: install_plugins provider build_sdks install_sdks @@ -111,6 +111,7 @@ install_nodejs_sdk: install_plugins: export PULUMI_HOME := $(WORKING_DIR)/.pulumi install_plugins: export PATH := $(WORKING_DIR)/.pulumi/bin:$(PATH) install_plugins: .pulumi/bin/pulumi + .pulumi/bin/pulumi plugin install converter terraform 1.0.16 lint_provider: provider cd provider && golangci-lint run -c ../.golangci.yml diff --git a/provider/cmd/pulumi-resource-archive/schema.json b/provider/cmd/pulumi-resource-archive/schema.json index 67e5d97..0770a84 100644 --- a/provider/cmd/pulumi-resource-archive/schema.json +++ b/provider/cmd/pulumi-resource-archive/schema.json @@ -315,7 +315,7 @@ }, "functions": { "archive:index/getFile:getFile": { - "description": "Generates an archive from content, a file, or directory of files.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as archive from \"@pulumi/archive\";\n\nconst init = archive.getFile({\n outputPath: `${path.module}/files/init.zip`,\n sourceFile: `${path.module}/init.tpl`,\n type: \"zip\",\n});\n```\n```python\nimport pulumi\nimport pulumi_archive as archive\n\ninit = archive.get_file(output_path=f\"{path['module']}/files/init.zip\",\n source_file=f\"{path['module']}/init.tpl\",\n type=\"zip\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Archive = Pulumi.Archive;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var init = Archive.GetFile.Invoke(new()\n {\n OutputPath = $\"{path.Module}/files/init.zip\",\n SourceFile = $\"{path.Module}/init.tpl\",\n Type = \"zip\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-archive/sdk/go/archive\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := archive.LookupFile(ctx, \u0026archive.LookupFileArgs{\n\t\t\tOutputPath: fmt.Sprintf(\"%v/files/init.zip\", path.Module),\n\t\t\tSourceFile: pulumi.StringRef(fmt.Sprintf(\"%v/init.tpl\", path.Module)),\n\t\t\tType: \"zip\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.archive.ArchiveFunctions;\nimport com.pulumi.archive.inputs.GetFileArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var init = ArchiveFunctions.getFile(GetFileArgs.builder()\n .outputPath(String.format(\"%s/files/init.zip\", path.module()))\n .sourceFile(String.format(\"%s/init.tpl\", path.module()))\n .type(\"zip\")\n .build());\n\n }\n}\n```\n```yaml\nvariables:\n init:\n fn::invoke:\n Function: archive:getFile\n Arguments:\n outputPath: ${path.module}/files/init.zip\n sourceFile: ${path.module}/init.tpl\n type: zip\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as archive from \"@pulumi/archive\";\n\nconst dotfiles = archive.getFile({\n type: \"zip\",\n outputPath: `${path.module}/files/dotfiles.zip`,\n excludes: [`${path.module}/unwanted.zip`],\n sources: [\n {\n content: data.template_file.vimrc.rendered,\n filename: \".vimrc\",\n },\n {\n content: data.template_file.ssh_config.rendered,\n filename: \".ssh/config\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_archive as archive\n\ndotfiles = archive.get_file(type=\"zip\",\n output_path=f\"{path['module']}/files/dotfiles.zip\",\n excludes=[f\"{path['module']}/unwanted.zip\"],\n sources=[\n archive.GetFileSourceArgs(\n content=data[\"template_file\"][\"vimrc\"][\"rendered\"],\n filename=\".vimrc\",\n ),\n archive.GetFileSourceArgs(\n content=data[\"template_file\"][\"ssh_config\"][\"rendered\"],\n filename=\".ssh/config\",\n ),\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Archive = Pulumi.Archive;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var dotfiles = Archive.GetFile.Invoke(new()\n {\n Type = \"zip\",\n OutputPath = $\"{path.Module}/files/dotfiles.zip\",\n Excludes = new[]\n {\n $\"{path.Module}/unwanted.zip\",\n },\n Sources = new[]\n {\n new Archive.Inputs.GetFileSourceInputArgs\n {\n Content = data.Template_file.Vimrc.Rendered,\n Filename = \".vimrc\",\n },\n new Archive.Inputs.GetFileSourceInputArgs\n {\n Content = data.Template_file.Ssh_config.Rendered,\n Filename = \".ssh/config\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-archive/sdk/go/archive\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := archive.LookupFile(ctx, \u0026archive.LookupFileArgs{\n\t\t\tType: \"zip\",\n\t\t\tOutputPath: fmt.Sprintf(\"%v/files/dotfiles.zip\", path.Module),\n\t\t\tExcludes: []string{\n\t\t\t\tfmt.Sprintf(\"%v/unwanted.zip\", path.Module),\n\t\t\t},\n\t\t\tSources: []archive.GetFileSource{\n\t\t\t\t{\n\t\t\t\t\tContent: data.Template_file.Vimrc.Rendered,\n\t\t\t\t\tFilename: \".vimrc\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContent: data.Template_file.Ssh_config.Rendered,\n\t\t\t\t\tFilename: \".ssh/config\",\n\t\t\t\t},\n\t\t\t},\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.archive.ArchiveFunctions;\nimport com.pulumi.archive.inputs.GetFileArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var dotfiles = ArchiveFunctions.getFile(GetFileArgs.builder()\n .type(\"zip\")\n .outputPath(String.format(\"%s/files/dotfiles.zip\", path.module()))\n .excludes(String.format(\"%s/unwanted.zip\", path.module()))\n .sources( \n GetFileSourceArgs.builder()\n .content(data.template_file().vimrc().rendered())\n .filename(\".vimrc\")\n .build(),\n GetFileSourceArgs.builder()\n .content(data.template_file().ssh_config().rendered())\n .filename(\".ssh/config\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nvariables:\n dotfiles:\n fn::invoke:\n Function: archive:getFile\n Arguments:\n type: zip\n outputPath: ${path.module}/files/dotfiles.zip\n excludes:\n - ${path.module}/unwanted.zip\n sources:\n - content: ${data.template_file.vimrc.rendered}\n filename: .vimrc\n - content: ${data.template_file.ssh_config.rendered}\n filename: .ssh/config\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as archive from \"@pulumi/archive\";\n\nconst lambdaMyFunction = archive.getFile({\n outputFileMode: \"0666\",\n outputPath: `${path.module}/files/lambda-my-function.js.zip`,\n sourceFile: `${path.module}/../lambda/my-function/index.js`,\n type: \"zip\",\n});\n```\n```python\nimport pulumi\nimport pulumi_archive as archive\n\nlambda_my_function = archive.get_file(output_file_mode=\"0666\",\n output_path=f\"{path['module']}/files/lambda-my-function.js.zip\",\n source_file=f\"{path['module']}/../lambda/my-function/index.js\",\n type=\"zip\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Archive = Pulumi.Archive;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var lambdaMyFunction = Archive.GetFile.Invoke(new()\n {\n OutputFileMode = \"0666\",\n OutputPath = $\"{path.Module}/files/lambda-my-function.js.zip\",\n SourceFile = $\"{path.Module}/../lambda/my-function/index.js\",\n Type = \"zip\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-archive/sdk/go/archive\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := archive.LookupFile(ctx, \u0026archive.LookupFileArgs{\n\t\t\tOutputFileMode: pulumi.StringRef(\"0666\"),\n\t\t\tOutputPath: fmt.Sprintf(\"%v/files/lambda-my-function.js.zip\", path.Module),\n\t\t\tSourceFile: pulumi.StringRef(fmt.Sprintf(\"%v/../lambda/my-function/index.js\", path.Module)),\n\t\t\tType: \"zip\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.archive.ArchiveFunctions;\nimport com.pulumi.archive.inputs.GetFileArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var lambdaMyFunction = ArchiveFunctions.getFile(GetFileArgs.builder()\n .outputFileMode(\"0666\")\n .outputPath(String.format(\"%s/files/lambda-my-function.js.zip\", path.module()))\n .sourceFile(String.format(\"%s/../lambda/my-function/index.js\", path.module()))\n .type(\"zip\")\n .build());\n\n }\n}\n```\n```yaml\nvariables:\n lambdaMyFunction:\n fn::invoke:\n Function: archive:getFile\n Arguments:\n outputFileMode: '0666'\n outputPath: ${path.module}/files/lambda-my-function.js.zip\n sourceFile: ${path.module}/../lambda/my-function/index.js\n type: zip\n```\n\u003c!--End PulumiCodeChooser --\u003e\n", + "description": "Generates an archive from content, a file, or directory of files.\n\n", "inputs": { "description": "A collection of arguments for invoking getFile.\n", "properties": { @@ -376,85 +376,84 @@ "description": "A collection of values returned by getFile.\n", "properties": { "excludeSymlinkDirectories": { - "type": "boolean", - "description": "Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.\n" + "description": "Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.\n", + "type": "boolean" }, "excludes": { - "type": "array", + "description": "Specify files to ignore when reading the `source_dir`.\n", "items": { "type": "string" }, - "description": "Specify files to ignore when reading the `source_dir`.\n" + "type": "array" }, "id": { - "type": "string", - "description": "The sha1 checksum hash of the output.\n" + "description": "The sha1 checksum hash of the output.\n", + "type": "string" }, "outputBase64sha256": { - "type": "string", - "description": "Base64 Encoded SHA256 checksum of output file\n" + "description": "Base64 Encoded SHA256 checksum of output file\n", + "type": "string" }, "outputBase64sha512": { - "type": "string", - "description": "Base64 Encoded SHA512 checksum of output file\n" + "description": "Base64 Encoded SHA512 checksum of output file\n", + "type": "string" }, "outputFileMode": { - "type": "string", - "description": "String that specifies the octal file mode for all archived files. For example: `\"0666\"`. Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior.\n" + "description": "String that specifies the octal file mode for all archived files. For example: `\"0666\"`. Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior.\n", + "type": "string" }, "outputMd5": { - "type": "string", - "description": "MD5 of output file\n" + "description": "MD5 of output file\n", + "type": "string" }, "outputPath": { - "type": "string", - "description": "The output of the archive file.\n" + "description": "The output of the archive file.\n", + "type": "string" }, "outputSha": { - "type": "string", - "description": "SHA1 checksum of output file\n" + "description": "SHA1 checksum of output file\n", + "type": "string" }, "outputSha256": { - "type": "string", - "description": "SHA256 checksum of output file\n" + "description": "SHA256 checksum of output file\n", + "type": "string" }, "outputSha512": { - "type": "string", - "description": "SHA512 checksum of output file\n" + "description": "SHA512 checksum of output file\n", + "type": "string" }, "outputSize": { - "type": "integer", - "description": "The byte size of the output archive file.\n" + "description": "The byte size of the output archive file.\n", + "type": "integer" }, "sourceContent": { - "type": "string", - "description": "Add only this content to the archive with `source_content_filename` as the filename. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n" + "description": "Add only this content to the archive with `source_content_filename` as the filename. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n", + "type": "string" }, "sourceContentFilename": { - "type": "string", - "description": "Set this as the filename when using `source_content`. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n" + "description": "Set this as the filename when using `source_content`. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n", + "type": "string" }, "sourceDir": { - "type": "string", - "description": "Package entire contents of this directory into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n" + "description": "Package entire contents of this directory into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n", + "type": "string" }, "sourceFile": { - "type": "string", - "description": "Package this file into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n" + "description": "Package this file into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n", + "type": "string" }, "sources": { - "type": "array", + "description": "Specifies attributes of a single source file to include into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n", "items": { "$ref": "#/types/archive:index/getFileSource:getFileSource" }, - "description": "Specifies attributes of a single source file to include into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.\n" + "type": "array" }, "type": { - "type": "string", - "description": "The type of archive to generate. NOTE: `zip` is supported.\n" + "description": "The type of archive to generate. NOTE: `zip` is supported.\n", + "type": "string" } }, - "type": "object", "required": [ "id", "outputBase64sha256", @@ -466,7 +465,8 @@ "outputSha512", "outputSize", "type" - ] + ], + "type": "object" } } } diff --git a/sdk/dotnet/GetFile.cs b/sdk/dotnet/GetFile.cs index 3c2c373..5c6561c 100644 --- a/sdk/dotnet/GetFile.cs +++ b/sdk/dotnet/GetFile.cs @@ -13,170 +13,12 @@ public static class GetFile { /// /// Generates an archive from content, a file, or directory of files. - /// - /// ## Example Usage - /// - /// <!--Start PulumiCodeChooser --> - /// ```csharp - /// using System.Collections.Generic; - /// using System.Linq; - /// using Pulumi; - /// using Archive = Pulumi.Archive; - /// - /// return await Deployment.RunAsync(() => - /// { - /// var init = Archive.GetFile.Invoke(new() - /// { - /// OutputPath = $"{path.Module}/files/init.zip", - /// SourceFile = $"{path.Module}/init.tpl", - /// Type = "zip", - /// }); - /// - /// }); - /// ``` - /// <!--End PulumiCodeChooser --> - /// - /// <!--Start PulumiCodeChooser --> - /// ```csharp - /// using System.Collections.Generic; - /// using System.Linq; - /// using Pulumi; - /// using Archive = Pulumi.Archive; - /// - /// return await Deployment.RunAsync(() => - /// { - /// var dotfiles = Archive.GetFile.Invoke(new() - /// { - /// Type = "zip", - /// OutputPath = $"{path.Module}/files/dotfiles.zip", - /// Excludes = new[] - /// { - /// $"{path.Module}/unwanted.zip", - /// }, - /// Sources = new[] - /// { - /// new Archive.Inputs.GetFileSourceInputArgs - /// { - /// Content = data.Template_file.Vimrc.Rendered, - /// Filename = ".vimrc", - /// }, - /// new Archive.Inputs.GetFileSourceInputArgs - /// { - /// Content = data.Template_file.Ssh_config.Rendered, - /// Filename = ".ssh/config", - /// }, - /// }, - /// }); - /// - /// }); - /// ``` - /// <!--End PulumiCodeChooser --> - /// - /// <!--Start PulumiCodeChooser --> - /// ```csharp - /// using System.Collections.Generic; - /// using System.Linq; - /// using Pulumi; - /// using Archive = Pulumi.Archive; - /// - /// return await Deployment.RunAsync(() => - /// { - /// var lambdaMyFunction = Archive.GetFile.Invoke(new() - /// { - /// OutputFileMode = "0666", - /// OutputPath = $"{path.Module}/files/lambda-my-function.js.zip", - /// SourceFile = $"{path.Module}/../lambda/my-function/index.js", - /// Type = "zip", - /// }); - /// - /// }); - /// ``` - /// <!--End PulumiCodeChooser --> /// public static Task InvokeAsync(GetFileArgs args, InvokeOptions? options = null) => global::Pulumi.Deployment.Instance.InvokeAsync("archive:index/getFile:getFile", args ?? new GetFileArgs(), options.WithDefaults()); /// /// Generates an archive from content, a file, or directory of files. - /// - /// ## Example Usage - /// - /// <!--Start PulumiCodeChooser --> - /// ```csharp - /// using System.Collections.Generic; - /// using System.Linq; - /// using Pulumi; - /// using Archive = Pulumi.Archive; - /// - /// return await Deployment.RunAsync(() => - /// { - /// var init = Archive.GetFile.Invoke(new() - /// { - /// OutputPath = $"{path.Module}/files/init.zip", - /// SourceFile = $"{path.Module}/init.tpl", - /// Type = "zip", - /// }); - /// - /// }); - /// ``` - /// <!--End PulumiCodeChooser --> - /// - /// <!--Start PulumiCodeChooser --> - /// ```csharp - /// using System.Collections.Generic; - /// using System.Linq; - /// using Pulumi; - /// using Archive = Pulumi.Archive; - /// - /// return await Deployment.RunAsync(() => - /// { - /// var dotfiles = Archive.GetFile.Invoke(new() - /// { - /// Type = "zip", - /// OutputPath = $"{path.Module}/files/dotfiles.zip", - /// Excludes = new[] - /// { - /// $"{path.Module}/unwanted.zip", - /// }, - /// Sources = new[] - /// { - /// new Archive.Inputs.GetFileSourceInputArgs - /// { - /// Content = data.Template_file.Vimrc.Rendered, - /// Filename = ".vimrc", - /// }, - /// new Archive.Inputs.GetFileSourceInputArgs - /// { - /// Content = data.Template_file.Ssh_config.Rendered, - /// Filename = ".ssh/config", - /// }, - /// }, - /// }); - /// - /// }); - /// ``` - /// <!--End PulumiCodeChooser --> - /// - /// <!--Start PulumiCodeChooser --> - /// ```csharp - /// using System.Collections.Generic; - /// using System.Linq; - /// using Pulumi; - /// using Archive = Pulumi.Archive; - /// - /// return await Deployment.RunAsync(() => - /// { - /// var lambdaMyFunction = Archive.GetFile.Invoke(new() - /// { - /// OutputFileMode = "0666", - /// OutputPath = $"{path.Module}/files/lambda-my-function.js.zip", - /// SourceFile = $"{path.Module}/../lambda/my-function/index.js", - /// Type = "zip", - /// }); - /// - /// }); - /// ``` - /// <!--End PulumiCodeChooser --> /// public static Output Invoke(GetFileInvokeArgs args, InvokeOptions? options = null) => global::Pulumi.Deployment.Instance.Invoke("archive:index/getFile:getFile", args ?? new GetFileInvokeArgs(), options.WithDefaults()); diff --git a/sdk/go/archive/getFile.go b/sdk/go/archive/getFile.go index fa8cecf..cdf14bf 100644 --- a/sdk/go/archive/getFile.go +++ b/sdk/go/archive/getFile.go @@ -12,111 +12,6 @@ import ( ) // Generates an archive from content, a file, or directory of files. -// -// ## Example Usage -// -// -// ```go -// package main -// -// import ( -// -// "fmt" -// -// "github.com/pulumi/pulumi-archive/sdk/go/archive" -// "github.com/pulumi/pulumi/sdk/v3/go/pulumi" -// -// ) -// -// func main() { -// pulumi.Run(func(ctx *pulumi.Context) error { -// _, err := archive.LookupFile(ctx, &archive.LookupFileArgs{ -// OutputPath: fmt.Sprintf("%v/files/init.zip", path.Module), -// SourceFile: pulumi.StringRef(fmt.Sprintf("%v/init.tpl", path.Module)), -// Type: "zip", -// }, nil) -// if err != nil { -// return err -// } -// return nil -// }) -// } -// -// ``` -// -// -// -// ```go -// package main -// -// import ( -// -// "fmt" -// -// "github.com/pulumi/pulumi-archive/sdk/go/archive" -// "github.com/pulumi/pulumi/sdk/v3/go/pulumi" -// -// ) -// -// func main() { -// pulumi.Run(func(ctx *pulumi.Context) error { -// _, err := archive.LookupFile(ctx, &archive.LookupFileArgs{ -// Type: "zip", -// OutputPath: fmt.Sprintf("%v/files/dotfiles.zip", path.Module), -// Excludes: []string{ -// fmt.Sprintf("%v/unwanted.zip", path.Module), -// }, -// Sources: []archive.GetFileSource{ -// { -// Content: data.Template_file.Vimrc.Rendered, -// Filename: ".vimrc", -// }, -// { -// Content: data.Template_file.Ssh_config.Rendered, -// Filename: ".ssh/config", -// }, -// }, -// }, nil) -// if err != nil { -// return err -// } -// return nil -// }) -// } -// -// ``` -// -// -// -// ```go -// package main -// -// import ( -// -// "fmt" -// -// "github.com/pulumi/pulumi-archive/sdk/go/archive" -// "github.com/pulumi/pulumi/sdk/v3/go/pulumi" -// -// ) -// -// func main() { -// pulumi.Run(func(ctx *pulumi.Context) error { -// _, err := archive.LookupFile(ctx, &archive.LookupFileArgs{ -// OutputFileMode: pulumi.StringRef("0666"), -// OutputPath: fmt.Sprintf("%v/files/lambda-my-function.js.zip", path.Module), -// SourceFile: pulumi.StringRef(fmt.Sprintf("%v/../lambda/my-function/index.js", path.Module)), -// Type: "zip", -// }, nil) -// if err != nil { -// return err -// } -// return nil -// }) -// } -// -// ``` -// func LookupFile(ctx *pulumi.Context, args *LookupFileArgs, opts ...pulumi.InvokeOption) (*LookupFileResult, error) { opts = internal.PkgInvokeDefaultOpts(opts) var rv LookupFileResult diff --git a/sdk/java/src/main/java/com/pulumi/archive/ArchiveFunctions.java b/sdk/java/src/main/java/com/pulumi/archive/ArchiveFunctions.java index 63c4952..3c2fe1f 100644 --- a/sdk/java/src/main/java/com/pulumi/archive/ArchiveFunctions.java +++ b/sdk/java/src/main/java/com/pulumi/archive/ArchiveFunctions.java @@ -17,117 +17,6 @@ public final class ArchiveFunctions { /** * Generates an archive from content, a file, or directory of files. * - * ## Example Usage - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var init = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputPath(String.format("%s/files/init.zip", path.module())) - * .sourceFile(String.format("%s/init.tpl", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var dotfiles = ArchiveFunctions.getFile(GetFileArgs.builder() - * .type("zip") - * .outputPath(String.format("%s/files/dotfiles.zip", path.module())) - * .excludes(String.format("%s/unwanted.zip", path.module())) - * .sources( - * GetFileSourceArgs.builder() - * .content(data.template_file().vimrc().rendered()) - * .filename(".vimrc") - * .build(), - * GetFileSourceArgs.builder() - * .content(data.template_file().ssh_config().rendered()) - * .filename(".ssh/config") - * .build()) - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var lambdaMyFunction = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputFileMode("0666") - * .outputPath(String.format("%s/files/lambda-my-function.js.zip", path.module())) - * .sourceFile(String.format("%s/../lambda/my-function/index.js", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * */ public static Output getFile(GetFileArgs args) { return getFile(args, InvokeOptions.Empty); @@ -135,117 +24,6 @@ public static Output getFile(GetFileArgs args) { /** * Generates an archive from content, a file, or directory of files. * - * ## Example Usage - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var init = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputPath(String.format("%s/files/init.zip", path.module())) - * .sourceFile(String.format("%s/init.tpl", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var dotfiles = ArchiveFunctions.getFile(GetFileArgs.builder() - * .type("zip") - * .outputPath(String.format("%s/files/dotfiles.zip", path.module())) - * .excludes(String.format("%s/unwanted.zip", path.module())) - * .sources( - * GetFileSourceArgs.builder() - * .content(data.template_file().vimrc().rendered()) - * .filename(".vimrc") - * .build(), - * GetFileSourceArgs.builder() - * .content(data.template_file().ssh_config().rendered()) - * .filename(".ssh/config") - * .build()) - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var lambdaMyFunction = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputFileMode("0666") - * .outputPath(String.format("%s/files/lambda-my-function.js.zip", path.module())) - * .sourceFile(String.format("%s/../lambda/my-function/index.js", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * */ public static CompletableFuture getFilePlain(GetFilePlainArgs args) { return getFilePlain(args, InvokeOptions.Empty); @@ -253,117 +31,6 @@ public static CompletableFuture getFilePlain(GetFilePlainArgs arg /** * Generates an archive from content, a file, or directory of files. * - * ## Example Usage - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var init = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputPath(String.format("%s/files/init.zip", path.module())) - * .sourceFile(String.format("%s/init.tpl", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var dotfiles = ArchiveFunctions.getFile(GetFileArgs.builder() - * .type("zip") - * .outputPath(String.format("%s/files/dotfiles.zip", path.module())) - * .excludes(String.format("%s/unwanted.zip", path.module())) - * .sources( - * GetFileSourceArgs.builder() - * .content(data.template_file().vimrc().rendered()) - * .filename(".vimrc") - * .build(), - * GetFileSourceArgs.builder() - * .content(data.template_file().ssh_config().rendered()) - * .filename(".ssh/config") - * .build()) - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var lambdaMyFunction = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputFileMode("0666") - * .outputPath(String.format("%s/files/lambda-my-function.js.zip", path.module())) - * .sourceFile(String.format("%s/../lambda/my-function/index.js", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * */ public static Output getFile(GetFileArgs args, InvokeOptions options) { return Deployment.getInstance().invoke("archive:index/getFile:getFile", TypeShape.of(GetFileResult.class), args, Utilities.withVersion(options)); @@ -371,117 +38,6 @@ public static Output getFile(GetFileArgs args, InvokeOptions opti /** * Generates an archive from content, a file, or directory of files. * - * ## Example Usage - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var init = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputPath(String.format("%s/files/init.zip", path.module())) - * .sourceFile(String.format("%s/init.tpl", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var dotfiles = ArchiveFunctions.getFile(GetFileArgs.builder() - * .type("zip") - * .outputPath(String.format("%s/files/dotfiles.zip", path.module())) - * .excludes(String.format("%s/unwanted.zip", path.module())) - * .sources( - * GetFileSourceArgs.builder() - * .content(data.template_file().vimrc().rendered()) - * .filename(".vimrc") - * .build(), - * GetFileSourceArgs.builder() - * .content(data.template_file().ssh_config().rendered()) - * .filename(".ssh/config") - * .build()) - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * - * <!--Start PulumiCodeChooser --> - * ```java - * package generated_program; - * - * import com.pulumi.Context; - * import com.pulumi.Pulumi; - * import com.pulumi.core.Output; - * import com.pulumi.archive.ArchiveFunctions; - * import com.pulumi.archive.inputs.GetFileArgs; - * import java.util.List; - * import java.util.ArrayList; - * import java.util.Map; - * import java.io.File; - * import java.nio.file.Files; - * import java.nio.file.Paths; - * - * public class App { - * public static void main(String[] args) { - * Pulumi.run(App::stack); - * } - * - * public static void stack(Context ctx) { - * final var lambdaMyFunction = ArchiveFunctions.getFile(GetFileArgs.builder() - * .outputFileMode("0666") - * .outputPath(String.format("%s/files/lambda-my-function.js.zip", path.module())) - * .sourceFile(String.format("%s/../lambda/my-function/index.js", path.module())) - * .type("zip") - * .build()); - * - * } - * } - * ``` - * <!--End PulumiCodeChooser --> - * */ public static CompletableFuture getFilePlain(GetFilePlainArgs args, InvokeOptions options) { return Deployment.getInstance().invokeAsync("archive:index/getFile:getFile", TypeShape.of(GetFileResult.class), args, Utilities.withVersion(options)); diff --git a/sdk/nodejs/getFile.ts b/sdk/nodejs/getFile.ts index 9f9c98e..2e85c11 100644 --- a/sdk/nodejs/getFile.ts +++ b/sdk/nodejs/getFile.ts @@ -8,58 +8,6 @@ import * as utilities from "./utilities"; /** * Generates an archive from content, a file, or directory of files. - * - * ## Example Usage - * - * - * ```typescript - * import * as pulumi from "@pulumi/pulumi"; - * import * as archive from "@pulumi/archive"; - * - * const init = archive.getFile({ - * outputPath: `${path.module}/files/init.zip`, - * sourceFile: `${path.module}/init.tpl`, - * type: "zip", - * }); - * ``` - * - * - * - * ```typescript - * import * as pulumi from "@pulumi/pulumi"; - * import * as archive from "@pulumi/archive"; - * - * const dotfiles = archive.getFile({ - * type: "zip", - * outputPath: `${path.module}/files/dotfiles.zip`, - * excludes: [`${path.module}/unwanted.zip`], - * sources: [ - * { - * content: data.template_file.vimrc.rendered, - * filename: ".vimrc", - * }, - * { - * content: data.template_file.ssh_config.rendered, - * filename: ".ssh/config", - * }, - * ], - * }); - * ``` - * - * - * - * ```typescript - * import * as pulumi from "@pulumi/pulumi"; - * import * as archive from "@pulumi/archive"; - * - * const lambdaMyFunction = archive.getFile({ - * outputFileMode: "0666", - * outputPath: `${path.module}/files/lambda-my-function.js.zip`, - * sourceFile: `${path.module}/../lambda/my-function/index.js`, - * type: "zip", - * }); - * ``` - * */ export function getFile(args: GetFileArgs, opts?: pulumi.InvokeOptions): Promise { @@ -203,58 +151,6 @@ export interface GetFileResult { } /** * Generates an archive from content, a file, or directory of files. - * - * ## Example Usage - * - * - * ```typescript - * import * as pulumi from "@pulumi/pulumi"; - * import * as archive from "@pulumi/archive"; - * - * const init = archive.getFile({ - * outputPath: `${path.module}/files/init.zip`, - * sourceFile: `${path.module}/init.tpl`, - * type: "zip", - * }); - * ``` - * - * - * - * ```typescript - * import * as pulumi from "@pulumi/pulumi"; - * import * as archive from "@pulumi/archive"; - * - * const dotfiles = archive.getFile({ - * type: "zip", - * outputPath: `${path.module}/files/dotfiles.zip`, - * excludes: [`${path.module}/unwanted.zip`], - * sources: [ - * { - * content: data.template_file.vimrc.rendered, - * filename: ".vimrc", - * }, - * { - * content: data.template_file.ssh_config.rendered, - * filename: ".ssh/config", - * }, - * ], - * }); - * ``` - * - * - * - * ```typescript - * import * as pulumi from "@pulumi/pulumi"; - * import * as archive from "@pulumi/archive"; - * - * const lambdaMyFunction = archive.getFile({ - * outputFileMode: "0666", - * outputPath: `${path.module}/files/lambda-my-function.js.zip`, - * sourceFile: `${path.module}/../lambda/my-function/index.js`, - * type: "zip", - * }); - * ``` - * */ export function getFileOutput(args: GetFileOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output { return pulumi.output(args).apply((a: any) => getFile(a, opts)) diff --git a/sdk/python/pulumi_archive/get_file.py b/sdk/python/pulumi_archive/get_file.py index 80aa88b..db0f1dc 100644 --- a/sdk/python/pulumi_archive/get_file.py +++ b/sdk/python/pulumi_archive/get_file.py @@ -264,52 +264,6 @@ def get_file(exclude_symlink_directories: Optional[bool] = None, """ Generates an archive from content, a file, or directory of files. - ## Example Usage - - - ```python - import pulumi - import pulumi_archive as archive - - init = archive.get_file(output_path=f"{path['module']}/files/init.zip", - source_file=f"{path['module']}/init.tpl", - type="zip") - ``` - - - - ```python - import pulumi - import pulumi_archive as archive - - dotfiles = archive.get_file(type="zip", - output_path=f"{path['module']}/files/dotfiles.zip", - excludes=[f"{path['module']}/unwanted.zip"], - sources=[ - archive.GetFileSourceArgs( - content=data["template_file"]["vimrc"]["rendered"], - filename=".vimrc", - ), - archive.GetFileSourceArgs( - content=data["template_file"]["ssh_config"]["rendered"], - filename=".ssh/config", - ), - ]) - ``` - - - - ```python - import pulumi - import pulumi_archive as archive - - lambda_my_function = archive.get_file(output_file_mode="0666", - output_path=f"{path['module']}/files/lambda-my-function.js.zip", - source_file=f"{path['module']}/../lambda/my-function/index.js", - type="zip") - ``` - - :param bool exclude_symlink_directories: Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`. :param Sequence[str] excludes: Specify files to ignore when reading the `source_dir`. @@ -372,52 +326,6 @@ def get_file_output(exclude_symlink_directories: Optional[pulumi.Input[Optional[ """ Generates an archive from content, a file, or directory of files. - ## Example Usage - - - ```python - import pulumi - import pulumi_archive as archive - - init = archive.get_file(output_path=f"{path['module']}/files/init.zip", - source_file=f"{path['module']}/init.tpl", - type="zip") - ``` - - - - ```python - import pulumi - import pulumi_archive as archive - - dotfiles = archive.get_file(type="zip", - output_path=f"{path['module']}/files/dotfiles.zip", - excludes=[f"{path['module']}/unwanted.zip"], - sources=[ - archive.GetFileSourceArgs( - content=data["template_file"]["vimrc"]["rendered"], - filename=".vimrc", - ), - archive.GetFileSourceArgs( - content=data["template_file"]["ssh_config"]["rendered"], - filename=".ssh/config", - ), - ]) - ``` - - - - ```python - import pulumi - import pulumi_archive as archive - - lambda_my_function = archive.get_file(output_file_mode="0666", - output_path=f"{path['module']}/files/lambda-my-function.js.zip", - source_file=f"{path['module']}/../lambda/my-function/index.js", - type="zip") - ``` - - :param bool exclude_symlink_directories: Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`. :param Sequence[str] excludes: Specify files to ignore when reading the `source_dir`.