« blib/lib/Paws/Batch/ListTagsForResourceResponse.pm
↑ Summary
blib/lib/Paws/Batch/LogConfigurationOptionsMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::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::Batch::LogConfigurationOptionsMap', request_name => 'options', traits => ['NameInRequest']); | ||
| 6 | has SecretOptions => (is => 'ro', isa => 'ArrayRef[Paws::Batch::Secret]', request_name => 'secretOptions', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Batch::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::Batch::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::Batch::LogConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->LogDriver | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Log configuration options to send to a custom log driver for the | ||
| 39 | container. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> LogDriver => Str | ||
| 45 | |||
| 46 | The log driver to use for the container. The valid values listed for | ||
| 47 | this parameter are log drivers that the Amazon ECS container agent can | ||
| 48 | communicate with by default. | ||
| 49 | |||
| 50 | The supported log drivers are C<awslogs>, C<fluentd>, C<gelf>, | ||
| 51 | C<json-file>, C<journald>, C<logentries>, C<syslog>, and C<splunk>. | ||
| 52 | |||
| 53 | Jobs running on Fargate resources are restricted to the C<awslogs> and | ||
| 54 | C<splunk> log drivers. | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item awslogs | ||
| 59 | |||
| 60 | Specifies the Amazon CloudWatch Logs logging driver. For more | ||
| 61 | information, see Using the awslogs Log Driver | ||
| 62 | (https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html) | ||
| 63 | in the I<AWS Batch User Guide> and Amazon CloudWatch Logs logging | ||
| 64 | driver (https://docs.docker.com/config/containers/logging/awslogs/) in | ||
| 65 | the Docker documentation. | ||
| 66 | |||
| 67 | =item fluentd | ||
| 68 | |||
| 69 | Specifies the Fluentd logging driver. For more information, including | ||
| 70 | usage and options, see Fluentd logging driver | ||
| 71 | (https://docs.docker.com/config/containers/logging/fluentd/) in the | ||
| 72 | Docker documentation. | ||
| 73 | |||
| 74 | =item gelf | ||
| 75 | |||
| 76 | Specifies the Graylog Extended Format (GELF) logging driver. For more | ||
| 77 | information, including usage and options, see Graylog Extended Format | ||
| 78 | logging driver | ||
| 79 | (https://docs.docker.com/config/containers/logging/gelf/) in the Docker | ||
| 80 | documentation. | ||
| 81 | |||
| 82 | =item journald | ||
| 83 | |||
| 84 | Specifies the journald logging driver. For more information, including | ||
| 85 | usage and options, see Journald logging driver | ||
| 86 | (https://docs.docker.com/config/containers/logging/journald/) in the | ||
| 87 | Docker documentation. | ||
| 88 | |||
| 89 | =item json-file | ||
| 90 | |||
| 91 | Specifies the JSON file logging driver. For more information, including | ||
| 92 | usage and options, see JSON File logging driver | ||
| 93 | (https://docs.docker.com/config/containers/logging/json-file/) in the | ||
| 94 | Docker documentation. | ||
| 95 | |||
| 96 | =item splunk | ||
| 97 | |||
| 98 | Specifies the Splunk logging driver. For more information, including | ||
| 99 | usage and options, see Splunk logging driver | ||
| 100 | (https://docs.docker.com/config/containers/logging/splunk/) in the | ||
| 101 | Docker documentation. | ||
| 102 | |||
| 103 | =item syslog | ||
| 104 | |||
| 105 | Specifies the syslog logging driver. For more information, including | ||
| 106 | usage and options, see Syslog logging driver | ||
| 107 | (https://docs.docker.com/config/containers/logging/syslog/) in the | ||
| 108 | Docker documentation. | ||
| 109 | |||
| 110 | =back | ||
| 111 | |||
| 112 | If you have a custom driver that's not listed earlier that you want to | ||
| 113 | work with the Amazon ECS container agent, you can fork the Amazon ECS | ||
| 114 | container agent project that's available on GitHub | ||
| 115 | (https://github.com/aws/amazon-ecs-agent) and customize it to work with | ||
| 116 | that driver. We encourage you to submit pull requests for changes that | ||
| 117 | you want to have included. However, Amazon Web Services doesn't | ||
| 118 | currently support running modified copies of this software. | ||
| 119 | |||
| 120 | This parameter requires version 1.18 of the Docker Remote API or | ||
| 121 | greater on your container instance. To check the Docker Remote API | ||
| 122 | version on your container instance, log into your container instance | ||
| 123 | and run the following command: C<sudo docker version | grep "Server API | ||
| 124 | version"> | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Options => L<Paws::Batch::LogConfigurationOptionsMap> | ||
| 128 | |||
| 129 | The configuration options to send to the log driver. This parameter | ||
| 130 | requires version 1.19 of the Docker Remote API or greater on your | ||
| 131 | container instance. To check the Docker Remote API version on your | ||
| 132 | container instance, log into your container instance and run the | ||
| 133 | following command: C<sudo docker version | grep "Server API version"> | ||
| 134 | |||
| 135 | |||
| 136 | =head2 SecretOptions => ArrayRef[L<Paws::Batch::Secret>] | ||
| 137 | |||
| 138 | The secrets to pass to the log configuration. For more information, see | ||
| 139 | Specifying Sensitive Data | ||
| 140 | (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) | ||
| 141 | in the I<AWS Batch User Guide>. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head1 SEE ALSO | ||
| 146 | |||
| 147 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 148 | |||
| 149 | =head1 BUGS and CONTRIBUTIONS | ||
| 150 | |||
| 151 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 152 | |||
| 153 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 154 | |||
| 155 | =cut | ||
| 156 |