(feat): introduce custom runtime aspect class for nodejs

packages/@aws-cdk-testing/framework-integ/test/core/test/integ.aspect-stack.ts

@@ -0,0 +1,25 @@
+import * as cdk from 'aws-cdk-lib';
+import { IntegTest } from '@aws-cdk/integ-tests-alpha';
+import { Construct } from 'constructs/lib/construct';
+import { AttributeType, Table } from 'aws-cdk-lib/aws-dynamodb';
+import * as customAspect from 'aws-cdk-lib/core/lib/nodejs-aspect';
+/**
+ * This test creates a stack and changes termination protection with the setter.
+ */
+
+//Dynamo DB
+class NodejsAspectTest extends cdk.Stack {
+
+ constructor(scope: Construct, id: string, props?: cdk.StackProps) {
+ super(scope, id, props);
+ new Table(this, 'Table', {
+ partitionKey: { name: 'hashKey', type: AttributeType.STRING },
+ removalPolicy: cdk.RemovalPolicy.DESTROY,
+ replicationRegions: ['us-east-2'],
+ });
+ }
+}
+const app = new cdk.App();
+const stack = new NodejsAspectTest(app, 'NodejsStack', { terminationProtection: false });
+customAspect.Runtime.of(stack).add('nodejs18.x');
+new IntegTest(app, 'stack', { testCases: [stack] });

packages/aws-cdk-lib/core/lib/cfn-resource.ts

@@ -40,6 +40,10 @@ export class CfnResource extends CfnRefElement {
  return x !== null && typeof(x) === 'object' && x.cfnResourceType !== undefined;
  }
 
+ public getResourceProperty(key: string): any {
+ return this._cfnProperties[key];
+ }
+
  // MAINTAINERS NOTE: this class serves as the base class for the generated L1
  // ("CFN") resources (such as `s3.CfnBucket`). These resources will have a
  // property for each CloudFormation property of the resource. This means that

packages/aws-cdk-lib/core/lib/custom-resource-provider/custom-resource-provider-base.ts

@@ -48,10 +48,19 @@ export abstract class CustomResourceProviderBase extends Construct {
  return this._codeHash;
  }
 
+ /**
+ * Base runtime
+ */
+ public get runtime(): string {
+ if (!this._runtime) {
+ throw new Error('Runtime not provided');
+ }
+ return this._runtime;
+ }
  private _codeHash?: string;
  private policyStatements?: any[];
  private role?: CfnResource;
