@rio-cloud/cdk-v2-constructs 6.0.1 → 6.2.1

package/README.md

@@ -18,18 +18,18 @@ $ npm install --save @rio-cloud/cdk-v2-constructs
 
 ## See also
 
- * [How to contribute](./CONTRIBUTION.md)
- * [Changelog](./CHANGELOG.md)
- * [brief API description](./API.md)
+ * [How to contribute](./docs/contribution.md)
+ * [Changelog](./docs/changelog.md)
+ * [brief API description](./docs/API.md)
 
 ## Internal documentation for library devs
-[Documentation](./developers-readme.md)
+[Documentation](./docs/developers-readme.md)
 
 ## Constructs overview (Under construction...)
 
 ### Watchful
 
-Watchful constructs help generate some default monitors based on the resouces defined in your stack. Eg - If your stack contains a lambda function and you configure watchful construct, then it will create out of box metric monitors for Throttling, Lambda error and Log error monitors. The ever growing list of resources that watchful creates monitors for as of today are:
+Watchful constructs help generate some default monitors based on the resources defined in your stack. E.g. - If your stack contains a lambda function, and you configure watchful construct, then it will create out of box metric monitors for Throttling, Lambda error and Log error monitors. The ever-growing list of resources that watchful creates monitors for as of today are:
 
 - Application load balancer
 - Cloudfront
@@ -73,7 +73,7 @@ For Metrics query monitors, you can configure the priority (defaults as 3). For
 ```
 
 There is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make sure to use the method before the `watchscope` function.
-Eg -
+E.g. -
 ```
 ...
 const dw = new Watchful(stack, 'Watchful', {});

package/catalog-info.yaml

@@ -0,0 +1,13 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: cdk-v2-constructs
+  description: the 
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+  links:
+    - url: https://www.npmjs.com/package/@rio-cloud/cdk-v2-constructs
+spec:
+  type: library
+  lifecycle: active-development
+  owner: rio-team-claid

package/{API.md → docs/API.md}

@@ -10309,6 +10309,7 @@ const kafkaTopicV4Props: KafkaTopicV4Props = { ... }
 | <code><a href="#@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.numberOfPartitions">numberOfPartitions</a></code> | <code>number</code> | Defines degree of parallelism of the topic; |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.instantDeletionEnabled">instantDeletionEnabled</a></code> | <code>boolean</code> | If set to 'false, the topic's data will be deleted on Kafka 10 days after stack deletion. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.logCompactionProperties">logCompactionProperties</a></code> | <code>@rio-cloud/cdk-v2-constructs.kafka.LogCompactionProperties</code> | Must only be provided if 'isLogCompacted' is 'true'. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.managedBackupEnabled">managedBackupEnabled</a></code> | <code>boolean</code> | Specify whether the topic should be backed up automatically or not. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.replicationFactor">replicationFactor</a></code> | <code>number</code> | Defines degree of replication of messages; |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.retention">retention</a></code> | <code>aws-cdk-lib.Duration</code> | Time how long messages are retained on Kafka cluster; |
 
@@ -10408,6 +10409,21 @@ Must only be provided if 'isLogCompacted' is 'true'.
 
 ---
 
+##### `managedBackupEnabled`<sup>Optional</sup> <a name="managedBackupEnabled" id="@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.managedBackupEnabled"></a>
+
+```typescript
+public readonly managedBackupEnabled: boolean;
+```
+
+- *Type:* boolean
+- *Default:* undefined
+
+Specify whether the topic should be backed up automatically or not.
+
+It could just be enabled, if the topic is compacted and the RecoveryPolicy is 'recoverable'.
+
+---
+
 ##### `replicationFactor`<sup>Optional</sup> <a name="replicationFactor" id="@rio-cloud/cdk-v2-constructs.KafkaTopicV4Props.property.replicationFactor"></a>
 
 ```typescript
@@ -10464,6 +10480,7 @@ const kafkaTopicV4Props: kafka.KafkaTopicV4Props = { ... }
 | <code><a href="#@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.numberOfPartitions">numberOfPartitions</a></code> | <code>number</code> | Defines degree of parallelism of the topic; |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.instantDeletionEnabled">instantDeletionEnabled</a></code> | <code>boolean</code> | If set to 'false, the topic's data will be deleted on Kafka 10 days after stack deletion. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.logCompactionProperties">logCompactionProperties</a></code> | <code>@rio-cloud/cdk-v2-constructs.kafka.LogCompactionProperties</code> | Must only be provided if 'isLogCompacted' is 'true'. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.managedBackupEnabled">managedBackupEnabled</a></code> | <code>boolean</code> | Specify whether the topic should be backed up automatically or not. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.replicationFactor">replicationFactor</a></code> | <code>number</code> | Defines degree of replication of messages; |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.retention">retention</a></code> | <code>aws-cdk-lib.Duration</code> | Time how long messages are retained on Kafka cluster; |
 
@@ -10563,6 +10580,21 @@ Must only be provided if 'isLogCompacted' is 'true'.
 
 ---
 
+##### `managedBackupEnabled`<sup>Optional</sup> <a name="managedBackupEnabled" id="@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.managedBackupEnabled"></a>
+
+```typescript
+public readonly managedBackupEnabled: boolean;
+```
+
+- *Type:* boolean
+- *Default:* undefined
+
+Specify whether the topic should be backed up automatically or not.
+
+It could just be enabled, if the topic is compacted and the RecoveryPolicy is 'recoverable'.
+
+---
+
 ##### `replicationFactor`<sup>Optional</sup> <a name="replicationFactor" id="@rio-cloud/cdk-v2-constructs.kafka.KafkaTopicV4Props.property.replicationFactor"></a>
 
 ```typescript