sink

A Sink is a Stream Machine configuration object for a remote file storage. For now, AWS S3 and Google Cloud Storage Buckets are supported. By itself, a Sink does nothing. A Batch Exporter needs to be connected to a Sink and a Stream to start outputting events.

Upon creation, Stream Machine validates whether or not the Bucket exists and if it is accessible with the given credentials.

create

Create a new Sink, with the given name, pointing to the given bucket.

Usage

strm create sink [sink-name] [bucket-name] [flags].

Options

Option Description

sink-name

The name of this sink.

bucket-name

The simple name of the bucket, so not an URL like s3://bucket-name.

Flags

Flag Alias Description

--credentials-file string

Required: The file with the credentials used to authenticate with the bucket provider.

--sink-type string

The type of the sink. If omitted, the CLI tries to guess it, based on the structure of the credentials file. If guessing is not possible, the flag has to be specified.

See Global flags for all global flags.

delete

Delete a Sink by name.

Usage

strm delete sink [name] [flags].

Options

Option Description

name

The name of the Sink.

Flags

--recursive is supported to also delete the dependent Batch Exporters.

No specific flags. See Global flags.

get

Get a Sink by name.

Usage

strm get sink [name] [flags].

Options

Option Description

name

The name of the Sink.

Flags

--recursive is supported to also list the dependent Batch Exporters.

No specific flags. See Global flags.

list

List Sinks.

Usage

strm list sinks [flags].

Options

No options

Flags

--recursive is supported to also list the dependent Batch Exporters.

No specific flags. See Global flags.