-
+ private _runtime?: string;
  /**
  * The ARN of the provider's AWS Lambda function which should be used as the `serviceToken` when defining a custom
  * resource.
@@ -88,6 +97,7 @@ export abstract class CustomResourceProviderBase extends Construct {
  // need to initialize this attribute, but there should never be an instance
  // where config.enabled=true && config.preventSynthesis=true
  this.roleArn = '';
+ this._runtime = props.runtimeName;
  if (config.enabled) {
  // gives policyStatements a chance to resolve
  this.node.addValidation({
@@ -250,7 +260,6 @@ export abstract class CustomResourceProviderBase extends Construct {
  });
 
  this._codeHash = staging.assetHash;
-
  return {
  code: {
  S3Bucket: asset.bucketName,
@@ -279,3 +288,4 @@ export type Code = {
  S3Bucket: string;
  S3Key: string;
 };
+

packages/aws-cdk-lib/core/lib/nodejs-aspect.ts

@@ -0,0 +1,138 @@
+/* eslint-disable brace-style */
+import { Construct, IConstruct } from 'constructs';
+import { IAspect, Aspects } from './aspect';
+import * as cdk from '../../../aws-cdk-lib';
+import * as lambda from '../../aws-lambda';
+import { ReceiptRuleSet } from '../../aws-ses/lib/receipt-rule-set';
+import { Provider } from '../../custom-resources/lib';
+
+/**
+ * Runtime aspec
+ */
+abstract class RuntimeAspectsBase implements IAspect {
+
+ /**
+ * The string key for the runtime
+ */
+ public readonly targetRuntime: string;
+
+ constructor(runtime: string) {
+ this.targetRuntime = runtime;
+ }
+
+ public visit(construct: IConstruct): void {
+
+ //To handle custom providers
+ if (construct instanceof cdk.CustomResourceProviderBase) {
+ this.handleCustomResourceProvider(construct);
+ }
+
+ //To handle providers
+ else if (construct instanceof Provider) {
+ this.handleProvider(construct);
+ }
+
+ //To handle single Function case
+ else if (construct instanceof ReceiptRuleSet) {
+ this.handleReceiptRuleSet(construct);
+ }
+ }
+
+ private handleCustomResourceProvider(provider: cdk.CustomResourceProviderBase): void {
+ const node = provider as cdk.CustomResourceProviderBase;
+ // only replace for nodejs case
+ if (this.isValidRuntime(node.runtime)) {
+ const targetnode = node.node.children.find((child) => child instanceof cdk.CfnResource &&
+ child.cfnResourceType === 'AWS::Lambda::Function') as cdk.CfnResource;
+ targetnode.addPropertyOverride('Runtime', 'nodejs20.x');
+ }
+ }
+
+ private handleProvider(provider: Provider): void {
+ const functionNodes = provider.node.children.filter((child) => child instanceof lambda.Function);
+ for ( var node of functionNodes) {
+ const targetNode = node.node.children.find((child) => child instanceof cdk.CfnResource && child.cfnResourceType === 'AWS::Lambda::Function') as cdk.CfnResource;
+ if (this.isValidRuntime(this.getRuntimeProperty(targetNode))) {
+ targetNode.addPropertyOverride('Runtime', 'nodejs20.x');
+ }
+
+ // onEvent Handlers
+ const onEventHandler = provider.onEventHandler as lambda.Function;
+ const onEventHandlerRuntime = onEventHandler.node.children.find((child) => child instanceof cdk.CfnResource && child.cfnResourceType === 'AWS::Lambda::Function') as cdk.CfnResource;
+ if (this.isValidRuntime(this.getRuntimeProperty(targetNode))) {
+ onEventHandlerRuntime.addPropertyOverride('Runtime', 'nodejs20.x');
+ }
+
+ //isComplete Handlers
+ // Handlers
+ const isCompleteHandler = provider.isCompleteHandler as lambda.Function;
+ const isCompleteHandlerRuntime = isCompleteHandler.node.children.find((child) => child instanceof cdk.CfnResource && child.cfnResourceType === 'AWS::Lambda::Function') as cdk.CfnResource;
+ if (this.isValidRuntime(this.getRuntimeProperty(targetNode))) {
+ isCompleteHandlerRuntime.addPropertyOverride('Runtime', 'nodejs20.x');
+ }
+ }
+ }
+
+ private handleReceiptRuleSet(ruleSet: ReceiptRuleSet): void {
+ const functionnode = ruleSet.node.findChild('DropSpam');
+ const ses = functionnode.node.findChild('Function') as lambda.CfnFunction;
+ if (ses.runtime && this.isValidRuntime(ses.runtime)) {
+ ses.addPropertyOverride('Runtime', 'nodejs20.x');
+ }
+ }
+
+ /**
+ *Runtime Validation
+ *
+ */
+ private isValidRuntime(runtime: string) : boolean {
+ return runtime === this.targetRuntime;
+ }
+
+ private getRuntimeProperty(node: cdk.CfnResource) {
+ return (node.getResourceProperty('runtime') || node.getResourceProperty('Runtime')) as string;
+ }
+}
+//}
+/**
+ * RuntimeAspect
+ */
+export class RuntimeAspect extends RuntimeAspectsBase {
+
+ /**
+ * DEPRECATED: add tags to the node of a construct and all its the taggable children
+ *
+ * @deprecated use `Tags.of(scope).add()`
+ */
+ public static add(scope: Construct, key: string) {
+ Runtime.of(scope).add(key);
+ }
+
+ constructor(key: string) {
+ super(key);
+ }
+}
+
+/**
+ * Runtime
+ */
+export class Runtime {
+ /**
+ * Returns the runtime API for this scope.
+ * @param scope The scope
+ */
+ public static of(scope: IConstruct): Runtime {
+ return new Runtime(scope);
+ }
+
+ private constructor(private readonly scope: IConstruct) { }
+
+ /**
+ * modify runtime
+ */
+ public add(key: string) {
+ Aspects.of(this.scope).add(new RuntimeAspect(key));
+ }
+
+}
+