Interface CfnTaskDefinition.IEnvironmentFileProperty
A list of files containing the environment variables to pass to a container.
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEnvironmentFileProperty
Syntax (vb)
Public Interface IEnvironmentFileProperty
Remarks
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:
Consider the following when using the Fargate launch type:
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var environmentFileProperty = new EnvironmentFileProperty {
Type = "type",
Value = "value"
};
Synopsis
Properties
Type | The file type to use. |
Value | The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. |
Properties
Type
The file type to use.
virtual string Type { get; }
Property Value
System.String
Remarks
Environment files are objects in Amazon S3. The only supported value is s3
.
Value
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
virtual string Value { get; }
Property Value
System.String