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

Class: Aws::OpsWorks::Types::EnvironmentVariable

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass EnvironmentVariable data as a hash:

{
  key: "String", # required
  value: "String", # required
  secure: false,
}

Represents an app's environment variable.

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

Returns:

  • (String)


3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3767

class EnvironmentVariable < Struct.new(
  :key,
  :value,
  :secure)
  include Aws::Structure
end

#secureBoolean

(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false.

Returns:

  • (Boolean)


3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3767

class EnvironmentVariable < Struct.new(
  :key,
  :value,
  :secure)
  include Aws::Structure
end

#valueString

(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

Returns:

  • (String)


3767
3768
3769
3770
3771
3772
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3767

class EnvironmentVariable < Struct.new(
  :key,
  :value,
  :secure)
  include Aws::Structure
end