File Coverage

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