S3SettingsExtensions Class

Summary

Contains extension methods for S3Settings.
Assembly
Cake.AWS.S3.dll
Namespace
Cake.AWS.S3
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["S3SettingsExtensions"] class Type type-node

Syntax

public static class S3SettingsExtensions

Methods

Name Value Summary
SetAccelerate<T>(T, bool) T
Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint.
static
SetAccessKey<T>(T, string) T
Specifies the AWS Access Key to use as credentials.
static
SetBucketName<T>(T, string) T
Specifies the name of the load balancer.
static
SetEncryptionKey<T>(T, 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.
static
SetEncryptionKeyMD5<T>(T, 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.
static
SetEncryptionMethod<T>(T, ServerSideEncryptionCustomerMethod) T
Specifies the Server-side encryption algorithm to be used with the customer provided key.
static
SetRegion<T>(T, RegionEndpoint) T
Specifies the endpoints available to AWS clients.
static
SetRegion<T>(T, string) T
Specifies the endpoints available to AWS clients.
static
SetSecretKey<T>(T, string) T
Specifies the AWS Secret Key to use as credentials.
static
SetSessionToken<T>(T, string) T
Specifies the AWS Session Token to use as credentials.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin