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
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name or key of the environment variable.

Returns:

  • (String)

    The name or key of the environment variable.

#typeString

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.

    Possible values:

    • PLAINTEXT
    • PARAMETER_STORE

Returns:

  • (String)

    The type of environment variable.

#valueString

The value of the environment variable.

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).

Returns:

  • (String)

    The value of the environment variable.