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

Inherits:
Struct
  • Object
show all
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.

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name or key of the environment variable.

Returns:

  • (String)


1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1401

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

#typeString

The type of environment variable. Valid values include:

Returns:

  • (String)


1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1401

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

#valueString

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)


1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1401

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