如何根据环境变量选择性应用VPC、告警等配置？

问题描述 #

我想根据环境变量是否设置，选择性应用VPC配置，尝试了如下配置：

custom:
  vpc:
    securityGroupIds:
      - ...
    subnetIds:
      - ...

functions:
  main:
    ...
    vpc: !If
      - ${env:USE_VPC}
      - ${self:custom.vpc}
      - ~

同时还想对告警（选择性添加接收邮箱）等其他字段实现类似逻辑，但配置后出现报错：

Configuration error: 
     at 'functions.main.vpc': must have required property 'securityGroupIds'
     at 'functions.main.vpc': must have required property 'subnetIds'
     at 'functions.main.vpc': unrecognized property 'Fn::If'

解决方案 #

1. VPC配置的正确写法 #

Serverless Framework的!If不能直接用在vpc字段根节点，因为框架会优先校验字段结构导致报错。正确做法是条件性注入整个vpc配置块：

方式一：使用外部配置文件

先定义通用VPC配置：

custom:
  vpc:
    securityGroupIds:
      - sg-xxxxxx
      - sg-yyyyyy
    subnetIds:
      - subnet-xxxxxx
      - subnet-yyyyyy

然后在函数配置中根据环境变量动态引入：

functions:
  main:
    ...
    # 根据USE_VPC的值决定是否加载vpc配置
    ${file(./vpc-toggle.yml):${env:USE_VPC, 'false'}}

新建vpc-toggle.yml文件，内容如下：

true:
  vpc: ${self:custom.vpc}
false:
  # 空配置，不添加vpc字段

方式二：内联写法（无需额外文件）

直接在函数配置中用环境变量控制字段注入：

functions:
  main:
    ...
    ${env:USE_VPC, 'false'}:
      vpc: ${self:custom.vpc}

注意：USE_VPC环境变量需设为true或false，框架会根据值决定是否注入vpc配置。

2. 告警邮箱的选择性配置 #

对于告警接收邮箱这类字段，同样用条件字段注入的方式实现：

custom:
  alertEmail: alert@example.com

functions:
  main:
    ...
    alarms:
      - name: FunctionErrorAlarm
        description: 函数报错时触发告警
        threshold: 1
        statistic: Sum
        period: 60
        evaluationPeriods: 1
        comparisonOperator: GreaterThanThreshold
        metric: Errors
        # 根据ENABLE_ALERT的值决定是否添加邮箱字段
        ${env:ENABLE_ALERT, 'false'}:
          topic:
            - email: ${self:custom.alertEmail}

当ENABLE_ALERT设为true时，自动添加告警邮箱配置；设为false则跳过。

3. 通用规则总结 #

• 不要在字段内部直接使用!If，框架的Schema校验会优先执行，导致结构不合法报错。
• 采用条件性字段注入：利用Serverless的变量替换语法，根据环境变量值动态注入整个配置块或特定字段。
• 环境变量值要明确（如true/false），确保条件判断的准确性。

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