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 downlad requests to Amazon S3
- Assembly
- Cake
.AWS .S3 .dll - Namespace
- Cake
.AWS .S3 - Base Types
-
- Object
- S3Settings
graph BT
Type-->Base0["S3Settings"]
click Base0 "/api/Cake.AWS.S3/S3Settings"
Base0-->Base1["Object"]
Type["DownloadSettings"]
class Type type-node
Syntax
public class DownloadSettings : S3SettingsConstructors
| Name | Summary |
|---|---|
| DownloadSettings |
Initializes a new instance of the DownloadSettings 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
|
| 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 | Server |
The Server-side encryption algorithm to be used with the customer provided key.
Inherited from S3Settings
|
| ModifiedDate | DateTime |
The date the file was last modified
|
| 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
|
| WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the process to be started.
Inherited from S3Settings
|
Methods
| Name | Value | Summary |
|---|---|---|
| Copy |
DownloadSettings |
Creates a new instance of the
DownloadSettings class with the current settings.
|
| CopyS3Settings |
T |
Copies the settings to a instance of
S3Settings class.
Inherited from S3Settings
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| SetAccelerate |
T |
Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetAccessKey |
T |
Specifies the AWS Access Key to use as credentials.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetBucketName |
T |
Specifies the name of the load balancer.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetEncryptionKey |
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.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetEncryptionKeyMD5 |
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.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetEncryptionMethod |
T |
Specifies the Server-side encryption algorithm to be used with the customer provided key.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetModifiedDate |
DownloadSettings |
Specifies the date the file was last modified
Requires the Cake.AWS.S3 addin
|
| SetRegion |
T |
Specifies the endpoints available to AWS clients.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetRegion |
T |
Specifies the endpoints available to AWS clients.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetSecretKey |
T |
Specifies the AWS Secret Key to use as credentials.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| SetSessionToken |
T |
Specifies the AWS Session Token to use as credentials.
From S3SettingsExtensions
Requires the Cake.AWS.S3 addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|