fix(asea): add option to append unique suffixes to vpc names

Author: oliviergaumond

reference-artifacts/Custom-Scripts/lza-upgrade/src/asea-config/index.ts

@@ -1318,18 +1318,18 @@ export class AcceleratorConfig {
    * Find all VPC configurations in mandatory accounts, workload accounts and organizational units. VPC configuration in
    * organizational units will have the correct `accountKey` based on the `deploy` value of the VPC configuration.
    */
-  getVpcConfigs(): ResolvedVpcConfig[] {
+  getVpcConfigs(appendSuffix: boolean): ResolvedVpcConfig[] {
     const vpcConfigs: ResolvedVpcConfig[] = [];
 
     // Add mandatory account VPC configuration first
     for (const [accountKey, accountConfig] of this.getMandatoryAccountConfigs()) {
       for (const vpcConfig of accountConfig.vpc || []) {
-        const lzaVpcName = createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region);
+        const lzaVpcName = createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region, appendSuffix);
         vpcConfigs.push({
           accountKey,
           vpcConfig,
           ouKey: accountConfig.ou,
-          lzaVpcName 
+          lzaVpcName
         });
       }
     }
@@ -1349,9 +1349,9 @@ export class AcceleratorConfig {
                 continue;
               }
             }
-            vpcConfig.lzaVpcName = createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region);
+            vpcConfig.lzaVpcName = createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region, appendSuffix);
             if (vpcConfig['cidr-src'] === 'dynamic') {
-              const lzaVpcName = createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region);
+              const lzaVpcName = createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region, appendSuffix);
               vpcConfigs.push({
                 ouKey,
                 accountKey,
@@ -1365,7 +1365,7 @@ export class AcceleratorConfig {
               ouKey,
               vpcConfig,
               excludeAccounts,
-              lzaVpcName: createLzaVpcName(vpcConfig.name, ouKey, vpcConfig.region),
+              lzaVpcName: createLzaVpcName(vpcConfig.name, ouKey, vpcConfig.region, appendSuffix),
             });
           }
         } else {
@@ -1374,7 +1374,7 @@ export class AcceleratorConfig {
             ouKey,
             accountKey: destinationAccountKey,
             vpcConfig,
-            lzaVpcName: createLzaVpcName(vpcConfig.name, destinationAccountKey, vpcConfig.region)
+            lzaVpcName: createLzaVpcName(vpcConfig.name, destinationAccountKey, vpcConfig.region, appendSuffix)
           });
         }
       }
@@ -1387,16 +1387,16 @@ export class AcceleratorConfig {
           accountKey,
           vpcConfig,
           ouKey: accountConfig.ou,
-          lzaVpcName: createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region),
+          lzaVpcName: createLzaVpcName(vpcConfig.name, accountKey, vpcConfig.region, appendSuffix),
         });
       }
     }
 
     return vpcConfigs;
   }
 
