Enable creation of custom parameter group

Author: mandryllo

src/v2/components/database/builder.ts

@@ -1,10 +1,13 @@
-
 import * as pulumi from '@pulumi/pulumi';
+import * as aws from '@pulumi/aws';
 import * as awsx from '@pulumi/awsx';
 import { Database } from '.';
 
 export namespace DatabaseBuilder {
-  export type Config = Omit<Database.Args, 'vpc' | 'enableMonitoring' | 'snapshotIdentifier'>;
+  export type Config = Omit<
+    Database.Args,
+    'vpc' | 'enableMonitoring' | 'snapshotIdentifier'
+  >;
 }
 
 export class DatabaseBuilder {
@@ -13,7 +16,8 @@ export class DatabaseBuilder {
   private _vpc?: Database.Args['vpc'];
   private _enableMonitoring?: Database.Args['enableMonitoring'];
   private _snapshotIdentifier?: Database.Args['snapshotIdentifier'];
-  
+  private _parameterGroupArgs?: Database.Args['parameterGroupArgs'];
+
   constructor(name: string) {
     this._name = name;
   }
@@ -34,19 +38,27 @@ export class DatabaseBuilder {
 
   public withVpc(vpc: pulumi.Input<awsx.ec2.Vpc>): this {
     this._vpc = pulumi.output(vpc);
-    
+
     return this;
   }
 
   public withMonitoring(): this {
     this._enableMonitoring = true;
-    
+
     return this;
   }
 
   public withSnapshot(snapshotIdentifier: pulumi.Input<string>): this {
     this._snapshotIdentifier = snapshotIdentifier;
-    
+
+    return this;
+  }
+
+  public withParameterGroup(
+    parameterGroupArgs: pulumi.Input<aws.rds.ParameterGroupArgs>,
+  ): this {
+    this._parameterGroupArgs = parameterGroupArgs;
+
     return this;
   }
 
@@ -63,17 +75,16 @@ export class DatabaseBuilder {
       );
     }
 
-
     return new Database(
       this._name,
       {
         ...this._config,
         vpc: this._vpc,
         enableMonitoring: this._enableMonitoring,
         snapshotIdentifier: this._snapshotIdentifier,
+        parameterGroupArgs: this._parameterGroupArgs,
       },
       opts,
     );
   }
-
 }

src/v2/components/database/index.ts

