archive

package
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing Archive cloud resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type File 

type File struct {
	pulumi.CustomResourceState

	// Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.
	ExcludeSymlinkDirectories pulumi.BoolPtrOutput `pulumi:"excludeSymlinkDirectories"`
	// Specify files to ignore when reading the `sourceDir`.
	Excludes pulumi.StringArrayOutput `pulumi:"excludes"`
	// Base64 Encoded SHA256 checksum of output file
	OutputBase64sha256 pulumi.StringOutput `pulumi:"outputBase64sha256"`
	// Base64 Encoded SHA512 checksum of output file
	OutputBase64sha512 pulumi.StringOutput `pulumi:"outputBase64sha512"`
	// 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.
	OutputFileMode pulumi.StringPtrOutput `pulumi:"outputFileMode"`
	// MD5 of output file
	OutputMd5 pulumi.StringOutput `pulumi:"outputMd5"`
	// The output of the archive file.
	OutputPath pulumi.StringOutput `pulumi:"outputPath"`
	// SHA1 checksum of output file
	OutputSha pulumi.StringOutput `pulumi:"outputSha"`
	// SHA256 checksum of output file
	OutputSha256 pulumi.StringOutput `pulumi:"outputSha256"`
	// SHA512 checksum of output file
	OutputSha512 pulumi.StringOutput `pulumi:"outputSha512"`
	// The byte size of the output archive file.
	OutputSize pulumi.IntOutput `pulumi:"outputSize"`
	// Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContent pulumi.StringPtrOutput `pulumi:"sourceContent"`
	// Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContentFilename pulumi.StringPtrOutput `pulumi:"sourceContentFilename"`
	// Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceDir pulumi.StringPtrOutput `pulumi:"sourceDir"`
	// Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceFile pulumi.StringPtrOutput `pulumi:"sourceFile"`
	// Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	Sources FileSourceArrayOutput `pulumi:"sources"`
	// The type of archive to generate. NOTE: `zip` is supported.
	Type pulumi.StringOutput `pulumi:"type"`
}

**NOTE**: This resource is deprecated, use data source instead.

func GetFile 

func GetFile(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *FileState, opts ...pulumi.ResourceOption) (*File, error)

GetFile gets an existing File resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewFile 

func NewFile(ctx *pulumi.Context,
	name string, args *FileArgs, opts ...pulumi.ResourceOption) (*File, error)

NewFile registers a new resource with the given unique name, arguments, and options.

func (*File) ElementType 

func (*File) ElementType() reflect.Type

func (*File) ToFileOutput 

func (i *File) ToFileOutput() FileOutput

func (*File) ToFileOutputWithContext 

func (i *File) ToFileOutputWithContext(ctx context.Context) FileOutput

type FileArgs 

type FileArgs struct {
	// Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.
	ExcludeSymlinkDirectories pulumi.BoolPtrInput
	// Specify files to ignore when reading the `sourceDir`.
	Excludes pulumi.StringArrayInput
	// 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.
	OutputFileMode pulumi.StringPtrInput
	// The output of the archive file.
	OutputPath pulumi.StringInput
	// Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContent pulumi.StringPtrInput
	// Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContentFilename pulumi.StringPtrInput
	// Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceDir pulumi.StringPtrInput
	// Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceFile pulumi.StringPtrInput
	// Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	Sources FileSourceArrayInput
	// The type of archive to generate. NOTE: `zip` is supported.
	Type pulumi.StringInput
}

The set of arguments for constructing a File resource.

func (FileArgs) ElementType 

func (FileArgs) ElementType() reflect.Type

type FileArray 

type FileArray []FileInput

func (FileArray) ElementType 

func (FileArray) ElementType() reflect.Type

func (FileArray) ToFileArrayOutput 

func (i FileArray) ToFileArrayOutput() FileArrayOutput

func (FileArray) ToFileArrayOutputWithContext 

func (i FileArray) ToFileArrayOutputWithContext(ctx context.Context) FileArrayOutput

type FileArrayInput 

type FileArrayInput interface {
	pulumi.Input

	ToFileArrayOutput() FileArrayOutput
	ToFileArrayOutputWithContext(context.Context) FileArrayOutput
}

FileArrayInput is an input type that accepts FileArray and FileArrayOutput values. You can construct a concrete instance of `FileArrayInput` via: 

FileArray{ FileArgs{...} }

type FileArrayOutput 

type FileArrayOutput struct{ *pulumi.OutputState }

func (FileArrayOutput) ElementType 

