Skip to content
v2.278.0

EcsEnvironmentFileProperty Struct ​

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.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const ecsEnvironmentFileProperty: pipes.CfnPipe.EcsEnvironmentFileProperty = {
  type: 'type',
  value: 'value',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pipes as pipes

ecs_environment_file_property = pipes.CfnPipe.EcsEnvironmentFileProperty(
    type="type",
    value="value"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.pipes.*;

EcsEnvironmentFileProperty ecsEnvironmentFileProperty = EcsEnvironmentFileProperty.builder()
        .type("type")
        .value("value")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pipes;

var ecsEnvironmentFileProperty = new EcsEnvironmentFileProperty {
    Type = "type",
    Value = "value"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

ecsEnvironmentFileProperty := &EcsEnvironmentFileProperty{
	Type: jsii.String("type"),
	Value: jsii.String("value"),
}

Properties ​

typestringtypestrtypeStringTypestringType*string required #
The file type to use.

The only supported value is s3 .

valuestringvaluestrvalueStringValuestringValue*string required #
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.