Class: Aws::ECS::Types::EnvironmentFile

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass EnvironmentFile data as a hash:

{
  value: "String", # required
  type: "s3", # required, accepts s3
}

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 on 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 are processed from the top down. It is recommended to use unique variable names. For more information, see [Specifying environment variables] in the *Amazon Elastic Container Service Developer Guide*.

This field is only valid for containers in Fargate tasks that use platform version `1.4.0` or later.

[1]: docs.docker.com/compose/env-file/ [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#typeString

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

Returns:

  • (String)

4818
4819
4820
4821
4822
4823
# File 'lib/aws-sdk-ecs/types.rb', line 4818

class EnvironmentFile < Struct.new(
  :value,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#valueString

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

Returns:

  • (String)

4818
4819
4820
4821
4822
4823
# File 'lib/aws-sdk-ecs/types.rb', line 4818

class EnvironmentFile < Struct.new(
  :value,
  :type)
  SENSITIVE = []
  include Aws::Structure
end