Class AWSS3StorageCacheOptions
Configuration options for the AWSS3StorageCache provider.
Inherited Members
Namespace: SixLabors.ImageSharp.Web.Caching.AWS
Assembly: SixLabors.ImageSharp.Web.Providers.AWS.dll
Syntax
public class AWSS3StorageCacheOptions
Properties
| Edit this page View SourceAccessKey
Gets or sets the AWS key - Can be used to override keys provided by the environment. If deploying inside an EC2 instance AWS keys will already be available via environment variables and don't need to be specified. Follow AWS best security practices on https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
Declaration
public string? AccessKey { get; set; }
Property Value
Type | Description |
---|---|
string |
AccessSecret
Gets or sets the AWS endpoint - used to override the default service endpoint. If deploying inside an EC2 instance AWS keys will already be available via environment variables and don't need to be specified. Follow AWS best security practices on https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
Declaration
public string? AccessSecret { get; set; }
Property Value
Type | Description |
---|---|
string |
BucketName
Gets or sets the AWS bucket name.
Declaration
public string BucketName { get; set; }
Property Value
Type | Description |
---|---|
string |
CacheFolder
Gets or sets the cache folder's name that'll store cache files under the configured bucket.
Declaration
public string? CacheFolder { get; set; }
Property Value
Type | Description |
---|---|
string |
Endpoint
Gets or sets the AWS endpoint - used for testing to over region endpoint allowing it to be set to localhost.
Declaration
public string? Endpoint { get; set; }
Property Value
Type | Description |
---|---|
string |
Region
Gets or sets the AWS region endpoint (us-east-1/us-west-1/ap-southeast-2).
Declaration
public string? Region { get; set; }
Property Value
Type | Description |
---|---|
string |
Timeout
Gets or sets a value indicating the timeout for the S3 client. If the value is set, the value is assigned to the Timeout property of the HttpWebRequest/HttpClient object used to send requests.
Declaration
public TimeSpan? Timeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan? |
UseAccelerateEndpoint
Gets or sets a value indicating whether the S3 accelerate endpoint is used. The feature must be enabled on the bucket. Follow AWS instruction on https://docs.aws.amazon.com/AmazonS3/latest/userguide/transfer-acceleration.html.
Declaration
public bool UseAccelerateEndpoint { get; set; }
Property Value
Type | Description |
---|---|
bool |