使用AWS CDK TypeScript的HostedConfiguration构建AppConfig功能标志报错求助

问题描述 #

使用AWS CDK for TypeScript的HostedConfiguration构造创建AppConfig功能标志时，无官方实现指南可参考，执行cdk deploy触发以下错误：

Error invoking extension AppConfig Feature Flags Helper: Invalid 'Content' data

尝试用JSON.stringify处理功能标志JSON内容后，报错仍未解决。

代码示例 #

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as appconfig from 'aws-cdk-lib/aws-appconfig';
import * as fs from 'fs';

interface AppConfigFeatureFlagsProps {
  applicationName: string;
  environmentName: string;
}

export class AppConfigFeatureFlags extends Construct {
  constructor(scope: Construct, id: string, props: AppConfigFeatureFlagsProps) {
  super(scope, id);

  const featureFlagConfigContent = JSON.parse(fs.readFileSync(props.jsonFilePath, 'utf-8'));

  const app = new appconfig.Application(this, 'MyApp');
  const env = new appconfig.Environment(this, 'MyEnv', {
    application: app,
  });

  const deploymentStrategy = new appconfig.DeploymentStrategy(this, 'MyDeploymentStrategy', {
    rolloutStrategy: appconfig.RolloutStrategy.linear({
    growthFactor: 20,
    deploymentDuration: Duration.minutes(30),
    finalBakeTime: Duration.minutes(30),
   }),
  });

  const hostedConfiguration = new appconfig.HostedConfiguration(this, 'HostedConfiguration', {
    application: app,
    deployTo: [env],
    type: appconfig.ConfigurationType.FEATURE_FLAGS,
    deploymentStrategy: deploymentStrategy,
    validators: [{
       content: JSON.stringify(featureFlagConfigContent),
       type: ValidatorType.JSON_SCHEMA,
    }],
    content: {
      content: JSON.stringify({
                  flags: {
                    flagkey: {
                      name: 'sso_enabled',
                    },
                  },
                  values: {
                    flagkey: {
                      enabled: true,
                    },
                  },
                  version: '1',
      }),
      contentType: 'application/json',
    },
  });
 }
}

排查前置说明 #

我的JSON文件严格遵循AWS功能标志JSON Schema，且已通过Schema验证：

解决方法 #

1. 修复代码依赖与参数缺失 #

• 补全AppConfigFeatureFlagsProps接口，添加jsonFilePath字段（代码中已使用但未定义）
• 导入缺失的依赖：Duration来自cdk，ValidatorType来自appconfig
• 显式设置应用、环境、配置的名称，避免CDK自动生成的名称引发潜在问题

2. 调整功能标志内容加载方式 #

AWS AppConfig对Feature Flags的JSON内容有严格格式要求，直接读取已验证的JSON文件字符串即可，无需先JSON.parse再JSON.stringify，避免转义错误：

content: {
  content: fs.readFileSync(props.jsonFilePath, 'utf-8'),
  contentType: 'application/json',
},

3. 修正Validator配置逻辑 #

Validator的content应为JSON Schema的字符串，而非功能标志的配置内容。如果使用官方Schema验证，需将Schema文件内容作为validator参数；若无需验证可暂时移除该配置：

validators: [{
  content: fs.readFileSync('path/to/aws-feature-flag-schema.json', 'utf-8'),
  type: appconfig.ValidatorType.JSON_SCHEMA,
}],

4. 完整修正代码示例 #

import * as cdk from 'aws-cdk-lib';
import { Duration } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as appconfig from 'aws-cdk-lib/aws-appconfig';
import * as fs from 'fs';

interface AppConfigFeatureFlagsProps {
  applicationName: string;
  environmentName: string;
  jsonFilePath: string; // 补全缺失字段
}

export class AppConfigFeatureFlags extends Construct {
  constructor(scope: Construct, id: string, props: AppConfigFeatureFlagsProps) {
    super(scope, id);

    const app = new appconfig.Application(this, 'MyApp', {
      applicationName: props.applicationName,
    });

    const env = new appconfig.Environment(this, 'MyEnv', {
      application: app,
      environmentName: props.environmentName,
    });

    const deploymentStrategy = new appconfig.DeploymentStrategy(this, 'MyDeploymentStrategy', {
      rolloutStrategy: appconfig.RolloutStrategy.linear({
        growthFactor: 20,
        deploymentDuration: Duration.minutes(30),
        finalBakeTime: Duration.minutes(30),
      }),
      deploymentStrategyName: 'LinearRollout',
    });

    const featureFlagContent = fs.readFileSync(props.jsonFilePath, 'utf-8');

    const hostedConfiguration = new appconfig.HostedConfiguration(this, 'HostedConfiguration', {
      application: app,
      deployTo: [env],
      type: appconfig.ConfigurationType.FEATURE_FLAGS,
      deploymentStrategy: deploymentStrategy,
      // 可选：启用官方Schema验证
      // validators: [{
      //   content: fs.readFileSync('aws-feature-flag-schema.json', 'utf-8'),
      //   type: appconfig.ValidatorType.JSON_SCHEMA,
      // }],
      content: {
        content: featureFlagContent,
        contentType: 'application/json',
      },
      configurationName: 'SSOFeatureFlags',
    });
  }
}

5. 额外验证步骤 #

部署前可通过AWS CLI验证配置内容合法性：

aws appconfig validate-configuration --application-id <app-id> --configuration-profile-id <profile-id> --content file://your-config.json --content-type application/json

同时确保使用最新稳定版CDK，避免版本兼容问题。

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