blib/lib/Paws/Firehose/ElasticsearchDestinationConfiguration.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Firehose::ElasticsearchDestinationConfiguration;
3 use Moose;
4 has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchBufferingHints');
5 has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions');
6 has ClusterEndpoint => (is => 'ro', isa => 'Str');
7 has DomainARN => (is => 'ro', isa => 'Str');
8 has IndexName => (is => 'ro', isa => 'Str', required => 1);
9 has IndexRotationPeriod => (is => 'ro', isa => 'Str');
10 has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration');
11 has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchRetryOptions');
12 has RoleARN => (is => 'ro', isa => 'Str', required => 1);
13 has S3BackupMode => (is => 'ro', isa => 'Str');
14 has S3Configuration => (is => 'ro', isa => 'Paws::Firehose::S3DestinationConfiguration', required => 1);
15 has TypeName => (is => 'ro', isa => 'Str');
16 has VpcConfiguration => (is => 'ro', isa => 'Paws::Firehose::VpcConfiguration');
17  
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Firehose::ElasticsearchDestinationConfiguration
25  
26 =head1 USAGE
27  
28 This class represents one of two things:
29  
30 =head3 Arguments in a call to a service
31  
32 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
33 Each attribute should be used as a named argument in the calls that expect this type of object.
34  
35 As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchDestinationConfiguration object:
36  
37 $service_obj->Method(Att1 => { BufferingHints => $value, ..., VpcConfiguration => $value });
38  
39 =head3 Results returned from an API call
40  
41 Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationConfiguration object:
42  
43 $result = $service_obj->Method(...);
44 $result->Att1->BufferingHints
45  
46 =head1 DESCRIPTION
47  
48 Describes the configuration of a destination in Amazon ES.
49  
50 =head1 ATTRIBUTES
51  
52  
53 =head2 BufferingHints => L<Paws::Firehose::ElasticsearchBufferingHints>
54  
55 The buffering options. If no value is specified, the default values for
56 C<ElasticsearchBufferingHints> are used.
57  
58  
59 =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions>
60  
61 The Amazon CloudWatch logging options for your delivery stream.
62  
63  
64 =head2 ClusterEndpoint => Str
65  
66 The endpoint to use when communicating with the cluster. Specify either
67 this C<ClusterEndpoint> or the C<DomainARN> field.
68  
69  
70 =head2 DomainARN => Str
71  
72 The ARN of the Amazon ES domain. The IAM role must have permissions for
73 C<DescribeElasticsearchDomain>, C<DescribeElasticsearchDomains>, and
74 C<DescribeElasticsearchDomainConfig> after assuming the role specified
75 in B<RoleARN>. For more information, see Amazon Resource Names (ARNs)
76 and AWS Service Namespaces
77 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
78  
79 Specify either C<ClusterEndpoint> or C<DomainARN>.
80  
81  
82 =head2 B<REQUIRED> IndexName => Str
83  
84 The Elasticsearch index name.
85  
86  
87 =head2 IndexRotationPeriod => Str
88  
89 The Elasticsearch index rotation period. Index rotation appends a
90 timestamp to the C<IndexName> to facilitate the expiration of old data.
91 For more information, see Index Rotation for the Amazon ES Destination
92 (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation).
93 The default value is C<OneDay>.
94  
95  
96 =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration>
97  
98 The data processing configuration.
99  
100  
101 =head2 RetryOptions => L<Paws::Firehose::ElasticsearchRetryOptions>
102  
103 The retry behavior in case Kinesis Data Firehose is unable to deliver
104 documents to Amazon ES. The default value is 300 (5 minutes).
105  
106  
107 =head2 B<REQUIRED> RoleARN => Str
108  
109 The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
110 Data Firehose for calling the Amazon ES Configuration API and for
111 indexing documents. For more information, see Grant Kinesis Data
112 Firehose Access to an Amazon S3 Destination
113 (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3)
114 and Amazon Resource Names (ARNs) and AWS Service Namespaces
115 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
116  
117  
118 =head2 S3BackupMode => Str
119  
120 Defines how documents should be delivered to Amazon S3. When it is set
121 to C<FailedDocumentsOnly>, Kinesis Data Firehose writes any documents
122 that could not be indexed to the configured Amazon S3 destination, with
123 C<elasticsearch-failed/> appended to the key prefix. When set to
124 C<AllDocuments>, Kinesis Data Firehose delivers all incoming records to
125 Amazon S3, and also writes failed documents with
126 C<elasticsearch-failed/> appended to the prefix. For more information,
127 see Amazon S3 Backup for the Amazon ES Destination
128 (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup).
129 Default value is C<FailedDocumentsOnly>.
130  
131 You can't change this backup mode after you create the delivery stream.
132  
133  
134 =head2 B<REQUIRED> S3Configuration => L<Paws::Firehose::S3DestinationConfiguration>
135  
136 The configuration for the backup Amazon S3 location.
137  
138  
139 =head2 TypeName => Str
140  
141 The Elasticsearch type name. For Elasticsearch 6.x, there can be only
142 one type per index. If you try to specify a new type for an existing
143 index that already has another type, Kinesis Data Firehose returns an
144 error during run time.
145  
146 For Elasticsearch 7.x, don't specify a C<TypeName>.
147  
148  
149 =head2 VpcConfiguration => L<Paws::Firehose::VpcConfiguration>
150  
151 The details of the VPC of the Amazon ES destination.
152  
153  
154  
155 =head1 SEE ALSO
156  
157 This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
158  
159 =head1 BUGS and CONTRIBUTIONS
160  
161 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
162  
163 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
164  
165 =cut
166