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:

  • 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:

    • 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:

    • toBuilder

      public EnvironmentFile.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<EnvironmentFile.Builder,EnvironmentFile>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.