Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Synced Folder
  3. API Docs
  4. S3BucketFolder
Synced Folder v0.11.1 published on Wednesday, Aug 2, 2023 by Pulumi
pulumi/pulumi-synced-folder

synced-folder.S3BucketFolder

Explore with Pulumi AI

synced-folder logo
Synced Folder v0.11.1 published on Wednesday, Aug 2, 2023 by Pulumi
pulumi/pulumi-synced-folder

    Create S3BucketFolder Resource

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

    Constructor syntax

    new S3BucketFolder(name: string, args: S3BucketFolderArgs, opts?: ComponentResourceOptions);
    @overload
def S3BucketFolder(resource_name: str,
                   args: S3BucketFolderArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def S3BucketFolder(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   acl: Optional[str] = None,
                   bucket_name: Optional[str] = None,
                   path: Optional[str] = None,
                   disable_managed_object_aliases: Optional[bool] = None,
                   include_hidden_files: Optional[bool] = None,
                   managed_objects: Optional[bool] = None)
    func NewS3BucketFolder(ctx *Context, name string, args S3BucketFolderArgs, opts ...ResourceOption) (*S3BucketFolder, error)
    public S3BucketFolder(string name, S3BucketFolderArgs args, ComponentResourceOptions? opts = null)
    public S3BucketFolder(String name, S3BucketFolderArgs args)
public S3BucketFolder(String name, S3BucketFolderArgs args, ComponentResourceOptions options)

    type: synced-folder:S3BucketFolder
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 S3BucketFolderArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args S3BucketFolderArgs
    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 S3BucketFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args S3BucketFolderArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args S3BucketFolderArgs
    The arguments to resource properties.
    options ComponentResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var s3bucketFolderResource = new SyncedFolder.S3BucketFolder("s3bucketFolderResource", new()
{
    Acl = "string",
    BucketName = "string",
    Path = "string",
    DisableManagedObjectAliases = false,
    IncludeHiddenFiles = false,
    ManagedObjects = false,
});

    example, err := syncedfolder.NewS3BucketFolder(ctx, "s3bucketFolderResource", &syncedfolder.S3BucketFolderArgs{
	Acl:                         pulumi.String("string"),
	BucketName:                  pulumi.String("string"),
	Path:                        pulumi.String("string"),
	DisableManagedObjectAliases: pulumi.Bool(false),
	IncludeHiddenFiles:          pulumi.Bool(false),
	ManagedObjects:              pulumi.Bool(false),
})

    var s3bucketFolderResource = new S3BucketFolder("s3bucketFolderResource", S3BucketFolderArgs.builder()
    .acl("string")
    .bucketName("string")
    .path("string")
    .disableManagedObjectAliases(false)
    .includeHiddenFiles(false)
    .managedObjects(false)
    .build());

    s3bucket_folder_resource = synced_folder.S3BucketFolder("s3bucketFolderResource",
    acl="string",
    bucket_name="string",
    path="string",
    disable_managed_object_aliases=False,
    include_hidden_files=False,
    managed_objects=False)

    const s3bucketFolderResource = new synced_folder.S3BucketFolder("s3bucketFolderResource", {
    acl: "string",
    bucketName: "string",
    path: "string",
    disableManagedObjectAliases: false,
    includeHiddenFiles: false,
    managedObjects: false,
});

    type: synced-folder:S3BucketFolder
properties:
    acl: string
    bucketName: string
    disableManagedObjectAliases: false
    includeHiddenFiles: false
    managedObjects: false
    path: string

    S3BucketFolder 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 S3BucketFolder resource accepts the following input properties:

    Acl string
    The AWS Canned ACL to apply to each file (e.g., public-read). Required.
    BucketName string
    The name of the S3 bucket to sync to (e.g., my-bucket in s3://my-bucket). Required.
    Path string
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    DisableManagedObjectAliases bool
    Disables adding an alias resource option to managed objects in the bucket.
    IncludeHiddenFiles bool
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    ManagedObjects bool
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    Acl string
    The AWS Canned ACL to apply to each file (e.g., public-read). Required.
    BucketName string
    The name of the S3 bucket to sync to (e.g., my-bucket in s3://my-bucket). Required.
    Path string
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    DisableManagedObjectAliases bool
    Disables adding an alias resource option to managed objects in the bucket.
    IncludeHiddenFiles bool
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    ManagedObjects bool
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    acl String
    The AWS Canned ACL to apply to each file (e.g., public-read). Required.
    bucketName String
    The name of the S3 bucket to sync to (e.g., my-bucket in s3://my-bucket). Required.
    path String
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    disableManagedObjectAliases Boolean
    Disables adding an alias resource option to managed objects in the bucket.
    includeHiddenFiles Boolean
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managedObjects Boolean
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    acl string
    The AWS Canned ACL to apply to each file (e.g., public-read). Required.
    bucketName string
    The name of the S3 bucket to sync to (e.g., my-bucket in s3://my-bucket). Required.
    path string
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    disableManagedObjectAliases boolean
    Disables adding an alias resource option to managed objects in the bucket.
    includeHiddenFiles boolean
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managedObjects boolean
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    acl str
    The AWS Canned ACL to apply to each file (e.g., public-read). Required.
    bucket_name str
    The name of the S3 bucket to sync to (e.g., my-bucket in s3://my-bucket). Required.
    path str
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    disable_managed_object_aliases bool
    Disables adding an alias resource option to managed objects in the bucket.
    include_hidden_files bool
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managed_objects bool
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    acl String
    The AWS Canned ACL to apply to each file (e.g., public-read). Required.
    bucketName String
    The name of the S3 bucket to sync to (e.g., my-bucket in s3://my-bucket). Required.
    path String
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    disableManagedObjectAliases Boolean
    Disables adding an alias resource option to managed objects in the bucket.
    includeHiddenFiles Boolean
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managedObjects Boolean
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.

    Outputs

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

    Package Details

    Repository
    synced-folder pulumi/pulumi-synced-folder
    License
    synced-folder logo
    Synced Folder v0.11.1 published on Wednesday, Aug 2, 2023 by Pulumi
    pulumi/pulumi-synced-folder