Type Definitions
Credentials
An AWS Credentials Object
- Object
| Name | Type | Attributes | Description |
|---|---|---|---|
bucket | String | the AWS bucket to connect to | |
accessKeyId | String | the AWS accessKey | |
secretAccessKey | String | the AWS secretAccessKey | |
region | String | the AWS region | |
endpoint | String | <optional> | the endpoint URL when using an S3 like service (e.g. Minio) |
forcePathStyle | Boolean | <optional> | whether to force path style endpoints (required for Minio and the like) |
Transfer
A transfer Object
- Object
| Name | Type | Default | Description |
|---|---|---|---|
localPath | String | the path to the file locally that you want to upload to the item folder | |
json | String | a JSON object to store in the file directly | |
content | String | some content to store in the file directly | |
target | String | the target name for the file; this will be set relative to the item path | |
registerFile | Boolean | true | whether the file should be registered in ro-crate-metadata.json. The file will be registered in the hasPart property of the root dataset if there isn't already an entry for the file. |
version | Boolean | false | whether the file should be versioned. If true, the existing file will be copied to ${file}.v${date as ISO String}.{ext} before the new version is uploaded to the target name |