Interface S3NodeParameters

Source

interface S3NodeParameters {
    additionalFields?:
        | {
            acl?: | "authenticatedRead"
            | "Private"
            | "publicRead"
            | "publicReadWrite";
            bucketObjectLockEnabled?: boolean;
            grantFullControl?: boolean;
            grantRead?: boolean;
            grantReadAcp?: boolean;
            grantWrite?: boolean;
            grantWriteAcp?: boolean;
            region?: string;
        }
        | {
            delimiter?: string;
            encodingType?: "url";
            fetchOwner?: boolean;
            prefix?: string;
            requesterPays?: boolean;
            startAfter?: string;
        }
        | {
            parentFolderKey?: string;
            requesterPays?: boolean;
            storageClass?: | "standard"
            | "deepArchive"
            | "glacier"
            | "intelligentTiering"
            | "onezoneIA"
            | "RecudedRedundancy"
            | "standardIA";
        }
        | {
            acl?: | "private"
            | "authenticatedRead"
            | "publicRead"
            | "publicReadWrite"
            | "awsExecRead"
            | "bucketOwnerFullControl"
            | "bucketOwnerRead";
            encryptionAwsKmsKeyId?: string;
            grantFullControl?: boolean;
            grantRead?: boolean;
            grantReadAcp?: boolean;
            grantWriteAcp?: boolean;
            lockLegalHold?: boolean;
            lockMode?: "governance"
            | "compliance";
            lockRetainUntilDate?: string;
            metadataDirective?: "copy" | "replace";
            requesterPays?: boolean;
            serverSideEncryption?: "AES256" | "aws:kms";
            serverSideEncryptionContext?: string;
            serversideEncryptionCustomerAlgorithm?: string;
            serversideEncryptionCustomerKey?: string;
            serversideEncryptionCustomerKeyMD5?: string;
            storageClass?:
                | "standard"
                | "deepArchive"
                | "glacier"
                | "intelligentTiering"
                | "onezoneIA"
                | "standardIA";
            taggingDirective?: "copy"
            | "replace";
        }
        | {
            acl?: | "private"
            | "authenticatedRead"
            | "publicRead"
            | "publicReadWrite"
            | "awsExecRead"
            | "bucketOwnerFullControl"
            | "bucketOwnerRead";
            encryptionAwsKmsKeyId?: string;
            grantFullControl?: boolean;
            grantRead?: boolean;
            grantReadAcp?: boolean;
            grantWriteAcp?: boolean;
            lockLegalHold?: boolean;
            lockMode?: "governance"
            | "compliance";
            lockRetainUntilDate?: string;
            parentFolderKey?: string;
            requesterPays?: boolean;
            serverSideEncryption?: "AES256" | "aws:kms";
            serverSideEncryptionContext?: string;
            serversideEncryptionCustomerAlgorithm?: string;
            serversideEncryptionCustomerKey?: string;
            serversideEncryptionCustomerKeyMD5?: string;
            storageClass?:
                | "standard"
                | "deepArchive"
                | "glacier"
                | "intelligentTiering"
                | "onezoneIA"
                | "standardIA";
        };
    binaryData?: boolean;
    binaryPropertyName?: string;
    bucketName?: string;
    destinationPath?: string;
    fileContent?: string;
    fileKey?: string;
    fileName?: string;
    folderKey?: string;
    folderName?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "getAll"
    | "delete"
    | "search"
    | "upload"
    | "copy"
    | "download";
    options?: | {
        fetchOwner?: boolean;
        folderKey?: string;
    }
    | { versionId?: string };
    resource?: "file" | "bucket" | "folder";
    returnAll?: boolean;
    sourcePath?: string;
    tagsUi?: {
        tagsValues: { key?: string; value?: string }[];
    };
}

Properties§

Source§

