You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeBuild::Types::EnvironmentVariable

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EnvironmentVariable as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "NonEmptyString", # required
  value: "String", # required
  type: "PLAINTEXT", # accepts PLAINTEXT, PARAMETER_STORE, SECRETS_MANAGER
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name or key of the environment variable.

Returns:

  • (String) —

    The name or key of the environment variable.

#type ⇒ String

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 env/parameter-store in the AWS CodeBuild User Guide.

  • 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 env/secrets-manager in the AWS CodeBuild User Guide.

Returns:

  • (String) —

    The type of environment variable.

#value ⇒ String

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment 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 type PARAMETER_STORE or SECRETS_MANAGER.

Returns:

  • (String) —

    The value of the environment variable.