Struct StorageProviderS3 

pub struct StorageProviderS3 {

    pub url: Option<String>,
    pub bucket: Option<String>,
    pub region: Option<String>,
    pub key: Option<String>,
    pub secret: Option<String>,
    pub base_path: Option<String>,
    pub endpoint: Option<String>,
    pub use_vhost_request: Option<bool>,
    pub token: Option<String>,
    pub kms: Option<String>,
    pub use_bucket_key: Option<bool>,
    pub multipart_threshold: ByteSize,
    pub multipart_part_size: ByteSize,
    pub use_https: Option<bool>,
    pub use_signatures: Option<bool>,
    pub use_payload_signatures: Option<bool>,
    pub startup_check: bool,
}

Fields

url: Option<String>

Supply an s3 URL e.g. “s3://bucket/path”. These URLs may contain one or all of bucket, region, and path . When not supplied, such additional items can be supplied below individually.

bucket: Option<String>

The name of the S3 bucket. e.g. “bucketname-123456789-us-west-2-an”.

region: Option<String>

The region of the S3 bucket. e.g. “us-west-2”.

default: “us-east-1”

key: Option<String>

Your amazon IAM Key ID with access granted to this bucket. e.g. “ABCDEFG1X1ZZYYXXWWVV”

secret: Option<String>

The secret key component which is approx 40 characters of base64.

default: display: sensitive

base_path: Option<String>

Optional path prefix within the bucket where all our operations will take place.

endpoint: Option<String>

(expert use) Override the location of s3 applied after components of the parsed url (or when none set).

use_vhost_request: Option<bool>

(expert use) Override this property useful for some self-hosted environments. By default it is derived when parsing the primary url.

token: Option<String>

(expert use) Alternative session-token authentication method.

display: sensitive default:

kms: Option<String>

(expert use) Associated SSE-KMS key material.

display: sensitive

use_bucket_key: Option<bool>

(expert use) When configured for the bucket it should be reflected here.

multipart_threshold: ByteSize

(expert use) Threshold size for switching to Multi-part uploads. This is a quirk of the S3 protocol which requires us to use a different approach for “large” uploads. This value determines what a “large” upload is. The default value should be sufficient for most providers. The value is a parsed string allowing SI or IEC units for convenience.

default: 100 MiB

multipart_part_size: ByteSize

(expert use) Size of each individual part within a Multi-part upload. Once an upload exceeds multipart_threshold the payload is split into parts of this size, each sent as a separate HTTP PUT. Smaller values keep individual requests under per-request timeouts on slow uplinks at the cost of more round-trips. S3 requires every part except the last to be at least 5 MiB. The value is a parsed string allowing SI or IEC units for convenience.

default: 10 MiB

use_https: Option<bool>

(developer use) Allows relaxing default requirement forcing HTTPS.

default: true

use_signatures: Option<bool>

(developer_use) Allows skipping request header signatures (will be reejected by AWS).

default: true

use_payload_signatures: Option<bool>

(developer_use) Allows disabling request payload signatures.

default: true

startup_check: bool

(developer use) Enables checks performed at startup such as pinging the provider. Failures are considered critical startup errors which abort startup. When set to false, faulty providers are only discovered with first use and will not be fatal errors.

Only set this to false if you expect a provider to be down at startup or for development/testing purposes; checks are disabled when the server is started in ‘–maintenance’ mode.

default: true

Trait Implementations

impl Clone for StorageProviderS3

fn clone(&self) -> StorageProviderS3

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StorageProviderS3

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StorageProviderS3

fn default() -> StorageProviderS3

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StorageProviderS3

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StorageProviderS3

fn fmt(&self, out: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.