Class: AWSCDK::ECS::CfnTaskDefinition::EnvironmentFileProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnTaskDefinition::EnvironmentFileProperty

Defined in:

ecs/cfn_task_definition.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.

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:

• Linux platform version 1.4.0 or later.
• Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

• The file is handled like a native Docker env-file.
• There is no support for shell escape handling.
• The container entry point interperts the VARIABLE values.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.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: nil, value: nil) ⇒ EnvironmentFileProperty constructor

  A new instance of EnvironmentFileProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type: nil, value: nil) ⇒ EnvironmentFileProperty

Returns a new instance of EnvironmentFileProperty.

Parameters:

• type (String, nil) (defaults to: nil) —

  The file type to use.

• value (String, nil) (defaults to: nil) —

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

# File 'ecs/cfn_task_definition.rb', line 1764

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

Instance Attribute Details

#type ⇒ String^? (readonly)

The file type to use.

Environment files are objects in Amazon S3. The only supported value is s3 .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-type

# File 'ecs/cfn_task_definition.rb', line 1777

def type
  @type
end

#value ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html#cfn-ecs-taskdefinition-environmentfile-value

# File 'ecs/cfn_task_definition.rb', line 1782

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 1784

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

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 1791

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