| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::FirelensConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Options => (is => 'ro', isa => 'Paws::ECS::FirelensConfigurationOptionsMap', request_name => 'options', traits => ['NameInRequest']); | ||
| 5 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ECS::FirelensConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::ECS::FirelensConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Options => $value, ..., Type => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::FirelensConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Options | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The FireLens configuration for the container. This is used to specify | ||
| 38 | and configure a log router for container logs. For more information, | ||
| 39 | see Custom Log Routing | ||
| 40 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) | ||
| 41 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Options => L<Paws::ECS::FirelensConfigurationOptionsMap> | ||
| 47 | |||
| 48 | The options to use when configuring the log router. This field is | ||
| 49 | optional and can be used to specify a custom configuration file or to | ||
| 50 | add additional metadata, such as the task, task definition, cluster, | ||
| 51 | and container instance details to the log event. If specified, the | ||
| 52 | syntax to use is | ||
| 53 | C<"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}>. | ||
| 54 | For more information, see Creating a Task Definition that Uses a | ||
| 55 | FireLens Configuration | ||
| 56 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef) | ||
| 57 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 58 | |||
| 59 | Tasks hosted on AWS Fargate only support the C<file> configuration file | ||
| 60 | type. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Type => Str | ||
| 64 | |||
| 65 | The log router to use. The valid values are C<fluentd> or C<fluentbit>. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 72 | |||
| 73 | =head1 BUGS and CONTRIBUTIONS | ||
| 74 | |||
| 75 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 76 | |||
| 77 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 78 | |||
| 79 | =cut | ||
| 80 |