StackResourceRenamer
A CDK aspect, StackResourceRenamer renames CDK stack name and stack's subordinate resources' physical names, so that a CDK stack can be used to create multiple stacks in same AWS environment without confliction.
API: API.md
Two main use cases:
- rename custom resources names in stack, so that stack can be reused and replicated:
StackResourceRenamer.rename(stack, {
rename: (resName, _)=>{
return resName+'-'+alias;
},
});- for resources without custom name, which by default will use unique id AWS auto generate as its physical id, we can create a more readable and identifiable name, for testing, debugging or metrics monitoring environments.
StackResourceRenamer.rename(stack, {
rename: (_, typeName)=>{
counts[typeName]++;
return projectName+'-'+serviceName+'-'+typeName+'-'+counts[typeName];
},
}, { userCustomNameOnly: false });Samples
typescript
import { StackResourceRenamer } from 'cdk-stack-resource-rename';
const app = new core.App();
const stack = new core.Stack(app, 'my-stack');
let alias = stack.node.tryGetContext('alias');
if (alias) {
//if alias is defined, rename stack and resources' custom names
StackResourceRenamer.rename(stack, {
rename: (resName, _)=>{
return resName+'-'+alias;
},
});
}
//resources in stack
const bucket = new s3.Bucket(stack, 'bucket', {
bucketName: 'my-bucket',
});
... python
from cdk_stack_resource_rename import (StackResourceRenamer, IRenameOperation)
@jsii.implements(IRenameOperation)
class RenameOper:
def __init__(self, alias):
self.alias=alias
def rename(self, resName, typeName):
return resName+'-'+self.alias
class AppStack(core.Stack):
def __init__(self, scope: core.Construct, construct_id: str, **kwargs) -> None:
......
alias = self.node.try_get_context("alias")
if alias != None:
# if alias is defined, rename stack/resources' custom names
StackResourceRenamer.rename(self, RenameOper(alias))java
import io.github.yglcode.cdkutils.aspects.resourcerename.StackResourceRenamer;
import io.github.yglcode.cdkutils.aspects.resourcerename.IRenameOperation;
public class AppStack extends Stack {
......
String alias = (String) this.getNode().tryGetContext("alias");
if (alias != null) {
StackResourceRenamer.rename(this, new IRenameOperation() {
public String rename(String resName, String typeName) {
return resName + "-"+alias;
}
});
}csharp
using CdkUtils.Aspects.ResourceRename;
public class RenameOper: Amazon.JSII.Runtime.Deputy.DeputyBase, IRenameOperation {
private string alias;
public RenameOper(string alias) {
this.alias=alias;
}
public string Rename(string resName, string typeName) {
return resName+"-"+alias;
}
}
public class AppStack : Stack
{
internal AppStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
{
......
var alias = (string)this.Node.TryGetContext("alias");
if (alias!=null) {
StackResourceRenamer.Rename(this, new RenameOper(alias));
} To create multiple stacks:
cdk -c alias=a1 deploy
will create a stack: my-stack-a1 with my-bucket-a1.
To create more stacks: my-stack-a2 with my-bucket-a2, my-stack-a3 with my-bucket-a3:
cdk -c alias=a2 deploy
cdk -c alias=a3 deploy