(cli): tags with an equals sign in the value only use the value of the string prior to the equals sign

[peterwoodworth]

Describe the bug

If you need a tag with a key value pair such as

Key : MyKey
Value : MyValue=Something

The stack will have a key value pair that shows

Key: MyKey
Value: MyValue

Expected Behavior

I would expect the value of the tag to be MyValue=Something

Current Behavior

Doesn't read the full tag value

Reproduction Steps

Try to create a stack with a tag that has an equals sign in the value

Possible Solution

The code which parses tags in the command line will split when it sees an equals sign, and will only use the second split value as the tag value, when it should be everything after the first split

aws-cdk/packages/aws-cdk/lib/settings.ts

Lines 327 to 348 in a7e3eab

	private static parseStringTagsListToObject(argTags: string[] | undefined): Tag[] | undefined {
	if (argTags === undefined) { return undefined; }
	if (argTags.length === 0) { return undefined; }
	const nonEmptyTags = argTags.filter(t => t !== '');
	if (nonEmptyTags.length === 0) { return []; }
	const tags: Tag[] = [];
	for (const assignment of nonEmptyTags) {
	const parts = assignment.split('=', 2);
	if (parts.length === 2) {
	debug('CLI argument tags: %s=%s', parts[0], parts[1]);
	tags.push({
	Key: parts[0],
	Value: parts[1],
	});
	} else {
	warning('Tags argument is not an assignment (key=value): %s', assignment);
	}
	}
	return tags.length > 0 ? tags : undefined;
	}

Additional Information/Context

No response

CDK CLI Version

.

Framework Version

No response

Node.js Version

.

OS

.

Language

Typescript

Language Version

No response

Other information

No response

[nvcaine]

Hi Peter,

I encountered the same problem while attempting to tag the resources created in the bootstrapping phase of the deployment process, specifically the S3 bucket created by CDK prior to actually deploying the stack(s).

Here is a workaround:

First, a custom name is used for the bootstrap the bucket. That can be done with the following command:

cdk bootstrap aws://{ACCOUNT}/{REGION} --toolkit-bucket-name {CUSTOM BUCKET NAME}

Now that the bucket has a name, its ARN can be determined. Finally the AWS resourcegroupstaggingapi can be used to tag resources:

aws resourcegroupstaggingapi tag-resources --cli-input-json file://{PATH TO TAGS FILE}.json --region {REGION}

We found the most convenient way is to use a JSON file with the following structure:

{
    "ResourceARNList": ["arn:aws:s3:::{CUSTOM BUCKET NAME}"],
    "Tags": {
        "{TAG KEY}": "{SOME FIELD}={SOME VALUE}",
        ...
    }
}

This approach works for preserving values which contain =, but you have to do the bootstrapping phase in two steps.

Have a good day,
Romi

[seungholee-dev]

Hi, @peterwoodworth
I am a new contributor to this project and can I try working on 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.