S3 Backend Config Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/objectStorage/properties/restore/properties/sources/properties/s3
Supports both AWS and non-AWS implementations.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (S3 Backend Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| region | string |
Optional | cannot be null | Welkin Apps Config |
| regionEndpoint | string |
Optional | cannot be null | Welkin Apps Config |
| forcePathStyle | boolean |
Optional | cannot be null | Welkin Apps Config |
region¶
Region to store data.
region
-
is optional
-
Type:
string(S3 Region) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (S3 Region)
regionEndpoint¶
Endpoint to reach the S3 service, mainly applicable for non-AWS implementations.
Make sure to prepend the protocol (e.g. https://).
regionEndpoint
-
is optional
-
Type:
string(S3 Region Endpoint) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (S3 Region Endpoint)
CONSTRAINTS:
URI: the string must be a URI, according to RFC 3986
forcePathStyle¶
Force the use of path style access instead of virtual host style access.
Generally false when using AWS, Exoscale, and UpCloud and true for other providers.
forcePathStyle
-
is optional
-
Type:
boolean(S3 Force Path Style) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
boolean (S3 Force Path Style)
Return to the root config schema
Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main