File Coverage

blib/lib/Paws/Firehose/ElasticsearchDestinationConfiguration.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::ElasticsearchDestinationConfiguration;
2 1     1   534 use Moose;
  1         3  
  1         9  
3             has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchBufferingHints');
4             has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions');
5             has DomainARN => (is => 'ro', isa => 'Str', required => 1);
6             has IndexName => (is => 'ro', isa => 'Str', required => 1);
7             has IndexRotationPeriod => (is => 'ro', isa => 'Str');
8             has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration');
9             has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchRetryOptions');
10             has RoleARN => (is => 'ro', isa => 'Str', required => 1);
11             has S3BackupMode => (is => 'ro', isa => 'Str');
12             has S3Configuration => (is => 'ro', isa => 'Paws::Firehose::S3DestinationConfiguration', required => 1);
13             has TypeName => (is => 'ro', isa => 'Str', required => 1);
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::Firehose::ElasticsearchDestinationConfiguration
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchDestinationConfiguration object:
32              
33             $service_obj->Method(Att1 => { BufferingHints => $value, ..., TypeName => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationConfiguration object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->BufferingHints
41              
42             =head1 DESCRIPTION
43              
44             Describes the configuration of a destination in Amazon ES.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 BufferingHints => L<Paws::Firehose::ElasticsearchBufferingHints>
50              
51             The buffering options. If no value is specified, the default values for
52             B<ElasticsearchBufferingHints> are used.
53              
54              
55             =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions>
56              
57             The CloudWatch logging options for your delivery stream.
58              
59              
60             =head2 B<REQUIRED> DomainARN => Str
61              
62             The ARN of the Amazon ES domain. The IAM role must have permissions for
63             C<DescribeElasticsearchDomain>, C<DescribeElasticsearchDomains>, and
64             C<DescribeElasticsearchDomainConfig> after assuming the role specified
65             in B<RoleARN>.
66              
67              
68             =head2 B<REQUIRED> IndexName => Str
69              
70             The Elasticsearch index name.
71              
72              
73             =head2 IndexRotationPeriod => Str
74              
75             The Elasticsearch index rotation period. Index rotation appends a time
76             stamp to the IndexName to facilitate the expiration of old data. For
77             more information, see Index Rotation for Amazon Elasticsearch Service
78             Destination. The default value is C<OneDay>.
79              
80              
81             =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration>
82              
83             The data processing configuration.
84              
85              
86             =head2 RetryOptions => L<Paws::Firehose::ElasticsearchRetryOptions>
87              
88             The retry behavior in case Kinesis Firehose is unable to deliver
89             documents to Amazon ES. The default value is 300 (5 minutes).
90              
91              
92             =head2 B<REQUIRED> RoleARN => Str
93              
94             The ARN of the IAM role to be assumed by Kinesis Firehose for calling
95             the Amazon ES Configuration API and for indexing documents. For more
96             information, see Amazon S3 Bucket Access.
97              
98              
99             =head2 S3BackupMode => Str
100              
101             Defines how documents should be delivered to Amazon S3. When set to
102             FailedDocumentsOnly, Kinesis Firehose writes any documents that could
103             not be indexed to the configured Amazon S3 destination, with
104             elasticsearch-failed/ appended to the key prefix. When set to
105             AllDocuments, Kinesis Firehose delivers all incoming records to Amazon
106             S3, and also writes failed documents with elasticsearch-failed/
107             appended to the prefix. For more information, see Amazon S3 Backup for
108             Amazon Elasticsearch Service Destination. Default value is
109             FailedDocumentsOnly.
110              
111              
112             =head2 B<REQUIRED> S3Configuration => L<Paws::Firehose::S3DestinationConfiguration>
113              
114             The configuration for the backup Amazon S3 location.
115              
116              
117             =head2 B<REQUIRED> TypeName => Str
118              
119             The Elasticsearch type name.
120              
121              
122              
123             =head1 SEE ALSO
124              
125             This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
126              
127             =head1 BUGS and CONTRIBUTIONS
128              
129             The source code is located here: https://github.com/pplu/aws-sdk-perl
130              
131             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
132              
133             =cut
134