Struct S3StorageBinding 

pub struct S3StorageBinding {
    pub access_key_id: Option<BindingValueString>,
    pub bucket_name: BindingValueString,
    pub endpoint: Option<BindingValueString>,
    pub force_path_style: Option<bool>,
    pub region: Option<BindingValueString>,
    pub secret_access_key: Option<BindingValueString>,
}

S3 storage binding configuration.

Targets AWS S3 by default. Setting endpoint targets any S3-compatible store instead (MinIO, Ceph RGW, NetApp StorageGRID, Cloudflare R2, …), which is how Kubernetes deployments outside a cloud account attach the customer’s existing object storage.

JSON schema

{
 "description": "S3 storage binding configuration.\n\nTargets AWS S3 by default. Setting `endpoint` targets any S3-compatible\nstore instead (MinIO, Ceph RGW, NetApp StorageGRID, Cloudflare R2, ...),\nwhich is how Kubernetes deployments outside a cloud account attach the\ncustomer's existing object storage.",
 "type": "object",
 "required": [
   "bucketName"
 ],
 "properties": {
   "accessKeyId": {
     "description": "Static access key ID. Unset means the ambient AWS credential chain.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/BindingValue_String"
           }
         ]
       }
     ]
   },
   "bucketName": {
     "$ref": "#/components/schemas/BindingValue_String"
   },
   "endpoint": {
     "description": "Endpoint of an S3-compatible store, e.g. `https://minio.internal:9000`.\nUnset means AWS S3.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/BindingValue_String"
           }
         ]
       }
     ]
   },
   "forcePathStyle": {
     "description": "Use path-style URLs (`endpoint/bucket/key`) instead of virtual-hosted\nones (`bucket.endpoint/key`). Defaults to `true` when `endpoint` is\nset, since most S3-compatible stores require it.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "region": {
     "description": "Region to sign requests for. Defaults to the ambient AWS region, or\n`us-east-1` for S3-compatible endpoints.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/BindingValue_String"
           }
         ]
       }
     ]
   },
   "secretAccessKey": {
     "description": "Static secret access key; required when `accessKeyId` is set.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/BindingValue_String"
           }
         ]
       }
     ]
   }
 }
}

Fields

access_key_id: Option<BindingValueString>

Static access key ID. Unset means the ambient AWS credential chain.

bucket_name: BindingValueString

endpoint: Option<BindingValueString>

Endpoint of an S3-compatible store, e.g. https://minio.internal:9000. Unset means AWS S3.

force_path_style: Option<bool>

Use path-style URLs (endpoint/bucket/key) instead of virtual-hosted ones (bucket.endpoint/key). Defaults to true when endpoint is set, since most S3-compatible stores require it.

region: Option<BindingValueString>

Region to sign requests for. Defaults to the ambient AWS region, or us-east-1 for S3-compatible endpoints.

secret_access_key: Option<BindingValueString>

Static secret access key; required when accessKeyId is set.

Implementations

impl S3StorageBinding

pub fn builder() -> S3StorageBinding

Trait Implementations

impl Clone for S3StorageBinding

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for S3StorageBinding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for S3StorageBinding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&S3StorageBinding> for S3StorageBinding

fn from(value: &S3StorageBinding) -> Self

Converts to this type from the input type.

impl From<S3StorageBinding> for S3StorageBinding

fn from(value: S3StorageBinding) -> Self

Converts to this type from the input type.

impl Serialize for S3StorageBinding

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<S3StorageBinding> for S3StorageBinding

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: S3StorageBinding) -> Result<Self, ConversionError>

Performs the conversion.