File Coverage

blib/lib/Paws/KinesisAnalytics/S3ReferenceDataSource.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::KinesisAnalytics::S3ReferenceDataSource;
2 1     1   458 use Moose;
  1         4  
  1         7  
3             has BucketARN => (is => 'ro', isa => 'Str', required => 1);
4             has FileKey => (is => 'ro', isa => 'Str', required => 1);
5             has ReferenceRoleARN => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::KinesisAnalytics::S3ReferenceDataSource
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::KinesisAnalytics::S3ReferenceDataSource object:
24              
25             $service_obj->Method(Att1 => { BucketARN => $value, ..., ReferenceRoleARN => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisAnalytics::S3ReferenceDataSource object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->BucketARN
33              
34             =head1 DESCRIPTION
35              
36             Identifies the S3 bucket and object that contains the reference data.
37             Also identifies the IAM role Amazon Kinesis Analytics can assume to
38             read this object on your behalf.
39              
40             An Amazon Kinesis Analytics application loads reference data only once.
41             If the data changes, you call the UpdateApplication operation to
42             trigger reloading of data into your application.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> BucketARN => Str
48              
49             Amazon Resource Name (ARN) of the S3 bucket.
50              
51              
52             =head2 B<REQUIRED> FileKey => Str
53              
54             Object key name containing reference data.
55              
56              
57             =head2 B<REQUIRED> ReferenceRoleARN => Str
58              
59             ARN of the IAM role that the service can assume to read data on your
60             behalf. This role must have permission for the C<s3:GetObject> action
61             on the object and trust policy that allows Amazon Kinesis Analytics
62             service principal to assume this role.
63              
64              
65              
66             =head1 SEE ALSO
67              
68             This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalytics>
69              
70             =head1 BUGS and CONTRIBUTIONS
71              
72             The source code is located here: https://github.com/pplu/aws-sdk-perl
73              
74             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
75              
76             =cut
77