Class: AWSCDK::Pipes::CfnPipe::ECSEnvironmentFileProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::ECSEnvironmentFileProperty

Defined in:

pipes/cfn_pipe.rb

Overview

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 Also:

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

Instance Attribute Summary

• #type ⇒ String readonly

  The file type to use.

• #value ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, value:) ⇒ ECSEnvironmentFileProperty constructor

  A new instance of ECSEnvironmentFileProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, value:) ⇒ ECSEnvironmentFileProperty

Returns a new instance of ECSEnvironmentFileProperty.

Parameters:

• type (String) —

  The file type to use.

• value (String) —

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

# File 'pipes/cfn_pipe.rb', line 1412

def initialize(type:, value:)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
end

Instance Attribute Details

#type ⇒ String (readonly)

The file type to use.

The only supported value is s3 .

Returns:

• (String)

See Also:

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

# File 'pipes/cfn_pipe.rb', line 1425

def type
  @type
end

#value ⇒ String (readonly)

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

Returns:

• (String)

See Also:

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

# File 'pipes/cfn_pipe.rb', line 1430

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 1432

def self.jsii_properties
  {
    :type => "type",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 1439

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "value" => @value,
  })
  result.compact
end