feat(neptune-alpha): add tests for publiclyAccessible property

Author: Dennis Ruhe

packages/@aws-cdk/aws-neptune-alpha/lib/cluster.ts

@@ -407,7 +407,7 @@ export interface DatabaseClusterProps {
    * @see DatabaseInstanceProps.publiclyAccessible
    * @see https://docs.aws.amazon.com/neptune/latest/userguide/neptune-public-endpoints.html
    *
-   * @default false
+   * @default - false
    */
   readonly publiclyAccessible?: boolean;
 }

packages/@aws-cdk/aws-neptune-alpha/lib/instance.ts

@@ -416,7 +416,7 @@ export interface DatabaseInstanceProps {
   /**
    * Indicates whether the DB instance is publicly accessible.
    *
-   * @default false
+   * @default - false
    */
   readonly publiclyAccessible?: boolean;
 }

packages/@aws-cdk/aws-neptune-alpha/test/cluster.test.ts

@@ -675,6 +675,41 @@ describe('DatabaseCluster', () => {
     });
   });
 
+  test('publiclyAccessible is enabled when configured', () => {
+    // GIVEN
+    const stack = testStack();
+    const vpc = new ec2.Vpc(stack, 'VPC');
+
+    // WHEN
+    new DatabaseCluster(stack, 'Cluster', {
+      vpc,
+      instanceType: InstanceType.R5_LARGE,
+      publiclyAccessible: true,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::Neptune::DBInstance', {
+      PubliclyAccessible: true,
+    });
+  });
+
+  test('publiclyAccessible is not enabled when not configured', () => {
+    // GIVEN
+    const stack = testStack();
+    const vpc = new ec2.Vpc(stack, 'VPC');
+
+    // WHEN
+    new DatabaseCluster(stack, 'Cluster', {
+      vpc,
+      instanceType: InstanceType.R5_LARGE,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::Neptune::DBInstance', {
+      PubliclyAccessible: false,
+    });
+  });
+
   test('cloudwatchLogsExports is enabled when configured', () => {
     // GIVEN
     const stack = testStack();

packages/@aws-cdk/aws-neptune-alpha/test/instance.test.ts

@@ -125,6 +125,23 @@ describe('DatabaseInstance', () => {
     });
   });
 
+  test.each([true, false])('instance with publiclyAccessible', (publiclyAccessible) => {
+    // GIVEN
+    const stack = testStack();
+
+    // WHEN
+    new DatabaseInstance(stack, 'Instance', {
+      cluster: stack.cluster,
+      instanceType: InstanceType.R5_LARGE,
+      publiclyAccessible,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::Neptune::DBInstance', {
+      PubliclyAccessible: publiclyAccessible,
+    });
+  });
+
   test('instance type from CfnParameter', () => {
     // GIVEN
     const stack = testStack();

packages/@aws-cdk/aws-neptune-alpha/test/integ.cluster.ts

@@ -43,6 +43,7 @@ const cluster = new DatabaseCluster(stack, 'Database', {
   kmsKey,
   removalPolicy: cdk.RemovalPolicy.DESTROY,
   autoMinorVersionUpgrade: true,
+  publiclyAccessible: true,
   cloudwatchLogsExports: [LogType.AUDIT],
   cloudwatchLogsRetention: logs.RetentionDays.ONE_MONTH,
 });

packages/@aws-cdk/aws-neptune-alpha/test/integ.instance-publicly-accessible.ts

@@ -0,0 +1,53 @@
+import * as ec2 from 'aws-cdk-lib/aws-ec2';
+import * as cdk from 'aws-cdk-lib';
+import * as integ from '@aws-cdk/integ-tests-alpha';
+import { DatabaseCluster, DatabaseInstance, InstanceType } from '../lib';
+import { ClusterParameterGroup, ParameterGroupFamily } from '../lib/parameter-group';
+
+/*
+ * Test creating a cluster without specifying engine version.
+ * This defaults to engine version >= 1.4.0.0 and associated parameter group with family neptune1.4
+ *
+ * Stack verification steps:
+ * * aws docdb describe-db-clusters --db-cluster-identifier <deployed db cluster identifier>
+ */
+
+const app = new cdk.App();
+
+const stack = new cdk.Stack(app, 'AutoMinorVersionUpgradeInstanceStack');
+
+const vpc = new ec2.Vpc(stack, 'VPC', { maxAzs: 2, natGateways: 1 });
+
+const clusterParameterGroup = new ClusterParameterGroup(stack, 'Params', {
+  description: 'A nice parameter group',
+  family: ParameterGroupFamily.NEPTUNE_1_4,
+  parameters: {
+    neptune_enable_audit_log: '1',
+    neptune_query_timeout: '100000',
+  },
+});
+
+const cluster = new DatabaseCluster(stack, 'Database', {
+  vpc,
+  instanceType: InstanceType.R5_LARGE,
+  clusterParameterGroup,
+  removalPolicy: cdk.RemovalPolicy.DESTROY,
+});
+
+new DatabaseInstance(stack, 'EnabledInstance', {
+  cluster,
+  instanceType: InstanceType.R5_LARGE,
+  removalPolicy: cdk.RemovalPolicy.DESTROY,
+  publiclyAccessible: true,
+});
+
+new DatabaseInstance(stack, 'DisabledInstance', {
+  cluster,
+  instanceType: InstanceType.R5_LARGE,
+  removalPolicy: cdk.RemovalPolicy.DESTROY,
+  publiclyAccessible: false,
+});
+
+new integ.IntegTest(app, 'PubliclyAccessibleInstanceInteg', {
+  testCases: [stack],
+});