com.amazonaws.services.ecs.model

Class EnvironmentFile

java.lang.Object

com.amazonaws.services.ecs.model.EnvironmentFile

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EnvironmentFile
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnvironmentFile()

Method Summary

Modifier and Type	Method and Description
EnvironmentFile	clone()
boolean	equals(Object obj)
String	getType() The file type to use.
String	getValue() The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setType(String type) The file type to use.
void	setValue(String value) The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
String	toString() Returns a string representation of this object.
EnvironmentFile	withType(EnvironmentFileType type) The file type to use.
EnvironmentFile	withType(String type) The file type to use.
EnvironmentFile	withValue(String value) The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnvironmentFile

public EnvironmentFile()

Method Detail

setValue

public void setValue(String value)

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

Parameters:

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

getValue

public String getValue()

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

Returns:

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

withValue

public EnvironmentFile withValue(String value)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

Parameters:

type - The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

See Also:

EnvironmentFileType

getType

public String getType()

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

Returns:

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

See Also:

EnvironmentFileType

withType

public EnvironmentFile withType(String type)

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

Parameters:

type - The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentFileType

withType

public EnvironmentFile withType(EnvironmentFileType type)

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

Parameters:

type - The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentFileType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EnvironmentFile clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.