Show / Hide Table of Contents

Class CfnPipe.EcsEnvironmentFileProperty

A list of files containing the environment variables to pass to a container.

Inheritance
object
CfnPipe.EcsEnvironmentFileProperty
Implements
CfnPipe.IEcsEnvironmentFileProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPipe.EcsEnvironmentFileProperty : CfnPipe.IEcsEnvironmentFileProperty
Syntax (vb)
Public Class CfnPipe.EcsEnvironmentFileProperty Implements CfnPipe.IEcsEnvironmentFileProperty
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. 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:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html

    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.Pipes;
    
                 var ecsEnvironmentFileProperty = new EcsEnvironmentFileProperty {
                     Type = "type",
                     Value = "value"
                 };

    Synopsis

    Constructors

    EcsEnvironmentFileProperty()

    A list of files containing the environment variables to pass to a container.

    Properties

    Type

    The file type to use.

    Value

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

    Constructors

    EcsEnvironmentFileProperty()

    A list of files containing the environment variables to pass to a container.

    public EcsEnvironmentFileProperty()
    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. 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:

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html

      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.Pipes;
      
                   var ecsEnvironmentFileProperty = new EcsEnvironmentFileProperty {
                       Type = "type",
                       Value = "value"
                   };

      Properties

      Type

      The file type to use.

      public string Type { get; set; }
      Property Value

      string

      Remarks

      The only supported value is s3 .

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html#cfn-pipes-pipe-ecsenvironmentfile-type

      Value

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

      public string Value { get; set; }
      Property Value

      string

      Remarks

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html#cfn-pipes-pipe-ecsenvironmentfile-value

      Implements

      CfnPipe.IEcsEnvironmentFileProperty
      Back to top Generated by DocFX