From 0acb590d8042d747826f9ca832826dd611f55d3a Mon Sep 17 00:00:00 2001 From: Kendra Neil <53584728+TheRealAmazonKendra@users.noreply.github.com> Date: Thu, 27 Jun 2024 09:39:26 -0700 Subject: [PATCH] Revert "fix(core): overrideLogicalId validation (#29708)" This reverts commit b196b13b0b8a54dcacadf87fdbe744772a6e6c4d. --- packages/aws-cdk-lib/core/lib/cfn-element.ts | 23 +----- packages/aws-cdk-lib/core/test/stack.test.ts | 84 ++------------------ 2 files changed, 8 insertions(+), 99 deletions(-) diff --git a/packages/aws-cdk-lib/core/lib/cfn-element.ts b/packages/aws-cdk-lib/core/lib/cfn-element.ts index 396a27b6f8d5d..230ed20376662 100644 --- a/packages/aws-cdk-lib/core/lib/cfn-element.ts +++ b/packages/aws-cdk-lib/core/lib/cfn-element.ts @@ -81,33 +81,14 @@ export abstract class CfnElement extends Construct { /** * Overrides the auto-generated logical ID with a specific ID. * @param newLogicalId The new logical ID to use for this stack element. - * - * @throws an error if `logicalId` has already been locked - * @throws an error if `newLogicalId` is empty - * @throws an error if `newLogicalId` contains more than 255 characters - * @throws an error if `newLogicalId` contains non-alphanumeric characters - * - * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-logicalid */ public overrideLogicalId(newLogicalId: string) { if (this._logicalIdLocked) { throw new Error(`The logicalId for resource at path ${Node.of(this).path} has been locked and cannot be overridden\n` + 'Make sure you are calling "overrideLogicalId" before Stack.exportValue'); + } else { + this._logicalIdOverride = newLogicalId; } - - if (!Token.isUnresolved(newLogicalId)) { - if (!newLogicalId) { - throw new Error('Cannot set an empty logical ID'); - } - if (newLogicalId.length > 255) { - throw new Error(`Invalid logical ID override: '${newLogicalId}'. It must be at most 255 characters long, got ${newLogicalId.length} characters.`); - } - if (!newLogicalId.match(/^[A-Za-z0-9]+$/)) { - throw new Error(`Invalid logical ID override: '${newLogicalId}'. It must only contain alphanumeric characters.`); - } - } - - this._logicalIdOverride = newLogicalId; } /** diff --git a/packages/aws-cdk-lib/core/test/stack.test.ts b/packages/aws-cdk-lib/core/test/stack.test.ts index 5aa4b5d44fa5f..82be67b19499b 100644 --- a/packages/aws-cdk-lib/core/test/stack.test.ts +++ b/packages/aws-cdk-lib/core/test/stack.test.ts @@ -1370,49 +1370,10 @@ describe('stack', () => { // THEN - producers are the same expect(() => { - resourceM.overrideLogicalId('OVERRIDELOGICALID'); + resourceM.overrideLogicalId('OVERRIDE_LOGICAL_ID'); }).toThrow(/The logicalId for resource at path Producer\/ResourceXXX has been locked and cannot be overridden/); }); - test('throw error if overrideLogicalId contains non-alphanumeric characters', () => { - // GIVEN: manual - const appM = new App(); - const producerM = new Stack(appM, 'Producer'); - const resourceM = new CfnResource(producerM, 'ResourceXXX', { type: 'AWS::Resource' }); - - // THEN - producers are the same - expect(() => { - resourceM.overrideLogicalId('INVALID_LOGICAL_ID'); - }).toThrow(/must only contain alphanumeric characters/); - }); - - test('throw error if overrideLogicalId is over 255 characters', () => { - // GIVEN: manual - const appM = new App(); - const producerM = new Stack(appM, 'Producer'); - const resourceM = new CfnResource(producerM, 'ResourceXXX', { type: 'AWS::Resource' }); - - // THEN - producers are the same - expect(() => { - resourceM.overrideLogicalId( - // 256 character long string of "aaaa..." - Array(256).fill('a').join(''), - ); - }).toThrow(/must be at most 255 characters long, got 256 characters/); - }); - - test('throw error if overrideLogicalId is an empty string', () => { - // GIVEN: manual - const appM = new App(); - const producerM = new Stack(appM, 'Producer'); - const resourceM = new CfnResource(producerM, 'ResourceXXX', { type: 'AWS::Resource' }); - - // THEN - producers are the same - expect(() => { - resourceM.overrideLogicalId(''); - }).toThrow('Cannot set an empty logical ID'); - }); - test('do not throw error if overrideLogicalId is used and logicalId is not locked', () => { // GIVEN: manual const appM = new App(); @@ -1420,59 +1381,26 @@ describe('stack', () => { const resourceM = new CfnResource(producerM, 'ResourceXXX', { type: 'AWS::Resource' }); // THEN - producers are the same - resourceM.overrideLogicalId('OVERRIDELOGICALID'); - producerM.exportValue(resourceM.getAtt('Att')); - - const template = appM.synth().getStackByName(producerM.stackName).template; - expect(template).toMatchObject({ - Outputs: { - ExportsOutputFnGetAttOVERRIDELOGICALIDAtt76AC816F: { - Export: { - Name: 'Producer:ExportsOutputFnGetAttOVERRIDELOGICALIDAtt76AC816F', - }, - Value: { - 'Fn::GetAtt': [ - 'OVERRIDELOGICALID', - 'Att', - ], - }, - }, - }, - Resources: { - OVERRIDELOGICALID: { - Type: 'AWS::Resource', - }, - }, - }); - }); - - test('do not throw if overrideLogicalId is unresolved', () => { - // GIVEN: manual - const appM = new App(); - const producerM = new Stack(appM, 'Producer'); - const resourceM = new CfnResource(producerM, 'ResourceXXX', { type: 'AWS::Resource' }); - - // THEN - producers are the same - resourceM.overrideLogicalId(Lazy.string({ produce: () => 'INVALID_LOGICAL_ID' })); + resourceM.overrideLogicalId('OVERRIDE_LOGICAL_ID'); producerM.exportValue(resourceM.getAtt('Att')); const template = appM.synth().getStackByName(producerM.stackName).template; expect(template).toMatchObject({ Outputs: { - ExportsOutputFnGetAttINVALIDLOGICALIDAtt6CB9E5B9: { + ExportsOutputFnGetAttOVERRIDELOGICALIDAtt2DD28019: { Export: { - Name: 'Producer:ExportsOutputFnGetAttINVALIDLOGICALIDAtt6CB9E5B9', + Name: 'Producer:ExportsOutputFnGetAttOVERRIDELOGICALIDAtt2DD28019', }, Value: { 'Fn::GetAtt': [ - 'INVALID_LOGICAL_ID', + 'OVERRIDE_LOGICAL_ID', 'Att', ], }, }, }, Resources: { - INVALID_LOGICAL_ID: { + OVERRIDE_LOGICAL_ID: { Type: 'AWS::Resource', }, },