Allow user agent from env (opensearch-project#435)

Signed-off-by: Tanner Lewis <lewijacn@amazon.com>
gregschohn · Nov 16, 2023 · bc3f775 · bc3f775
1 parent f8dcf96
commit bc3f775
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/deployment/cdk/opensearch-service-migration/bin/app.ts b/deployment/cdk/opensearch-service-migration/bin/app.ts
@@ -15,8 +15,10 @@ const migrationsAppRegistryARN = process.env.MIGRATIONS_APP_REGISTRY_ARN
 if (migrationsAppRegistryARN) {
     console.info(`App Registry mode is enabled for CFN stack tracking. Will attempt to import the App Registry application from the MIGRATIONS_APP_REGISTRY_ARN env variable of ${migrationsAppRegistryARN} and looking in the configured region of ${region}`)
 }
+const customReplayerUserAgent = process.env.CUSTOM_REPLAYER_USER_AGENT
 
 new StackComposer(app, {
     migrationsAppRegistryARN: migrationsAppRegistryARN,
+    customReplayerUserAgent: customReplayerUserAgent,
     env: { account: account, region: region }
 });
diff --git a/deployment/cdk/opensearch-service-migration/lib/stack-composer.ts b/deployment/cdk/opensearch-service-migration/lib/stack-composer.ts
@@ -19,12 +19,13 @@ import {Application} from "@aws-cdk/aws-servicecatalogappregistry-alpha";
 
 export interface StackPropsExt extends StackProps {
     readonly stage: string,
-    readonly defaultDeployId: string
+    readonly defaultDeployId: string,
     readonly addOnMigrationDeployId?: string
 }
 
 export interface StackComposerProps extends StackProps {
-    readonly migrationsAppRegistryARN?: string
+    readonly migrationsAppRegistryARN?: string,
+    readonly customReplayerUserAgent?: string
 }
 
 export class StackComposer {
@@ -192,6 +193,14 @@ export class StackComposer {
             throw new Error("Provided domainRemovalPolicy does not match a selectable option, for reference https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html")
         }
 
+        let trafficReplayerCustomUserAgent
+        if (props.customReplayerUserAgent && trafficReplayerUserAgentSuffix) {
+            trafficReplayerCustomUserAgent = `${props.customReplayerUserAgent};${trafficReplayerUserAgentSuffix}`
+        }
+        else {
+            trafficReplayerCustomUserAgent = trafficReplayerUserAgentSuffix ? trafficReplayerUserAgentSuffix : props.customReplayerUserAgent
+        }
+
         const deployId = addOnMigrationDeployId ? addOnMigrationDeployId : defaultDeployId
 
         // If enabled re-use existing VPC and/or associated resources or create new
@@ -398,7 +407,7 @@ export class StackComposer {
                 enableClusterFGACAuth: trafficReplayerEnableClusterFGACAuth,
                 addOnMigrationDeployId: addOnMigrationDeployId,
                 customKafkaGroupId: trafficReplayerGroupId,
-                userAgentSuffix: trafficReplayerUserAgentSuffix,
+                userAgentSuffix: trafficReplayerCustomUserAgent,
                 extraArgs: trafficReplayerExtraArgs,
                 analyticsServiceEnabled: migrationAnalyticsServiceEnabled,
                 stackName: `OSMigrations-${stage}-${region}-${deployId}-TrafficReplayer`,