@pulumi/synced-folder
Version:
A Pulumi component that synchronizes a local folder to Amazon S3, Azure Blob Storage, or Google Cloud Storage.
46 lines (45 loc) • 1.97 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class S3BucketFolder extends pulumi.ComponentResource {
/**
* Returns true if the given object is an instance of S3BucketFolder. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is S3BucketFolder;
/**
* Create a S3BucketFolder resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: S3BucketFolderArgs, opts?: pulumi.ComponentResourceOptions);
}
/**
* The set of arguments for constructing a S3BucketFolder resource.
*/
export interface S3BucketFolderArgs {
/**
* The AWS [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) to apply to each file (e.g., `public-read`). Required.
*/
acl: pulumi.Input<string>;
/**
* The name of the S3 bucket to sync to (e.g., `my-bucket` in `s3://my-bucket`). Required.
*/
bucketName: pulumi.Input<string>;
/**
* Disables adding an [alias](https://www.pulumi.com/docs/intro/concepts/resources/options/aliases/) resource option to managed objects in the bucket.
*/
disableManagedObjectAliases?: pulumi.Input<boolean>;
/**
* Include hidden files ("dotfiles") when synchronizing folders. Defaults to `false`.
*/
includeHiddenFiles?: pulumi.Input<boolean>;
/**
* Whether to have Pulumi manage files as individual cloud resources. Defaults to `true`.
*/
managedObjects?: pulumi.Input<boolean>;
/**
* The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
*/
path: pulumi.Input<string>;
}