func (FileArrayOutput) ElementType() reflect.Type

func (FileArrayOutput) Index 

func (o FileArrayOutput) Index(i pulumi.IntInput) FileOutput

func (FileArrayOutput) ToFileArrayOutput 

func (o FileArrayOutput) ToFileArrayOutput() FileArrayOutput

func (FileArrayOutput) ToFileArrayOutputWithContext 

func (o FileArrayOutput) ToFileArrayOutputWithContext(ctx context.Context) FileArrayOutput

type FileInput 

type FileInput interface {
	pulumi.Input

	ToFileOutput() FileOutput
	ToFileOutputWithContext(ctx context.Context) FileOutput
}

type FileMap 

type FileMap map[string]FileInput

func (FileMap) ElementType 

func (FileMap) ElementType() reflect.Type

func (FileMap) ToFileMapOutput 

func (i FileMap) ToFileMapOutput() FileMapOutput

func (FileMap) ToFileMapOutputWithContext 

func (i FileMap) ToFileMapOutputWithContext(ctx context.Context) FileMapOutput

type FileMapInput 

type FileMapInput interface {
	pulumi.Input

	ToFileMapOutput() FileMapOutput
	ToFileMapOutputWithContext(context.Context) FileMapOutput
}

FileMapInput is an input type that accepts FileMap and FileMapOutput values. You can construct a concrete instance of `FileMapInput` via: 

FileMap{ "key": FileArgs{...} }

type FileMapOutput 

type FileMapOutput struct{ *pulumi.OutputState }

func (FileMapOutput) ElementType 

func (FileMapOutput) ElementType() reflect.Type

func (FileMapOutput) MapIndex 

func (o FileMapOutput) MapIndex(k pulumi.StringInput) FileOutput

func (FileMapOutput) ToFileMapOutput 

func (o FileMapOutput) ToFileMapOutput() FileMapOutput

func (FileMapOutput) ToFileMapOutputWithContext 

func (o FileMapOutput) ToFileMapOutputWithContext(ctx context.Context) FileMapOutput

type FileOutput 

type FileOutput struct{ *pulumi.OutputState }

func (FileOutput) ElementType 

func (FileOutput) ElementType() reflect.Type

func (FileOutput) ExcludeSymlinkDirectories 

func (o FileOutput) ExcludeSymlinkDirectories() pulumi.BoolPtrOutput

Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.

func (FileOutput) Excludes 

func (o FileOutput) Excludes() pulumi.StringArrayOutput

Specify files to ignore when reading the `sourceDir`.

func (FileOutput) OutputBase64sha256 

func (o FileOutput) OutputBase64sha256() pulumi.StringOutput

Base64 Encoded SHA256 checksum of output file

func (FileOutput) OutputBase64sha512 

func (o FileOutput) OutputBase64sha512() pulumi.StringOutput

Base64 Encoded SHA512 checksum of output file

func (FileOutput) OutputFileMode 

func (o FileOutput) OutputFileMode() pulumi.StringPtrOutput

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.

func (FileOutput) OutputMd5 

func (o FileOutput) OutputMd5() pulumi.StringOutput

MD5 of output file

func (FileOutput) OutputPath 

func (o FileOutput) OutputPath() pulumi.StringOutput

The output of the archive file.

func (FileOutput) OutputSha 

func (o FileOutput) OutputSha() pulumi.StringOutput

SHA1 checksum of output file

func (FileOutput) OutputSha256 

func (o FileOutput) OutputSha256() pulumi.StringOutput

SHA256 checksum of output file

func (FileOutput) OutputSha512 

func (o FileOutput) OutputSha512() pulumi.StringOutput

SHA512 checksum of output file

func (FileOutput) OutputSize 

func (o FileOutput) OutputSize() pulumi.IntOutput

The byte size of the output archive file.

func (FileOutput) SourceContent 

func (o FileOutput) SourceContent() pulumi.StringPtrOutput

Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (FileOutput) SourceContentFilename 

func (o FileOutput) SourceContentFilename() pulumi.StringPtrOutput

Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (FileOutput) SourceDir 

func (o FileOutput) SourceDir() pulumi.StringPtrOutput

Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (FileOutput) SourceFile 

func (o FileOutput) SourceFile() pulumi.StringPtrOutput

Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (FileOutput) Sources 

func (o FileOutput) Sources() FileSourceArrayOutput

Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (FileOutput) ToFileOutput 

func (o FileOutput) ToFileOutput() FileOutput

func (FileOutput) ToFileOutputWithContext 

func (o FileOutput) ToFileOutputWithContext(ctx context.Context) FileOutput

func (FileOutput) Type 

func (o FileOutput) Type() pulumi.StringOutput

The type of archive to generate. NOTE: `zip` is supported.

type FileSource 

type FileSource struct {
	// Add this content to the archive with `filename` as the filename.
	Content string `pulumi:"content"`
	// Set this as the filename when declaring a `source`.
	Filename string `pulumi:"filename"`
}

type FileSourceArgs 

type FileSourceArgs struct {
	// Add this content to the archive with `filename` as the filename.
	Content pulumi.StringInput `pulumi:"content"`
	// Set this as the filename when declaring a `source`.
	Filename pulumi.StringInput `pulumi:"filename"`
}

func (FileSourceArgs) ElementType 

func (FileSourceArgs) ElementType() reflect.Type

func (FileSourceArgs) ToFileSourceOutput 

func (i FileSourceArgs) ToFileSourceOutput() FileSourceOutput

func (FileSourceArgs) ToFileSourceOutputWithContext 

func (i FileSourceArgs) ToFileSourceOutputWithContext(ctx context.Context) FileSourceOutput

type FileSourceArray 

type FileSourceArray []FileSourceInput

func (FileSourceArray) ElementType 

func (FileSourceArray) ElementType() reflect.Type

func (FileSourceArray) ToFileSourceArrayOutput 

func (i FileSourceArray) ToFileSourceArrayOutput() FileSourceArrayOutput

func (FileSourceArray) ToFileSourceArrayOutputWithContext 

func (i FileSourceArray) ToFileSourceArrayOutputWithContext(ctx context.Context) FileSourceArrayOutput

type FileSourceArrayInput 

type FileSourceArrayInput interface {
	pulumi.Input

	ToFileSourceArrayOutput() FileSourceArrayOutput
	ToFileSourceArrayOutputWithContext(context.Context) FileSourceArrayOutput
}

FileSourceArrayInput is an input type that accepts FileSourceArray and FileSourceArrayOutput values. You can construct a concrete instance of `FileSourceArrayInput` via: 

FileSourceArray{ FileSourceArgs{...} }

type FileSourceArrayOutput 

type FileSourceArrayOutput struct{ *pulumi.OutputState }

func (FileSourceArrayOutput) ElementType 

func (FileSourceArrayOutput) ElementType() reflect.Type

func (FileSourceArrayOutput) Index 

func (o FileSourceArrayOutput) Index(i pulumi.IntInput) FileSourceOutput

func (FileSourceArrayOutput) ToFileSourceArrayOutput 

func (o FileSourceArrayOutput) ToFileSourceArrayOutput() FileSourceArrayOutput

func (FileSourceArrayOutput) ToFileSourceArrayOutputWithContext 

func (o FileSourceArrayOutput) ToFileSourceArrayOutputWithContext(ctx context.Context) FileSourceArrayOutput

type FileSourceInput 

type FileSourceInput interface {
	pulumi.Input

	ToFileSourceOutput() FileSourceOutput
	ToFileSourceOutputWithContext(context.Context) FileSourceOutput
}

FileSourceInput is an input type that accepts FileSourceArgs and FileSourceOutput values. You can construct a concrete instance of `FileSourceInput` via: 

FileSourceArgs{...}

type FileSourceOutput 

type FileSourceOutput struct{ *pulumi.OutputState }

func (FileSourceOutput) Content 

func (o FileSourceOutput) Content() pulumi.StringOutput

Add this content to the archive with `filename` as the filename.

func (FileSourceOutput) ElementType 

func (FileSourceOutput) ElementType() reflect.Type

func (FileSourceOutput) Filename 

func (o FileSourceOutput) Filename() pulumi.StringOutput

Set this as the filename when declaring a `source`.

func (FileSourceOutput) ToFileSourceOutput 

func (o FileSourceOutput) ToFileSourceOutput() FileSourceOutput

func (FileSourceOutput) ToFileSourceOutputWithContext 

func (o FileSourceOutput) ToFileSourceOutputWithContext(ctx context.Context) FileSourceOutput

type FileState 

