Class AWSS3SinkSettings

AWS S3 sink settings.

Inheritance

object

AWSS3SinkSettings

Implements

IMediaBlockSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.Types.X.Sinks

Assembly: VisioForge.Core.dll

Syntax

public class AWSS3SinkSettings : IMediaBlockSettings

Constructors

AWSS3SinkSettings()

Initializes a new instance of the AWSS3SinkSettings class.

Declaration

public AWSS3SinkSettings()

Properties

AccessKey

AWS Access Key.

Declaration

public string AccessKey { get; set; }

Property Value

Type	Description
string

Bucket

The bucket of the file to write.

Declaration

public string Bucket { get; set; }

Property Value

Type	Description
string

ContentDisposition

Content-Disposition header to set for uploaded object.

Declaration

public string ContentDisposition { get; set; }

Property Value

Type	Description
string

ContentType

Content-Type header to set for uploaded object.

Declaration

public string ContentType { get; set; }

Property Value

Type	Description
string

EndpointUri

The S3 endpoint URI to use.

Declaration

public string EndpointUri { get; set; }

Property Value

Type	Description
string

ForcePathStyle

Force client to use path-style addressing for buckets.

Declaration

public bool ForcePathStyle { get; set; }

Property Value

Type	Description
bool

Key

The key of the file to write.

Declaration

public string Key { get; set; }

Property Value

Type	Description
string

Metadata

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

Declaration

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

Property Value

Type	Description
Dictionary<string, string>

OnError

How to handle errors during upload.

Declaration

public S3sinkOnError OnError { get; set; }

Property Value

Type	Description
S3sinkOnError

PartSize

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

Declaration

public ulong PartSize { get; set; }

Property Value

Type	Description
ulong

Region

An AWS region.

Declaration

public string Region { get; set; }

Property Value

Type	Description
string

RequestTimeout

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

Declaration

public TimeSpan RequestTimeout { get; set; }

Property Value

Type	Description
TimeSpan

RetryAttempts

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

Declaration

public uint RetryAttempts { get; set; }

Property Value

Type	Description
uint

SecretAccessKey

AWS Secret Access Key.

Declaration

public string SecretAccessKey { get; set; }

Property Value

Type	Description
string

SessionToken

AWS temporary Session Token from STS.

Declaration

public string SessionToken { get; set; }

Property Value

Type	Description
string

Uri

The S3 object URI.

Declaration

public string Uri { get; set; }

Property Value

Type	Description
string

Methods

CreateBlock()

Creates the block.

Declaration

public MediaBlock CreateBlock()

Returns

Type	Description
MediaBlock	MediaBlock.

Implements

IMediaBlockSettings