AWS::CodeBuild::Project EnvironmentVariable - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::CodeBuild::Project EnvironmentVariable

EnvironmentVariableAWS CodeBuild Project Environment 属性类型的属性,用于指定 AWS CodeBuild 项目环境的环境变量的名称和值。当您使用此环境运行某个构建时,这些变量将对要使用的构建可用。EnvironmentVariable 包含 EnvironmentVariable 属性类型的列表。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Name" : String, "Type" : String, "Value" : String }

YAML

Name: String Type: String Value: String

属性

Name

环境变量的名称或键。

必需:是

类型:字符串

最低1

Update requires: No interruption

Type

环境变量的类型。有效值包括:

  • PARAMETER_STORE:存储在 Amazon EC2 Systems Manager Parameter Store 中的环境变量。要了解如何指定参数存储环境变量,请参阅 AWS CodeBuild 用户指南 中的 env/parameter-store

  • PLAINTEXT:采用纯文本格式的环境变量。这是默认值。

  • SECRETS_MANAGER:存储在 AWS Secrets Manager 中的环境变量。要了解如何指定 Secrets Manager 环境变量,请参阅 AWS CodeBuild 用户指南 中的 env/secrets-manager

必需:否

类型:字符串

允许的值PARAMETER_STORE | PLAINTEXT | SECRETS_MANAGER

Update requires: No interruption

Value

环境变量的值。

重要

我们强烈建议您不要使用 PLAINTEXT 环境变量存储敏感值,尤其是 AWS 私有密钥 ID 和秘密访问密钥。可以使用 AWS CodeBuild 控制台和 AWS 命令行界面 (AWS CLI) 以纯文本形式显示 PLAINTEXT 环境变量。对于敏感值,我们建议您使用 PARAMETER_STORESECRETS_MANAGER 类型的环境变量。

必需:是

类型:字符串

Update requires: No interruption

示例

JSON

{ "Project": { "Environment": { "EnvironmentVariables": [ { "Name": "MY_VAR_1", "Type": "PLAINTEXT", "Value": "VAR_1_VALUE" }, { "Name": "MY_VAR_2", "Type": "PLAINTEXT", "Value": "VAR_2_VALUE" } ] } } }

YAML

Project: Type: AWS::CodeBuild::Project Properties: Environment: EnvironmentVariables: - Name: MY_VAR_1 Type: PLAINTEXT Value: VAR_1_VALUE - Name: MY_VAR_2 Type: PLAINTEXT Value: VAR_2_VALUE