type FileState struct {
	// Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.
	ExcludeSymlinkDirectories pulumi.BoolPtrInput
	// Specify files to ignore when reading the `sourceDir`.
	Excludes pulumi.StringArrayInput
	// Base64 Encoded SHA256 checksum of output file
	OutputBase64sha256 pulumi.StringPtrInput
	// Base64 Encoded SHA512 checksum of output file
	OutputBase64sha512 pulumi.StringPtrInput
	// 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.
	OutputFileMode pulumi.StringPtrInput
	// MD5 of output file
	OutputMd5 pulumi.StringPtrInput
	// The output of the archive file.
	OutputPath pulumi.StringPtrInput
	// SHA1 checksum of output file
	OutputSha pulumi.StringPtrInput
	// SHA256 checksum of output file
	OutputSha256 pulumi.StringPtrInput
	// SHA512 checksum of output file
	OutputSha512 pulumi.StringPtrInput
	// The byte size of the output archive file.
	OutputSize pulumi.IntPtrInput
	// Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContent pulumi.StringPtrInput
	// Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContentFilename pulumi.StringPtrInput
	// Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceDir pulumi.StringPtrInput
	// Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceFile pulumi.StringPtrInput
	// Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	Sources FileSourceArrayInput
	// The type of archive to generate. NOTE: `zip` is supported.
	Type pulumi.StringPtrInput
}

func (FileState) ElementType 

func (FileState) ElementType() reflect.Type

type GetFileSource 

type GetFileSource struct {
	// Add this content to the archive with `filename` as the filename.
	Content string `pulumi:"content"`
	// Set this as the filename when declaring a `source`.
	Filename string `pulumi:"filename"`
}

type GetFileSourceArgs 

type GetFileSourceArgs struct {
	// Add this content to the archive with `filename` as the filename.
	Content pulumi.StringInput `pulumi:"content"`
	// Set this as the filename when declaring a `source`.
	Filename pulumi.StringInput `pulumi:"filename"`
}

func (GetFileSourceArgs) ElementType 

func (GetFileSourceArgs) ElementType() reflect.Type

func (GetFileSourceArgs) ToGetFileSourceOutput 

func (i GetFileSourceArgs) ToGetFileSourceOutput() GetFileSourceOutput

func (GetFileSourceArgs) ToGetFileSourceOutputWithContext 

func (i GetFileSourceArgs) ToGetFileSourceOutputWithContext(ctx context.Context) GetFileSourceOutput

type GetFileSourceArray 

type GetFileSourceArray []GetFileSourceInput

func (GetFileSourceArray) ElementType 

func (GetFileSourceArray) ElementType() reflect.Type

func (GetFileSourceArray) ToGetFileSourceArrayOutput 

func (i GetFileSourceArray) ToGetFileSourceArrayOutput() GetFileSourceArrayOutput

func (GetFileSourceArray) ToGetFileSourceArrayOutputWithContext 

func (i GetFileSourceArray) ToGetFileSourceArrayOutputWithContext(ctx context.Context) GetFileSourceArrayOutput

type GetFileSourceArrayInput 

type GetFileSourceArrayInput interface {
	pulumi.Input

	ToGetFileSourceArrayOutput() GetFileSourceArrayOutput
	ToGetFileSourceArrayOutputWithContext(context.Context) GetFileSourceArrayOutput
}

GetFileSourceArrayInput is an input type that accepts GetFileSourceArray and GetFileSourceArrayOutput values. You can construct a concrete instance of `GetFileSourceArrayInput` via: 

GetFileSourceArray{ GetFileSourceArgs{...} }

type GetFileSourceArrayOutput 

type GetFileSourceArrayOutput struct{ *pulumi.OutputState }

func (GetFileSourceArrayOutput) ElementType 

func (GetFileSourceArrayOutput) ElementType() reflect.Type

func (GetFileSourceArrayOutput) Index 

func (o GetFileSourceArrayOutput) Index(i pulumi.IntInput) GetFileSourceOutput

func (GetFileSourceArrayOutput) ToGetFileSourceArrayOutput 

func (o GetFileSourceArrayOutput) ToGetFileSourceArrayOutput() GetFileSourceArrayOutput

func (GetFileSourceArrayOutput) ToGetFileSourceArrayOutputWithContext 

func (o GetFileSourceArrayOutput) ToGetFileSourceArrayOutputWithContext(ctx context.Context) GetFileSourceArrayOutput

type GetFileSourceInput 

type GetFileSourceInput interface {
	pulumi.Input

	ToGetFileSourceOutput() GetFileSourceOutput
	ToGetFileSourceOutputWithContext(context.Context) GetFileSourceOutput
}

GetFileSourceInput is an input type that accepts GetFileSourceArgs and GetFileSourceOutput values. You can construct a concrete instance of `GetFileSourceInput` via: 

GetFileSourceArgs{...}

