Package software.amazon.awssdk.services.ecs.model

Class EnvironmentFile

java.lang.Object

software.amazon.awssdk.services.ecs.model.EnvironmentFile

All Implemented Interfaces:

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

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

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Use a file to pass environment variables to a container in the Amazon Elastic Container Service Developer Guide.

Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.

You must use the following platforms for the Fargate launch type:

• Linux platform version 1.4.0 or later.

• Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

• The file is handled like a native Docker env-file.

• There is no support for shell escape handling.

• The container entry point interperts the VARIABLE values.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnvironmentFile.Builder

Method Summary

Modifier and Type	Method	Description
static EnvironmentFile.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends EnvironmentFile.Builder>	serializableBuilderClass()
EnvironmentFile.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final EnvironmentFileType	type()	The file type to use.
final String	typeAsString()	The file type to use.
final String	value()	The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

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 Details

value

public final String value()

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

Returns:

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

type

public final EnvironmentFileType type()

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

If the service returns an enum value that is not available in the current SDK version, type will return EnvironmentFileType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

See Also:

• EnvironmentFileType

typeAsString

public final String typeAsString()

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

If the service returns an enum value that is not available in the current SDK version, type will return EnvironmentFileType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

See Also:

• EnvironmentFileType

toBuilder

public EnvironmentFile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnvironmentFile.Builder,EnvironmentFile>

builder

public static EnvironmentFile.Builder builder()

serializableBuilderClass

public static Class<? extends EnvironmentFile.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo