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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name or key of the environment variable.

Returns:

  • (String)


2435
2436
2437
2438
2439
2440
2441
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2435

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

#typeString

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.

Returns:

  • (String)


2435
2436
2437
2438
2439
2440
2441
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2435

class EnvironmentVariable < Struct.new(
  :name,
  :value,
  :type)
  SENSITIVE = []
  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 Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Returns:

  • (String)


2435
2436
2437
2438
2439
2440
2441
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2435

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