AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EnvironmentVariable as input to an Aws::Client method, you can use a vanilla 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)

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

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

    (Optional) Whether the variable\'s value will be returned by the DescribeApps action.

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

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