如何在AWS ImageBuilder组件开发中区分Shell变量与CloudFormation模板参数
AWS CloudFormation Fn::Sub 与 Shell 变量冲突问题
实际遇到的场景
编写AWS::ImageBuilder::Component资源时,模板里同时存在两类需要用${}包裹的变量:
- CloudFormation侧参数,比如示例中的
cloudVersion,需要在模板部署渲染阶段替换为实际值 - Linux Shell运行时变量,比如
GroupID、UserID、USER,需要在镜像构建的Shell命令执行阶段才会被解析
两类变量都使用相同的${变量名}写法,配合!Sub(即Fn::Sub内置函数)使用时,CloudFormation的替换逻辑会扫描所有${}结构,导致cfn-lint抛出“Sub替换参数未找到”的报错,和预期的Shell运行时解析逻辑冲突。
问题本质
Fn::Sub的默认工作逻辑是:扫描字符串中所有${标识}结构,匹配到的CFN内置值、参数、资源属性会做模板渲染替换,找不到匹配项时就会触发lint校验报错,不会主动区分哪些是后续要交给Shell解析的运行时变量。
无侵入原生解决方案
不需要把Shell侧变量改成CloudFormation参数,Fn::Sub本身内置了转义规则:要让某段${}结构跳过CloudFormation的渲染、原样保留给Shell解析,只需要把单层${}改成双层${{}}写法即可。
对应转换规则示例:
# 原有写法:会被Fn::Sub识别为需要替换的CFN参数 sudo groupadd --gid ${GroupID} ${USER} # 转义后写法:Fn::Sub会原样输出为${GroupID}、${USER},留给Shell执行时解析 sudo groupadd --gid ${{GroupID}} ${{USER}}
所有需要原样保留的Shell变量,只要把对应的${xxx}替换成${{xxx}}即可。CloudFormation执行Sub替换时,会自动把${{xxx}}转成字面量${xxx},完全不会触发参数未找到的lint报错。
注意:真正需要被CloudFormation替换的CFN参数,比如示例里的cloudVersion,仍然保持原来的单层${cloudVersion}写法即可,不需要改动。
调整完成后的可运行模板片段:
Parameters: cloudVersion: Type: String Default: "1.10.11" Description: Cloud Version to release Resources: CloudInstallComponent: Type: AWS::ImageBuilder::Component Properties: Name: CloudAMI Version: !Ref cloudVersion Description: Install the latest cloud. ChangeDescription: Cloud First version Platform: Linux Data: !Sub | name: DeployCloudComponents description: This is to deploy cloud components. schemaVersion: 1.0 phases: - name: build steps: - name: CreateUser action: ExecuteBash inputs: commands: - "Creating New User cloud" - export GroupID=7560 - export UserID=7560 - export USER=cloud # 所有Shell运行时变量用双花括号转义,跳过CFN Sub替换 - sudo groupadd --gid ${{GroupID}} ${{USER}} - sudo useradd --uid ${{UserID}} --gid ${{GroupID}} --create-home --shell /bin/bash ${{USER}} - sudo usermod -G wheel ${{USER}} - |- echo "${{USER}} ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers # CFN模板参数保持单花括号,正常完成渲染替换 - sudo wget -O a.tgz 'abc.net/mg/api/v1/help/${cloudVersion}/on/download/a.tgz'
方案实际效果
- 无需将Shell变量硬转换为CloudFormation参数,减少不必要的模板参数冗余
- cfn-lint可正常通过校验,不再抛出未找到Sub参数的报错
- 两类变量的解析边界完全清晰:单花括号
${}结构走CFN模板渲染逻辑,双花括号${{}}结构原样保留给Shell做运行时解析
内容的提问来源于stack exchange,提问作者SRJ
相关产品推荐
相关产品推荐

