File Coverage

blib/lib/Paws/Firehose/S3DestinationConfiguration.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::Firehose::S3DestinationConfiguration;
2 1     1   437 use Moose;
  1         2  
  1         6  
3             has BucketARN => (is => 'ro', isa => 'Str', required => 1);
4             has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::BufferingHints');
5             has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions');
6             has CompressionFormat => (is => 'ro', isa => 'Str');
7             has EncryptionConfiguration => (is => 'ro', isa => 'Paws::Firehose::EncryptionConfiguration');
8             has Prefix => (is => 'ro', isa => 'Str');
9             has RoleARN => (is => 'ro', isa => 'Str', required => 1);
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::Firehose::S3DestinationConfiguration
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::Firehose::S3DestinationConfiguration object:
28              
29             $service_obj->Method(Att1 => { BucketARN => $value, ..., RoleARN => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::S3DestinationConfiguration object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->BucketARN
37              
38             =head1 DESCRIPTION
39              
40             Describes the configuration of a destination in Amazon S3.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 B<REQUIRED> BucketARN => Str
46              
47             The ARN of the S3 bucket.
48              
49              
50             =head2 BufferingHints => L<Paws::Firehose::BufferingHints>
51              
52             The buffering option. If no value is specified, B<BufferingHints>
53             object default values are used.
54              
55              
56             =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions>
57              
58             The CloudWatch logging options for your delivery stream.
59              
60              
61             =head2 CompressionFormat => Str
62              
63             The compression format. If no value is specified, the default is
64             C<UNCOMPRESSED>.
65              
66             The compression formats C<SNAPPY> or C<ZIP> cannot be specified for
67             Amazon Redshift destinations because they are not supported by the
68             Amazon Redshift C<COPY> operation that reads from the S3 bucket.
69              
70              
71             =head2 EncryptionConfiguration => L<Paws::Firehose::EncryptionConfiguration>
72              
73             The encryption configuration. If no value is specified, the default is
74             no encryption.
75              
76              
77             =head2 Prefix => Str
78              
79             The "YYYY/MM/DD/HH" time format prefix is automatically used for
80             delivered S3 files. You can specify an extra prefix to be added in
81             front of the time format prefix. If the prefix ends with a slash, it
82             appears as a folder in the S3 bucket. For more information, see Amazon
83             S3 Object Name Format in the I<Amazon Kinesis Firehose Developer
84             Guide>.
85              
86              
87             =head2 B<REQUIRED> RoleARN => Str
88              
89             The ARN of the AWS credentials.
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104