@@ -62,10 +62,14 @@ export namespace Database {
      */
     autoMinorVersionUpgrade?: pulumi.Input<boolean>;
     /**
-     * The name of custom aws.rds.ParameterGroup. Setting this param will apply custom
+     * The name of existing custom aws.rds.ParameterGroup. Setting this param will apply custom
      * DB parameters to this instance.
      */
     parameterGroupName?: pulumi.Input<string>;
+    /**
+     * Arguments for creation of new custom aws.rds.ParameterGroup.
+     */
+    parameterGroupArgs?: pulumi.Input<aws.rds.ParameterGroupArgs>;
     /**
      * Set this to `{ enabled: true }` to enable low-downtime updates using RDS Blue/Green deployments.
      * Defaults to `{ enabled: false }`.
@@ -115,6 +119,7 @@ export class Database extends pulumi.ComponentResource {
   password: Password;
   encryptedSnapshotCopy?: aws.rds.SnapshotCopy;
   monitoringRole?: aws.iam.Role;
+  parameterGroup?: pulumi.Output<aws.rds.ParameterGroup>;
 
   constructor(
     name: string,
@@ -129,6 +134,7 @@ export class Database extends pulumi.ComponentResource {
     const {
       enableMonitoring,
       snapshotIdentifier,
+      parameterGroupArgs,
     } = argsWithDefaults;
 
     const vpc = pulumi.output(argsWithDefaults.vpc);
@@ -148,6 +154,9 @@ export class Database extends pulumi.ComponentResource {
       this.encryptedSnapshotCopy =
         this.createEncryptedSnapshotCopy(snapshotIdentifier);
     }
+    if (parameterGroupArgs) {
+      this.parameterGroup = this.createParameterGroup(parameterGroupArgs);
+    }
     this.instance = this.createDatabaseInstance(args);
 
     this.registerOutputs();
@@ -248,6 +257,18 @@ export class Database extends pulumi.ComponentResource {
     return encryptedSnapshotCopy;
   }
 
+  private createParameterGroup(
+    parameterGroupArgs: pulumi.Input<aws.rds.ParameterGroupArgs>
+  ) {
+    return pulumi.output(parameterGroupArgs).apply(args => {
+      return new aws.rds.ParameterGroup(
+        `${this.name}-parameter-group`,
+        args,
+        { parent: this }
+      );
+    })
+  }
+
   private createDatabaseInstance(args: Database.Args) {
     const argsWithDefaults = Object.assign({}, defaults, args);
     const stack = pulumi.getStack();
@@ -262,6 +283,10 @@ export class Database extends pulumi.ComponentResource {
           }
         : {};
 
+    const parameterGroupName = this.parameterGroup
+        ? this.parameterGroup.name
+        : argsWithDefaults.parameterGroupName;
+
     const instance = new aws.rds.Instance(
       `${this.name}-rds`,
       {
@@ -288,7 +313,7 @@ export class Database extends pulumi.ComponentResource {
         backupWindow: '06:00-06:30',
         backupRetentionPeriod: 14,
         caCertIdentifier: 'rds-ca-rsa2048-g1',
-        parameterGroupName: argsWithDefaults.parameterGroupName,
+        parameterGroupName,
         allowMajorVersionUpgrade: argsWithDefaults.allowMajorVersionUpgrade,
         blueGreenUpdate: argsWithDefaults.blueGreenUpdate,
         snapshotIdentifier:

tests/build/index.tst.ts

@@ -314,6 +314,12 @@ describe('Build output', () => {
       it('should have withSnapshot method', () => {
         expect(builder.withSnapshot).type.toBeCallableWith('snapshot-id');
       });
+
+      it('should have withParameterGroup method', () => {
+        expect(builder.withParameterGroup).type.toBeCallableWith({
+          family: 'custom-family'
+        });
+      });
     });
   });
 });

tests/database/index.test.ts

@@ -17,6 +17,7 @@ import { DatabaseTestContext } from './test-context';
 import { IAMClient } from '@aws-sdk/client-iam';
 import { InlineProgramArgs } from '@pulumi/pulumi/automation';
 import { testDbWithMonitoring } from './monitoring.test';
+import { testDbWithParameterGroup } from './parameter-group.test';
 
 const programArgs: InlineProgramArgs = {
   stackName: 'dev',
@@ -181,4 +182,5 @@ describe('Database component deployment', () => {
   });
 
   describe('With monitoring', () => testDbWithMonitoring(ctx));
+  describe('With parameter group', () => testDbWithParameterGroup(ctx));
 });

tests/database/infrastructure/index.ts

@@ -13,8 +13,8 @@ const database = new studion.DatabaseBuilder(config.instanceName)
   .build();
 
 const dbWithMonitoring = new studion.DatabaseBuilder(
-  `${config.instanceName}-w-monitoring`,
-)
+    `${config.instanceName}-w-monitoring`,
+  )
   .configure(config.dbName, config.username, {
     password: config.password,
     applyImmediately: config.applyImmediately,
@@ -24,4 +24,18 @@ const dbWithMonitoring = new studion.DatabaseBuilder(
   .withMonitoring()
   .build();
 
-export { vpc, database, dbWithMonitoring };
+const dbWithParameterGroup = new studion.DatabaseBuilder(
+    `${config.instanceName}-w-param-group`,
+  )
+  .configure(config.dbName, config.username, {
+    password: config.password,
+    applyImmediately: config.applyImmediately,
+    skipFinalSnapshot: config.skipFinalSnapshot,
+  })
+  .withVpc(vpc.vpc)
+  .withParameterGroup({
+    family: 'postgres17'
+  })
+  .build();
+
+export { vpc, database, dbWithMonitoring, dbWithParameterGroup };

tests/database/parameter-group.test.ts

@@ -0,0 +1,40 @@
+import * as assert from 'node:assert';
+import { DatabaseTestContext } from './test-context';
+import { DescribeDBParameterGroupsCommand } from '@aws-sdk/client-rds';
+import { it } from 'node:test';
+
+export function testDbWithParameterGroup(ctx: DatabaseTestContext) {
+  it('should properly configure parameter group', () => {
+    const dbWithParameterGroup = ctx.outputs.dbWithParameterGroup.value;
+    
+    assert.ok(
+      dbWithParameterGroup.parameterGroup,
+      'Parameter group should exist',
+    );
+    assert.strictEqual(
+      dbWithParameterGroup.instance.parameterGroupName,
+      dbWithParameterGroup.parameterGroup.name,
+      'Parameter group name should be set correctly',
+    );
+  });
+
+  it('should create parameter group with correct family', async () => {
+    const dbWithParameterGroup = ctx.outputs.dbWithParameterGroup.value;
+    const parameterGroupName = dbWithParameterGroup.parameterGroup.name;
+
+    const command = new DescribeDBParameterGroupsCommand({
+      DBParameterGroupName: parameterGroupName,
+    });
+    const { DBParameterGroups } = await ctx.clients.rds.send(command);
+    assert.ok(
+      DBParameterGroups && DBParameterGroups.length > 0,
+      'DB parameter group should exist',
+    );
+    const [parameterGroup] = DBParameterGroups;
+    assert.strictEqual(
+      parameterGroup.DBParameterGroupFamily,
+      'postgres17',
+      'DB Parameter group family should be set correctly',
+    );
+  });
+}