S3 Bucket Alerts 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/prometheus/$defs/s3BucketAlerts
Definitions for S3 bucket alerts.
| 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 Bucket Alerts)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| objects | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| size | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| totalSize | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| exclude | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
objects¶
Alert when an S3 buckets reaches the set percentage of the set number of objects.
objects
-
is optional
-
Type:
object(S3 Bucket Alerts Objects) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (S3 Bucket Alerts Objects)
size¶
Alert when an S3 bucket reaches the set percentage of the set size.
size
-
is optional
-
Type:
object(S3 Bucket Alerts Size) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (S3 Bucket Alerts Size)
totalSize¶
Alert when all S3 buckets reaches the set percentage of the set size.
totalSize
-
is optional
-
Type:
object(S3 Bucket Alerts Total Size) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (S3 Bucket Alerts Total Size)
exclude¶
Exclude buckets from S3 alerts.
exclude
-
is optional
-
Type:
string[](S3 Bucket Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[] (S3 Bucket Name)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main