type GetFileSourceOutput 

type GetFileSourceOutput struct{ *pulumi.OutputState }

func (GetFileSourceOutput) Content 

func (o GetFileSourceOutput) Content() pulumi.StringOutput

Add this content to the archive with `filename` as the filename.

func (GetFileSourceOutput) ElementType 

func (GetFileSourceOutput) ElementType() reflect.Type

func (GetFileSourceOutput) Filename 

func (o GetFileSourceOutput) Filename() pulumi.StringOutput

Set this as the filename when declaring a `source`.

func (GetFileSourceOutput) ToGetFileSourceOutput 

func (o GetFileSourceOutput) ToGetFileSourceOutput() GetFileSourceOutput

func (GetFileSourceOutput) ToGetFileSourceOutputWithContext 

func (o GetFileSourceOutput) ToGetFileSourceOutputWithContext(ctx context.Context) GetFileSourceOutput

type LookupFileArgs 

type LookupFileArgs struct {
	// Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.
	ExcludeSymlinkDirectories *bool `pulumi:"excludeSymlinkDirectories"`
	// Specify files to ignore when reading the `sourceDir`.
	Excludes []string `pulumi:"excludes"`
	// 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.
	OutputFileMode *string `pulumi:"outputFileMode"`
	// The output of the archive file.
	OutputPath string `pulumi:"outputPath"`
	// Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContent *string `pulumi:"sourceContent"`
	// Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContentFilename *string `pulumi:"sourceContentFilename"`
	// Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceDir *string `pulumi:"sourceDir"`
	// Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceFile *string `pulumi:"sourceFile"`
	// Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	Sources []GetFileSource `pulumi:"sources"`
	// The type of archive to generate. NOTE: `zip` is supported.
	Type string `pulumi:"type"`
}

A collection of arguments for invoking getFile.

type LookupFileOutputArgs 

type LookupFileOutputArgs struct {
	// Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.
	ExcludeSymlinkDirectories pulumi.BoolPtrInput `pulumi:"excludeSymlinkDirectories"`
	// Specify files to ignore when reading the `sourceDir`.
	Excludes pulumi.StringArrayInput `pulumi:"excludes"`
	// 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.
	OutputFileMode pulumi.StringPtrInput `pulumi:"outputFileMode"`
	// The output of the archive file.
	OutputPath pulumi.StringInput `pulumi:"outputPath"`
	// Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContent pulumi.StringPtrInput `pulumi:"sourceContent"`
	// Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContentFilename pulumi.StringPtrInput `pulumi:"sourceContentFilename"`
	// Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceDir pulumi.StringPtrInput `pulumi:"sourceDir"`
	// Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceFile pulumi.StringPtrInput `pulumi:"sourceFile"`
	// Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	Sources GetFileSourceArrayInput `pulumi:"sources"`
	// The type of archive to generate. NOTE: `zip` is supported.
	Type pulumi.StringInput `pulumi:"type"`
}

A collection of arguments for invoking getFile.

func (LookupFileOutputArgs) ElementType 

func (LookupFileOutputArgs) ElementType() reflect.Type

type LookupFileResult 

type LookupFileResult struct {
	// Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.
	ExcludeSymlinkDirectories *bool `pulumi:"excludeSymlinkDirectories"`
	// Specify files to ignore when reading the `sourceDir`.
	Excludes []string `pulumi:"excludes"`
	// The sha1 checksum hash of the output.
	Id string `pulumi:"id"`
	// Base64 Encoded SHA256 checksum of output file
	OutputBase64sha256 string `pulumi:"outputBase64sha256"`
	// Base64 Encoded SHA512 checksum of output file
	OutputBase64sha512 string `pulumi:"outputBase64sha512"`
	// 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.
	OutputFileMode *string `pulumi:"outputFileMode"`
	// MD5 of output file
	OutputMd5 string `pulumi:"outputMd5"`
	// The output of the archive file.
	OutputPath string `pulumi:"outputPath"`
	// SHA1 checksum of output file
	OutputSha string `pulumi:"outputSha"`
	// SHA256 checksum of output file
	OutputSha256 string `pulumi:"outputSha256"`
	// SHA512 checksum of output file
	OutputSha512 string `pulumi:"outputSha512"`
	// The byte size of the output archive file.
	OutputSize int `pulumi:"outputSize"`
	// Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContent *string `pulumi:"sourceContent"`
	// Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceContentFilename *string `pulumi:"sourceContentFilename"`
	// Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceDir *string `pulumi:"sourceDir"`
	// Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	SourceFile *string `pulumi:"sourceFile"`
	// Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.
	Sources []GetFileSource `pulumi:"sources"`
	// The type of archive to generate. NOTE: `zip` is supported.
	Type string `pulumi:"type"`
}

