| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::LogConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has LogDriver => (is => 'ro', isa => 'Str', request_name => 'logDriver', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Options => (is => 'ro', isa => 'Paws::ECS::LogConfigurationOptionsMap', request_name => 'options', traits => ['NameInRequest']); | ||
| 6 | has SecretOptions => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Secret]', request_name => 'secretOptions', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ECS::LogConfiguration | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ECS::LogConfiguration object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { LogDriver => $value, ..., SecretOptions => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::LogConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->LogDriver | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The log configuration for the container. This parameter maps to | ||
| 39 | C<LogConfig> in the Create a container | ||
| 40 | (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) | ||
| 41 | section of the Docker Remote API | ||
| 42 | (https://docs.docker.com/engine/api/v1.35/) and the C<--log-driver> | ||
| 43 | option to C<docker run> | ||
| 44 | (https://docs.docker.com/engine/reference/commandline/run/). | ||
| 45 | |||
| 46 | By default, containers use the same logging driver that the Docker | ||
| 47 | daemon uses; however the container may use a different logging driver | ||
| 48 | than the Docker daemon by specifying a log driver configuration in the | ||
| 49 | container definition. For more information on the options for different | ||
| 50 | supported log drivers, see Configure logging drivers | ||
| 51 | (https://docs.docker.com/engine/admin/logging/overview/) in the Docker | ||
| 52 | documentation. | ||
| 53 | |||
| 54 | The following should be noted when specifying a log configuration for | ||
| 55 | your containers: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | Amazon ECS currently supports a subset of the logging drivers available | ||
| 62 | to the Docker daemon (shown in the valid values below). Additional log | ||
| 63 | drivers may be available in future releases of the Amazon ECS container | ||
| 64 | agent. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | This parameter requires version 1.18 of the Docker Remote API or | ||
| 69 | greater on your container instance. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | For tasks hosted on Amazon EC2 instances, the Amazon ECS container | ||
| 74 | agent must register the available logging drivers with the | ||
| 75 | C<ECS_AVAILABLE_LOGGING_DRIVERS> environment variable before containers | ||
| 76 | placed on that instance can use these log configuration options. For | ||
| 77 | more information, see Amazon ECS container agent configuration | ||
| 78 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) | ||
| 79 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | For tasks on AWS Fargate, because you do not have access to the | ||
| 84 | underlying infrastructure your tasks are hosted on, any additional | ||
| 85 | software needed will have to be installed outside of the task. For | ||
| 86 | example, the Fluentd output aggregators or a remote host running | ||
| 87 | Logstash to send Gelf logs to. | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | |||
| 92 | =head1 ATTRIBUTES | ||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> LogDriver => Str | ||
| 96 | |||
| 97 | The log driver to use for the container. | ||
| 98 | |||
| 99 | For tasks on AWS Fargate, the supported log drivers are C<awslogs>, | ||
| 100 | C<splunk>, and C<awsfirelens>. | ||
| 101 | |||
| 102 | For tasks hosted on Amazon EC2 instances, the supported log drivers are | ||
| 103 | C<awslogs>, C<fluentd>, C<gelf>, C<json-file>, C<journald>, | ||
| 104 | C<logentries>,C<syslog>, C<splunk>, and C<awsfirelens>. | ||
| 105 | |||
| 106 | For more information about using the C<awslogs> log driver, see Using | ||
| 107 | the awslogs log driver | ||
| 108 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) | ||
| 109 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 110 | |||
| 111 | For more information about using the C<awsfirelens> log driver, see | ||
| 112 | Custom log routing | ||
| 113 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) | ||
| 114 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 115 | |||
| 116 | If you have a custom driver that is not listed, you can fork the Amazon | ||
| 117 | ECS container agent project that is available on GitHub | ||
| 118 | (https://github.com/aws/amazon-ecs-agent) and customize it to work with | ||
| 119 | that driver. We encourage you to submit pull requests for changes that | ||
| 120 | you would like to have included. However, we do not currently provide | ||
| 121 | support for running modified copies of this software. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 Options => L<Paws::ECS::LogConfigurationOptionsMap> | ||
| 125 | |||
| 126 | The configuration options to send to the log driver. This parameter | ||
| 127 | requires version 1.19 of the Docker Remote API or greater on your | ||
| 128 | container instance. To check the Docker Remote API version on your | ||
| 129 | container instance, log in to your container instance and run the | ||
| 130 | following command: C<sudo docker version --format | ||
| 131 | '{{.Server.APIVersion}}'> | ||
| 132 | |||
| 133 | |||
| 134 | =head2 SecretOptions => ArrayRef[L<Paws::ECS::Secret>] | ||
| 135 | |||
| 136 | The secrets to pass to the log configuration. For more information, see | ||
| 137 | Specifying Sensitive Data | ||
| 138 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) | ||
| 139 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |