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

#include <LogConfiguration.h>

Public Member Functions

 LogConfiguration ()
 
 LogConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
LogConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const LogDriverGetLogDriver () const
 
bool LogDriverHasBeenSet () const
 
void SetLogDriver (const LogDriver &value)
 
void SetLogDriver (LogDriver &&value)
 
LogConfigurationWithLogDriver (const LogDriver &value)
 
LogConfigurationWithLogDriver (LogDriver &&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)
 
LogConfigurationWithOptions (const Aws::Map< Aws::String, Aws::String > &value)
 
LogConfigurationWithOptions (Aws::Map< Aws::String, Aws::String > &&value)
 
LogConfigurationAddOptions (const Aws::String &key, const Aws::String &value)
 
LogConfigurationAddOptions (Aws::String &&key, const Aws::String &value)
 
LogConfigurationAddOptions (const Aws::String &key, Aws::String &&value)
 
LogConfigurationAddOptions (Aws::String &&key, Aws::String &&value)
 
LogConfigurationAddOptions (const char *key, Aws::String &&value)
 
LogConfigurationAddOptions (Aws::String &&key, const char *value)
 
LogConfigurationAddOptions (const char *key, const char *value)
 
const Aws::Vector< Secret > & GetSecretOptions () const
 
bool SecretOptionsHasBeenSet () const
 
void SetSecretOptions (const Aws::Vector< Secret > &value)
 
void SetSecretOptions (Aws::Vector< Secret > &&value)
 
LogConfigurationWithSecretOptions (const Aws::Vector< Secret > &value)
 
LogConfigurationWithSecretOptions (Aws::Vector< Secret > &&value)
 
LogConfigurationAddSecretOptions (const Secret &value)
 
LogConfigurationAddSecretOptions (Secret &&value)
 

Detailed Description

The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

The following should be noted when specifying a log configuration for your containers:

See Also:

AWS API Reference

Definition at line 65 of file LogConfiguration.h.

Constructor & Destructor Documentation

◆ LogConfiguration() [1/2]

Aws::ECS::Model::LogConfiguration::LogConfiguration ( )

◆ LogConfiguration() [2/2]

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

Member Function Documentation

◆ AddOptions() [1/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 280 of file LogConfiguration.h.

◆ AddOptions() [2/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 289 of file LogConfiguration.h.

◆ AddOptions() [3/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 298 of file LogConfiguration.h.

◆ AddOptions() [4/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 307 of file LogConfiguration.h.

◆ AddOptions() [5/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 316 of file LogConfiguration.h.

◆ AddOptions() [6/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 325 of file LogConfiguration.h.

◆ AddOptions() [7/7]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 334 of file LogConfiguration.h.

◆ AddSecretOptions() [1/2]

LogConfiguration& Aws::ECS::Model::LogConfiguration::AddSecretOptions ( const Secret value)
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 391 of file LogConfiguration.h.

◆ AddSecretOptions() [2/2]

LogConfiguration& Aws::ECS::Model::LogConfiguration::AddSecretOptions ( Secret &&  value)
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 399 of file LogConfiguration.h.

◆ GetLogDriver()

const LogDriver& Aws::ECS::Model::LogConfiguration::GetLogDriver ( ) const
inline

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.

Definition at line 96 of file LogConfiguration.h.

◆ GetOptions()

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 226 of file LogConfiguration.h.

◆ GetSecretOptions()

const Aws::Vector<Secret>& Aws::ECS::Model::LogConfiguration::GetSecretOptions ( ) const
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 343 of file LogConfiguration.h.

◆ Jsonize()

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

◆ LogDriverHasBeenSet()

bool Aws::ECS::Model::LogConfiguration::LogDriverHasBeenSet ( ) const
inline

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.

Definition at line 120 of file LogConfiguration.h.

◆ operator=()

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

◆ OptionsHasBeenSet()

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 235 of file LogConfiguration.h.

◆ SecretOptionsHasBeenSet()

bool Aws::ECS::Model::LogConfiguration::SecretOptionsHasBeenSet ( ) const
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 351 of file LogConfiguration.h.

◆ SetLogDriver() [1/2]

void Aws::ECS::Model::LogConfiguration::SetLogDriver ( const LogDriver value)
inline

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.

Definition at line 144 of file LogConfiguration.h.

◆ SetLogDriver() [2/2]

void Aws::ECS::Model::LogConfiguration::SetLogDriver ( LogDriver &&  value)
inline

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.

Definition at line 168 of file LogConfiguration.h.

◆ SetOptions() [1/2]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 244 of file LogConfiguration.h.

◆ SetOptions() [2/2]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 253 of file LogConfiguration.h.

◆ SetSecretOptions() [1/2]

void Aws::ECS::Model::LogConfiguration::SetSecretOptions ( const Aws::Vector< Secret > &  value)
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 359 of file LogConfiguration.h.

◆ SetSecretOptions() [2/2]

void Aws::ECS::Model::LogConfiguration::SetSecretOptions ( Aws::Vector< Secret > &&  value)
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 367 of file LogConfiguration.h.

◆ WithLogDriver() [1/2]

LogConfiguration& Aws::ECS::Model::LogConfiguration::WithLogDriver ( const LogDriver value)
inline

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.

Definition at line 192 of file LogConfiguration.h.

◆ WithLogDriver() [2/2]

LogConfiguration& Aws::ECS::Model::LogConfiguration::WithLogDriver ( LogDriver &&  value)
inline

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.

Definition at line 216 of file LogConfiguration.h.

◆ WithOptions() [1/2]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 262 of file LogConfiguration.h.

◆ WithOptions() [2/2]

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

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 271 of file LogConfiguration.h.

◆ WithSecretOptions() [1/2]

LogConfiguration& Aws::ECS::Model::LogConfiguration::WithSecretOptions ( const Aws::Vector< Secret > &  value)
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 375 of file LogConfiguration.h.

◆ WithSecretOptions() [2/2]

LogConfiguration& Aws::ECS::Model::LogConfiguration::WithSecretOptions ( Aws::Vector< Secret > &&  value)
inline

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 383 of file LogConfiguration.h.


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