EnvironmentVariable
Information about an environment variable for a build project or a build.
Contents
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 the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs and secret access keys.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.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. To learn how to specify a parameter store environment variable, see parameter store reference-key in the buildspec file. -
PLAINTEXT: An environment variable in plain text format. This is the default value. -
SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see secrets manager reference-key in the buildspec file.
Type: String
Valid Values:
PLAINTEXT | PARAMETER_STORE | SECRETS_MANAGERRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
