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

Inherits:

Struct

• Object
• Struct
• Aws::CodeBuild::Types::EnvironmentVariable

Defined in:

gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass EnvironmentVariable data as a 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:

• AWS API Documentation

Instance Attribute Summary

• #name ⇒ String

  The name or key of the environment variable.

• #type ⇒ String

  The type of environment variable.

• #value ⇒ String

  The value of the environment variable.

Instance Attribute Details

#name ⇒ String

The name or key of the environment variable.

Returns:

• (String)

# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1401

class EnvironmentVariable < Struct.new(
  :name,
  :value,
  :type)
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1401

class EnvironmentVariable < Struct.new(
  :name,
  :value,
  :type)
  include Aws::Structure
end

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

# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1401

class EnvironmentVariable < Struct.new(
  :name,
  :value,
  :type)
  include Aws::Structure
end