readonly additionalFields?:
    | {
        acl?: | "authenticatedRead"
        | "Private"
        | "publicRead"
        | "publicReadWrite";
        bucketObjectLockEnabled?: boolean;
        grantFullControl?: boolean;
        grantRead?: boolean;
        grantReadAcp?: boolean;
        grantWrite?: boolean;
        grantWriteAcp?: boolean;
        region?: string;
    }
    | {
        delimiter?: string;
        encodingType?: "url";
        fetchOwner?: boolean;
        prefix?: string;
        requesterPays?: boolean;
        startAfter?: string;
    }
    | {
        parentFolderKey?: string;
        requesterPays?: boolean;
        storageClass?: | "standard"
        | "deepArchive"
        | "glacier"
        | "intelligentTiering"
        | "onezoneIA"
        | "RecudedRedundancy"
        | "standardIA";
    }
    | {
        acl?: | "private"
        | "authenticatedRead"
        | "publicRead"
        | "publicReadWrite"
        | "awsExecRead"
        | "bucketOwnerFullControl"
        | "bucketOwnerRead";
        encryptionAwsKmsKeyId?: string;
        grantFullControl?: boolean;
        grantRead?: boolean;
        grantReadAcp?: boolean;
        grantWriteAcp?: boolean;
        lockLegalHold?: boolean;
        lockMode?: "governance"
        | "compliance";
        lockRetainUntilDate?: string;
        metadataDirective?: "copy" | "replace";
        requesterPays?: boolean;
        serverSideEncryption?: "AES256" | "aws:kms";
        serverSideEncryptionContext?: string;
        serversideEncryptionCustomerAlgorithm?: string;
        serversideEncryptionCustomerKey?: string;
        serversideEncryptionCustomerKeyMD5?: string;
        storageClass?:
            | "standard"
            | "deepArchive"
            | "glacier"
            | "intelligentTiering"
            | "onezoneIA"
            | "standardIA";
        taggingDirective?: "copy"
        | "replace";
    }
    | {
        acl?: | "private"
        | "authenticatedRead"
        | "publicRead"
        | "publicReadWrite"
        | "awsExecRead"
        | "bucketOwnerFullControl"
        | "bucketOwnerRead";
        encryptionAwsKmsKeyId?: string;
        grantFullControl?: boolean;
        grantRead?: boolean;
        grantReadAcp?: boolean;
        grantWriteAcp?: boolean;
        lockLegalHold?: boolean;
        lockMode?: "governance"
        | "compliance";
        lockRetainUntilDate?: string;
        parentFolderKey?: string;
        requesterPays?: boolean;
        serverSideEncryption?: "AES256" | "aws:kms";
        serverSideEncryptionContext?: string;
        serversideEncryptionCustomerAlgorithm?: string;
        serversideEncryptionCustomerKey?: string;
        serversideEncryptionCustomerKeyMD5?: string;
        storageClass?:
            | "standard"
            | "deepArchive"
            | "glacier"
            | "intelligentTiering"
            | "onezoneIA"
            | "standardIA";
    }

Default: {}

Source§

readonly binaryData?: boolean

Whether the data to upload should be taken from binary field Default: true

Source§

readonly binaryPropertyName?: string

Default: "data"

Source§

readonly bucketName?: string

Source§

readonly destinationPath?: string

The name of the destination bucket and key name of the destination object, separated by a slash (/)

Source§

readonly fileContent?: string

The text content of the file to upload

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

Source§

readonly name?: string

A succinct description of the nature, symptoms, cause, or effect of the bucket

Source§

readonly operation?:
    | "create"
    | "getAll"
    | "delete"
    | "search"
    | "upload"
    | "copy"
    | "download"

Default: "create"

Source§

readonly options?:
| { fetchOwner?: boolean; folderKey?: string }
| { versionId?: string }

Default: {}

Source§

readonly resource?: "file" | "bucket" | "folder"

Default: "file"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly sourcePath?: string

The name of the source bucket should start with (/) and key name of the source object, separated by a slash (/)

Source§

readonly tagsUi?: { tagsValues: { key?: string; value?: string }[] }

Optional extra headers to add to the message (most headers are allowed) Default: {} Type options: {"multipleValues":true}

Interface S3NodeParametersCopy item path

Properties§

readonly binaryData?: boolean

readonly binaryPropertyName?: string

readonly bucketName?: string

readonly destinationPath?: string

readonly fileContent?: string

readonly fileKey?: string

readonly fileName?: string

readonly folderKey?: string

readonly folderName?: string

readonly limit?: number

readonly name?: string

readonly operation?: | "create" | "getAll" | "delete" | "search" | "upload" | "copy" | "download"

readonly options?: | { fetchOwner?: boolean; folderKey?: string } | { versionId?: string }

readonly resource?: "file" | "bucket" | "folder"

readonly returnAll?: boolean

readonly sourcePath?: string

readonly tagsUi?: { tagsValues: { key?: string; value?: string }[] }

Interface S3NodeParameters

readonly operation?:
| "create"
| "getAll"
| "delete"
| "search"
| "upload"
| "copy"
| "download"

readonly options?:
| { fetchOwner?: boolean; folderKey?: string }
| { versionId?: string }