CDK Aspects Library - Tags
A library of AWS CDK Aspects for applying consistent tagging to AWS resources.
Features
This library provides two main aspects for tagging AWS resources:
ApplyTags
An aspect that applies a set of custom tags to all taggable resources in the given scope. This is useful for:
- Cost allocation and tracking
- Resource management and organization
- Compliance and governance requirements
- Environment identification
ApplyKmsTags
An aspect that applies CloudFormation-specific tags to KMS keys, including:
cfn:stack-name
- The name of the CloudFormation stack
cfn:logical-id
- The logical ID of the KMS key resource
This is particularly useful because KMS keys are not automatically tagged by CloudFormation, making them difficult to track and manage in large deployments.
It's not possible to use the same tags that CloudFormation applies to other resources, because those names are reserved for CloudFormation's internal use. As a best approximation, it uses the similar tag names listed above.
Examples
TypeScript
import { Aspects, App, Stack } from 'aws-cdk-lib';
import { aws_s3 as s3, aws_kms as kms } from 'aws-cdk-lib';
import { ApplyTags, ApplyKmsTags } from '@renovosolutions/cdk-aspects-library-tags';
const app = new App();
const stack = new Stack(app, 'MyStack');
new s3.Bucket(stack, 'MyBucket');
new kms.Key(stack, 'MyKey');
const tags = {
'Environment': 'Production',
'Project': 'MyProject',
'Owner': 'TeamName'
};
Aspects.of(stack).add(new ApplyTags(tags));
Aspects.of(stack).add(new ApplyKmsTags());
Python
from aws_cdk import (
Aspects,
App,
Stack,
aws_s3 as s3,
aws_kms as kms,
)
from renovosolutions_aspects_tags import (
ApplyTags,
ApplyKmsTags,
)
app = App()
stack = Stack(app, "MyStack")
s3.Bucket(stack, "MyBucket")
kms.Key(stack, "MyKey")
tags = {
"Environment": "Production",
"Project": "MyProject",
"Owner": "TeamName"
}
Aspects.of(stack).add(ApplyTags(tags))
Aspects.of(stack).add(ApplyKmsTags())
C Sharp
using Amazon.CDK;
using Amazon.CDK.AWS.S3;
using Amazon.CDK.AWS.KMS;
using System.Collections.Generic;
using renovosolutions;
var app = new App();
var stack = new Stack(app, "MyStack");
new Bucket(stack, "MyBucket");
new Key(stack, "MyKey");
var tags = new Dictionary<string, string>
{
["Environment"] = "Production",
["Project"] = "MyProject",
["Owner"] = "TeamName"
};
Aspects.Of(stack).Add(new ApplyTags(tags));
Aspects.Of(stack).Add(new ApplyKmsTags());
Scope of Application
The aspects in this library work at different scopes:
- ApplyTags: Applies to all resources that implement the
ITaggable
interface (most AWS resources)
- ApplyKmsTags: Applies specifically to
AWS::KMS::Key
resources
You can apply these aspects at any level in your CDK hierarchy:
- App level: Tags all resources across all stacks
- Stack level: Tags all resources within a specific stack
- Construct level: Tags resources within a specific construct
API Reference
For detailed API documentation, see API.md.
Contributing
Contributions are welcome! Please see our contributing guidelines for more details.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.