kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

docs: s3 lib: deprecated #Put in favor #Object

Browse Source 
Signed-off-by: Sam Alba <sam.alba@gmail.com>
This commit is contained in:
Sam Alba
2021-06-15 18:42:51 +02:00
parent 5eb40b3176
commit 0d5f41ee31
4 changed files with 14 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/reference/universe/aws/s3.md
View File

@@ -6,32 +6,11 @@ sidebar_label: s3
AWS Simple Storage Service
## #Put
## #Object
S3 Bucket upload (file or directory)
S3 Bucket object(s) sync
### #Put Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*config.region* | `string` |AWS region |
|*config.accessKey* | `dagger.#Secret` |AWS access key |
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*target* | `string` |Target S3 URL (eg. s3://\<bucket-name\>/\<path\>/\<sub-path\>) |
|*contentType* | `*"" \| string` |Object content type |
|*always* | `*true \| bool` |Always write the object to S3 |
### #Put Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
|*url* | `string` |URL of the uploaded S3 object |
## #Sync
S3 Bucket sync
### #Sync Inputs
### #Object Inputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |
@@ -40,11 +19,11 @@ S3 Bucket sync
|*config.secretKey* | `dagger.#Secret` |AWS secret key |
|*source* | `dagger.#Artifact` |Source Artifact to upload to S3 |
|*target* | `string` |Target S3 URL (eg. s3://\<bucket-name\>/\<path\>/\<sub-path\>) |
|*delete* | `*false \| bool` |Delete files that already exist on remote destination |
|*delete* | `false` |Delete files that already exist on remote destination |
|*contentType* | `*"" \| string` |Object content type |
|*always* | `*true \| bool` |Always write the object to S3 |
|*always* | `*true \| false` |Always write the object to S3 |
### #Sync Outputs
### #Object Outputs
| Name | Type | Description |
| ------------- |:-------------: |:-------------: |