aws-s3: Unable to use Bucket.fromBucketName on legacy s3 bucket with Uppcase Letters in the name

[gregmagdits]

Describe the bug

I'm attempting to reference an s3 bucket in my cdk code that was created in 2013 outside of cdk. The bucket has Capital letters in its name, which was legal for buckets before March 1, 2018 (new buckets can't have Capital letters or underscores in their names). I've tried referencing the bucket with both Bucket.fromBucketName and Bucket.fromBucketAttributes, but both throw this error: (note that I've slightly changed the name of the actual bucket for privacy)

Error: Invalid S3 bucket name (value: ABCD_Central_1) Bucket name must only contain lowercase characters and the symbols, period (.), underscore (_), and dash (-) (offset: 0) Bucket name must start and end with a lowercase character or number (offset: 0) at Function.validateBucketName (cdk-bug-test/node_modules/aws-cdk-lib/aws-s3/lib/bucket.js:1:19752) at Function.fromBucketAttributes (cdk-bug-test/node_modules/aws-cdk-lib/aws-s3/lib/bucket.js:1:15111) at Function.fromBucketName (cdk-bug-test/node_modules/aws-cdk-lib/aws-s3/lib/bucket.js:1:14511)

Regression Issue

• [ ] Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

I expect to be able to import the bucket.

Current Behavior

See error message in the description

Reproduction Steps

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

export class CdkBugTestStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);
    //
    let bucket = cdk.aws_s3.Bucket.fromBucketName(this, 'test-bucket', 'ABCD_Central_1');
    // also didnt work
    //let fromBucketName = cdk.aws_s3.Bucket.fromBucketArn(this, 'test-bucket', 'arn:aws:s3:::ABCD_Central_1');
    /*let fromBucketName = cdk.aws_s3.Bucket.fromBucketAttributes(this, 'test-bucket', {
      bucketName: 'NDAR_Central_1'
    });*/
  }
}

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.161.1

Framework Version

No response

Node.js Version

v20.15.0

OS

Ubuntu via (Window Subsystem for Linux)

Language

TypeScript

Language Version

No response

Other information

No response

[gregmagdits]

Note - this is almost identical to #22640

[khushail]

@gregmagdits , thanks for reaching out and linking similar issue.

As mentioned in the linked issue and also on the S3 README-

Note that this method allows importing buckets with legacy names containing underscores (_), which was permitted for buckets created before March 1, 2018. For buckets created after this date, underscores are not allowed in the bucket name.

which means your bucket name having underscore would be acceptable but I see that your bucket name consists of Uppercase letters as well which is not accepted as per norms.

You mentioned that you renamed your bucket. In that case, you might want to retry naming with lowercase letters and see if that works.

Let me know if this is not helpful.

[gregmagdits]

Hello @khushail , I think you misunderstood. In my bucket name, I only changed the first four uppercase letters to four other uppercase letters. Our bucket, created in 2013, matches the following regex. [A-Z]{4}Central[0-9]

At one point it was definitely legal to create s3 buckets with uppercase letters. I am not sure when this policy changed (perhaps in 2018 when aws also removed the ability for bucket names to contain underscores) but the cdk should support importing buckets with capital letters in the name, if they were created at the time when that was legal. The cdk already makes this provision for underscores, so it would just need to expand on this logic to include uppercase letters.

Please let me know if more information is needed. We do have an aws support account so if you need the name of the bucket, I would be happy to open a support ticket and reference this github issue.

[khushail]

@gregmagdits ,thanks for elaborating on your usecase. However I am not really sure if CDK Team would support such a case.

I would be reaching out to core team and would request their insights on this issue whether it should be supported(Uppercase naming support for Buckets) or share any comments on this issue. Thanks

[GavinZZ]

Yes, you're right. The support of upper case letters in bucket name is removed since 2018, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html. Before March 1, 2018, buckets created in the US East (N. Virginia) Region could have names that were up to 255 characters long and included uppercase letters and underscores. Beginning March 1, 2018, new buckets in US East (N. Virginia) must conform to the same rules applied in all other Regions..

The current implementation of fromBucketAttributes method set allowLegacyBucketNaming to true. We should also allow upper case values when allowLegacyBucketNaming is set to true.

[github-actions[bot]]

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.