AWS CloudFormation
User Guide (Version )

AWS::CodeBuild::Project EnvironmentVariable

EnvironmentVariable is a property of the AWS CodeBuild Project Environment property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. EnvironmentVariable contains a list of EnvironmentVariable property types.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

YAML

Name: String Type: String Value: String

Properties

Name

The name or key of the environment variable.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

Type

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.

  • PLAINTEXT: An environment variable in plaintext format.

Required: No

Type: String

Allowed Values: PARAMETER_STORE | PLAINTEXT

Update requires: No interruption

Value

The value of the environment variable.

Important

We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).

Required: Yes

Type: String

Update requires: No interruption

On this page: