core: logical ID validation regex is inconsistant with cloudformation specification

[ashwin300]

Describe the bug

The CloudFormation documentation indicates that logical ID's must be only alphanumeric, yet the regex in the logical ID validation file is /^[A-Za-z][A-Za-z0-9]{1,254}$/. This causes logical IDs such as 030ffab42b5f448fb39750B452 to fail even though they are valid according to the CloudFormation standard.

Expected Behavior

Logical IDs such as 030ffab42b5f448fb39750B452 to be considered valid to the CDK when synthesizing a stack

Current Behavior

Logical IDs such as 030ffab42b5f448fb39750B452 are not considered valid when synthesizing a stack.

Error: Resolution error: Logical ID must adhere to the regular expression: /^[A-Za-z][A-Za-z0-9]{1,254}$/, got '030ffab42b5f448fb39750B452'.

Reproduction Steps

1. initialize sample cdk app
2. in the stack, add the following code:

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as sqs from 'aws-cdk-lib/aws-sqs';

export class CdkErrorTestStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // The code that defines your stack goes here

    // example resource
    const queue = new sqs.Queue(this, '030ffab42b5f448fb39750B452', {
      visibilityTimeout: cdk.Duration.seconds(300)
    });
  }
}

run cdk synth

Possible Solution

Change the logical ID validation regex to fit CloudFormation documentation, or change the documentation to reflect the regex validation.

Additional Information/Context

No response

CDK CLI Version

2.85.0 (build 4e0d726)

Framework Version

No response

Node.js Version

v14.21.3

OS

Linux

Language

Typescript

Language Version

No response

Other information

No response

[peterwoodworth]

Thanks for reporting this, I think it's likely that CloudFormation used to have this constraint, but does not anymore. We'll see what we can do about this

[peterwoodworth]

I just tried deploying through the console and CLI with a number at the beginning, and I'm getting this error:

An error occurred (ValidationError) when calling the CreateStack operation: 1 validation error detected: Value '0NameWithNumber' at 'stackName' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-zA-Z][-a-zA-Z0-9]*

So I think this is properly constrained by CDK

[ashwin300]

The regex applies to stack names, however, the same regex is being used for resource names, which can have a number at the beginning.

[peterwoodworth]

Thanks... don't know why I read stack ID here

[peterwoodworth]

Verified you can override the logical ID to deploy successfully, we should be good to accept a PR with this

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.