@rio-cloud/cdk-v2-constructs 2.0.2 → 2.0.3

package/.jsii

@@ -11,7 +11,7 @@
     "js-yaml": "~4.1.0"
   },
   "dependencies": {
-    "aws-cdk-lib": "2.20.0",
+    "aws-cdk-lib": "^2.20.0",
     "constructs": "^10.0.107"
   },
   "dependencyClosure": {
@@ -3244,14 +3244,14 @@
           "abstract": true,
           "docs": {
             "default": "- No environment variables.",
-            "remarks": "Environment variables set by default are overwritten if passed.\n\nThe default environment variables set are\n\nDD_ENV: Set same as prop stage\n\nDD_SERVICE: Set same as prop serviceName\n\nDD_VERSION: Set same as prop version\n\nDD_LOGS_INJECTION: true\n\nDD_SERVICE_MAPPING: database:fargate-web-app-aurora,java-aws-sdk:fargate-web-app-aws-sdk,kafka:fargate-web-app-kafka,mysql:fargate-web-app-aurora\n\nDD_TAGS: env:prod,service:fargate-web-app,version:notag,account_id:${accountID},account_name:${accountName},region:${AWSRegion},team:${teamName from ssm param /config/team/name}\n\nDD_TRACE_SAMPLE_RATE: 1.0",
+            "remarks": "Some Datadog specific environment variables are not allowed to be set,\nbecause they are set automatically or computed from other attributes.\nThese are:\n* DD_ENV: Set same as prop stage\n* DD_SERVICE: Set same as prop serviceName\n* DD_VERSION: Set same as prop version\n* DD_TAGS: Set same as DatadogIntegrationProps#additionalTags\n* DD_LOGS_INJECTION: true\nOther DD_-prefixed vaiable may be added to this list.\n\nOther Environment variables set by default are overwritten if passed.\nThese are:\n* DD_SERVICE_MAPPING: database:fargate-web-app-aurora,java-aws-sdk:fargate-web-app-aws-sdk,kafka:fargate-web-app-kafka,mysql:fargate-web-app-aurora\n* DD_TRACE_SAMPLE_RATE: 1.0",
             "stability": "stable",
             "summary": "The environment variables to pass to the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 103
+            "line": 100
           },
           "name": "environment",
           "optional": true,
@@ -3274,7 +3274,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 117
+            "line": 114
           },
           "name": "healthCheck",
           "optional": true,
@@ -3292,7 +3292,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 110
+            "line": 107
           },
           "name": "secrets",
           "optional": true,
@@ -3380,7 +3380,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/fargate/rio-fargate-service.ts",
-        "line": 273
+        "line": 289
       },
       "members": [
         {
@@ -3607,10 +3607,33 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/fargate/rio-fargate-service.ts",
-        "line": 218
+        "line": 215
       },
       "name": "DatadogIntegrationProps",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "We would like to learn about your use cases.\n\nDefault tags are not allowed to be overridden!\n\nDefaults are:\n* env: Set to RioFargateServiceProps#stage prop\n* service: Set to RioFargateServiceProps#serviceName prop\n* version: Set to RioFargateServiceProps#version prop\n* account_id:${accountID}\n* account_name:${accountName}\n* region:${AWSRegion}\n* team:${teamName from ssm param /config/team/name}\n* team_identifier:${teamIdentifier from ssm param /config/team/identifier}",
+            "stability": "stable",
+            "summary": "Configure additional tags, which are appended to the defaults, When you define custom tags we would be glad if you contact us."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/fargate/rio-fargate-service.ts",
+            "line": 286
+          },
+          "name": "additionalTags",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -3622,7 +3645,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 257
+            "line": 254
           },
           "name": "apmGetEndpointsToIgnore",
           "optional": true,
@@ -3645,7 +3668,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 224
+            "line": 221
           },
           "name": "cpu",
           "optional": true,
@@ -3663,7 +3686,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 264
+            "line": 261
           },
           "name": "datadogSidecarEssential",
           "optional": true,
@@ -3681,7 +3704,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 270
+            "line": 267
           },
           "name": "datadogSidecarTag",
           "optional": true,
@@ -3699,7 +3722,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 250
+            "line": 247
           },
           "name": "loggingModeForDatadogAgent",
           "optional": true,
@@ -3717,7 +3740,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 243
+            "line": 240
           },
           "name": "loggingModeForService",
           "optional": true,
