Chore: [AEA-6258] - Remove exports that aren't necessary at the construct level (#647)

## Summary

- Routine Change

### Details

The export of a parameter is not needed in all cases - it should be
handled higher up the hierarchy, rather than doing it by default at the
construct level every time.

Author: wildjames

packages/cdkConstructs/src/constructs/SsmParametersConstruct.ts

@@ -1,4 +1,3 @@
-import {CfnOutput} from "aws-cdk-lib"
 import {Effect, ManagedPolicy, PolicyStatement} from "aws-cdk-lib/aws-iam"
 import {StringParameter} from "aws-cdk-lib/aws-ssm"
 import {Construct} from "constructs"
@@ -34,16 +33,6 @@ export interface SsmParameterDefinition {
    * Value stored in the SSM parameter.
    */
   readonly value: string
-  /**
-   * Optional export suffix for the output containing the parameter name.
-   * @default nameSuffix value
-   */
-  readonly outputExportSuffix?: string
-  /**
-   * Optional output description.
-   * @default description value
-   */
-  readonly outputDescription?: string
 }
 
 /**
@@ -54,10 +43,6 @@ export interface SsmParameterDefinition {
  * @property parameters List of SSM parameters to create.
  * @property readPolicyDescription Description for the managed policy that grants
  * read access. Defaults to "Allows reading SSM parameters".
- * @property readPolicyOutputDescription Description for the output exporting the
- * managed policy ARN. Defaults to "Access to the parameters used by the integration".
- * @property readPolicyExportSuffix Export suffix for the output exporting the
- * managed policy ARN.
  */
 export interface SsmParametersConstructProps {
   /**
@@ -73,15 +58,6 @@ export interface SsmParametersConstructProps {
    * @default "Allows reading SSM parameters"
    */
   readonly readPolicyDescription?: string
-  /**
-   * Description for the output exporting the managed policy ARN.
-   * @default "Access to the parameters used by the integration"
-   */
-  readonly readPolicyOutputDescription?: string
-  /**
-   * Export suffix for the output exporting the managed policy ARN.
-   */
-  readonly readPolicyExportSuffix: string
 }
 
 /**
@@ -107,9 +83,7 @@ export class SsmParametersConstruct extends Construct {
     const {
       namePrefix,
       parameters,
-      readPolicyExportSuffix,
-      readPolicyDescription = "Allows reading SSM parameters",
-      readPolicyOutputDescription = "Access to the parameters used by the integration"
+      readPolicyDescription = "Allows reading SSM parameters"
     } = props
 
     if (parameters.length === 0) {
@@ -141,12 +115,6 @@ export class SsmParametersConstruct extends Construct {
       })
 
       createdParameters[parameter.id] = ssmParameter
-
-      new CfnOutput(this, `${parameter.id}ParameterNameOutput`, {
-        description: parameter.outputDescription ?? parameter.description,
-        value: ssmParameter.parameterName,
-        exportName: `${namePrefix}-${parameter.outputExportSuffix ?? parameter.nameSuffix}`
-      })
     }
 
     const readParametersPolicy = new ManagedPolicy(this, "GetParametersPolicy", {
@@ -160,12 +128,6 @@ export class SsmParametersConstruct extends Construct {
       ]
     })
 
-    new CfnOutput(this, "ReadParametersPolicyOutput", {
-      description: readPolicyOutputDescription,
-      value: readParametersPolicy.managedPolicyArn,
-      exportName: `${namePrefix}-${readPolicyExportSuffix}`
-    })
-
     this.parameters = createdParameters
     this.readParametersPolicy = readParametersPolicy
   }

packages/cdkConstructs/tests/constructs/ssmParametersConstruct.test.ts

@@ -24,30 +24,22 @@ describe("SsmParametersConstruct", () => {
           id: "MockParam1",
           nameSuffix: "MockParam1",
           description: "Description for mock parameter 1",
-          value: "mock-value-1",
-          outputExportSuffix: "MockParam1Parameter",
-          outputDescription: "Name of the SSM parameter holding MockParam1"
+          value: "mock-value-1"
         },
         {
           id: "MockParam2",
           nameSuffix: "MockParam2",
           description: "Description for mock parameter 2",
-          value: "mock-value-2",
-          outputExportSuffix: "MockParam2Parameter",
-          outputDescription: "Name of the SSM parameter holding MockParam2"
+          value: "mock-value-2"
         },
         {
           id: "MockParam3",
           nameSuffix: "MockParam3",
           description: "Description for mock parameter 3",
-          value: "mock-value-3",
-          outputExportSuffix: "MockParam3Parameter",
-          outputDescription: "Name of the SSM parameter holding MockParam3"
+          value: "mock-value-3"
         }
       ],
-      readPolicyDescription: "Mock policy description",
-      readPolicyOutputDescription: "Mock read policy output description",
-      readPolicyExportSuffix: "MockGetParametersPolicy"
+      readPolicyDescription: "Mock policy description"
     })
     // Sonarcloud complains that the construct is not used, so we add an assertion to sidestep that.
     assert(params, "SsmParametersConstruct should be created successfully")
@@ -99,37 +91,10 @@ describe("SsmParametersConstruct", () => {
     expect(statement.Action).toEqual(["ssm:GetParameter", "ssm:GetParameters"])
     expect(statement.Resource).toHaveLength(3)
   })
-
-  test("exports parameter names and policy ARN", () => {
-    const outputs = template.toJSON().Outputs as Record<string, {
-      Description?: string
-      Export?: {
-        Name?: string
-      }
-    }>
-
-    const exportedNames = Object.values(outputs)
-      .map((output) => output.Export?.Name)
-      .filter((name): name is string => name !== undefined)
-
-    const descriptions = Object.values(outputs)
-      .map((output) => output.Description)
-      .filter((description): description is string => description !== undefined)
-
-    expect(exportedNames).toContain("mock-stack-MockParam1Parameter")
-    expect(exportedNames).toContain("mock-stack-MockParam2Parameter")
-    expect(exportedNames).toContain("mock-stack-MockParam3Parameter")
-    expect(exportedNames).toContain("mock-stack-MockGetParametersPolicy")
-
-    expect(descriptions).toContain("Name of the SSM parameter holding MockParam1")
-    expect(descriptions).toContain("Name of the SSM parameter holding MockParam2")
-    expect(descriptions).toContain("Name of the SSM parameter holding MockParam3")
-    expect(descriptions).toContain("Mock read policy output description")
-  })
 })
 
 describe("SsmParametersConstruct uses defaults when optional fields are omitted", () => {
-  test("outputDescription defaults to description and outputExportSuffix defaults to nameSuffix", () => {
+  test("creates parameter and policy with default readPolicyDescription", () => {
     const app = new App()
     const stack = new Stack(app, "defaultsStack")
     const params = new SsmParametersConstruct(stack, "DefaultsParameters", {
@@ -140,22 +105,23 @@ describe("SsmParametersConstruct uses defaults when optional fields are omitted"
           nameSuffix: "MockParam1Suffix",
           description: "Mock SSM parameter description",
           value: "mock-value-1"
-          // outputDescription and outputExportSuffix intentionally omitted
         }
       ]
     })
     // Get sonar to shup up about the construct not being used
     assert(params, "SsmParametersConstruct should be created successfully")
     const template = Template.fromStack(stack)
 
-    const outputs = template.toJSON().Outputs as Record<string, {
-      Description?: string
-      Export?: {Name?: string}
-    }>
+    template.hasResourceProperties("AWS::SSM::Parameter", {
+      Name: "mock-stack-MockParam1Suffix",
+      Type: "String",
+      Value: "mock-value-1",
+      Description: "Mock SSM parameter description"
+    })
 
-    const outputValues = Object.values(outputs)
-    expect(outputValues.some((o) => o.Description === "Mock SSM parameter description")).toBe(true)
-    expect(outputValues.some((o) => o.Export?.Name === "mock-stack-MockParam1Suffix")).toBe(true)
+    template.hasResourceProperties("AWS::IAM::ManagedPolicy", {
+      Description: "Allows reading SSM parameters"
+    })
   })
 })