« blib/lib/Paws/CloudWatchLogs/MetricFilterMatchRecord.pm
↑ Summary
blib/lib/Paws/CloudWatchLogs/PutDestination.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchLogs::MetricTransformation; | ||
| 3 | use Moose; | ||
| 4 | has DefaultValue => (is => 'ro', isa => 'Num', request_name => 'defaultValue', traits => ['NameInRequest']); | ||
| 5 | has Dimensions => (is => 'ro', isa => 'Paws::CloudWatchLogs::Dimensions', request_name => 'dimensions', traits => ['NameInRequest']); | ||
| 6 | has MetricName => (is => 'ro', isa => 'Str', request_name => 'metricName', traits => ['NameInRequest'], required => 1); | ||
| 7 | has MetricNamespace => (is => 'ro', isa => 'Str', request_name => 'metricNamespace', traits => ['NameInRequest'], required => 1); | ||
| 8 | has MetricValue => (is => 'ro', isa => 'Str', request_name => 'metricValue', traits => ['NameInRequest'], required => 1); | ||
| 9 | has Unit => (is => 'ro', isa => 'Str', request_name => 'unit', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudWatchLogs::MetricTransformation | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CloudWatchLogs::MetricTransformation object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { DefaultValue => $value, ..., Unit => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchLogs::MetricTransformation object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->DefaultValue | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Indicates how to transform ingested log events to metric data in a | ||
| 42 | CloudWatch metric. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DefaultValue => Num | ||
| 48 | |||
| 49 | (Optional) The value to emit when a filter pattern does not match a log | ||
| 50 | event. This value can be null. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Dimensions => L<Paws::CloudWatchLogs::Dimensions> | ||
| 54 | |||
| 55 | The fields to use as dimensions for the metric. One metric filter can | ||
| 56 | include as many as three dimensions. | ||
| 57 | |||
| 58 | Metrics extracted from log events are charged as custom metrics. To | ||
| 59 | prevent unexpected high charges, do not specify high-cardinality fields | ||
| 60 | such as C<IPAddress> or C<requestID> as dimensions. Each different | ||
| 61 | value found for a dimension is treated as a separate metric and accrues | ||
| 62 | charges as a separate custom metric. | ||
| 63 | |||
| 64 | To help prevent accidental high charges, Amazon disables a metric | ||
| 65 | filter if it generates 1000 different name/value pairs for the | ||
| 66 | dimensions that you have specified within a certain amount of time. | ||
| 67 | |||
| 68 | You can also set up a billing alarm to alert you if your charges are | ||
| 69 | higher than expected. For more information, see Creating a Billing | ||
| 70 | Alarm to Monitor Your Estimated AWS Charges | ||
| 71 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> MetricName => Str | ||
| 75 | |||
| 76 | The name of the CloudWatch metric. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> MetricNamespace => Str | ||
| 80 | |||
| 81 | A custom namespace to contain your metric in CloudWatch. Use namespaces | ||
| 82 | to group together metrics that are similar. For more information, see | ||
| 83 | Namespaces | ||
| 84 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> MetricValue => Str | ||
| 88 | |||
| 89 | The value to publish to the CloudWatch metric when a filter pattern | ||
| 90 | matches a log event. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Unit => Str | ||
| 94 | |||
| 95 | The unit to assign to the metric. If you omit this, the unit is set as | ||
| 96 | C<None>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchLogs> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |