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

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
}

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) 


723
724
725
726
727
728
 
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 723

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.

  • PLAINTEXT: An environment variable in plaintext format.

Returns:

  • (String) 


723
724
725
726
727
728
 
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 723

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

#value ⇒ String

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) 


723
724
725
726
727
728
 
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 723

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