@rio-cloud/cdk-v2-constructs 6.20.0 → 6.21.1-alpha.0

package/.jsii

@@ -3900,7 +3900,7 @@
     "@rio-cloud/cdk-v2-constructs.backup": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 38
+        "line": 39
       },
       "symbolId": "src/backup/index:"
     },
@@ -3921,7 +3921,7 @@
     "@rio-cloud/cdk-v2-constructs.ecr": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 40
+        "line": 41
       },
       "symbolId": "src/ecr/index:"
     },
@@ -6773,6 +6773,86 @@
       ],
       "symbolId": "src/datadog/datadog-monitor:DatadogMonitorProps"
     },
+    "@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "See https://docs.datadoghq.com/api/latest/synthetics/ for more information (especially the typescript examples).\nCurrently, tests of type `api`, `browser` and `mobile` are supported.\n\nThe resource does the following modification to the passed `testConfig`:\n- Adds team name and service name to the test name.\n- Adds the usual tags (account_id, account_name, service, team, team_identifier) to the test tags.",
+        "stability": "stable",
+        "summary": "Creates a Datadog Synthetics test via Datadog API through a custom resource."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test.ts",
+          "line": 41
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test.ts",
+        "line": 40
+      },
+      "name": "DatadogSyntheticsTest",
+      "symbolId": "src/contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test:DatadogSyntheticsTest"
+    },
+    "@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test.ts",
+        "line": 16
+      },
+      "name": "DatadogSyntheticsTestProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Used to enhance the test name and apply the `service` tag.",
+            "stability": "stable",
+            "summary": "The name of the service to which the test belongs."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test.ts",
+            "line": 23
+          },
+          "name": "serviceName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test:DatadogSyntheticsTestProps"
+    },
     "@rio-cloud/cdk-v2-constructs.DatadogUsageMonitoring": {
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "base": "constructs.Construct",
@@ -20751,5 +20831,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "fXkwKoqGGbb94E0bldrx65ENlHruSN7qGCzVTEVjhnM="
+  "fingerprint": "ZZbMGyaaRkOHRGAeyAtT3C+C0XomITIFo8BljixrrYc="
 }

package/docs/API.md

@@ -2467,6 +2467,128 @@ This is equal to `secretArn` in most cases, but is undefined when a full ARN is
 ---
 
 
+### DatadogSyntheticsTest <a name="DatadogSyntheticsTest" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest"></a>
+
+Creates a Datadog Synthetics test via Datadog API through a custom resource.
+
+See https://docs.datadoghq.com/api/latest/synthetics/ for more information (especially the typescript examples).
+Currently, tests of type `api`, `browser` and `mobile` are supported.
+
+The resource does the following modification to the passed `testConfig`:
+- Adds team name and service name to the test name.
+- Adds the usual tags (account_id, account_name, service, team, team_identifier) to the test tags.
+
+#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer"></a>
+
+```typescript
+import { DatadogSyntheticsTest } from '@rio-cloud/cdk-v2-constructs'
+
+new DatadogSyntheticsTest(scope: Construct, id: string, props: DatadogSyntheticsTestProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer.parameter.props">props</a></code> | <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps">DatadogSyntheticsTestProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps">DatadogSyntheticsTestProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.isConstruct"></a>
+
+```typescript
+import { DatadogSyntheticsTest } from '@rio-cloud/cdk-v2-constructs'
+
+DatadogSyntheticsTest.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTest.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+
 ### DatadogUsageMonitoring <a name="DatadogUsageMonitoring" id="@rio-cloud/cdk-v2-constructs.DatadogUsageMonitoring"></a>
 
 #### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.DatadogUsageMonitoring.Initializer"></a>
@@ -12299,6 +12421,38 @@ The type of the service.
 
 ---
 
+### DatadogSyntheticsTestProps <a name="DatadogSyntheticsTestProps" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps"></a>
+
+#### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps.Initializer"></a>
+
+```typescript
+import { DatadogSyntheticsTestProps } from '@rio-cloud/cdk-v2-constructs'
+
+const datadogSyntheticsTestProps: DatadogSyntheticsTestProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps.property.serviceName">serviceName</a></code> | <code>string</code> | The name of the service to which the test belongs. |
+
+---
+
+##### `serviceName`<sup>Required</sup> <a name="serviceName" id="@rio-cloud/cdk-v2-constructs.DatadogSyntheticsTestProps.property.serviceName"></a>
+
+```typescript
+public readonly serviceName: string;
+```
+
+- *Type:* string
+
+The name of the service to which the test belongs.
+
+Used to enhance the test name and apply the `service` tag.
+
+---
+
 ### DatadogUsageMonitoringProps <a name="DatadogUsageMonitoringProps" id="@rio-cloud/cdk-v2-constructs.DatadogUsageMonitoringProps"></a>
 
 #### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.DatadogUsageMonitoringProps.Initializer"></a>

package/docs/changelog.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [6.21.1-alpha.0](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv6.21.0&sourceBranch=refs%2Ftags%2Fv6.21.1-alpha.0) (2025-03-06)
+
+## [6.21.0](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv6.20.0&sourceBranch=refs%2Ftags%2Fv6.21.0) (2025-03-05)
+
+
+### Features
+
+* **datadog-synthetics:** Add new custom resource to deploy datadog synthetics tests. ([8ef5ab8](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/commits/8ef5ab884cfc5da0fc0033dc0b02be2264f2b8e3))
+
 ## [6.20.0](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv6.19.0&sourceBranch=refs%2Ftags%2Fv6.20.0) (2025-02-27)
 
 

package/esbuild.mjs

@@ -26,6 +26,10 @@ const entryPoints = [
         basePath: 'ses/lambda',
         fileName: 'ses-logger.ts',
     },
+    {
+        basePath: 'contributions/team-transport-two/datadog-synthetics/datadog-synthetics-test-custom-resource',
+        fileName: 'handler.ts',
+    },
 ]
 
 for (const handler of entryPoints) {