A collection of values returned by getFile.

func LookupFile 

func LookupFile(ctx *pulumi.Context, args *LookupFileArgs, opts ...pulumi.InvokeOption) (*LookupFileResult, error)

Generates an archive from content, a file, or directory of files.

## Example Usage

<!--Start PulumiCodeChooser --> ```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
	})
}

``` <!--End PulumiCodeChooser -->

<!--Start PulumiCodeChooser --> ```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
	})
}

``` <!--End PulumiCodeChooser -->

<!--Start PulumiCodeChooser --> ```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
	})
}

``` <!--End PulumiCodeChooser -->

type LookupFileResultOutput 

type LookupFileResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getFile.

func LookupFileOutput 

func LookupFileOutput(ctx *pulumi.Context, args LookupFileOutputArgs, opts ...pulumi.InvokeOption) LookupFileResultOutput

func (LookupFileResultOutput) ElementType 

func (LookupFileResultOutput) ElementType() reflect.Type

func (LookupFileResultOutput) ExcludeSymlinkDirectories 

func (o LookupFileResultOutput) ExcludeSymlinkDirectories() pulumi.BoolPtrOutput

Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`.

func (LookupFileResultOutput) Excludes 

func (o LookupFileResultOutput) Excludes() pulumi.StringArrayOutput

Specify files to ignore when reading the `sourceDir`.

func (LookupFileResultOutput) Id 

func (o LookupFileResultOutput) Id() pulumi.StringOutput

The sha1 checksum hash of the output.

func (LookupFileResultOutput) OutputBase64sha256 

func (o LookupFileResultOutput) OutputBase64sha256() pulumi.StringOutput

Base64 Encoded SHA256 checksum of output file

func (LookupFileResultOutput) OutputBase64sha512 

func (o LookupFileResultOutput) OutputBase64sha512() pulumi.StringOutput

Base64 Encoded SHA512 checksum of output file

func (LookupFileResultOutput) OutputFileMode 

func (o LookupFileResultOutput) OutputFileMode() pulumi.StringPtrOutput

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.

func (LookupFileResultOutput) OutputMd5 

func (o LookupFileResultOutput) OutputMd5() pulumi.StringOutput

MD5 of output file

func (LookupFileResultOutput) OutputPath 

func (o LookupFileResultOutput) OutputPath() pulumi.StringOutput

The output of the archive file.

func (LookupFileResultOutput) OutputSha 

func (o LookupFileResultOutput) OutputSha() pulumi.StringOutput

SHA1 checksum of output file

func (LookupFileResultOutput) OutputSha256 

func (o LookupFileResultOutput) OutputSha256() pulumi.StringOutput

SHA256 checksum of output file

func (LookupFileResultOutput) OutputSha512 

func (o LookupFileResultOutput) OutputSha512() pulumi.StringOutput

SHA512 checksum of output file

func (LookupFileResultOutput) OutputSize 

func (o LookupFileResultOutput) OutputSize() pulumi.IntOutput

The byte size of the output archive file.

func (LookupFileResultOutput) SourceContent 

func (o LookupFileResultOutput) SourceContent() pulumi.StringPtrOutput

Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (LookupFileResultOutput) SourceContentFilename 

func (o LookupFileResultOutput) SourceContentFilename() pulumi.StringPtrOutput

Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (LookupFileResultOutput) SourceDir 

func (o LookupFileResultOutput) SourceDir() pulumi.StringPtrOutput

Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (LookupFileResultOutput) SourceFile 

func (o LookupFileResultOutput) SourceFile() pulumi.StringPtrOutput

Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (LookupFileResultOutput) Sources 

func (o LookupFileResultOutput) Sources() GetFileSourceArrayOutput

Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified.

func (LookupFileResultOutput) ToLookupFileResultOutput 

func (o LookupFileResultOutput) ToLookupFileResultOutput() LookupFileResultOutput

func (LookupFileResultOutput) ToLookupFileResultOutputWithContext 

func (o LookupFileResultOutput) ToLookupFileResultOutputWithContext(ctx context.Context) LookupFileResultOutput

func (LookupFileResultOutput) Type 

func (o LookupFileResultOutput) Type() pulumi.StringOutput

The type of archive to generate. NOTE: `zip` is supported.

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the archive package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.