SyncSettings Class

Summary

The settings to use when syncing a folder to Amazon S3
Assembly
Cake.AWS.S3.dll
Namespace
Cake.AWS.S3
Base Types
graph BT Type-->Base0["UploadSettings"] click Base0 "/api/Cake.AWS.S3/UploadSettings" Base0-->Base1["S3Settings"] click Base1 "/api/Cake.AWS.S3/S3Settings" Base1-->Base2["Object"] Type["SyncSettings"] class Type type-node

Syntax

public class SyncSettings : UploadSettings

Constructors

Name Summary
SyncSettings() Initializes a new instance of the SyncSettings 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
Inherited from UploadSettings
CannedACL S3CannedACL
The ACL to be used for S3 Buckets or S3 Objects.
Inherited from UploadSettings
CompressContent bool
Gzip the content of css / js
Inherited from UploadSettings
CompressExtensions IList<string>
List of file extensions to compress
Inherited from UploadSettings
DefaultContentType string
Content type to use when no mime type is found
Inherited from UploadSettings
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
Inherited from UploadSettings
GenerateContentType bool
Generate the ContentType based on the file extension
Inherited from UploadSettings
GenerateETag bool
Generate an ETag based on the hash of the file
Inherited from UploadSettings
GenerateHashTag bool
Generate a custom meta-data field based on the hash of the file
Inherited from UploadSettings
Headers HeadersCollection
Used to set the http-headers for an S3 object.
Inherited from UploadSettings
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
Inherited from UploadSettings
KeyPrefix string
The prefix to use when generating S3 keys
LowerPaths bool
Lower the file paths when generating S3 keys
ModifiedCheck ModifiedCheck
How to check if a file has been modified
Region RegionEndpoint
The endpoints available to AWS clients.
Inherited from S3Settings
SearchFilter string
The filter to use when searching for files
SearchScope SearchScope
The scope to use when searching for files
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
Inherited from UploadSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the process to be started.
Inherited from S3Settings

Methods

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

Extension Methods

Name Value Summary
Dump<SyncSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SyncSettings>(SyncSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SyncSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<SyncSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
SetAccelerate<SyncSettings>(bool) T
Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint.
Requires the Cake.AWS.S3 addin
SetAccessKey<SyncSettings>(string) T
Specifies the AWS Access Key to use as credentials.
Requires the Cake.AWS.S3 addin
SetBucketName<SyncSettings>(string) T
Specifies the name of the load balancer.
Requires the Cake.AWS.S3 addin
SetCannedACL(S3CannedACL) UploadSettings
Specifies the ACL to be used for S3 Buckets or S3 Objects.
Requires the Cake.AWS.S3 addin
SetCannedACL(string) UploadSettings
Specifies the ACL to be used for S3 Buckets or S3 Objects.
Requires the Cake.AWS.S3 addin
SetEncryptionKey<SyncSettings>(string) T
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.
Requires the Cake.AWS.S3 addin
SetEncryptionKeyMD5<SyncSettings>(string) T
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.
Requires the Cake.AWS.S3 addin
SetEncryptionMethod<SyncSettings>(ServerSideEncryptionCustomerMethod) T
Specifies the Server-side encryption algorithm to be used with the customer provided key.
Requires the Cake.AWS.S3 addin
SetGenerateContentType(bool) UploadSettings
Generate the ContentType based on the file extension
Requires the Cake.AWS.S3 addin
SetGenerateETag(bool) UploadSettings
Generate an ETag based on the hash of the file
Requires the Cake.AWS.S3 addin
SetKeyManagementServiceKeyId(string) UploadSettings
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
Requires the Cake.AWS.S3 addin
SetKeyPrefix(string) SyncSettings
The prefix to use when generating S3 keys
Requires the Cake.AWS.S3 addin
SetLowerPaths(bool) SyncSettings
Lower the file paths when generating S3 keys
Requires the Cake.AWS.S3 addin
SetModifiedCheck(ModifiedCheck) SyncSettings
The prefix to use when generating S3 keys
Requires the Cake.AWS.S3 addin
SetRegion<SyncSettings>(RegionEndpoint) T
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.S3 addin
SetRegion<SyncSettings>(string) T
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.S3 addin
SetSearchFilter(string) SyncSettings
Specifies the filter to use when searching for files.
Requires the Cake.AWS.S3 addin
SetSearchScope(SearchScope) SyncSettings
Specifies the scope to use when searching for files.
Requires the Cake.AWS.S3 addin
SetSecretKey<SyncSettings>(string) T
Specifies the AWS Secret Key to use as credentials.
Requires the Cake.AWS.S3 addin
SetSessionToken<SyncSettings>(string) T
Specifies the AWS Session Token to use as credentials.
Requires the Cake.AWS.S3 addin
SetStorageClass(S3StorageClass) UploadSettings
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
Requires the Cake.AWS.S3 addin
SetStorageClass(string) UploadSettings
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
Requires the Cake.AWS.S3 addin
ThrowIfNull<SyncSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<SyncSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin