EnvironmentVariableArgs

data class EnvironmentVariableArgs(val name: Output<String>? = null, val type: Output<EnvironmentVariableTypeEnumValueArgs>? = null, val value: Output<String>? = null) : ConvertibleToJava<EnvironmentVariableArgs>

Definition of EnvironmentVariable

Constructors

Link copied to clipboard
constructor(name: Output<String>? = null, type: Output<EnvironmentVariableTypeEnumValueArgs>? = null, value: Output<String>? = null)

Properties

Link copied to clipboard
val name: Output<String>? = null

The name or key of the environment variable.

Link copied to clipboard

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

Link copied to clipboard
val value: Output<String>? = null

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Functions

Link copied to clipboard
open override fun toJava(): EnvironmentVariableArgs