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

#include <FirelensConfiguration.h>

Public Member Functions

 FirelensConfiguration ()
 
 FirelensConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
FirelensConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const FirelensConfigurationTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const FirelensConfigurationType &value)
 
void SetType (FirelensConfigurationType &&value)
 
FirelensConfigurationWithType (const FirelensConfigurationType &value)
 
FirelensConfigurationWithType (FirelensConfigurationType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetOptions () const
 
bool OptionsHasBeenSet () const
 
void SetOptions (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetOptions (Aws::Map< Aws::String, Aws::String > &&value)
 
FirelensConfigurationWithOptions (const Aws::Map< Aws::String, Aws::String > &value)
 
FirelensConfigurationWithOptions (Aws::Map< Aws::String, Aws::String > &&value)
 
FirelensConfigurationAddOptions (const Aws::String &key, const Aws::String &value)
 
FirelensConfigurationAddOptions (Aws::String &&key, const Aws::String &value)
 
FirelensConfigurationAddOptions (const Aws::String &key, Aws::String &&value)
 
FirelensConfigurationAddOptions (Aws::String &&key, Aws::String &&value)
 
FirelensConfigurationAddOptions (const char *key, Aws::String &&value)
 
FirelensConfigurationAddOptions (Aws::String &&key, const char *value)
 
FirelensConfigurationAddOptions (const char *key, const char *value)
 

Detailed Description

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

See Also:

AWS API Reference

Definition at line 37 of file FirelensConfiguration.h.

Constructor & Destructor Documentation

◆ FirelensConfiguration() [1/2]

Aws::ECS::Model::FirelensConfiguration::FirelensConfiguration ( )

◆ FirelensConfiguration() [2/2]

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

Member Function Documentation

◆ AddOptions() [1/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 221 of file FirelensConfiguration.h.

◆ AddOptions() [2/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( Aws::String &&  key,
const Aws::String value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 193 of file FirelensConfiguration.h.

◆ AddOptions() [3/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( Aws::String &&  key,
const char *  value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 249 of file FirelensConfiguration.h.

◆ AddOptions() [4/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( const Aws::String key,
Aws::String &&  value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 207 of file FirelensConfiguration.h.

◆ AddOptions() [5/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( const Aws::String key,
const Aws::String value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 179 of file FirelensConfiguration.h.

◆ AddOptions() [6/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( const char *  key,
Aws::String &&  value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 235 of file FirelensConfiguration.h.

◆ AddOptions() [7/7]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::AddOptions ( const char *  key,
const char *  value 
)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 263 of file FirelensConfiguration.h.

◆ GetOptions()

const Aws::Map<Aws::String, Aws::String>& Aws::ECS::Model::FirelensConfiguration::GetOptions ( ) const
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 95 of file FirelensConfiguration.h.

◆ GetType()

const FirelensConfigurationType& Aws::ECS::Model::FirelensConfiguration::GetType ( ) const
inline

The log router to use. The valid values are fluentd or fluentbit.

Definition at line 50 of file FirelensConfiguration.h.

◆ Jsonize()

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

◆ operator=()

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

◆ OptionsHasBeenSet()

bool Aws::ECS::Model::FirelensConfiguration::OptionsHasBeenSet ( ) const
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 109 of file FirelensConfiguration.h.

◆ SetOptions() [1/2]

void Aws::ECS::Model::FirelensConfiguration::SetOptions ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 137 of file FirelensConfiguration.h.

◆ SetOptions() [2/2]

void Aws::ECS::Model::FirelensConfiguration::SetOptions ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 123 of file FirelensConfiguration.h.

◆ SetType() [1/2]

void Aws::ECS::Model::FirelensConfiguration::SetType ( const FirelensConfigurationType value)
inline

The log router to use. The valid values are fluentd or fluentbit.

Definition at line 62 of file FirelensConfiguration.h.

◆ SetType() [2/2]

void Aws::ECS::Model::FirelensConfiguration::SetType ( FirelensConfigurationType &&  value)
inline

The log router to use. The valid values are fluentd or fluentbit.

Definition at line 68 of file FirelensConfiguration.h.

◆ TypeHasBeenSet()

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

The log router to use. The valid values are fluentd or fluentbit.

Definition at line 56 of file FirelensConfiguration.h.

◆ WithOptions() [1/2]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::WithOptions ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 165 of file FirelensConfiguration.h.

◆ WithOptions() [2/2]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::WithOptions ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

Definition at line 151 of file FirelensConfiguration.h.

◆ WithType() [1/2]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::WithType ( const FirelensConfigurationType value)
inline

The log router to use. The valid values are fluentd or fluentbit.

Definition at line 74 of file FirelensConfiguration.h.

◆ WithType() [2/2]

FirelensConfiguration& Aws::ECS::Model::FirelensConfiguration::WithType ( FirelensConfigurationType &&  value)
inline

The log router to use. The valid values are fluentd or fluentbit.

Definition at line 80 of file FirelensConfiguration.h.


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