com.amazonaws.services.opsworks.model

Class EnvironmentVariable

java.lang.Object

com.amazonaws.services.opsworks.model.EnvironmentVariable

All Implemented Interfaces:

Serializable

public class EnvironmentVariable
extends Object
implements Serializable

Represents an app's environment variable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariable()

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnvironmentVariable

public EnvironmentVariable()

Method Detail

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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 to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.

Returns:

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

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 to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.

Parameters:

secure - (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.

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 to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.

Returns a reference to this object so that method calls can be chained together.

Parameters:

secure - (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:

A reference to this updated object so that method calls can be chained together.

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 to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.

Returns:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object