Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Local Provider
  3. API Docs
  4. SensitiveFile
local 2.5.2 published on Thursday, Feb 6, 2025 by hashicorp
hashicorp/terraform-provider-local

local.SensitiveFile

Explore with Pulumi AI

local logo
local 2.5.2 published on Thursday, Feb 6, 2025 by hashicorp
hashicorp/terraform-provider-local

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as local from "@pulumi/local";

const foo = new local.SensitiveFile("foo", {
    content: "foo!",
    filename: `${path.module}/foo.bar`,
});

    import pulumi
import pulumi_local as local

foo = local.SensitiveFile("foo",
    content="foo!",
    filename=f"{path['module']}/foo.bar")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/local/v2/local"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := local.NewSensitiveFile(ctx, "foo", &local.SensitiveFileArgs{
			Content:  pulumi.String("foo!"),
			Filename: pulumi.Sprintf("%v/foo.bar", path.Module),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Local = Pulumi.Local;

return await Deployment.RunAsync(() => 
{
    var foo = new Local.SensitiveFile("foo", new()
    {
        Content = "foo!",
        Filename = $"{path.Module}/foo.bar",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.local.SensitiveFile;
import com.pulumi.local.SensitiveFileArgs;
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) {
        var foo = new SensitiveFile("foo", SensitiveFileArgs.builder()
            .content("foo!")
            .filename(String.format("%s/foo.bar", path.module()))
            .build());

    }
}

    resources:
  foo:
    type: local:SensitiveFile
    properties:
      content: foo!
      filename: ${path.module}/foo.bar

    Create SensitiveFile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SensitiveFile(name: string, args: SensitiveFileArgs, opts?: CustomResourceOptions);
    @overload
def SensitiveFile(resource_name: str,
                  args: SensitiveFileArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SensitiveFile(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  filename: Optional[str] = None,
                  content: Optional[str] = None,
                  content_base64: Optional[str] = None,
                  directory_permission: Optional[str] = None,
                  file_permission: Optional[str] = None,
                  source: Optional[str] = None)
    func NewSensitiveFile(ctx *Context, name string, args SensitiveFileArgs, opts ...ResourceOption) (*SensitiveFile, error)
    public SensitiveFile(string name, SensitiveFileArgs args, CustomResourceOptions? opts = null)
    public SensitiveFile(String name, SensitiveFileArgs args)
public SensitiveFile(String name, SensitiveFileArgs args, CustomResourceOptions options)

    type: local:SensitiveFile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SensitiveFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SensitiveFileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SensitiveFileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SensitiveFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SensitiveFileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sensitiveFileResource = new Local.SensitiveFile("sensitiveFileResource", new()
{
    Filename = "string",
    Content = "string",
    ContentBase64 = "string",
    DirectoryPermission = "string",
    FilePermission = "string",
    Source = "string",
});

    example, err := local.NewSensitiveFile(ctx, "sensitiveFileResource", &local.SensitiveFileArgs{
	Filename:            pulumi.String("string"),
	Content:             pulumi.String("string"),
	ContentBase64:       pulumi.String("string"),
	DirectoryPermission: pulumi.String("string"),
	FilePermission:      pulumi.String("string"),
	Source:              pulumi.String("string"),
})

    var sensitiveFileResource = new SensitiveFile("sensitiveFileResource", SensitiveFileArgs.builder()
    .filename("string")
    .content("string")
    .contentBase64("string")
    .directoryPermission("string")
    .filePermission("string")
    .source("string")
    .build());

    sensitive_file_resource = local.SensitiveFile("sensitiveFileResource",
    filename="string",
    content="string",
    content_base64="string",
    directory_permission="string",
    file_permission="string",
    source="string")

    const sensitiveFileResource = new local.SensitiveFile("sensitiveFileResource", {
    filename: "string",
    content: "string",
    contentBase64: "string",
    directoryPermission: "string",
    filePermission: "string",
    source: "string",
});

    type: local:SensitiveFile
properties:
    content: string
    contentBase64: string
    directoryPermission: string
    filePermission: string
    filename: string
    source: string

    SensitiveFile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SensitiveFile resource accepts the following input properties:

    Filename string
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    Content string
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    ContentBase64 string
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    DirectoryPermission string
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    FilePermission string
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    Source string
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    Filename string
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    Content string
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    ContentBase64 string
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    DirectoryPermission string
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    FilePermission string
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    Source string
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    filename String
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    content String
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    contentBase64 String
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    directoryPermission String
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    filePermission String
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    source String
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    filename string
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    content string
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    contentBase64 string
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    directoryPermission string
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    filePermission string
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    source string
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    filename str
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    content str
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    content_base64 str
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    directory_permission str
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    file_permission str
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    source str
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    filename String
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    content String
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    contentBase64 String
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    directoryPermission String
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    filePermission String
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    source String
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SensitiveFile resource produces the following output properties:

    ContentBase64sha256 string
    Base64 encoded SHA256 checksum of file content.
    ContentBase64sha512 string
    Base64 encoded SHA512 checksum of file content.
    ContentMd5 string
    MD5 checksum of file content.
    ContentSha1 string
    SHA1 checksum of file content.
    ContentSha256 string
    SHA256 checksum of file content.
    ContentSha512 string
    SHA512 checksum of file content.
    Id string
    The provider-assigned unique ID for this managed resource.
    ContentBase64sha256 string
    Base64 encoded SHA256 checksum of file content.
    ContentBase64sha512 string
    Base64 encoded SHA512 checksum of file content.
    ContentMd5 string
    MD5 checksum of file content.
    ContentSha1 string
    SHA1 checksum of file content.
    ContentSha256 string
    SHA256 checksum of file content.
    ContentSha512 string
    SHA512 checksum of file content.
    Id string
    The provider-assigned unique ID for this managed resource.
    contentBase64sha256 String
    Base64 encoded SHA256 checksum of file content.
    contentBase64sha512 String
    Base64 encoded SHA512 checksum of file content.
    contentMd5 String
    MD5 checksum of file content.
    contentSha1 String
    SHA1 checksum of file content.
    contentSha256 String
    SHA256 checksum of file content.
    contentSha512 String
    SHA512 checksum of file content.
    id String
    The provider-assigned unique ID for this managed resource.
    contentBase64sha256 string
    Base64 encoded SHA256 checksum of file content.
    contentBase64sha512 string
    Base64 encoded SHA512 checksum of file content.
    contentMd5 string
    MD5 checksum of file content.
    contentSha1 string
    SHA1 checksum of file content.
    contentSha256 string
    SHA256 checksum of file content.
    contentSha512 string
    SHA512 checksum of file content.
    id string
    The provider-assigned unique ID for this managed resource.
    content_base64sha256 str
    Base64 encoded SHA256 checksum of file content.
    content_base64sha512 str
    Base64 encoded SHA512 checksum of file content.
    content_md5 str
    MD5 checksum of file content.
    content_sha1 str
    SHA1 checksum of file content.
    content_sha256 str
    SHA256 checksum of file content.
    content_sha512 str
    SHA512 checksum of file content.
    id str
    The provider-assigned unique ID for this managed resource.
    contentBase64sha256 String
    Base64 encoded SHA256 checksum of file content.
    contentBase64sha512 String
    Base64 encoded SHA512 checksum of file content.
    contentMd5 String
    MD5 checksum of file content.
    contentSha1 String
    SHA1 checksum of file content.
    contentSha256 String
    SHA256 checksum of file content.
    contentSha512 String
    SHA512 checksum of file content.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SensitiveFile Resource

    Get an existing SensitiveFile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SensitiveFileState, opts?: CustomResourceOptions): SensitiveFile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content: Optional[str] = None,
        content_base64: Optional[str] = None,
        content_base64sha256: Optional[str] = None,
        content_base64sha512: Optional[str] = None,
        content_md5: Optional[str] = None,
        content_sha1: Optional[str] = None,
        content_sha256: Optional[str] = None,
        content_sha512: Optional[str] = None,
        directory_permission: Optional[str] = None,
        file_permission: Optional[str] = None,
        filename: Optional[str] = None,
        source: Optional[str] = None) -> SensitiveFile
    func GetSensitiveFile(ctx *Context, name string, id IDInput, state *SensitiveFileState, opts ...ResourceOption) (*SensitiveFile, error)
    public static SensitiveFile Get(string name, Input<string> id, SensitiveFileState? state, CustomResourceOptions? opts = null)
    public static SensitiveFile get(String name, Output<String> id, SensitiveFileState state, CustomResourceOptions options)
    resources:  _:    type: local:SensitiveFile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Content string
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    ContentBase64 string
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    ContentBase64sha256 string
    Base64 encoded SHA256 checksum of file content.
    ContentBase64sha512 string
    Base64 encoded SHA512 checksum of file content.
    ContentMd5 string
    MD5 checksum of file content.
    ContentSha1 string
    SHA1 checksum of file content.
    ContentSha256 string
    SHA256 checksum of file content.
    ContentSha512 string
    SHA512 checksum of file content.
    DirectoryPermission string
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    FilePermission string
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    Filename string
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    Source string
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    Content string
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    ContentBase64 string
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    ContentBase64sha256 string
    Base64 encoded SHA256 checksum of file content.
    ContentBase64sha512 string
    Base64 encoded SHA512 checksum of file content.
    ContentMd5 string
    MD5 checksum of file content.
    ContentSha1 string
    SHA1 checksum of file content.
    ContentSha256 string
    SHA256 checksum of file content.
    ContentSha512 string
    SHA512 checksum of file content.
    DirectoryPermission string
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    FilePermission string
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    Filename string
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    Source string
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    content String
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    contentBase64 String
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    contentBase64sha256 String
    Base64 encoded SHA256 checksum of file content.
    contentBase64sha512 String
    Base64 encoded SHA512 checksum of file content.
    contentMd5 String
    MD5 checksum of file content.
    contentSha1 String
    SHA1 checksum of file content.
    contentSha256 String
    SHA256 checksum of file content.
    contentSha512 String
    SHA512 checksum of file content.
    directoryPermission String
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    filePermission String
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    filename String
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    source String
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    content string
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    contentBase64 string
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    contentBase64sha256 string
    Base64 encoded SHA256 checksum of file content.
    contentBase64sha512 string
    Base64 encoded SHA512 checksum of file content.
    contentMd5 string
    MD5 checksum of file content.
    contentSha1 string
    SHA1 checksum of file content.
    contentSha256 string
    SHA256 checksum of file content.
    contentSha512 string
    SHA512 checksum of file content.
    directoryPermission string
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    filePermission string
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    filename string
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    source string
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    content str
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    content_base64 str
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    content_base64sha256 str
    Base64 encoded SHA256 checksum of file content.
    content_base64sha512 str
    Base64 encoded SHA512 checksum of file content.
    content_md5 str
    MD5 checksum of file content.
    content_sha1 str
    SHA1 checksum of file content.
    content_sha256 str
    SHA256 checksum of file content.
    content_sha512 str
    SHA512 checksum of file content.
    directory_permission str
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    file_permission str
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    filename str
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    source str
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.
    content String
    Sensitive Content to store in the file, expected to be a UTF-8 encoded string. Conflicts with content_base64 and source. Exactly one of these three arguments must be specified.
    contentBase64 String
    Sensitive Content to store in the file, expected to be binary encoded as base64 string. Conflicts with content and source. Exactly one of these three arguments must be specified.
    contentBase64sha256 String
    Base64 encoded SHA256 checksum of file content.
    contentBase64sha512 String
    Base64 encoded SHA512 checksum of file content.
    contentMd5 String
    MD5 checksum of file content.
    contentSha1 String
    SHA1 checksum of file content.
    contentSha256 String
    SHA256 checksum of file content.
    contentSha512 String
    SHA512 checksum of file content.
    directoryPermission String
    Permissions to set for directories created (before umask), expressed as string in numeric notation. Default value is "0700".
    filePermission String
    Permissions to set for the output file (before umask), expressed as string in numeric notation. Default value is "0700".
    filename String
    The path to the file that will be created. Missing parent directories will be created. If the file already exists, it will be overridden with the given content.
    source String
    Path to file to use as source for the one we are creating. Conflicts with content and content_base64. Exactly one of these three arguments must be specified.

    Package Details

    Repository
    local hashicorp/terraform-provider-local
    License
    Notes
    This Pulumi package is based on the local Terraform Provider.
    local logo
    local 2.5.2 published on Thursday, Feb 6, 2025 by hashicorp
    hashicorp/terraform-provider-local