Class EnvironmentVariable
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EnvironmentVariable.Builder,
EnvironmentVariable>
Represents an app's environment variable.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EnvironmentVariable.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
key()
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.final Boolean
secure()
(Optional) Whether the variable's value will be returned by the DescribeApps action.static Class
<? extends EnvironmentVariable.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
(Optional) The environment variable's value, which can be left empty.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
(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
(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
.
-
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 interfaceToCopyableBuilder<EnvironmentVariable.Builder,
EnvironmentVariable> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-