Skip to content

API.md

Latest commit

 

History

History
131 lines (72 loc) · 3.98 KB

API.md

File metadata and controls

131 lines (72 loc) · 3.98 KB

API Reference

Classes

ApplyKmsTags

  • Implements: aws-cdk-lib.IAspect

An aspect that applies CloudFormation tags to all KMS keys in the given scope.

This is useful because KMS keys are not automatically tagged by CloudFormation, which makes them hard to track and manage.

Initializers 

import { ApplyKmsTags } from '@renovosolutions/cdk-aspects-library-tags'

new ApplyKmsTags()
Name Type Description

Methods

Name Description
visit Visits each construct in the scope and applies the tags if the construct is a KMS key.
visit 
public visit(node: IConstruct): void

Visits each construct in the scope and applies the tags if the construct is a KMS key.

nodeRequired
  • Type: constructs.IConstruct

ApplyTags

  • Implements: aws-cdk-lib.IAspect

An aspect that applies a set of tags to all taggable resources in the given scope.

This aspect can be used to enforce consistent tagging across resources, which is useful for cost allocation, resource management, and compliance purposes.

Initializers 

import { ApplyTags } from '@renovosolutions/cdk-aspects-library-tags'

new ApplyTags(tags: {[ key: string ]: string})
Name Type Description
tags {[ key: string ]: string} - a record of key-value pairs to apply as tags to taggable resources in the CDK app.
tagsRequired
  • Type: {[ key: string ]: string}

a record of key-value pairs to apply as tags to taggable resources in the CDK app.

Methods

Name Description
visit Visits each construct in the scope and applies the tags if the construct is taggable.
visit 
public visit(node: IConstruct): void

Visits each construct in the scope and applies the tags if the construct is taggable.

nodeRequired
  • Type: constructs.IConstruct

the construct to visit.

Properties

Name Type Description
tags {[ key: string ]: string} A record of key-value pairs to apply as tags to taggable resources in the CDK app.
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

A record of key-value pairs to apply as tags to taggable resources in the CDK app.