Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

EnvironmentVariable

Information about an environment variable for a build project or a build.

Contents

Note

In the following list, the required parameters are described first.

name

The name or key of the environment variable.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

value

The value of the environment variable.

Important

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

Type: String

Required: Yes

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.

Type: String

Valid Values: PLAINTEXT | PARAMETER_STORE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: