Package software.amazon.awssdk.services.opsworks.model

Class EnvironmentVariable

java.lang.Object

software.amazon.awssdk.services.opsworks.model.EnvironmentVariable

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

@Generated("software.amazon.awssdk:codegen")
public final class EnvironmentVariable
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

Represents an app's environment variable.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnvironmentVariable.Builder

Method Summary

Modifier and Type	Method	Description
static EnvironmentVariable.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.
List<SdkField<?>>	sdkFields()
Boolean	secure()	(Optional) Whether the variable's value will be returned by the DescribeApps action.
static Class<? extends EnvironmentVariable.Builder>	serializableBuilderClass()
EnvironmentVariable.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final 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:

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

value

public final 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:

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

secure

public final 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:

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

toBuilder

public EnvironmentVariable.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

builder

public static EnvironmentVariable.Builder builder()

serializableBuilderClass

public static Class<? extends EnvironmentVariable.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo