如何在AWS CDK中通过AwsCustomResource读取SSM参数存储的JSON值？

问题背景 #

我此前使用SSMParameterReader类从AWS参数存储获取配置，原始代码如下：

export class SSMParameterReader extends AwsCustomResource {
  constructor(scope: Construct, name: string, props: SSMParameterReaderProps) {
    const { parameterName, region } = props;

    const ssmAwsSdkCall: AwsSdkCall = {
      service: 'SSM',
      action: 'getParameter',
      parameters: {
        Name: parameterName
      },
      region,
      physicalResourceId: {id:Date.now().toString()}
    };

    super(scope, name, { onUpdate: ssmAwsSdkCall,policy:{
        statements:[new iam.PolicyStatement({
        resources : ['*'],
        actions   : ['ssm:GetParameter'],
        effect:iam.Effect.ALLOW,
      }
      )]
   }});
  }

  public getParameterValue(): string {
    return this.getResponseField('Parameter.Value').toString();
  }
}

现在遇到JSON格式的参数（示例：{ "subnetId": "subnet-xxxxxx" }），尝试修改getParameterValue方法添加路径参数后无法解析：

...

  public getParameterValue(path: string): string {
    return this.getResponseField(`Parameter.Value.${path}`).toString();
  }

请问如何提取其中的subnetId值？

解决方案 #

问题本质 #

AWS SSM返回的Parameter.Value对于JSON格式的参数是字符串类型，而非嵌套的JSON对象，因此getResponseField无法通过点语法直接访问字符串内部的JSON字段。必须先将整个JSON字符串解析为对象，再提取目标字段。

实现方式 #

方式1：提取单层字段

如果只需获取单层结构的字段（如subnetId），可以新增如下方法：

public getJsonParameterValue(fieldName: string): string {
  // 获取SSM返回的JSON字符串
  const jsonString = this.getResponseField('Parameter.Value').toString();
  // 解析为JSON对象
  const jsonObj = JSON.parse(jsonString);
  // 返回目标字段值
  return jsonObj[fieldName].toString();
}

使用示例：

const reader = new SSMParameterReader(scope, 'MyReader', {
  parameterName: '/my/json/parameter',
  region: 'us-east-1'
});
const subnetId = reader.getJsonParameterValue('subnetId');

方式2：支持多层嵌套路径

如果需要提取多层嵌套的字段（如config.network.subnetId），可以添加路径解析逻辑：

public getJsonParameterValue(path: string): string {
  const jsonString = this.getResponseField('Parameter.Value').toString();
  const jsonObj = JSON.parse(jsonString);
  
  // 拆分路径并逐层访问对象属性
  const value = path.split('.').reduce((currentObj, key) => {
    return currentObj[key];
  }, jsonObj);
  
  return value.toString();
}

使用示例：

const nestedValue = reader.getJsonParameterValue('config.network.subnetId');

注意事项 #

• 确保SSM参数是有效的JSON格式，否则JSON.parse会抛出错误，建议添加try-catch错误处理。
• 如果JSON包含非字符串类型的值（如数字、布尔值），可根据需求调整返回类型或转换逻辑。

内容的提问来源于stack exchange，提问作者Renato Gama