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

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::EnvironmentVariable

Includes:

Structure

Defined in:

lib/aws-sdk-opsworks/types.rb

Overview

Represents an app’s environment variable.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key ⇒ String

  (Required) The environment variable’s name, which can consist of up to 64 characters and must be specified.

• #secure ⇒ Boolean

  (Optional) Whether the variable’s value is returned by the DescribeApps action.

• #value ⇒ String

  (Optional) The environment variable’s value, which can be left empty.

Instance Attribute Details

#key ⇒ String

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

# File 'lib/aws-sdk-opsworks/types.rb', line 3258

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

#secure ⇒ Boolean

(Optional) Whether the variable’s value is returned by the DescribeApps action. To hide an environment variable’s value, set ‘Secure` to `true`. `DescribeApps` returns `*****FILTERED*****` instead of the actual value. The default value for `Secure` is `false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 3258

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

#value ⇒ String

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

# File 'lib/aws-sdk-opsworks/types.rb', line 3258

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