CreateBucket

Create Key/Value bucket in NATS.

yaml
type: "io.kestra.plugin.nats.kv.CreateBucket"

Examples

Creates a new Key/Value bucket, with all required properties.

yaml
id: nats_kv_create_bucket
namespace: company.team

tasks:
  - id: create_bucket
    type: io.kestra.plugin.nats.kv.CreateBucket
    url: nats://localhost:4222
    username: nats_user
    password: nats_passwd
    name: my_bucket

Creates a new Key/Value bucket.

yaml
id: nats_kv_create_bucket
namespace: company.team

tasks:
  - id: create_bucket
    type: io.kestra.plugin.nats.kv.CreateBucket
    url: nats://localhost:4222
    username: nats_user
    password: nats_passwd
    name: my_bucket
    description: my bucket for special purposes
    historyPerKey: 2
    bucketSize: 1024
    valueSize: 1024
    metadata: {"key1":"value1","key2":"value2"}

Properties

name *string

Min length 1

url *string

Min length 1

URL to connect to NATS server

The format is (nats://)server_url: port. You can also provide a connection token like so: nats://token@server_url: port

bucketSize integerstring

creds string

Credentials files authentification

description string

The description of the key value bucket.

historyPerKey integerstring

Default 1

metadata object

SubType string

The metadata of the key value bucket.

password string

Plaintext authentication password

token string

Token authentification

username string

Plaintext authentication username

valueSize integerstring

Outputs

bucket string

The name of the key value bucket.

bucketSize integer

Default 0

The maximum size in bytes for this bucket.

description string

The description of the bucket.

entryCount integer

Default 0

The number of total entries in the bucket, including historical entries.

history integer

Default 0

The maximum number of history for a key.

metadata object

SubType string

The metadata for the store

valueSize integer

Default 0

The maximum size in bytes for an individual value in the bucket.

​Create​Bucket

CreateBucket