@@ -3736,7 +3759,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 236
+            "line": 233
           },
           "name": "memoryLimitMiB",
           "optional": true,
@@ -3971,7 +3994,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/fargate/rio-fargate-service.ts",
-        "line": 120
+        "line": 117
       },
       "name": "FargateTaskDefinitionProps",
       "properties": [
@@ -3986,7 +4009,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 138
+            "line": 135
           },
           "name": "cpu",
           "type": {
@@ -4004,7 +4027,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 156
+            "line": 153
           },
           "name": "memoryLimitMiB",
           "type": {
@@ -4021,7 +4044,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 164
+            "line": 161
           },
           "name": "desiredCount",
           "optional": true,
@@ -4679,7 +4702,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/fargate/rio-fargate-service.ts",
-        "line": 167
+        "line": 164
       },
       "name": "ListenerRule",
       "properties": [
@@ -4691,7 +4714,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 170
+            "line": 167
           },
           "name": "conditions",
           "type": {
@@ -4711,7 +4734,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 168
+            "line": 165
           },
           "name": "priority",
           "type": {
@@ -4731,7 +4754,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/fargate/rio-fargate-service.ts",
-        "line": 173
+        "line": 170
       },
       "name": "LoadBalancerOptions",
       "properties": [
@@ -4744,7 +4767,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 192
+            "line": 189
           },
           "name": "healthCheck",
           "type": {
@@ -4760,7 +4783,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 197
+            "line": 194
           },
           "name": "healthCheckGracePeriod",
           "type": {
@@ -4776,7 +4799,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 177
+            "line": 174
           },
           "name": "listener",
           "type": {
@@ -4793,7 +4816,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 187
+            "line": 184
           },
           "name": "listenerRules",
           "type": {
@@ -4816,7 +4839,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 215
+            "line": 212
           },
           "name": "deregistrationDelay",
           "optional": true,
@@ -4835,7 +4858,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 206
+            "line": 203
           },
           "name": "slowStart",
           "optional": true,
@@ -5284,7 +5307,7 @@
         },
         "locationInModule": {
           "filename": "src/fargate/rio-fargate-service.ts",
-          "line": 316
+          "line": 351
         },
         "parameters": [
           {
@@ -5313,7 +5336,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/fargate/rio-fargate-service.ts",
-        "line": 292
+        "line": 308
       },
       "name": "RioFargateService",
       "properties": [
@@ -5325,7 +5348,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 312
+            "line": 347
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -5340,7 +5363,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 308
+            "line": 343
           },
           "name": "datadogSideCarContainerDefinition",
           "type": {
@@ -5354,7 +5377,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 313
+            "line": 348
           },
           "name": "service",
           "type": {
@@ -5368,7 +5391,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 307
+            "line": 342
           },
           "name": "serviceContainerDefinition",
           "type": {
@@ -5382,7 +5405,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 310
+            "line": 345
           },
           "name": "taskDefinition",
           "type": {
@@ -5396,7 +5419,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 309
+            "line": 344
           },
           "name": "logRouterContainerDefinition",
           "optional": true,
@@ -5411,7 +5434,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/fargate/rio-fargate-service.ts",
-            "line": 314
+            "line": 349
           },
           "name": "targetGroup",
           "optional": true,
