Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

在自定义组件文档中使用变量

变量提供了一种以在整个应用程序中可使用的有意义的名称来标记数据的方法。您可以为复杂的工作流程定义格式简单易读的自定义变量，并在组件的 YAML 应用程序组件文档中引用它们。 EC2 TOE

本节提供的信息可帮助您在 YAML 应用程序 EC2 TOE 组件文档中为组件定义变量，包括语法、名称约束和示例。

常量

常量是不可变的变量，一旦定义就无法修改或覆盖。常量可以使用 EC2 TOE 文档constants部分中的值来定义。

语法

constants:
  - <name>:
      type: <constant type>
      value: <constant value>

在文档中引用常量值

您可以在 YAML 文档内的步骤或循环输入中引用常量，如下所示：

示例

步骤输入中引用的常量

name: Download Amazon CLI version 2
schemaVersion: 1.0
constants:
  - Source:
      type: string
      value: https://awscli.amazonaws.com/AWSCLIV2.msi
phases:
  - name: build
    steps:
      - name: Download
        action: WebDownload
        inputs:
          - source: '{{ Source }}'
            destination: 'C:\Windows\Temp\AWSCLIV2.msi'

循环输入中引用的常量

name: PingHosts
schemaVersion: 1.0
constants:
  - Hosts:
      type: string
      value: 127.0.0.1,amazon.com
phases:
  - name: build
    steps:
      - name: Ping
        action: ExecuteBash
        loop:
          forEach:
            list: '{{ Hosts }}'
            delimiter: ','
        inputs:
          commands:
            - ping -c 4 {{ loop.value }}

参数

参数是可变变量，其设置由调用应用程序在运行时提供。您可以在 YAML 文档的 Parameters 部分中定义参数。

语法

parameters:
  - <name>:
      type: <parameter type>
      default: <parameter value>
      description: <parameter description>

在文档中引用参数值

您可以在 YAML 文档里的步骤或循环输入中引用参数，如下所示：

示例

以下示例显示如何在 YAML 文档中使用参数：

在运行时覆盖参数

您可以将中的--parameters选项与键值对 Amazon CLI 一起使用，在运行时设置参数值。

语法

--parameters name1=value1,name2=value2...

示例

以下示例显示如何在 YAML 文档中使用参数：

使用 Systems Manager 参数存储参数

您可以通过在变量前面加上前缀来引用组件文档中的 Amazon Systems Manager 参数存储参数（SSM 参数）。aws:ssm例如，

{{ aws:ssm:/my/param }}解析为 SSM 参数的值。/my/param

此功能支持以下 SSM 参数类型：

有关参数存储的更多信息，请参阅Amazon Systems Manager 用户指南中的Amazon Systems Manager 参数存储。

您也可以使用 SSM 参数SecureString引用 Amazon Secrets Manager 密钥。例如：{{ aws:ssm:/aws/reference/secretsmanager/test/test-secret }}。有关更多信息，请参阅从参数存储参数中引用 Amazon Secrets Manager 密钥。

所需的 IAM 权限

要在组件中使用 Systems Manager 参数，您的实例角色必须拥有参数资源 ARN 的ssm:GetParameter权限。例如：

{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Effect": "Allow",
			"Action": "ssm:GetParameter",
			"Resource": "arn:aws:ssm:*:111122223333:parameter/ImageBuilder-*"
		}
	]
}

要访问加密值，您还需要以下权限：

在组件文档中引用 SSM 参数

以下示例说明如何引用组件中 Systems Manager 参数的 Systems Manager 参数存储参数：

name: UseSSMParameterVariable
description: This is a sample component document that prints out the value of an SSM Parameter. Never do this for a SecureString parameter.
schemaVersion: 1.0

phases:
  - name: verify
    steps:
      - name: EchoParameterValue
        action: ExecuteBash
        inputs:
          commands:
            - echo "Log SSM parameter name: /my/test/param, value {{ aws:ssm:/my/test/param }}."

SSM 参数的动态运行时变量分辨率

AWSTOE 提供了以下内置函数，您可以在变量引用中使用该函数在运行时操作或转换值。

解析函数

该resolve函数解析另一个变量引用内部的变量引用，从而允许动态变量名引用。这在使用 SSM 参数时很有用，因为其中部分参数路径可能是可变的，并作为文档参数传入。

该resolve函数仅支持 SSM 参数名称部分的动态解析。

语法

以下示例dynamic_variable中的表示 SSM 参数的名称，并且必须是以下参数之一：

{{ aws:ssm:resolve(dynamic_variable) }}

示例：在运行时解析 SSM 参数

以下示例说明如何在 YAML 组件文档中使用该resolve函数：

name: SsmParameterTest
description: This component verifies an SSM parameter variable reference with the echo command.
schemaVersion: 1.0

parameters:
  - parameter-name:
      type: string
      description: "test"

phases:
  - name: validate
    steps:
      - name: PrintDynamicVariable
        action: ExecuteBash
        inputs:
          commands:
            - echo "{{ aws:ssm:resolve(parameter-name) }}"