Package org.cdk8s.plus24.k8s

Interface EnvVar

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EnvVar.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-28T00:25:43.940Z")
@Stability(Stable)
public interface EnvVar
extends software.amazon.jsii.JsiiSerializable

EnvVar represents an environment variable present in a Container.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EnvVar.Builder	A builder for EnvVar
static class	EnvVar.Jsii$Proxy	An implementation for EnvVar

Method Summary

Modifier and Type	Method	Description
static EnvVar.Builder	builder()
String	getName()	Name of the environment variable.
default String	getValue()	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables.
default EnvVarSource	getValueFrom()	Source for the environment variable's value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(Stable)
@NotNull
String getName()

Name of the environment variable.

Must be a C_IDENTIFIER.

getValue

@Stability(Stable)
@Nullable
default String getValue()

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables.

If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

Default: .

getValueFrom

@Stability(Stable)
@Nullable
default EnvVarSource getValueFrom()

Source for the environment variable's value.

Cannot be used if value is not empty.

builder

@Stability(Stable)
static EnvVar.Builder builder()

Returns:

a EnvVar.Builder of EnvVar