File Coverage

blib/lib/Paws/CloudWatchLogs/PutSubscriptionFilter.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudWatchLogs::PutSubscriptionFilter;
3 1     1   393 use Moose;
  1         3  
  1         6  
4             has DestinationArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationArn' , required => 1);
5             has Distribution => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'distribution' );
6             has FilterName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterName' , required => 1);
7             has FilterPattern => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterPattern' , required => 1);
8             has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1);
9             has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn' );
10              
11 1     1   5722 use MooseX::ClassAttribute;
  1         3  
  1         6  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutSubscriptionFilter');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CloudWatchLogs::PutSubscriptionFilter - Arguments for method PutSubscriptionFilter on Paws::CloudWatchLogs
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method PutSubscriptionFilter on the
27             Amazon CloudWatch Logs service. Use the attributes of this class
28             as arguments to method PutSubscriptionFilter.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutSubscriptionFilter.
31              
32             As an example:
33              
34             $service_obj->PutSubscriptionFilter(Att1 => $value1, Att2 => $value2, ...);
35              
36             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> DestinationArn => Str
42              
43             The ARN of the destination to deliver matching log events to.
44             Currently, the supported destinations are:
45              
46             =over
47              
48             =item *
49              
50             An Amazon Kinesis stream belonging to the same account as the
51             subscription filter, for same-account delivery.
52              
53             =item *
54              
55             A logical destination (specified using an ARN) belonging to a different
56             account, for cross-account delivery.
57              
58             =item *
59              
60             An Amazon Kinesis Firehose delivery stream belonging to the same
61             account as the subscription filter, for same-account delivery.
62              
63             =item *
64              
65             An AWS Lambda function belonging to the same account as the
66             subscription filter, for same-account delivery.
67              
68             =back
69              
70              
71              
72              
73             =head2 Distribution => Str
74              
75             The method used to distribute log data to the destination. By default
76             log data is grouped by log stream, but the grouping can be set to
77             random for a more even distribution. This property is only applicable
78             when the destination is an Amazon Kinesis stream.
79              
80             Valid values are: C<"Random">, C<"ByLogStream">
81              
82             =head2 B<REQUIRED> FilterName => Str
83              
84             A name for the subscription filter. If you are updating an existing
85             filter, you must specify the correct name in C<filterName>. Otherwise,
86             the call fails because you cannot associate a second filter with a log
87             group. To find the name of the filter currently associated with a log
88             group, use DescribeSubscriptionFilters.
89              
90              
91              
92             =head2 B<REQUIRED> FilterPattern => Str
93              
94             A filter pattern for subscribing to a filtered stream of log events.
95              
96              
97              
98             =head2 B<REQUIRED> LogGroupName => Str
99              
100             The name of the log group.
101              
102              
103              
104             =head2 RoleArn => Str
105              
106             The ARN of an IAM role that grants CloudWatch Logs permissions to
107             deliver ingested log events to the destination stream. You don't need
108             to provide the ARN when you are working with a logical destination for
109             cross-account delivery.
110              
111              
112              
113              
114             =head1 SEE ALSO
115              
116             This class forms part of L<Paws>, documenting arguments for method PutSubscriptionFilter in L<Paws::CloudWatchLogs>
117              
118             =head1 BUGS and CONTRIBUTIONS
119              
120             The source code is located here: https://github.com/pplu/aws-sdk-perl
121              
122             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
123              
124             =cut
125