AWS SDK for C++  1.9.175
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::EnvironmentFile Class Reference

#include <EnvironmentFile.h>

Public Member Functions

 EnvironmentFile ()
 
 EnvironmentFile (Aws::Utils::Json::JsonView jsonValue)
 
EnvironmentFileoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
EnvironmentFileWithValue (const Aws::String &value)
 
EnvironmentFileWithValue (Aws::String &&value)
 
EnvironmentFileWithValue (const char *value)
 
const EnvironmentFileTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const EnvironmentFileType &value)
 
void SetType (EnvironmentFileType &&value)
 
EnvironmentFileWithType (const EnvironmentFileType &value)
 
EnvironmentFileWithType (EnvironmentFileType &&value)
 

Detailed Description

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:

See Also:

AWS API Reference

Definition at line 50 of file EnvironmentFile.h.

Constructor & Destructor Documentation

◆ EnvironmentFile() [1/2]

Aws::ECS::Model::EnvironmentFile::EnvironmentFile ( )

◆ EnvironmentFile() [2/2]

Aws::ECS::Model::EnvironmentFile::EnvironmentFile ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetType()

const EnvironmentFileType& Aws::ECS::Model::EnvironmentFile::GetType ( ) const
inline

The file type to use. The only supported value is s3.

Definition at line 111 of file EnvironmentFile.h.

◆ GetValue()

const Aws::String& Aws::ECS::Model::EnvironmentFile::GetValue ( ) const
inline

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

Definition at line 63 of file EnvironmentFile.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::EnvironmentFile::Jsonize ( ) const

◆ operator=()

EnvironmentFile& Aws::ECS::Model::EnvironmentFile::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetType() [1/2]

void Aws::ECS::Model::EnvironmentFile::SetType ( const EnvironmentFileType value)
inline

The file type to use. The only supported value is s3.

Definition at line 121 of file EnvironmentFile.h.

◆ SetType() [2/2]

void Aws::ECS::Model::EnvironmentFile::SetType ( EnvironmentFileType &&  value)
inline

The file type to use. The only supported value is s3.

Definition at line 126 of file EnvironmentFile.h.

◆ SetValue() [1/3]

void Aws::ECS::Model::EnvironmentFile::SetValue ( Aws::String &&  value)
inline

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

Definition at line 81 of file EnvironmentFile.h.

◆ SetValue() [2/3]

void Aws::ECS::Model::EnvironmentFile::SetValue ( const Aws::String value)
inline

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

Definition at line 75 of file EnvironmentFile.h.

◆ SetValue() [3/3]

void Aws::ECS::Model::EnvironmentFile::SetValue ( const char *  value)
inline

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

Definition at line 87 of file EnvironmentFile.h.

◆ TypeHasBeenSet()

bool Aws::ECS::Model::EnvironmentFile::TypeHasBeenSet ( ) const
inline

The file type to use. The only supported value is s3.

Definition at line 116 of file EnvironmentFile.h.

◆ ValueHasBeenSet()

bool Aws::ECS::Model::EnvironmentFile::ValueHasBeenSet ( ) const
inline

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

Definition at line 69 of file EnvironmentFile.h.

◆ WithType() [1/2]

EnvironmentFile& Aws::ECS::Model::EnvironmentFile::WithType ( const EnvironmentFileType value)
inline

The file type to use. The only supported value is s3.

Definition at line 131 of file EnvironmentFile.h.

◆ WithType() [2/2]

EnvironmentFile& Aws::ECS::Model::EnvironmentFile::WithType ( EnvironmentFileType &&  value)
inline

The file type to use. The only supported value is s3.

Definition at line 136 of file EnvironmentFile.h.

◆ WithValue() [1/3]

EnvironmentFile& Aws::ECS::Model::EnvironmentFile::WithValue ( Aws::String &&  value)
inline

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

Definition at line 99 of file EnvironmentFile.h.

◆ WithValue() [2/3]

EnvironmentFile& Aws::ECS::Model::EnvironmentFile::WithValue ( const Aws::String value)
inline

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

Definition at line 93 of file EnvironmentFile.h.

◆ WithValue() [3/3]

EnvironmentFile& Aws::ECS::Model::EnvironmentFile::WithValue ( const char *  value)
inline

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

Definition at line 105 of file EnvironmentFile.h.


The documentation for this class was generated from the following file: