AwsS3PushDestinationSettings interface

awsCredentials?

AwsCredentials

(Optional) Static AWS credentials to be used for connecting to S3. When not provided, the AWS SDK default credential provider chain is used (environment variables, shared profile, IMDSv2, IRSA, ECS).

awsRegion

string

The AWS region being pushed to

bucket?

string

(Optional) The bucket to upload into. When set, pathPrefix is purely a key prefix and the deprecated host/port are ignored.

defaultSegmentCount?

number

(Optional) In the absence of a HLS_SKIP query parameter, how many segments should be served in a playlist this effectively controls how far back in time a player can seek from first load (as long as the data exists)

deltaPlaylist?

string

(Optional) If specified: generate a Delta Playlist update with this playlist name (and appropriate CAN-SKIP-UNTIL tags in the main playlist). Not supported with client-side playlist rewriting.

endpoint?

string

(Optional) Optional S3-compatible endpoint URL (e.g. OCI Object Storage, MinIO). When absent, the standard AWS endpoint for awsRegion is used.

forcePathStyle?

boolean

(Optional) Use path-style addressing (bucket in the path rather than the hostname).

holdBackSeconds?

number

(Optional) Server control directive, informs the client how far back in the stream (in seconds) it should attempt to play this should take into account the end to end latency from source capture, to the segment and playlist being published

host?

string

(Optional)

id

DestinationId

A unique identifier for this destination

This can be used for supplying updates to configuration to this destination specifically see: UpdateCredentials

partHoldBackSeconds?

number

(Optional) Server control directive, informs the client how far back in the stream (in seconds) it should attempt to play when using the lower latency parts this should take into account the end to end latency from source capture, to the part and playlist being published

pathPrefix

string

the path under which segments and playlists will be pushed to

port?

number

(Optional)

retentionPeriodSeconds

number

Informs the playlist generation how long segments will be retained for on the remote server in order to generate an accurate playlist

sessionId?

string

(Optional) Optionally supply a string that will be inserted into the path structure for segments published in this stream

This is useful for stream restarts or republishing when duplicate segment IDs would be generated causing problems with cacheing directives

type

"s3"