Table of Contents

Class AWSS3SinkSettings

Namespace
VisioForge.Core.Types.X.Sinks
Assembly
VisioForge.Core.dll

AWS S3 sink settings.

public class AWSS3SinkSettings : IMediaBlockSettings

Inheritance

Implements

Inherited Members

Constructors

AWSS3SinkSettings()

Initializes a new instance of the VisioForge.Core.Types.X.Sinks.AWSS3SinkSettings class.

public AWSS3SinkSettings()

Properties

AccessKey

AWS Access Key.

public string AccessKey { get; set; }

Property Value

string

Bucket

The bucket of the file to write.

public string Bucket { get; set; }

Property Value

string

ContentDisposition

Content-Disposition header to set for uploaded object.

public string ContentDisposition { get; set; }

Property Value

string

ContentType

Content-Type header to set for uploaded object.

public string ContentType { get; set; }

Property Value

string

EndpointUri

The S3 endpoint URI to use.

public string EndpointUri { get; set; }

Property Value

string

ForcePathStyle

Force client to use path-style addressing for buckets.

public bool ForcePathStyle { get; set; }

Property Value

bool

Key

The key of the file to write.

public string Key { get; set; }

Property Value

string

MaxLatency

Maximum latency before uploading buffer (in nanoseconds).

public ulong MaxLatency { get; set; }

Property Value

ulong

Metadata

A map of metadata to store with the object in S3.

public Dictionary<string, string> Metadata { get; set; }

Property Value

Dictionary<string, string>

OnError

How to handle errors during upload.

public S3SinkOnError OnError { get; set; }

Property Value

S3SinkOnError

PartSize

A size (in bytes) of an individual part used for multipart upload.

public ulong PartSize { get; set; }

Property Value

ulong

QueueSize

Size of the upload queue.

public uint QueueSize { get; set; }

Property Value

uint

Region

An AWS region.

public string Region { get; set; }

Property Value

string

RequestTimeout

Timeout for general S3 requests (set to Zero for infinity).

public TimeSpan RequestTimeout { get; set; }

Property Value

TimeSpan

RetryAttempts

Number of times AWS SDK attempts a request before abandoning the request.

public uint RetryAttempts { get; set; }

Property Value

uint

SecretAccessKey

AWS Secret Access Key.

public string SecretAccessKey { get; set; }

Property Value

string

ServerSideEncryption

Server-side encryption method (e.g., "AES256", "aws:kms").

public string ServerSideEncryption { get; set; }

Property Value

string

SessionToken

AWS temporary Session Token from STS.

public string SessionToken { get; set; }

Property Value

string

StorageClass

Storage class for the uploaded object (e.g., "STANDARD", "STANDARD_IA", "GLACIER").

public string StorageClass { get; set; }

Property Value

string

Uri

The S3 object URI.

public string Uri { get; set; }

Property Value

string

UseMultipartUpload

Use multipart upload for large files.

public bool UseMultipartUpload { get; set; }

Property Value

bool

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.