Skip to main content

S3.Put

Examples below assume this module is imported with an imports: entry under alias S3. Kind references (S3.Put, S3.Bucket) follow that alias — if you import the module under a different name, substitute your alias accordingly.

Uploads an object to a bucket declared as S3.Bucket. Invocable — invoke per request or inside a Run.Sequence step.


Example

kind: S3.Put
metadata:
name: UploadManifest
bucketRef: !ref ModuleStore

Invoke inside a sequence:

- name: upload
invoke:
kind: S3.Put
bucketRef: !ref ModuleStore
inputs:
key: "${{ inputs.fileKey }}"
body: "${{ inputs.body }}"
contentType: "text/yaml"

Fields

FieldTypeRequiredDescription
bucketRefreferenceyesA !ref to an S3.Bucket resource — local (!ref ModuleStore) or imported (!ref Alias.ModuleStore).

Invocation inputs

InputTypeRequiredDescription
keystringyesObject key (path inside the bucket).
bodystring | Uint8ArrayyesObject content — a UTF-8 string, or buffered binary (e.g. the bytes from Octet.Decoder).
contentTypestringnoMIME type. Defaults to application/octet-stream.

Output

FieldTypeDescription
keystringThe uploaded object's key (echoed back).