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

Class EnvironmentVariable

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

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

Represents an app's environment variable.

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)
int	hashCode()
String	key()	(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Boolean	secure()	(Optional) Whether the variable's value will be returned by the DescribeApps action.
static Class<? extends EnvironmentVariable.Builder>	serializableBuilderClass()
EnvironmentVariable.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	value()	(Optional) The environment variable's value, which can be left empty.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

key

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>

Returns:

a builder for type T

builder

public static EnvironmentVariable.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.