This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.AWS.S3.

Summary

The settings to use with upload requests to Amazon S3

Assembly

Cake.AWS.S3.dll

Namespace

Cake.AWS.S3

Base Types

Object
S3Settings

Derived Types

SyncSettings

graph BT Type-->Base0["S3Settings"] click Base0 "/api/Cake.AWS.S3/S3Settings" Base0-->Base1["Object"] Type["UploadSettings"] class Type type-node Derived0["SyncSettings"]-->Type click Derived0 "/api/Cake.AWS.S3/SyncSettings"

Syntax

public class UploadSettings : S3Settings

Constructors

Name	Summary
UploadSettings()	Initializes a new instance of the `UploadSettings` class.

Properties

Name	Value	Summary
Accelerate	bool	Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. Inherited from S3Settings
AccessKey	string	The AWS Access Key ID Inherited from S3Settings
BucketName	string	Gets or sets the name of the S3 bucket. Inherited from S3Settings
CacheControl	string	How objects should be cached
CannedACL	S3CannedACL	The ACL to be used for S3 Buckets or S3 Objects.
CompressContent	bool	Gzip the content of css / js
CompressExtensions	IList<string>	List of file extensions to compress
DefaultContentType	string	Content type to use when no mime type is found
EncryptionKey	string	The base64-encoded encryption key for Amazon S3 to use to decrypt the object Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide. When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you. Important: Amazon S3 does not store the encryption key you provide. Inherited from S3Settings
EncryptionKeyMD5	string	The MD5 of the customer encryption key. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. Inherited from S3Settings
EncryptionMethod	ServerSideEncryptionCustomerMethod	The Server-side encryption algorithm to be used with the customer provided key. Inherited from S3Settings
GenerateContentLength	bool	Generate the ContentLength based on the file size in bytes
GenerateContentType	bool	Generate the ContentType based on the file extension
GenerateETag	bool	Generate an ETag based on the hash of the file
GenerateHashTag	bool	Generate a custom meta-data field based on the hash of the file
Headers	HeadersCollection	Used to set the http-headers for an S3 object.
KeyManagementServiceKeyId	string	The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be
Region	RegionEndpoint	The endpoints available to AWS clients. Inherited from S3Settings
SecretKey	string	The AWS Secret Access Key. Inherited from S3Settings
SessionToken	string	The AWS Session Token, if using temporary credentials. Inherited from S3Settings
StorageClass	S3StorageClass	Specifies the Storage Class of of an S3 object. Possible values are: ReducedRedundancy: provides a 99.99% durability guarantee Standard: provides a 99.999999999% durability guarantee
WorkingDirectory	DirectoryPath	Gets or sets the working directory for the process to be started. Inherited from S3Settings

Methods

Name	Value	Summary
Clone()	UploadSettings	Creates a new instance of the `SyncSettings` class with the current settings.
CopyS3Settings<T>(T)	T	Copies the settings to a instance of `S3Settings` class. Inherited from S3Settings
CopyUploadSettings<T>(T)	T	Copies the settings to a instance of `UploadSettings` class.

Extension Methods