@@ -7847,5 +7870,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "fLo0lNL2i5mfqcEmQ4g+rvt4193Qh3l/53inM+rOhx0="
+  "fingerprint": "Jy+OKKtMmQl6v7Nh66t68Cg+74EnVQYYcPwEwkdbVvs="
 }

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.0.3](https://collaboration.msi.audi.com/stash/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv2.0.2&sourceBranch=refs%2Ftags%2Fv2.0.3) (2022-05-19)
+
 ### [2.0.2](https://collaboration.msi.audi.com/stash/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv2.0.1&sourceBranch=refs%2Ftags%2Fv2.0.2) (2022-04-21)
 
 ### [2.0.1](https://collaboration.msi.audi.com/stash/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv2.0.0&sourceBranch=refs%2Ftags%2Fv2.0.1) (2022-04-08)

package/MIGRATION_GUIDE.md

@@ -1,20 +1,23 @@
 # Migration Guide
 
 1. Remove projen if not already done
- * avoid `eject` as the resulting tasks script is unreadable and it contains unnecessary/unused features
- * remove projen dependencies
- * copy over necessary tasks from `.projen/tasks.json` to `package.json`
- * find a more detailed description [here](https://collaboration.msi.audi.com/confluence/display/RIOCLAID/Remove+Projen)
-2. udpate `aws-cdk` in `package-json` to latest 2.x version: `npm install --save-dev aws-cdk@2`
- a. remove CDK v1 dependencies from `package.json`
- b. add `aws-cdk-lib`: `npm install aws-cdk-lib`
- c. replace imports: `$ npx -p aws-cdk-migration rewrite-imports-v2 <your-source-root-here>/**/*.ts`
- d. update `cdk.json` (TODO)
- e. replace `@aws-cdk/assert` with `aws-cdk-lib/assertions` ando migrate expectations to `Template.fromStack(...).hasResource`
- * additional information: [Official Migration Guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html)
-5. replace `@rioclaid/cdk-constructs` with `@rio-cloud/cdk-v2-constructs`
- * remove dependency form `package.json`
- * add new dependency `npm install @rio-cloud/cdk-v2-constructs`
- * replace imports `import * as rio from '@rioclaid/cdk-constructs'` with `import * as rio from '@rio-cloud/cdk-v2-constructs'` 
-6. In case you use `Claidometer` there is a breaking change as the property `package` is a reserverd keyword in some languages and thus has been renamed to `packageName`
-7. adopt your renovate.json
+   1. **remove projen** dependencies from `package.json`
+   2. **copy over** necessary tasks from `.projen/tasks.json` to `package.json`
+   3. **remove** `.projen` directory
+   * **avoid `eject`** as the resulting tasks script is unreadable and it contains unnecessary/unused features
+   * find a more detailed description [here](https://collaboration.msi.audi.com/confluence/display/RIOCLAID/Remove+Projen)
+2. Update `aws-cdk` in `package-json` to latest 2.x version: 
+   1. **install CDK v2**: `npm install --save-dev aws-cdk@2`
+   2. **remove CDK v1 dependencies** (e.g., `@aws-cdk/...`, `constructs`, `@rioclaid/cdk-constructs`) from `package.json`
+   3. **add `aws-cdk-lib`**: `npm install aws-cdk-lib`
+   3. **add `constructs`**: `npm install constructs@10`
+   4. **replace imports**: `$ npx -p aws-cdk-migration rewrite-imports-v2 <your-source-root-here>/**/*.ts`
+   5. update `cdk.json` (e.g., by generating a new CDKv2 app in another folder with `npx cdk@2 init app --language=typescript` and comparing its `cdk.json` with yours)
+   6. replace `@aws-cdk/assert` with `aws-cdk-lib/assertions` ando migrate expectations to `Template.fromStack(...).hasResource`
+   * additional information: [Official Migration Guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html)
+5. Replace `@rioclaid/cdk-constructs` with `@rio-cloud/cdk-v2-constructs`
+   * **add `@rio-cloud/cdk-v2-constructs`**: `npm install @rio-cloud/cdk-v2-constructs`
+   * replace imports `import * as rio from '@rioclaid/cdk-constructs'` with `import * as rio from '@rio-cloud/cdk-v2-constructs'` 
+6. In case you use `Claidometer`:\
+   There is a breaking change as the property `package` is a reserved keyword in some languages and thus has been renamed to `packageName`
+7. Adopt `renovate.json`

package/lib/fargate/datadog.d.ts

@@ -2,17 +2,88 @@ import * as ecs from 'aws-cdk-lib/aws-ecs';
 import * as ssm from 'aws-cdk-lib/aws-ssm';
 import { Construct } from 'constructs';
 import { DataDogLoggingMode, RioFargateService } from './rio-fargate-service';
+/**
+ * @deprecated Moved out static methods and imporoved signature. Use named import instead.
+ */
 export declare class DataDog {
-    static getFargateContainerEnvironmentVariables(scope: Construct, stage: string, serviceName: string, version: string, accountName: string, teamName: string): {
+    static getFargateContainerEnvironmentVariables(scope: Construct, stage: string, serviceName: string, version: string, accountName: string, teamName: string, teamIdentifier: string, additionalTags: {
+        [k: string]: string;
+    } | undefined): {
         [key: string]: string;
     };
-    static getApmServiceMappingEnvironmentVariableValue(serviceName: string): string;
     static getFargateDockerLabels(stage: string, serviceName: string, version: string): {
         [key: string]: string;
     };
-    static addDatadogSidecar(scope: Construct, taskDefinition: ecs.TaskDefinition, accountName: string, teamName: string, stage: string, serviceName: string, version: string, datadogApiKeyParameter: ssm.IStringParameter, datadogSite: string, datadogLoggingMode: DataDogLoggingMode, apmGetResourcesToIgnore: string[], cpu: number, memoryLimitMiB: number, essential: boolean, containerTag: string): ecs.ContainerDefinition;
-    static getTagsEnvironmentVariableValue(accountId: string, accountName: string, region: string, teamName: string, stage: string, serviceName: string, version: string, containerType: 'service' | 'datadog-sidecar' | 'fluent-bit'): string;
+    static addDatadogSidecar(scope: Construct, taskDefinition: ecs.TaskDefinition, accountName: string, teamName: string, teamIdentifier: string, stage: string, serviceName: string, version: string, datadogApiKeyParameter: ssm.IStringParameter, datadogSite: string, datadogLoggingMode: DataDogLoggingMode, apmGetResourcesToIgnore: string[], cpu: number, memoryLimitMiB: number, essential: boolean, containerTag: string, additionalTags: {
+        [k: string]: string;
+    } | undefined): ecs.ContainerDefinition;
     static addFireLensLogRouter(taskDefinition: ecs.TaskDefinition, cpu: number, memoryLimitMiB: number): ecs.ContainerDefinition;
-    static setupLogging(scope: Construct, accountName: string, teamName: string, stage: string, serviceName: string, version: string, datadogApiKeyParameter: ssm.IStringParameter, datadogLoggingMode: DataDogLoggingMode, datadogSite: string, containerType: 'service' | 'datadog-sidecar'): ecs.LogDriver;
+    static setupLogging(scope: Construct, accountName: string, teamName: string, teamIdentifier: string, stage: string, serviceName: string, version: string, datadogApiKeyParameter: ssm.IStringParameter, datadogLoggingMode: DataDogLoggingMode, datadogSite: string, containerType: 'service' | 'datadog-sidecar', additionalTags: {
+        [k: string]: string;
+    } | undefined): ecs.LogDriver;
     static ensureLoggingAndMonitoringAreReadyBeforeServiceStarts(rioFargateService: RioFargateService): void;
 }
+export declare function getFargateContainerEnvironmentVariables(props: {
+    scope: Construct;
+    stage: string;
+    serviceName: string;
+    version: string;
+    accountName: string;
+    teamName: string;
+    teamIdentifier: string;
+    additionalTags: {
+        [k: string]: string;
+    } | undefined;
+}): {
+    [key: string]: string;
+};
+export declare function getFargateDockerLabels(props: {
+    stage: string;
+    serviceName: string;
+    version: string;
+}): {
+    [key: string]: string;
+};
+export declare function addDatadogSidecar(props: {
+    scope: Construct;
+    taskDefinition: ecs.TaskDefinition;
+    accountName: string;
+    teamName: string;
+    teamIdentifier: string;
+    stage: string;
+    serviceName: string;
+    version: string;
+    datadogApiKeyParameter: ssm.IStringParameter;
+    datadogSite: string;
+    datadogLoggingMode: DataDogLoggingMode;
+    apmGetResourcesToIgnore: string[];
+    cpu: number;
+    memoryLimitMiB: number;
+    essential: boolean;
+    containerTag: string;
+    additionalTags: {
+        [k: string]: string;
+    } | undefined;
+}): ecs.ContainerDefinition;
+export declare function addFireLensLogRouter(props: {
+    taskDefinition: ecs.TaskDefinition;
+    cpu: number;
+    memoryLimitMiB: number;
+}): ecs.ContainerDefinition;
+export declare function setupLogging(props: {
+    scope: Construct;
+    accountName: string;
+    teamName: string;
+    teamIdentifier: string;
+    stage: string;
+    serviceName: string;
+    version: string;
+    datadogApiKeyParameter: ssm.IStringParameter;
+    datadogLoggingMode: DataDogLoggingMode;
+    datadogSite: string;
+    containerType: 'service' | 'datadog-sidecar';
+    additionalTags: {
+        [k: string]: string;
+    } | undefined;
+}): ecs.LogDriver;
+export declare function ensureLoggingAndMonitoringAreReadyBeforeServiceStarts(rioFargateService: RioFargateService): void;