S3Settings Class

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 requests to Amazon S3

Assembly

Cake.AWS.S3.dll

Namespace

Base Types

Object

Derived Types

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

Syntax

public abstract class S3Settings

Constructors

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

Properties

Name	Value	Summary
Accelerate	bool	Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint.
AccessKey	string	The AWS Access Key ID
BucketName	string	Gets or sets the name of the S3 bucket.
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.
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.
EncryptionMethod	ServerSideEncryptionCustomerMethod	The Server-side encryption algorithm to be used with the customer provided key.
Region	RegionEndpoint	The endpoints available to AWS clients.
SecretKey	string	The AWS Secret Access Key.
SessionToken	string	The AWS Session Token, if using temporary credentials.
WorkingDirectory	DirectoryPath	Gets or sets the working directory for the process to be started.

Methods

Name	Value	Summary
CopyS3Settings<T>(T)	T	Copies the settings to a instance of `S3Settings` class.

Extension Methods

Name	Value	Summary
Dump<S3Settings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<S3Settings>(S3Settings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<S3Settings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<S3Settings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
SetAccelerate<S3Settings>(bool)	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<S3Settings>(string)	T	Specifies the AWS Access Key to use as credentials. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetBucketName<S3Settings>(string)	T	Specifies the name of the load balancer. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetEncryptionKey<S3Settings>(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. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetEncryptionKeyMD5<S3Settings>(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. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetEncryptionMethod<S3Settings>(ServerSideEncryptionCustomerMethod)	T	Specifies the Server-side encryption algorithm to be used with the customer provided key. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetRegion<S3Settings>(RegionEndpoint)	T	Specifies the endpoints available to AWS clients. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetRegion<S3Settings>(string)	T	Specifies the endpoints available to AWS clients. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetSecretKey<S3Settings>(string)	T	Specifies the AWS Secret Key to use as credentials. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
SetSessionToken<S3Settings>(string)	T	Specifies the AWS Session Token to use as credentials. From S3SettingsExtensions Requires the Cake.AWS.S3 addin
ThrowIfNull<S3Settings>(string, string)	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<S3Settings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin