How to use the Alibaba Cloud plugin

This plugin integrates Kestra flows with Alibaba Cloud. It currently covers Object Storage Service (OSS) through the io.kestra.plugin.alibaba.oss tasks. See the OSS Java SDK reference for the underlying API.

Authentication

Every task needs an AccessKey pair, and a Security Token Service (STS) token when you use temporary credentials.

• accessKeyId: the AccessKey ID.
• accessKeySecret: the AccessKey secret.
• securityToken: optional STS token.
• region: the region ID, for example cn-hangzhou. The endpoint defaults to https://oss-<region>.aliyuncs.com.
• endpointOverride: optional URL that replaces the region-derived endpoint. It must use https, unless pathStyleAccess is true, which allows plain http for local emulators. Treat it as trusted input, because signed requests and the STS token are sent to it.

Role-based credentials (ECS instance roles and RAM roles) are not supported.

Store the credentials as secrets and set them once for all tasks with plugin defaults:

pluginDefaults: 
  - type: io.kestra.plugin.alibaba.oss
    values: 
      accessKeyId: "{{ secret('ALIBABA_ACCESS_KEY_ID') }}"
      accessKeySecret: "{{ secret('ALIBABA_ACCESS_KEY_SECRET') }}"
      region: cn-hangzhou

Tasks

io.kestra.plugin.alibaba.oss.Upload

Uploads a file from Kestra internal storage to a bucket. The file is sent in a single request, so it is limited to 5 GB.

• Required: bucket, key, from.
• Optional: pathStyleAccess (address buckets as <endpoint>/<bucket>, useful with emulators).
• Outputs: etag, key.

io.kestra.plugin.alibaba.oss.Download

Downloads an object into Kestra internal storage.

• Required: bucket, key.
• Optional: pathStyleAccess.
• Outputs: uri, size.