-  getAzSubnets(accountKey: string, vpcName: string, subnetName: string) {
-    const vpcConfigs = this.getVpcConfigs();
+  getAzSubnets(accountKey: string, vpcName: string, subnetName: string, appendSuffix: boolean) {
+    const vpcConfigs = this.getVpcConfigs(appendSuffix);
     const vpcConfig = vpcConfigs.find((v) => v.accountKey === accountKey && v.vpcConfig.name === vpcName)?.vpcConfig;
     if (!vpcConfig) {
       throw new Error(`VPC named "${vpcName}" not found in account "${accountKey}"`);
@@ -1414,9 +1414,9 @@ export class AcceleratorConfig {
   }
 }
 
-export function createLzaVpcName(vpcName: string, accountKey: string, region: string): string {
+export function createLzaVpcName(vpcName: string, accountKey: string, region: string, appendSuffix: boolean): string {
   const md5Hash = crypto.createHash('md5').update(`${vpcName}_${accountKey}_${region}`).digest('hex');
   const vpcNameWithType = vpcName.endsWith('_vpc') ? vpcName : `${vpcName}_vpc`;
-  const lzaVpcName = `${vpcNameWithType}..${md5Hash.substring(0,5)}`;
+  const lzaVpcName = appendSuffix ? `${vpcNameWithType}..${md5Hash.substring(0,5)}` : vpcNameWithType;
   return lzaVpcName;
 }

reference-artifacts/Custom-Scripts/lza-upgrade/src/config.ts

@@ -36,6 +36,7 @@ export interface Config {
   skipDriftDetection?: boolean;
   localConfigFilePath?: string;
   enableTerminationProtection?: boolean;
+  appendUniqueSuffixToVPCNames?: boolean
   lzaInstallerTemplateBucket?: string
   lzaInstallerTemplateKey?: string
 }

reference-artifacts/Custom-Scripts/lza-upgrade/src/convert-config.ts

@@ -190,6 +190,7 @@ export class ConvertAseaConfig {
   private readonly assumeRoleName: string;
   private readonly writeFilesConfig: WriteToSourcesTypes.WriteToSourcesConfig;
   private readonly ouToNestedOuMap: Map<string, Set<string>> = new Map();
+  private readonly appendVpcSuffixes: boolean;
   private accounts: Account[] = [];
   private outputs: StackOutput[] = [];
   private vpcAssignedCidrs: VpcAssignedCidr[] = [];
@@ -213,6 +214,7 @@ export class ConvertAseaConfig {
     this.region = config.homeRegion;
     this.centralBucketName = config.centralBucket!;
     this.aseaPrefix = config.aseaPrefix!.endsWith('-') ? config.aseaPrefix! : `${config.aseaPrefix}-`;
+    this.appendVpcSuffixes = config.appendUniqueSuffixToVPCNames ?? false;
     this.parametersTable = `${this.aseaPrefix}Parameters`;
     this.acceleratorName = config.acceleratorName!;
     this.sts = new STS();
@@ -252,7 +254,7 @@ export class ConvertAseaConfig {
     this.subnetAssignedCidrs = await loadSubnetAssignedCidrs(subnetsCidrsTableName(this.aseaPrefix), this.dynamoDb);
     this.outputs = await loadOutputs(`${this.aseaPrefix}Outputs`, this.dynamoDb);
     this.globalOptions = aseaConfig['global-options'];
-    this.vpcConfigs = aseaConfig.getVpcConfigs();
+    this.vpcConfigs = aseaConfig.getVpcConfigs(this.appendVpcSuffixes);
     const regionsWithVpc = this.vpcConfigs.map((resolvedConfig) => resolvedConfig.vpcConfig.region);
     this.regionsWithoutVpc = this.globalOptions['supported-regions'].filter(
       (region) => !regionsWithVpc.includes(region),
@@ -2988,7 +2990,7 @@ export class ConvertAseaConfig {
               sourceVpcConfig = this.vpcConfigs.find(({ vpcConfig }) => vpcConfig.name === source.vpc);
             }
             if (SecurityGroupSourceConfig.is(source)) {
-              lzaRule.sources.push({ 
+              lzaRule.sources.push({
                 securityGroups: source['security-group'].map(securityGroupName),
               });
             } else if (SubnetSourceConfig.is(source)) {
@@ -3000,7 +3002,7 @@ export class ConvertAseaConfig {
                 ),
                 subnets: source.subnet.flatMap((sourceSubnet) =>
                   aseaConfig
-                    .getAzSubnets(sourceVpcConfig?.accountKey || source.account || accountKey || '', source.vpc, sourceSubnet)
+                    .getAzSubnets(sourceVpcConfig?.accountKey || source.account || accountKey || '', source.vpc, sourceSubnet, this.appendVpcSuffixes)
                     .map((s) => createSubnetName(source.vpc, s.subnetName, s.az)),
                 ),
                 vpc: sourceVpcConfig?.lzaVpcName ?? source.vpc,
@@ -3080,7 +3082,7 @@ export class ConvertAseaConfig {
                   target = {
                     account: destinationAccountKey,
                     subnet: createSubnetName(dest.vpc, ruleSubnet.subnetName, ruleSubnet.az),
-                    vpc: createLzaVpcName(destination, destinationAccountKey!, vpcConfig.region),
+                    vpc: createLzaVpcName(destination, destinationAccountKey!, vpcConfig.region, this.appendVpcSuffixes),
                     region: targetRegion,
                   };
                 }
@@ -3227,7 +3229,7 @@ export class ConvertAseaConfig {
           if (inboundResolver) {
             lzaEndpointsConfig.push({
               name: `${vpcConfig.name}InboundEndpoint`,
-              vpc: createLzaVpcName(vpcConfig.name, accountKey!, vpcConfig.region),
+              vpc: createLzaVpcName(vpcConfig.name, accountKey!, vpcConfig.region, this.appendVpcSuffixes),
               subnets:
                 vpcConfig.subnets
                   ?.find((subnetItem) => subnetItem.name === vpcConfig.resolvers?.subnet)
@@ -3241,7 +3243,7 @@ export class ConvertAseaConfig {
           if (outboundResolver) {
             lzaEndpointsConfig.push({
               name: `${vpcConfig.name}OutboundEndpoint`,
-              vpc: createLzaVpcName(vpcConfig.name, accountKey!, vpcConfig.region),
+              vpc: createLzaVpcName(vpcConfig.name, accountKey!, vpcConfig.region, this.appendVpcSuffixes),
               subnets:
                 vpcConfig.subnets
                   ?.find((subnetItem) => subnetItem.name === vpcConfig.resolvers?.subnet)
@@ -3740,7 +3742,7 @@ export class ConvertAseaConfig {
     return ipv4CidrBlock;
   }
   private async createCloudFormationStacksForALBIpForwarding(aseaConfig: AcceleratorConfig) {
-    const vpcs = aseaConfig.getVpcConfigs();
+    const vpcs = aseaConfig.getVpcConfigs(this.appendVpcSuffixes);
     const vpcMaps = [];
     for (const vpc of vpcs) {
       if (vpc.vpcConfig['alb-forwarding']) {