Class EnvironmentVariable
- java.lang.Object
-
- com.amazonaws.services.opsworks.model.EnvironmentVariable
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class EnvironmentVariable extends Object implements Serializable, Cloneable
Represents an app's environment variable.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EnvironmentVariable()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnvironmentVariable
clone()
boolean
equals(Object obj)
String
getKey()
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.Boolean
getSecure()
(Optional) Whether the variable's value will be returned by the DescribeApps action.String
getValue()
(Optional) The environment variable's value, which can be left empty.int
hashCode()
Boolean
isSecure()
(Optional) Whether the variable's value will be returned by the DescribeApps action.void
setKey(String key)
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.void
setSecure(Boolean secure)
(Optional) Whether the variable's value will be returned by the DescribeApps action.void
setValue(String value)
(Optional) The environment variable's value, which can be left empty.String
toString()
Returns a string representation of this object; useful for testing and debugging.EnvironmentVariable
withKey(String key)
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.EnvironmentVariable
withSecure(Boolean secure)
(Optional) Whether the variable's value will be returned by the DescribeApps action.EnvironmentVariable
withValue(String value)
(Optional) The environment variable's value, which can be left empty.
-
-
-
Method Detail
-
setKey
public void setKey(String key)
(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.
- Parameters:
key
- (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.
-
getKey
public String getKey()
(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:
- (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.
-
withKey
public EnvironmentVariable withKey(String key)
(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.
- Parameters:
key
- (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:
- Returns a reference to this object so that method calls can be chained together.
-
setValue
public void setValue(String value)
(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.
- Parameters:
value
- (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.
-
getValue
public String getValue()
(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:
- (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.
-
withValue
public EnvironmentVariable withValue(String value)
(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.
- Parameters:
value
- (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:
- Returns a reference to this object so that method calls can be chained together.
-
setSecure
public void setSecure(Boolean secure)
(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set
Secure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.- Parameters:
secure
- (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, setSecure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.
-
getSecure
public Boolean getSecure()
(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set
Secure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.- Returns:
- (Optional) Whether the variable's value will be returned by the
DescribeApps action. To conceal an environment variable's
value, set
Secure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.
-
withSecure
public EnvironmentVariable withSecure(Boolean secure)
(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set
Secure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.- Parameters:
secure
- (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, setSecure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isSecure
public Boolean isSecure()
(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set
Secure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.- Returns:
- (Optional) Whether the variable's value will be returned by the
DescribeApps action. To conceal an environment variable's
value, set
Secure
totrue
.DescribeApps
then returns*****FILTERED*****
instead of the actual value. The default value forSecure
isfalse
.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public EnvironmentVariable clone()
-
-