Amazonka.ECS.Types.EnvironmentFile

Documentation

data 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. For more information about the environment variable file syntax, see Declare default environment variables in file.

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 Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

• Linux platform version 1.4.0 or later.
• Windows platform version 1.0.0 or later.

See: newEnvironmentFile smart constructor.

Constructors

EnvironmentFile'

Fields

• value :: Text

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

• type' :: EnvironmentFileType

  The file type to use. The only supported value is s3.

Instances

FromJSON EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

parseJSON :: Value -> Parser EnvironmentFile

parseJSONList :: Value -> Parser [EnvironmentFile]

ToJSON EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

toJSON :: EnvironmentFile -> Value

toEncoding :: EnvironmentFile -> Encoding

toJSONList :: [EnvironmentFile] -> Value

toEncodingList :: [EnvironmentFile] -> Encoding

Generic EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Associated Types

type Rep EnvironmentFile :: Type -> Type

Methods

from :: EnvironmentFile -> Rep EnvironmentFile x

to :: Rep EnvironmentFile x -> EnvironmentFile

Read EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

readsPrec :: Int -> ReadS EnvironmentFile

readList :: ReadS [EnvironmentFile]

readPrec :: ReadPrec EnvironmentFile

readListPrec :: ReadPrec [EnvironmentFile]

Show EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

showsPrec :: Int -> EnvironmentFile -> ShowS

show :: EnvironmentFile -> String

showList :: [EnvironmentFile] -> ShowS

NFData EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

rnf :: EnvironmentFile -> ()

Eq EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

(==) :: EnvironmentFile -> EnvironmentFile -> Bool

(/=) :: EnvironmentFile -> EnvironmentFile -> Bool

Hashable EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

hashWithSalt :: Int -> EnvironmentFile -> Int

hash :: EnvironmentFile -> Int

type Rep EnvironmentFile

Defined in Amazonka.ECS.Types.EnvironmentFile

type Rep EnvironmentFile = D1 ('MetaData "EnvironmentFile" "Amazonka.ECS.Types.EnvironmentFile" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "EnvironmentFile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EnvironmentFileType)))

newEnvironmentFile

Arguments

:: Text

$sel:value:EnvironmentFile'

-> EnvironmentFileType

$sel:type':EnvironmentFile'

-> EnvironmentFile

Create a value of EnvironmentFile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:EnvironmentFile', environmentFile_value - The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

$sel:type':EnvironmentFile', environmentFile_type - The file type to use. The only supported value is s3.

environmentFile_value :: Lens' EnvironmentFile Text

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

environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType

The file type to use. The only supported value is s3.