Skip to content

Commit

Permalink
add tsdoc to describe legacy taggables
Browse files Browse the repository at this point in the history
  • Loading branch information
HBobertz committed Dec 20, 2024
1 parent ff57cc3 commit 3ae33c0
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions tools/@aws-cdk/spec2cdk/lib/cdk/tagging.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ export function resourceTaggabilityStyle(resource: Resource): TaggabilityStyle |
return undefined;
}

/**
* Mapping of legacy taggable resources to their tag property name and variant
*
* Before the introduction of iTaggablev2 the CDK defined a `tags` property on constructs
* which contained the tagManager, however in cases where the resource itself contained a
* property named 'tags', the CDK would create a `tagsRaw` property to represent that CFN tags property.
*
* Upon the introduction of iTaggablev2, the CDK now uses the `cdkTagManager` property to manage tags.
* This mapping of legacy resources is used to preserve the legacy behavior of tagging resources so that customers
* who previously were tagging these constructs using `myConstruct.tags.setTag('key', 'value')` will
* continue to be able to do so, without breaking changes.
*/
const LEGACY_TAGGABLES: Record<string, [string, TagInformation['variant']]> = {
'AWS::ACMPCA::CertificateAuthority': ['Tags', 'standard'],
'AWS::AccessAnalyzer::Analyzer': ['Tags', 'standard'],
Expand Down

0 comments on commit 3ae33c0

Please sign in to comment.