File Coverage

blib/lib/Paws/CloudWatchEvents/KinesisParameters.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudWatchEvents::KinesisParameters;
2 1     1   426 use Moose;
  1         2  
  1         7  
3             has PartitionKeyPath => (is => 'ro', isa => 'Str', required => 1);
4             1;
5              
6             ### main pod documentation begin ###
7              
8             =head1 NAME
9              
10             Paws::CloudWatchEvents::KinesisParameters
11              
12             =head1 USAGE
13              
14             This class represents one of two things:
15              
16             =head3 Arguments in a call to a service
17              
18             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
19             Each attribute should be used as a named argument in the calls that expect this type of object.
20              
21             As an example, if Att1 is expected to be a Paws::CloudWatchEvents::KinesisParameters object:
22              
23             $service_obj->Method(Att1 => { PartitionKeyPath => $value, ..., PartitionKeyPath => $value });
24              
25             =head3 Results returned from an API call
26              
27             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::KinesisParameters object:
28              
29             $result = $service_obj->Method(...);
30             $result->Att1->PartitionKeyPath
31              
32             =head1 DESCRIPTION
33              
34             This object enables you to specify a JSON path to extract from the
35             event and use as the partition key for the Amazon Kinesis stream, so
36             that you can control the shard to which the event goes. If you do not
37             include this parameter, the default is to use the C<eventId> as the
38             partition key.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> PartitionKeyPath => Str
44              
45             The JSON path to be extracted from the event and used as the partition
46             key. For more information, see Amazon Kinesis Streams Key Concepts in
47             the I<Amazon Kinesis Streams Developer Guide>.
48              
49              
50              
51             =head1 SEE ALSO
52              
53             This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents>
54              
55             =head1 BUGS and CONTRIBUTIONS
56              
57             The source code is located here: https://github.com/pplu/aws-sdk-perl
58              
59             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
60              
61             =cut
62