feat(cdk): configurable default SSM context provider (#889)

This feature is going to be used by the ECS constructs.
aws · Oct 10, 2018 · 9eebd05 · 9eebd05
1 parent 4a76287
commit 9eebd05
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/packages/@aws-cdk/cdk/lib/context.ts b/packages/@aws-cdk/cdk/lib/context.ts
@@ -151,9 +151,9 @@ export class SSMParameterProvider {
   /**
    * Return the SSM parameter string with the indicated key
    */
-  public getString(parameterName: string): any {
+  public getString(parameterName: string, defaultValue: string = "dummy"): any {
     const scope = this.provider.accountRegionScope('SSMParameterProvider');
-    return this.provider.getStringValue(SSM_PARAMETER_PROVIDER, scope, [parameterName], 'dummy');
+    return this.provider.getStringValue(SSM_PARAMETER_PROVIDER, scope, [parameterName], defaultValue);
   }
 }
 

diff --git a/packages/@aws-cdk/cdk/test/test.context.ts b/packages/@aws-cdk/cdk/test/test.context.ts
@@ -53,6 +53,19 @@ export = {
     test.done();
   },
 
+  'SSM parameter provider has configurable default'(test: Test) {
+    // GIVEN
+    const stack = new Stack(undefined, 'TestStack', { env: { account: '12345', region: 'us-east-1' } });
+
+    // WHEN
+    const customizedDefault = new SSMParameterProvider(stack).getString('test', 'some-value');
+
+    // THEN
+    test.equals(customizedDefault, 'some-value');
+
+    test.done();
+  },
+
   'Return default values if "env" is undefined to facilitate unit tests, but also expect metadata to include "error" messages'(test: Test) {
     const app = new App();
     const stack = new Stack(app, 'test-stack');