aws-sdk-firehose 1.49.0 → 1.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-firehose/client.rb +180 -20
- data/lib/aws-sdk-firehose/client_api.rb +55 -0
- data/lib/aws-sdk-firehose/types.rb +738 -136
- data/lib/aws-sdk-firehose.rb +1 -1
- metadata +2 -2
@@ -10,6 +10,385 @@
|
|
10
10
|
module Aws::Firehose
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Describes the buffering to perform before delivering data to the
|
14
|
+
# Serverless offering for Amazon OpenSearch Service destination.
|
15
|
+
#
|
16
|
+
# @note When making an API call, you may pass AmazonOpenSearchServerlessBufferingHints
|
17
|
+
# data as a hash:
|
18
|
+
#
|
19
|
+
# {
|
20
|
+
# interval_in_seconds: 1,
|
21
|
+
# size_in_m_bs: 1,
|
22
|
+
# }
|
23
|
+
#
|
24
|
+
# @!attribute [rw] interval_in_seconds
|
25
|
+
# Buffer incoming data for the specified period of time, in seconds,
|
26
|
+
# before delivering it to the destination. The default value is 300 (5
|
27
|
+
# minutes).
|
28
|
+
# @return [Integer]
|
29
|
+
#
|
30
|
+
# @!attribute [rw] size_in_m_bs
|
31
|
+
# Buffer incoming data to the specified size, in MBs, before
|
32
|
+
# delivering it to the destination. The default value is 5.
|
33
|
+
#
|
34
|
+
# We recommend setting this parameter to a value greater than the
|
35
|
+
# amount of data you typically ingest into the delivery stream in 10
|
36
|
+
# seconds. For example, if you typically ingest data at 1 MB/sec, the
|
37
|
+
# value should be 10 MB or higher.
|
38
|
+
# @return [Integer]
|
39
|
+
#
|
40
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessBufferingHints AWS API Documentation
|
41
|
+
#
|
42
|
+
class AmazonOpenSearchServerlessBufferingHints < Struct.new(
|
43
|
+
:interval_in_seconds,
|
44
|
+
:size_in_m_bs)
|
45
|
+
SENSITIVE = []
|
46
|
+
include Aws::Structure
|
47
|
+
end
|
48
|
+
|
49
|
+
# Describes the configuration of a destination in the Serverless
|
50
|
+
# offering for Amazon OpenSearch Service.
|
51
|
+
#
|
52
|
+
# @note When making an API call, you may pass AmazonOpenSearchServerlessDestinationConfiguration
|
53
|
+
# data as a hash:
|
54
|
+
#
|
55
|
+
# {
|
56
|
+
# role_arn: "RoleARN", # required
|
57
|
+
# collection_endpoint: "AmazonOpenSearchServerlessCollectionEndpoint",
|
58
|
+
# index_name: "AmazonOpenSearchServerlessIndexName", # required
|
59
|
+
# buffering_hints: {
|
60
|
+
# interval_in_seconds: 1,
|
61
|
+
# size_in_m_bs: 1,
|
62
|
+
# },
|
63
|
+
# retry_options: {
|
64
|
+
# duration_in_seconds: 1,
|
65
|
+
# },
|
66
|
+
# s3_backup_mode: "FailedDocumentsOnly", # accepts FailedDocumentsOnly, AllDocuments
|
67
|
+
# s3_configuration: { # required
|
68
|
+
# role_arn: "RoleARN", # required
|
69
|
+
# bucket_arn: "BucketARN", # required
|
70
|
+
# prefix: "Prefix",
|
71
|
+
# error_output_prefix: "ErrorOutputPrefix",
|
72
|
+
# buffering_hints: {
|
73
|
+
# size_in_m_bs: 1,
|
74
|
+
# interval_in_seconds: 1,
|
75
|
+
# },
|
76
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
77
|
+
# encryption_configuration: {
|
78
|
+
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
79
|
+
# kms_encryption_config: {
|
80
|
+
# awskms_key_arn: "AWSKMSKeyARN", # required
|
81
|
+
# },
|
82
|
+
# },
|
83
|
+
# cloud_watch_logging_options: {
|
84
|
+
# enabled: false,
|
85
|
+
# log_group_name: "LogGroupName",
|
86
|
+
# log_stream_name: "LogStreamName",
|
87
|
+
# },
|
88
|
+
# },
|
89
|
+
# processing_configuration: {
|
90
|
+
# enabled: false,
|
91
|
+
# processors: [
|
92
|
+
# {
|
93
|
+
# type: "RecordDeAggregation", # required, accepts RecordDeAggregation, Lambda, MetadataExtraction, AppendDelimiterToRecord
|
94
|
+
# parameters: [
|
95
|
+
# {
|
96
|
+
# parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, MetadataExtractionQuery, JsonParsingEngine, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds, SubRecordType, Delimiter
|
97
|
+
# parameter_value: "ProcessorParameterValue", # required
|
98
|
+
# },
|
99
|
+
# ],
|
100
|
+
# },
|
101
|
+
# ],
|
102
|
+
# },
|
103
|
+
# cloud_watch_logging_options: {
|
104
|
+
# enabled: false,
|
105
|
+
# log_group_name: "LogGroupName",
|
106
|
+
# log_stream_name: "LogStreamName",
|
107
|
+
# },
|
108
|
+
# vpc_configuration: {
|
109
|
+
# subnet_ids: ["NonEmptyStringWithoutWhitespace"], # required
|
110
|
+
# role_arn: "RoleARN", # required
|
111
|
+
# security_group_ids: ["NonEmptyStringWithoutWhitespace"], # required
|
112
|
+
# },
|
113
|
+
# }
|
114
|
+
#
|
115
|
+
# @!attribute [rw] role_arn
|
116
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
117
|
+
# Kinesis Data Firehose for calling the Serverless offering for Amazon
|
118
|
+
# OpenSearch Service Configuration API and for indexing documents.
|
119
|
+
# @return [String]
|
120
|
+
#
|
121
|
+
# @!attribute [rw] collection_endpoint
|
122
|
+
# The endpoint to use when communicating with the collection in the
|
123
|
+
# Serverless offering for Amazon OpenSearch Service.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] index_name
|
127
|
+
# The Serverless offering for Amazon OpenSearch Service index name.
|
128
|
+
# @return [String]
|
129
|
+
#
|
130
|
+
# @!attribute [rw] buffering_hints
|
131
|
+
# The buffering options. If no value is specified, the default values
|
132
|
+
# for AmazonopensearchserviceBufferingHints are used.
|
133
|
+
# @return [Types::AmazonOpenSearchServerlessBufferingHints]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] retry_options
|
136
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
137
|
+
# deliver documents to the Serverless offering for Amazon OpenSearch
|
138
|
+
# Service. The default value is 300 (5 minutes).
|
139
|
+
# @return [Types::AmazonOpenSearchServerlessRetryOptions]
|
140
|
+
#
|
141
|
+
# @!attribute [rw] s3_backup_mode
|
142
|
+
# Defines how documents should be delivered to Amazon S3. When it is
|
143
|
+
# set to FailedDocumentsOnly, Kinesis Data Firehose writes any
|
144
|
+
# documents that could not be indexed to the configured Amazon S3
|
145
|
+
# destination, with AmazonOpenSearchService-failed/ appended to the
|
146
|
+
# key prefix. When set to AllDocuments, Kinesis Data Firehose delivers
|
147
|
+
# all incoming records to Amazon S3, and also writes failed documents
|
148
|
+
# with AmazonOpenSearchService-failed/ appended to the prefix.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] s3_configuration
|
152
|
+
# Describes the configuration of a destination in Amazon S3.
|
153
|
+
# @return [Types::S3DestinationConfiguration]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] processing_configuration
|
156
|
+
# Describes a data processing configuration.
|
157
|
+
# @return [Types::ProcessingConfiguration]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] cloud_watch_logging_options
|
160
|
+
# Describes the Amazon CloudWatch logging options for your delivery
|
161
|
+
# stream.
|
162
|
+
# @return [Types::CloudWatchLoggingOptions]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] vpc_configuration
|
165
|
+
# The details of the VPC of the Amazon ES destination.
|
166
|
+
# @return [Types::VpcConfiguration]
|
167
|
+
#
|
168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessDestinationConfiguration AWS API Documentation
|
169
|
+
#
|
170
|
+
class AmazonOpenSearchServerlessDestinationConfiguration < Struct.new(
|
171
|
+
:role_arn,
|
172
|
+
:collection_endpoint,
|
173
|
+
:index_name,
|
174
|
+
:buffering_hints,
|
175
|
+
:retry_options,
|
176
|
+
:s3_backup_mode,
|
177
|
+
:s3_configuration,
|
178
|
+
:processing_configuration,
|
179
|
+
:cloud_watch_logging_options,
|
180
|
+
:vpc_configuration)
|
181
|
+
SENSITIVE = []
|
182
|
+
include Aws::Structure
|
183
|
+
end
|
184
|
+
|
185
|
+
# The destination description in the Serverless offering for Amazon
|
186
|
+
# OpenSearch Service.
|
187
|
+
#
|
188
|
+
# @!attribute [rw] role_arn
|
189
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
190
|
+
# @return [String]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] collection_endpoint
|
193
|
+
# The endpoint to use when communicating with the collection in the
|
194
|
+
# Serverless offering for Amazon OpenSearch Service.
|
195
|
+
# @return [String]
|
196
|
+
#
|
197
|
+
# @!attribute [rw] index_name
|
198
|
+
# The Serverless offering for Amazon OpenSearch Service index name.
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] buffering_hints
|
202
|
+
# The buffering options.
|
203
|
+
# @return [Types::AmazonOpenSearchServerlessBufferingHints]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] retry_options
|
206
|
+
# The Serverless offering for Amazon OpenSearch Service retry options.
|
207
|
+
# @return [Types::AmazonOpenSearchServerlessRetryOptions]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] s3_backup_mode
|
210
|
+
# The Amazon S3 backup mode.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] s3_destination_description
|
214
|
+
# Describes a destination in Amazon S3.
|
215
|
+
# @return [Types::S3DestinationDescription]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] processing_configuration
|
218
|
+
# Describes a data processing configuration.
|
219
|
+
# @return [Types::ProcessingConfiguration]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] cloud_watch_logging_options
|
222
|
+
# Describes the Amazon CloudWatch logging options for your delivery
|
223
|
+
# stream.
|
224
|
+
# @return [Types::CloudWatchLoggingOptions]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] vpc_configuration_description
|
227
|
+
# The details of the VPC of the Amazon ES destination.
|
228
|
+
# @return [Types::VpcConfigurationDescription]
|
229
|
+
#
|
230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessDestinationDescription AWS API Documentation
|
231
|
+
#
|
232
|
+
class AmazonOpenSearchServerlessDestinationDescription < Struct.new(
|
233
|
+
:role_arn,
|
234
|
+
:collection_endpoint,
|
235
|
+
:index_name,
|
236
|
+
:buffering_hints,
|
237
|
+
:retry_options,
|
238
|
+
:s3_backup_mode,
|
239
|
+
:s3_destination_description,
|
240
|
+
:processing_configuration,
|
241
|
+
:cloud_watch_logging_options,
|
242
|
+
:vpc_configuration_description)
|
243
|
+
SENSITIVE = []
|
244
|
+
include Aws::Structure
|
245
|
+
end
|
246
|
+
|
247
|
+
# Describes an update for a destination in the Serverless offering for
|
248
|
+
# Amazon OpenSearch Service.
|
249
|
+
#
|
250
|
+
# @note When making an API call, you may pass AmazonOpenSearchServerlessDestinationUpdate
|
251
|
+
# data as a hash:
|
252
|
+
#
|
253
|
+
# {
|
254
|
+
# role_arn: "RoleARN",
|
255
|
+
# collection_endpoint: "AmazonOpenSearchServerlessCollectionEndpoint",
|
256
|
+
# index_name: "AmazonOpenSearchServerlessIndexName",
|
257
|
+
# buffering_hints: {
|
258
|
+
# interval_in_seconds: 1,
|
259
|
+
# size_in_m_bs: 1,
|
260
|
+
# },
|
261
|
+
# retry_options: {
|
262
|
+
# duration_in_seconds: 1,
|
263
|
+
# },
|
264
|
+
# s3_update: {
|
265
|
+
# role_arn: "RoleARN",
|
266
|
+
# bucket_arn: "BucketARN",
|
267
|
+
# prefix: "Prefix",
|
268
|
+
# error_output_prefix: "ErrorOutputPrefix",
|
269
|
+
# buffering_hints: {
|
270
|
+
# size_in_m_bs: 1,
|
271
|
+
# interval_in_seconds: 1,
|
272
|
+
# },
|
273
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
274
|
+
# encryption_configuration: {
|
275
|
+
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
276
|
+
# kms_encryption_config: {
|
277
|
+
# awskms_key_arn: "AWSKMSKeyARN", # required
|
278
|
+
# },
|
279
|
+
# },
|
280
|
+
# cloud_watch_logging_options: {
|
281
|
+
# enabled: false,
|
282
|
+
# log_group_name: "LogGroupName",
|
283
|
+
# log_stream_name: "LogStreamName",
|
284
|
+
# },
|
285
|
+
# },
|
286
|
+
# processing_configuration: {
|
287
|
+
# enabled: false,
|
288
|
+
# processors: [
|
289
|
+
# {
|
290
|
+
# type: "RecordDeAggregation", # required, accepts RecordDeAggregation, Lambda, MetadataExtraction, AppendDelimiterToRecord
|
291
|
+
# parameters: [
|
292
|
+
# {
|
293
|
+
# parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, MetadataExtractionQuery, JsonParsingEngine, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds, SubRecordType, Delimiter
|
294
|
+
# parameter_value: "ProcessorParameterValue", # required
|
295
|
+
# },
|
296
|
+
# ],
|
297
|
+
# },
|
298
|
+
# ],
|
299
|
+
# },
|
300
|
+
# cloud_watch_logging_options: {
|
301
|
+
# enabled: false,
|
302
|
+
# log_group_name: "LogGroupName",
|
303
|
+
# log_stream_name: "LogStreamName",
|
304
|
+
# },
|
305
|
+
# }
|
306
|
+
#
|
307
|
+
# @!attribute [rw] role_arn
|
308
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
309
|
+
# Kinesis Data Firehose for calling the Serverless offering for Amazon
|
310
|
+
# OpenSearch Service Configuration API and for indexing documents.
|
311
|
+
# @return [String]
|
312
|
+
#
|
313
|
+
# @!attribute [rw] collection_endpoint
|
314
|
+
# The endpoint to use when communicating with the collection in the
|
315
|
+
# Serverless offering for Amazon OpenSearch Service.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] index_name
|
319
|
+
# The Serverless offering for Amazon OpenSearch Service index name.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] buffering_hints
|
323
|
+
# The buffering options. If no value is specified,
|
324
|
+
# AmazonopensearchBufferingHints object default values are used.
|
325
|
+
# @return [Types::AmazonOpenSearchServerlessBufferingHints]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] retry_options
|
328
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
329
|
+
# deliver documents to the Serverless offering for Amazon OpenSearch
|
330
|
+
# Service. The default value is 300 (5 minutes).
|
331
|
+
# @return [Types::AmazonOpenSearchServerlessRetryOptions]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] s3_update
|
334
|
+
# Describes an update for a destination in Amazon S3.
|
335
|
+
# @return [Types::S3DestinationUpdate]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] processing_configuration
|
338
|
+
# Describes a data processing configuration.
|
339
|
+
# @return [Types::ProcessingConfiguration]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] cloud_watch_logging_options
|
342
|
+
# Describes the Amazon CloudWatch logging options for your delivery
|
343
|
+
# stream.
|
344
|
+
# @return [Types::CloudWatchLoggingOptions]
|
345
|
+
#
|
346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessDestinationUpdate AWS API Documentation
|
347
|
+
#
|
348
|
+
class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
|
349
|
+
:role_arn,
|
350
|
+
:collection_endpoint,
|
351
|
+
:index_name,
|
352
|
+
:buffering_hints,
|
353
|
+
:retry_options,
|
354
|
+
:s3_update,
|
355
|
+
:processing_configuration,
|
356
|
+
:cloud_watch_logging_options)
|
357
|
+
SENSITIVE = []
|
358
|
+
include Aws::Structure
|
359
|
+
end
|
360
|
+
|
361
|
+
# Configures retry behavior in case Kinesis Data Firehose is unable to
|
362
|
+
# deliver documents to the Serverless offering for Amazon OpenSearch
|
363
|
+
# Service.
|
364
|
+
#
|
365
|
+
# @note When making an API call, you may pass AmazonOpenSearchServerlessRetryOptions
|
366
|
+
# data as a hash:
|
367
|
+
#
|
368
|
+
# {
|
369
|
+
# duration_in_seconds: 1,
|
370
|
+
# }
|
371
|
+
#
|
372
|
+
# @!attribute [rw] duration_in_seconds
|
373
|
+
# After an initial failure to deliver to the Serverless offering for
|
374
|
+
# Amazon OpenSearch Service, the total amount of time during which
|
375
|
+
# Kinesis Data Firehose retries delivery (including the first
|
376
|
+
# attempt). After this time has elapsed, the failed documents are
|
377
|
+
# written to Amazon S3. Default value is 300 seconds (5 minutes). A
|
378
|
+
# value of 0 (zero) results in no retries.
|
379
|
+
# @return [Integer]
|
380
|
+
#
|
381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessRetryOptions AWS API Documentation
|
382
|
+
#
|
383
|
+
class AmazonOpenSearchServerlessRetryOptions < Struct.new(
|
384
|
+
:duration_in_seconds)
|
385
|
+
SENSITIVE = []
|
386
|
+
include Aws::Structure
|
387
|
+
end
|
388
|
+
|
389
|
+
# Describes the buffering to perform before delivering data to the
|
390
|
+
# Amazon OpenSearch Service destination.
|
391
|
+
#
|
13
392
|
# @note When making an API call, you may pass AmazonopensearchserviceBufferingHints
|
14
393
|
# data as a hash:
|
15
394
|
#
|
@@ -19,9 +398,19 @@ module Aws::Firehose
|
|
19
398
|
# }
|
20
399
|
#
|
21
400
|
# @!attribute [rw] interval_in_seconds
|
401
|
+
# Buffer incoming data for the specified period of time, in seconds,
|
402
|
+
# before delivering it to the destination. The default value is 300 (5
|
403
|
+
# minutes).
|
22
404
|
# @return [Integer]
|
23
405
|
#
|
24
406
|
# @!attribute [rw] size_in_m_bs
|
407
|
+
# Buffer incoming data to the specified size, in MBs, before
|
408
|
+
# delivering it to the destination. The default value is 5.
|
409
|
+
#
|
410
|
+
# We recommend setting this parameter to a value greater than the
|
411
|
+
# amount of data you typically ingest into the delivery stream in 10
|
412
|
+
# seconds. For example, if you typically ingest data at 1 MB/sec, the
|
413
|
+
# value should be 10 MB or higher.
|
25
414
|
# @return [Integer]
|
26
415
|
#
|
27
416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonopensearchserviceBufferingHints AWS API Documentation
|
@@ -33,6 +422,9 @@ module Aws::Firehose
|
|
33
422
|
include Aws::Structure
|
34
423
|
end
|
35
424
|
|
425
|
+
# Describes the configuration of a destination in Amazon OpenSearch
|
426
|
+
# Service
|
427
|
+
#
|
36
428
|
# @note When making an API call, you may pass AmazonopensearchserviceDestinationConfiguration
|
37
429
|
# data as a hash:
|
38
430
|
#
|
@@ -100,30 +492,59 @@ module Aws::Firehose
|
|
100
492
|
# }
|
101
493
|
#
|
102
494
|
# @!attribute [rw] role_arn
|
495
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
496
|
+
# Kinesis Data Firehose for calling the Amazon OpenSearch Service
|
497
|
+
# Configuration API and for indexing documents.
|
103
498
|
# @return [String]
|
104
499
|
#
|
105
500
|
# @!attribute [rw] domain_arn
|
501
|
+
# The ARN of the Amazon OpenSearch Service domain. The IAM role must
|
502
|
+
# have permissions for DescribeElasticsearchDomain,
|
503
|
+
# DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig
|
504
|
+
# after assuming the role specified in RoleARN.
|
106
505
|
# @return [String]
|
107
506
|
#
|
108
507
|
# @!attribute [rw] cluster_endpoint
|
508
|
+
# The endpoint to use when communicating with the cluster. Specify
|
509
|
+
# either this ClusterEndpoint or the DomainARN field.
|
109
510
|
# @return [String]
|
110
511
|
#
|
111
512
|
# @!attribute [rw] index_name
|
513
|
+
# The ElasticsearAmazon OpenSearch Service index name.
|
112
514
|
# @return [String]
|
113
515
|
#
|
114
516
|
# @!attribute [rw] type_name
|
517
|
+
# The Amazon OpenSearch Service type name. For Elasticsearch 6.x,
|
518
|
+
# there can be only one type per index. If you try to specify a new
|
519
|
+
# type for an existing index that already has another type, Kinesis
|
520
|
+
# Data Firehose returns an error during run time.
|
115
521
|
# @return [String]
|
116
522
|
#
|
117
523
|
# @!attribute [rw] index_rotation_period
|
524
|
+
# The Amazon OpenSearch Service index rotation period. Index rotation
|
525
|
+
# appends a timestamp to the IndexName to facilitate the expiration of
|
526
|
+
# old data.
|
118
527
|
# @return [String]
|
119
528
|
#
|
120
529
|
# @!attribute [rw] buffering_hints
|
530
|
+
# The buffering options. If no value is specified, the default values
|
531
|
+
# for AmazonopensearchserviceBufferingHints are used.
|
121
532
|
# @return [Types::AmazonopensearchserviceBufferingHints]
|
122
533
|
#
|
123
534
|
# @!attribute [rw] retry_options
|
535
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
536
|
+
# deliver documents to Amazon OpenSearch Service. The default value is
|
537
|
+
# 300 (5 minutes).
|
124
538
|
# @return [Types::AmazonopensearchserviceRetryOptions]
|
125
539
|
#
|
126
540
|
# @!attribute [rw] s3_backup_mode
|
541
|
+
# Defines how documents should be delivered to Amazon S3. When it is
|
542
|
+
# set to FailedDocumentsOnly, Kinesis Data Firehose writes any
|
543
|
+
# documents that could not be indexed to the configured Amazon S3
|
544
|
+
# destination, with AmazonOpenSearchService-failed/ appended to the
|
545
|
+
# key prefix. When set to AllDocuments, Kinesis Data Firehose delivers
|
546
|
+
# all incoming records to Amazon S3, and also writes failed documents
|
547
|
+
# with AmazonOpenSearchService-failed/ appended to the prefix.
|
127
548
|
# @return [String]
|
128
549
|
#
|
129
550
|
# @!attribute [rw] s3_configuration
|
@@ -163,31 +584,47 @@ module Aws::Firehose
|
|
163
584
|
include Aws::Structure
|
164
585
|
end
|
165
586
|
|
587
|
+
# The destination description in Amazon OpenSearch Service.
|
588
|
+
#
|
166
589
|
# @!attribute [rw] role_arn
|
590
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
591
|
+
# credentials.
|
167
592
|
# @return [String]
|
168
593
|
#
|
169
594
|
# @!attribute [rw] domain_arn
|
595
|
+
# The ARN of the Amazon OpenSearch Service domain.
|
170
596
|
# @return [String]
|
171
597
|
#
|
172
598
|
# @!attribute [rw] cluster_endpoint
|
599
|
+
# The endpoint to use when communicating with the cluster. Kinesis
|
600
|
+
# Data Firehose uses either this ClusterEndpoint or the DomainARN
|
601
|
+
# field to send data to Amazon OpenSearch Service.
|
173
602
|
# @return [String]
|
174
603
|
#
|
175
604
|
# @!attribute [rw] index_name
|
605
|
+
# The Amazon OpenSearch Service index name.
|
176
606
|
# @return [String]
|
177
607
|
#
|
178
608
|
# @!attribute [rw] type_name
|
609
|
+
# The Amazon OpenSearch Service type name. This applies to
|
610
|
+
# Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and
|
611
|
+
# OpenSearch Service 1.x, there's no value for TypeName.
|
179
612
|
# @return [String]
|
180
613
|
#
|
181
614
|
# @!attribute [rw] index_rotation_period
|
615
|
+
# The Amazon OpenSearch Service index rotation period
|
182
616
|
# @return [String]
|
183
617
|
#
|
184
618
|
# @!attribute [rw] buffering_hints
|
619
|
+
# The buffering options.
|
185
620
|
# @return [Types::AmazonopensearchserviceBufferingHints]
|
186
621
|
#
|
187
622
|
# @!attribute [rw] retry_options
|
623
|
+
# The Amazon OpenSearch Service retry options.
|
188
624
|
# @return [Types::AmazonopensearchserviceRetryOptions]
|
189
625
|
#
|
190
626
|
# @!attribute [rw] s3_backup_mode
|
627
|
+
# The Amazon S3 backup mode.
|
191
628
|
# @return [String]
|
192
629
|
#
|
193
630
|
# @!attribute [rw] s3_destination_description
|
@@ -227,6 +664,8 @@ module Aws::Firehose
|
|
227
664
|
include Aws::Structure
|
228
665
|
end
|
229
666
|
|
667
|
+
# Describes an update for a destination in Amazon OpenSearch Service.
|
668
|
+
#
|
230
669
|
# @note When making an API call, you may pass AmazonopensearchserviceDestinationUpdate
|
231
670
|
# data as a hash:
|
232
671
|
#
|
@@ -288,27 +727,55 @@ module Aws::Firehose
|
|
288
727
|
# }
|
289
728
|
#
|
290
729
|
# @!attribute [rw] role_arn
|
730
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
731
|
+
# Kinesis Data Firehose for calling the Amazon OpenSearch Service
|
732
|
+
# Configuration API and for indexing documents.
|
291
733
|
# @return [String]
|
292
734
|
#
|
293
735
|
# @!attribute [rw] domain_arn
|
736
|
+
# The ARN of the Amazon OpenSearch Service domain. The IAM role must
|
737
|
+
# have permissions for DescribeDomain, DescribeDomains, and
|
738
|
+
# DescribeDomainConfig after assuming the IAM role specified in
|
739
|
+
# RoleARN.
|
294
740
|
# @return [String]
|
295
741
|
#
|
296
742
|
# @!attribute [rw] cluster_endpoint
|
743
|
+
# The endpoint to use when communicating with the cluster. Specify
|
744
|
+
# either this ClusterEndpoint or the DomainARN field.
|
297
745
|
# @return [String]
|
298
746
|
#
|
299
747
|
# @!attribute [rw] index_name
|
748
|
+
# The Amazon OpenSearch Service index name.
|
300
749
|
# @return [String]
|
301
750
|
#
|
302
751
|
# @!attribute [rw] type_name
|
752
|
+
# The Amazon OpenSearch Service type name. For Elasticsearch 6.x,
|
753
|
+
# there can be only one type per index. If you try to specify a new
|
754
|
+
# type for an existing index that already has another type, Kinesis
|
755
|
+
# Data Firehose returns an error during runtime.
|
756
|
+
#
|
757
|
+
# If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
|
758
|
+
# delivery stream, Kinesis Data Firehose still delivers data to
|
759
|
+
# Elasticsearch with the old index name and type name. If you want to
|
760
|
+
# update your delivery stream with a new index name, provide an empty
|
761
|
+
# string for TypeName.
|
303
762
|
# @return [String]
|
304
763
|
#
|
305
764
|
# @!attribute [rw] index_rotation_period
|
765
|
+
# The Amazon OpenSearch Service index rotation period. Index rotation
|
766
|
+
# appends a timestamp to IndexName to facilitate the expiration of old
|
767
|
+
# data.
|
306
768
|
# @return [String]
|
307
769
|
#
|
308
770
|
# @!attribute [rw] buffering_hints
|
771
|
+
# The buffering options. If no value is specified,
|
772
|
+
# AmazonopensearchBufferingHints object default values are used.
|
309
773
|
# @return [Types::AmazonopensearchserviceBufferingHints]
|
310
774
|
#
|
311
775
|
# @!attribute [rw] retry_options
|
776
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
777
|
+
# deliver documents to Amazon OpenSearch Service. The default value is
|
778
|
+
# 300 (5 minutes).
|
312
779
|
# @return [Types::AmazonopensearchserviceRetryOptions]
|
313
780
|
#
|
314
781
|
# @!attribute [rw] s3_update
|
@@ -342,6 +809,9 @@ module Aws::Firehose
|
|
342
809
|
include Aws::Structure
|
343
810
|
end
|
344
811
|
|
812
|
+
# Configures retry behavior in case Kinesis Data Firehose is unable to
|
813
|
+
# deliver documents to Amazon OpenSearch Service.
|
814
|
+
#
|
345
815
|
# @note When making an API call, you may pass AmazonopensearchserviceRetryOptions
|
346
816
|
# data as a hash:
|
347
817
|
#
|
@@ -350,6 +820,11 @@ module Aws::Firehose
|
|
350
820
|
# }
|
351
821
|
#
|
352
822
|
# @!attribute [rw] duration_in_seconds
|
823
|
+
# After an initial failure to deliver to Amazon OpenSearch Service,
|
824
|
+
# the total amount of time during which Kinesis Data Firehose retries
|
825
|
+
# delivery (including the first attempt). After this time has elapsed,
|
826
|
+
# the failed documents are written to Amazon S3. Default value is 300
|
827
|
+
# seconds (5 minutes). A value of 0 (zero) results in no retries.
|
353
828
|
# @return [Integer]
|
354
829
|
#
|
355
830
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonopensearchserviceRetryOptions AWS API Documentation
|
@@ -989,13 +1464,72 @@ module Aws::Firehose
|
|
989
1464
|
# value: "TagValue",
|
990
1465
|
# },
|
991
1466
|
# ],
|
1467
|
+
# amazon_open_search_serverless_destination_configuration: {
|
1468
|
+
# role_arn: "RoleARN", # required
|
1469
|
+
# collection_endpoint: "AmazonOpenSearchServerlessCollectionEndpoint",
|
1470
|
+
# index_name: "AmazonOpenSearchServerlessIndexName", # required
|
1471
|
+
# buffering_hints: {
|
1472
|
+
# interval_in_seconds: 1,
|
1473
|
+
# size_in_m_bs: 1,
|
1474
|
+
# },
|
1475
|
+
# retry_options: {
|
1476
|
+
# duration_in_seconds: 1,
|
1477
|
+
# },
|
1478
|
+
# s3_backup_mode: "FailedDocumentsOnly", # accepts FailedDocumentsOnly, AllDocuments
|
1479
|
+
# s3_configuration: { # required
|
1480
|
+
# role_arn: "RoleARN", # required
|
1481
|
+
# bucket_arn: "BucketARN", # required
|
1482
|
+
# prefix: "Prefix",
|
1483
|
+
# error_output_prefix: "ErrorOutputPrefix",
|
1484
|
+
# buffering_hints: {
|
1485
|
+
# size_in_m_bs: 1,
|
1486
|
+
# interval_in_seconds: 1,
|
1487
|
+
# },
|
1488
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
1489
|
+
# encryption_configuration: {
|
1490
|
+
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
1491
|
+
# kms_encryption_config: {
|
1492
|
+
# awskms_key_arn: "AWSKMSKeyARN", # required
|
1493
|
+
# },
|
1494
|
+
# },
|
1495
|
+
# cloud_watch_logging_options: {
|
1496
|
+
# enabled: false,
|
1497
|
+
# log_group_name: "LogGroupName",
|
1498
|
+
# log_stream_name: "LogStreamName",
|
1499
|
+
# },
|
1500
|
+
# },
|
1501
|
+
# processing_configuration: {
|
1502
|
+
# enabled: false,
|
1503
|
+
# processors: [
|
1504
|
+
# {
|
1505
|
+
# type: "RecordDeAggregation", # required, accepts RecordDeAggregation, Lambda, MetadataExtraction, AppendDelimiterToRecord
|
1506
|
+
# parameters: [
|
1507
|
+
# {
|
1508
|
+
# parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, MetadataExtractionQuery, JsonParsingEngine, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds, SubRecordType, Delimiter
|
1509
|
+
# parameter_value: "ProcessorParameterValue", # required
|
1510
|
+
# },
|
1511
|
+
# ],
|
1512
|
+
# },
|
1513
|
+
# ],
|
1514
|
+
# },
|
1515
|
+
# cloud_watch_logging_options: {
|
1516
|
+
# enabled: false,
|
1517
|
+
# log_group_name: "LogGroupName",
|
1518
|
+
# log_stream_name: "LogStreamName",
|
1519
|
+
# },
|
1520
|
+
# vpc_configuration: {
|
1521
|
+
# subnet_ids: ["NonEmptyStringWithoutWhitespace"], # required
|
1522
|
+
# role_arn: "RoleARN", # required
|
1523
|
+
# security_group_ids: ["NonEmptyStringWithoutWhitespace"], # required
|
1524
|
+
# },
|
1525
|
+
# },
|
992
1526
|
# }
|
993
1527
|
#
|
994
1528
|
# @!attribute [rw] delivery_stream_name
|
995
|
-
# The name of the delivery stream. This name must be unique per
|
996
|
-
# account in the same
|
997
|
-
# different accounts or different Regions, you
|
998
|
-
# delivery streams with the same name.
|
1529
|
+
# The name of the delivery stream. This name must be unique per Amazon
|
1530
|
+
# Web Services account in the same Amazon Web Services Region. If the
|
1531
|
+
# delivery streams are in different accounts or different Regions, you
|
1532
|
+
# can have multiple delivery streams with the same name.
|
999
1533
|
# @return [String]
|
1000
1534
|
#
|
1001
1535
|
# @!attribute [rw] delivery_stream_type
|
@@ -1040,6 +1574,8 @@ module Aws::Firehose
|
|
1040
1574
|
# @return [Types::ElasticsearchDestinationConfiguration]
|
1041
1575
|
#
|
1042
1576
|
# @!attribute [rw] amazonopensearchservice_destination_configuration
|
1577
|
+
# The destination in Amazon OpenSearch Service. You can specify only
|
1578
|
+
# one destination.
|
1043
1579
|
# @return [Types::AmazonopensearchserviceDestinationConfiguration]
|
1044
1580
|
#
|
1045
1581
|
# @!attribute [rw] splunk_destination_configuration
|
@@ -1053,12 +1589,12 @@ module Aws::Firehose
|
|
1053
1589
|
#
|
1054
1590
|
# @!attribute [rw] tags
|
1055
1591
|
# A set of tags to assign to the delivery stream. A tag is a key-value
|
1056
|
-
# pair that you can define and assign to
|
1057
|
-
# metadata. For example, you can add friendly
|
1058
|
-
# or other types of information that can help
|
1059
|
-
# delivery stream. For more information about
|
1060
|
-
# Allocation Tags][1] in the
|
1061
|
-
# Guide.
|
1592
|
+
# pair that you can define and assign to Amazon Web Services
|
1593
|
+
# resources. Tags are metadata. For example, you can add friendly
|
1594
|
+
# names and descriptions or other types of information that can help
|
1595
|
+
# you distinguish the delivery stream. For more information about
|
1596
|
+
# tags, see [Using Cost Allocation Tags][1] in the Amazon Web Services
|
1597
|
+
# Billing and Cost Management User Guide.
|
1062
1598
|
#
|
1063
1599
|
# You can specify up to 50 tags when creating a delivery stream.
|
1064
1600
|
#
|
@@ -1067,6 +1603,11 @@ module Aws::Firehose
|
|
1067
1603
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
1068
1604
|
# @return [Array<Types::Tag>]
|
1069
1605
|
#
|
1606
|
+
# @!attribute [rw] amazon_open_search_serverless_destination_configuration
|
1607
|
+
# The destination in the Serverless offering for Amazon OpenSearch
|
1608
|
+
# Service. You can specify only one destination.
|
1609
|
+
# @return [Types::AmazonOpenSearchServerlessDestinationConfiguration]
|
1610
|
+
#
|
1070
1611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/CreateDeliveryStreamInput AWS API Documentation
|
1071
1612
|
#
|
1072
1613
|
class CreateDeliveryStreamInput < Struct.new(
|
@@ -1081,7 +1622,8 @@ module Aws::Firehose
|
|
1081
1622
|
:amazonopensearchservice_destination_configuration,
|
1082
1623
|
:splunk_destination_configuration,
|
1083
1624
|
:http_endpoint_destination_configuration,
|
1084
|
-
:tags
|
1625
|
+
:tags,
|
1626
|
+
:amazon_open_search_serverless_destination_configuration)
|
1085
1627
|
SENSITIVE = []
|
1086
1628
|
include Aws::Structure
|
1087
1629
|
end
|
@@ -1101,10 +1643,10 @@ module Aws::Firehose
|
|
1101
1643
|
# Specifies that you want Kinesis Data Firehose to convert data from the
|
1102
1644
|
# JSON format to the Parquet or ORC format before writing it to Amazon
|
1103
1645
|
# S3. Kinesis Data Firehose uses the serializer and deserializer that
|
1104
|
-
# you specify, in addition to the column information from the
|
1105
|
-
# table, to deserialize your input data from JSON and then
|
1106
|
-
# to the Parquet or ORC format. For more information, see
|
1107
|
-
# Firehose Record Format Conversion][1].
|
1646
|
+
# you specify, in addition to the column information from the Amazon Web
|
1647
|
+
# Services Glue table, to deserialize your input data from JSON and then
|
1648
|
+
# serialize it to the Parquet or ORC format. For more information, see
|
1649
|
+
# [Kinesis Data Firehose Record Format Conversion][1].
|
1108
1650
|
#
|
1109
1651
|
#
|
1110
1652
|
#
|
@@ -1164,8 +1706,9 @@ module Aws::Firehose
|
|
1164
1706
|
# }
|
1165
1707
|
#
|
1166
1708
|
# @!attribute [rw] schema_configuration
|
1167
|
-
# Specifies the
|
1168
|
-
# information. This parameter is required if
|
1709
|
+
# Specifies the Amazon Web Services Glue Data Catalog table that
|
1710
|
+
# contains the column information. This parameter is required if
|
1711
|
+
# `Enabled` is set to true.
|
1169
1712
|
# @return [Types::SchemaConfiguration]
|
1170
1713
|
#
|
1171
1714
|
# @!attribute [rw] input_format_configuration
|
@@ -1215,8 +1758,9 @@ module Aws::Firehose
|
|
1215
1758
|
# customer error, such as when the CMK or the grant are in an invalid
|
1216
1759
|
# state. If you force deletion, you can then use the [RevokeGrant][1]
|
1217
1760
|
# operation to revoke the grant you gave to Kinesis Data Firehose. If
|
1218
|
-
# a failure to retire the grant happens due to an
|
1219
|
-
# Kinesis Data Firehose keeps retrying the delete
|
1761
|
+
# a failure to retire the grant happens due to an Amazon Web Services
|
1762
|
+
# KMS issue, Kinesis Data Firehose keeps retrying the delete
|
1763
|
+
# operation.
|
1220
1764
|
#
|
1221
1765
|
# The default value is false.
|
1222
1766
|
#
|
@@ -1246,8 +1790,8 @@ module Aws::Firehose
|
|
1246
1790
|
#
|
1247
1791
|
# @!attribute [rw] delivery_stream_arn
|
1248
1792
|
# The Amazon Resource Name (ARN) of the delivery stream. For more
|
1249
|
-
# information, see [Amazon Resource Names (ARNs) and
|
1250
|
-
# Namespaces][1].
|
1793
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web
|
1794
|
+
# Services Service Namespaces][1].
|
1251
1795
|
#
|
1252
1796
|
#
|
1253
1797
|
#
|
@@ -1338,15 +1882,16 @@ module Aws::Firehose
|
|
1338
1882
|
#
|
1339
1883
|
# @!attribute [rw] key_arn
|
1340
1884
|
# If `KeyType` is `CUSTOMER_MANAGED_CMK`, this field contains the ARN
|
1341
|
-
# of the customer managed CMK. If `KeyType` is `
|
1342
|
-
# `DeliveryStreamEncryptionConfiguration`
|
1343
|
-
# `KeyARN`.
|
1885
|
+
# of the customer managed CMK. If `KeyType` is `Amazon Web
|
1886
|
+
# Services_OWNED_CMK`, `DeliveryStreamEncryptionConfiguration`
|
1887
|
+
# doesn't contain a value for `KeyARN`.
|
1344
1888
|
# @return [String]
|
1345
1889
|
#
|
1346
1890
|
# @!attribute [rw] key_type
|
1347
1891
|
# Indicates the type of customer master key (CMK) that is used for
|
1348
|
-
# encryption. The default setting is `
|
1349
|
-
# information about CMKs, see [Customer Master Keys
|
1892
|
+
# encryption. The default setting is `Amazon Web Services_OWNED_CMK`.
|
1893
|
+
# For more information about CMKs, see [Customer Master Keys
|
1894
|
+
# (CMKs)][1].
|
1350
1895
|
#
|
1351
1896
|
#
|
1352
1897
|
#
|
@@ -1394,19 +1939,20 @@ module Aws::Firehose
|
|
1394
1939
|
# @!attribute [rw] key_arn
|
1395
1940
|
# If you set `KeyType` to `CUSTOMER_MANAGED_CMK`, you must specify the
|
1396
1941
|
# Amazon Resource Name (ARN) of the CMK. If you set `KeyType` to
|
1397
|
-
# `
|
1942
|
+
# `Amazon Web Services_OWNED_CMK`, Kinesis Data Firehose uses a
|
1943
|
+
# service-account CMK.
|
1398
1944
|
# @return [String]
|
1399
1945
|
#
|
1400
1946
|
# @!attribute [rw] key_type
|
1401
1947
|
# Indicates the type of customer master key (CMK) to use for
|
1402
|
-
# encryption. The default setting is `
|
1403
|
-
# information about CMKs, see [Customer Master Keys
|
1404
|
-
# you invoke CreateDeliveryStream or
|
1405
|
-
# with `KeyType` set to
|
1406
|
-
# invokes the Amazon KMS
|
1407
|
-
#
|
1408
|
-
#
|
1409
|
-
# Firehose manages that grant.
|
1948
|
+
# encryption. The default setting is `Amazon Web Services_OWNED_CMK`.
|
1949
|
+
# For more information about CMKs, see [Customer Master Keys
|
1950
|
+
# (CMKs)][1]. When you invoke CreateDeliveryStream or
|
1951
|
+
# StartDeliveryStreamEncryption with `KeyType` set to
|
1952
|
+
# CUSTOMER\_MANAGED\_CMK, Kinesis Data Firehose invokes the Amazon KMS
|
1953
|
+
# operation [CreateGrant][2] to create a grant that allows the Kinesis
|
1954
|
+
# Data Firehose service to use the customer managed CMK to perform
|
1955
|
+
# encryption and decryption. Kinesis Data Firehose manages that grant.
|
1410
1956
|
#
|
1411
1957
|
# When you invoke StartDeliveryStreamEncryption to change the CMK for
|
1412
1958
|
# a delivery stream that is encrypted with a customer managed CMK,
|
@@ -1421,7 +1967,8 @@ module Aws::Firehose
|
|
1421
1967
|
# To encrypt your delivery stream, use symmetric CMKs. Kinesis Data
|
1422
1968
|
# Firehose doesn't support asymmetric CMKs. For information about
|
1423
1969
|
# symmetric and asymmetric CMKs, see [About Symmetric and Asymmetric
|
1424
|
-
# CMKs][3] in the
|
1970
|
+
# CMKs][3] in the Amazon Web Services Key Management Service developer
|
1971
|
+
# guide.
|
1425
1972
|
#
|
1426
1973
|
#
|
1427
1974
|
#
|
@@ -1562,6 +2109,7 @@ module Aws::Firehose
|
|
1562
2109
|
# @return [Types::ElasticsearchDestinationDescription]
|
1563
2110
|
#
|
1564
2111
|
# @!attribute [rw] amazonopensearchservice_destination_description
|
2112
|
+
# The destination in Amazon OpenSearch Service.
|
1565
2113
|
# @return [Types::AmazonopensearchserviceDestinationDescription]
|
1566
2114
|
#
|
1567
2115
|
# @!attribute [rw] splunk_destination_description
|
@@ -1572,6 +2120,11 @@ module Aws::Firehose
|
|
1572
2120
|
# Describes the specified HTTP endpoint destination.
|
1573
2121
|
# @return [Types::HttpEndpointDestinationDescription]
|
1574
2122
|
#
|
2123
|
+
# @!attribute [rw] amazon_open_search_serverless_destination_description
|
2124
|
+
# The destination in the Serverless offering for Amazon OpenSearch
|
2125
|
+
# Service.
|
2126
|
+
# @return [Types::AmazonOpenSearchServerlessDestinationDescription]
|
2127
|
+
#
|
1575
2128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DestinationDescription AWS API Documentation
|
1576
2129
|
#
|
1577
2130
|
class DestinationDescription < Struct.new(
|
@@ -1582,7 +2135,8 @@ module Aws::Firehose
|
|
1582
2135
|
:elasticsearch_destination_description,
|
1583
2136
|
:amazonopensearchservice_destination_description,
|
1584
2137
|
:splunk_destination_description,
|
1585
|
-
:http_endpoint_destination_description
|
2138
|
+
:http_endpoint_destination_description,
|
2139
|
+
:amazon_open_search_serverless_destination_description)
|
1586
2140
|
SENSITIVE = []
|
1587
2141
|
include Aws::Structure
|
1588
2142
|
end
|
@@ -1590,12 +2144,7 @@ module Aws::Firehose
|
|
1590
2144
|
# The configuration of the dynamic partitioning mechanism that creates
|
1591
2145
|
# smaller data sets from the streaming data by partitioning it based on
|
1592
2146
|
# partition keys. Currently, dynamic partitioning is only supported for
|
1593
|
-
# Amazon S3 destinations.
|
1594
|
-
# [https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html][1]
|
1595
|
-
#
|
1596
|
-
#
|
1597
|
-
#
|
1598
|
-
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
|
2147
|
+
# Amazon S3 destinations.
|
1599
2148
|
#
|
1600
2149
|
# @note When making an API call, you may pass DynamicPartitioningConfiguration
|
1601
2150
|
# data as a hash:
|
@@ -1735,7 +2284,8 @@ module Aws::Firehose
|
|
1735
2284
|
# Kinesis Data Firehose for calling the Amazon ES Configuration API
|
1736
2285
|
# and for indexing documents. For more information, see [Grant Kinesis
|
1737
2286
|
# Data Firehose Access to an Amazon S3 Destination][1] and [Amazon
|
1738
|
-
# Resource Names (ARNs) and
|
2287
|
+
# Resource Names (ARNs) and Amazon Web Services Service
|
2288
|
+
# Namespaces][2].
|
1739
2289
|
#
|
1740
2290
|
#
|
1741
2291
|
#
|
@@ -1745,10 +2295,10 @@ module Aws::Firehose
|
|
1745
2295
|
#
|
1746
2296
|
# @!attribute [rw] domain_arn
|
1747
2297
|
# The ARN of the Amazon ES domain. The IAM role must have permissions
|
1748
|
-
# for `
|
1749
|
-
#
|
1750
|
-
#
|
1751
|
-
#
|
2298
|
+
# for `DescribeDomain`, `DescribeDomains`, and
|
2299
|
+
# `DescribeDomainConfig` after assuming the role specified in
|
2300
|
+
# **RoleARN**. For more information, see [Amazon Resource Names (ARNs)
|
2301
|
+
# and Amazon Web Services Service Namespaces][1].
|
1752
2302
|
#
|
1753
2303
|
# Specify either `ClusterEndpoint` or `DomainARN`.
|
1754
2304
|
#
|
@@ -1801,12 +2351,12 @@ module Aws::Firehose
|
|
1801
2351
|
# Defines how documents should be delivered to Amazon S3. When it is
|
1802
2352
|
# set to `FailedDocumentsOnly`, Kinesis Data Firehose writes any
|
1803
2353
|
# documents that could not be indexed to the configured Amazon S3
|
1804
|
-
# destination, with `
|
1805
|
-
# prefix. When set to `AllDocuments`, Kinesis Data Firehose
|
1806
|
-
# all incoming records to Amazon S3, and also writes failed
|
1807
|
-
# with `
|
1808
|
-
# information, see [Amazon S3 Backup for the Amazon
|
1809
|
-
# Destination][1]. Default value is `FailedDocumentsOnly`.
|
2354
|
+
# destination, with `AmazonOpenSearchService-failed/` appended to the
|
2355
|
+
# key prefix. When set to `AllDocuments`, Kinesis Data Firehose
|
2356
|
+
# delivers all incoming records to Amazon S3, and also writes failed
|
2357
|
+
# documents with `AmazonOpenSearchService-failed/` appended to the
|
2358
|
+
# prefix. For more information, see [Amazon S3 Backup for the Amazon
|
2359
|
+
# ES Destination][1]. Default value is `FailedDocumentsOnly`.
|
1810
2360
|
#
|
1811
2361
|
# You can't change this backup mode after you create the delivery
|
1812
2362
|
# stream.
|
@@ -1855,9 +2405,9 @@ module Aws::Firehose
|
|
1855
2405
|
# The destination description in Amazon ES.
|
1856
2406
|
#
|
1857
2407
|
# @!attribute [rw] role_arn
|
1858
|
-
# The Amazon Resource Name (ARN) of the
|
1859
|
-
# information, see [Amazon Resource Names (ARNs)
|
1860
|
-
# Namespaces][1].
|
2408
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
2409
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
2410
|
+
# and Amazon Web Services Service Namespaces][1].
|
1861
2411
|
#
|
1862
2412
|
#
|
1863
2413
|
#
|
@@ -1866,7 +2416,8 @@ module Aws::Firehose
|
|
1866
2416
|
#
|
1867
2417
|
# @!attribute [rw] domain_arn
|
1868
2418
|
# The ARN of the Amazon ES domain. For more information, see [Amazon
|
1869
|
-
# Resource Names (ARNs) and
|
2419
|
+
# Resource Names (ARNs) and Amazon Web Services Service
|
2420
|
+
# Namespaces][1].
|
1870
2421
|
#
|
1871
2422
|
# Kinesis Data Firehose uses either `ClusterEndpoint` or `DomainARN`
|
1872
2423
|
# to send data to Amazon ES.
|
@@ -1888,8 +2439,8 @@ module Aws::Firehose
|
|
1888
2439
|
#
|
1889
2440
|
# @!attribute [rw] type_name
|
1890
2441
|
# The Elasticsearch type name. This applies to Elasticsearch 6.x and
|
1891
|
-
# lower versions. For Elasticsearch 7.x
|
1892
|
-
# `TypeName`.
|
2442
|
+
# lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x,
|
2443
|
+
# there's no value for `TypeName`.
|
1893
2444
|
# @return [String]
|
1894
2445
|
#
|
1895
2446
|
# @!attribute [rw] index_rotation_period
|
@@ -2011,7 +2562,8 @@ module Aws::Firehose
|
|
2011
2562
|
# Kinesis Data Firehose for calling the Amazon ES Configuration API
|
2012
2563
|
# and for indexing documents. For more information, see [Grant Kinesis
|
2013
2564
|
# Data Firehose Access to an Amazon S3 Destination][1] and [Amazon
|
2014
|
-
# Resource Names (ARNs) and
|
2565
|
+
# Resource Names (ARNs) and Amazon Web Services Service
|
2566
|
+
# Namespaces][2].
|
2015
2567
|
#
|
2016
2568
|
#
|
2017
2569
|
#
|
@@ -2021,10 +2573,10 @@ module Aws::Firehose
|
|
2021
2573
|
#
|
2022
2574
|
# @!attribute [rw] domain_arn
|
2023
2575
|
# The ARN of the Amazon ES domain. The IAM role must have permissions
|
2024
|
-
# for `
|
2025
|
-
#
|
2026
|
-
#
|
2027
|
-
#
|
2576
|
+
# for `DescribeDomain`, `DescribeDomains`, and
|
2577
|
+
# `DescribeDomainConfig` after assuming the IAM role specified in
|
2578
|
+
# `RoleARN`. For more information, see [Amazon Resource Names (ARNs)
|
2579
|
+
# and Amazon Web Services Service Namespaces][1].
|
2028
2580
|
#
|
2029
2581
|
# Specify either `ClusterEndpoint` or `DomainARN`.
|
2030
2582
|
#
|
@@ -2284,9 +2836,9 @@ module Aws::Firehose
|
|
2284
2836
|
# }
|
2285
2837
|
#
|
2286
2838
|
# @!attribute [rw] role_arn
|
2287
|
-
# The Amazon Resource Name (ARN) of the
|
2288
|
-
# information, see [Amazon Resource Names (ARNs)
|
2289
|
-
# Namespaces][1].
|
2839
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
2840
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
2841
|
+
# and Amazon Web Services Service Namespaces][1].
|
2290
2842
|
#
|
2291
2843
|
#
|
2292
2844
|
#
|
@@ -2295,7 +2847,7 @@ module Aws::Firehose
|
|
2295
2847
|
#
|
2296
2848
|
# @!attribute [rw] bucket_arn
|
2297
2849
|
# The ARN of the S3 bucket. For more information, see [Amazon Resource
|
2298
|
-
# Names (ARNs) and
|
2850
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
2299
2851
|
#
|
2300
2852
|
#
|
2301
2853
|
#
|
@@ -2366,12 +2918,7 @@ module Aws::Firehose
|
|
2366
2918
|
# The configuration of the dynamic partitioning mechanism that creates
|
2367
2919
|
# smaller data sets from the streaming data by partitioning it based
|
2368
2920
|
# on partition keys. Currently, dynamic partitioning is only supported
|
2369
|
-
# for Amazon S3 destinations.
|
2370
|
-
# [https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html][1]
|
2371
|
-
#
|
2372
|
-
#
|
2373
|
-
#
|
2374
|
-
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
|
2921
|
+
# for Amazon S3 destinations.
|
2375
2922
|
# @return [Types::DynamicPartitioningConfiguration]
|
2376
2923
|
#
|
2377
2924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ExtendedS3DestinationConfiguration AWS API Documentation
|
@@ -2397,9 +2944,9 @@ module Aws::Firehose
|
|
2397
2944
|
# Describes a destination in Amazon S3.
|
2398
2945
|
#
|
2399
2946
|
# @!attribute [rw] role_arn
|
2400
|
-
# The Amazon Resource Name (ARN) of the
|
2401
|
-
# information, see [Amazon Resource Names (ARNs)
|
2402
|
-
# Namespaces][1].
|
2947
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
2948
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
2949
|
+
# and Amazon Web Services Service Namespaces][1].
|
2403
2950
|
#
|
2404
2951
|
#
|
2405
2952
|
#
|
@@ -2408,7 +2955,7 @@ module Aws::Firehose
|
|
2408
2955
|
#
|
2409
2956
|
# @!attribute [rw] bucket_arn
|
2410
2957
|
# The ARN of the S3 bucket. For more information, see [Amazon Resource
|
2411
|
-
# Names (ARNs) and
|
2958
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
2412
2959
|
#
|
2413
2960
|
#
|
2414
2961
|
#
|
@@ -2476,12 +3023,7 @@ module Aws::Firehose
|
|
2476
3023
|
# The configuration of the dynamic partitioning mechanism that creates
|
2477
3024
|
# smaller data sets from the streaming data by partitioning it based
|
2478
3025
|
# on partition keys. Currently, dynamic partitioning is only supported
|
2479
|
-
# for Amazon S3 destinations.
|
2480
|
-
# [https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html][1]
|
2481
|
-
#
|
2482
|
-
#
|
2483
|
-
#
|
2484
|
-
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
|
3026
|
+
# for Amazon S3 destinations.
|
2485
3027
|
# @return [Types::DynamicPartitioningConfiguration]
|
2486
3028
|
#
|
2487
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ExtendedS3DestinationDescription AWS API Documentation
|
@@ -2625,9 +3167,9 @@ module Aws::Firehose
|
|
2625
3167
|
# }
|
2626
3168
|
#
|
2627
3169
|
# @!attribute [rw] role_arn
|
2628
|
-
# The Amazon Resource Name (ARN) of the
|
2629
|
-
# information, see [Amazon Resource Names (ARNs)
|
2630
|
-
# Namespaces][1].
|
3170
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
3171
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
3172
|
+
# and Amazon Web Services Service Namespaces][1].
|
2631
3173
|
#
|
2632
3174
|
#
|
2633
3175
|
#
|
@@ -2636,7 +3178,7 @@ module Aws::Firehose
|
|
2636
3178
|
#
|
2637
3179
|
# @!attribute [rw] bucket_arn
|
2638
3180
|
# The ARN of the S3 bucket. For more information, see [Amazon Resource
|
2639
|
-
# Names (ARNs) and
|
3181
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
2640
3182
|
#
|
2641
3183
|
#
|
2642
3184
|
#
|
@@ -2706,12 +3248,7 @@ module Aws::Firehose
|
|
2706
3248
|
# The configuration of the dynamic partitioning mechanism that creates
|
2707
3249
|
# smaller data sets from the streaming data by partitioning it based
|
2708
3250
|
# on partition keys. Currently, dynamic partitioning is only supported
|
2709
|
-
# for Amazon S3 destinations.
|
2710
|
-
# [https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html][1]
|
2711
|
-
#
|
2712
|
-
#
|
2713
|
-
#
|
2714
|
-
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
|
3251
|
+
# for Amazon S3 destinations.
|
2715
3252
|
# @return [Types::DynamicPartitioningConfiguration]
|
2716
3253
|
#
|
2717
3254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ExtendedS3DestinationUpdate AWS API Documentation
|
@@ -3418,9 +3955,9 @@ module Aws::Firehose
|
|
3418
3955
|
#
|
3419
3956
|
# @!attribute [rw] awskms_key_arn
|
3420
3957
|
# The Amazon Resource Name (ARN) of the encryption key. Must belong to
|
3421
|
-
# the same
|
3422
|
-
# information, see [Amazon Resource Names (ARNs) and
|
3423
|
-
# Namespaces][1].
|
3958
|
+
# the same Amazon Web Services Region as the destination Amazon S3
|
3959
|
+
# bucket. For more information, see [Amazon Resource Names (ARNs) and
|
3960
|
+
# Amazon Web Services Service Namespaces][1].
|
3424
3961
|
#
|
3425
3962
|
#
|
3426
3963
|
#
|
@@ -3457,8 +3994,8 @@ module Aws::Firehose
|
|
3457
3994
|
#
|
3458
3995
|
# @!attribute [rw] role_arn
|
3459
3996
|
# The ARN of the role that provides access to the source Kinesis data
|
3460
|
-
# stream. For more information, see [
|
3461
|
-
# Management (IAM) ARN Format][1].
|
3997
|
+
# stream. For more information, see [Amazon Web Services Identity and
|
3998
|
+
# Access Management (IAM) ARN Format][1].
|
3462
3999
|
#
|
3463
4000
|
#
|
3464
4001
|
#
|
@@ -3489,8 +4026,8 @@ module Aws::Firehose
|
|
3489
4026
|
#
|
3490
4027
|
# @!attribute [rw] role_arn
|
3491
4028
|
# The ARN of the role used by the source Kinesis data stream. For more
|
3492
|
-
# information, see [
|
3493
|
-
# Format][1].
|
4029
|
+
# information, see [Amazon Web Services Identity and Access Management
|
4030
|
+
# (IAM) ARN Format][1].
|
3494
4031
|
#
|
3495
4032
|
#
|
3496
4033
|
#
|
@@ -3998,7 +4535,12 @@ module Aws::Firehose
|
|
3998
4535
|
# }
|
3999
4536
|
#
|
4000
4537
|
# @!attribute [rw] parameter_name
|
4001
|
-
# The name of the parameter.
|
4538
|
+
# The name of the parameter. Currently the following default values
|
4539
|
+
# are supported: 3 for `NumberOfRetries` and 60 for the
|
4540
|
+
# `BufferIntervalInSeconds`. The `BufferSizeInMBs` ranges between 0.2
|
4541
|
+
# MB and up to 3MB. The default buffering hint is 1MB for all
|
4542
|
+
# destinations, except Splunk. For Splunk, the default buffering hint
|
4543
|
+
# is 256 KB.
|
4002
4544
|
# @return [String]
|
4003
4545
|
#
|
4004
4546
|
# @!attribute [rw] parameter_value
|
@@ -4251,9 +4793,9 @@ module Aws::Firehose
|
|
4251
4793
|
# }
|
4252
4794
|
#
|
4253
4795
|
# @!attribute [rw] role_arn
|
4254
|
-
# The Amazon Resource Name (ARN) of the
|
4255
|
-
# information, see [Amazon Resource Names (ARNs)
|
4256
|
-
# Namespaces][1].
|
4796
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
4797
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
4798
|
+
# and Amazon Web Services Service Namespaces][1].
|
4257
4799
|
#
|
4258
4800
|
#
|
4259
4801
|
#
|
@@ -4333,9 +4875,9 @@ module Aws::Firehose
|
|
4333
4875
|
# Describes a destination in Amazon Redshift.
|
4334
4876
|
#
|
4335
4877
|
# @!attribute [rw] role_arn
|
4336
|
-
# The Amazon Resource Name (ARN) of the
|
4337
|
-
# information, see [Amazon Resource Names (ARNs)
|
4338
|
-
# Namespaces][1].
|
4878
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
4879
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
4880
|
+
# and Amazon Web Services Service Namespaces][1].
|
4339
4881
|
#
|
4340
4882
|
#
|
4341
4883
|
#
|
@@ -4482,9 +5024,9 @@ module Aws::Firehose
|
|
4482
5024
|
# }
|
4483
5025
|
#
|
4484
5026
|
# @!attribute [rw] role_arn
|
4485
|
-
# The Amazon Resource Name (ARN) of the
|
4486
|
-
# information, see [Amazon Resource Names (ARNs)
|
4487
|
-
# Namespaces][1].
|
5027
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
5028
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
5029
|
+
# and Amazon Web Services Service Namespaces][1].
|
4488
5030
|
#
|
4489
5031
|
#
|
4490
5032
|
#
|
@@ -4665,9 +5207,9 @@ module Aws::Firehose
|
|
4665
5207
|
# }
|
4666
5208
|
#
|
4667
5209
|
# @!attribute [rw] role_arn
|
4668
|
-
# The Amazon Resource Name (ARN) of the
|
4669
|
-
# information, see [Amazon Resource Names (ARNs)
|
4670
|
-
# Namespaces][1].
|
5210
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
5211
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
5212
|
+
# and Amazon Web Services Service Namespaces][1].
|
4671
5213
|
#
|
4672
5214
|
#
|
4673
5215
|
#
|
@@ -4676,7 +5218,7 @@ module Aws::Firehose
|
|
4676
5218
|
#
|
4677
5219
|
# @!attribute [rw] bucket_arn
|
4678
5220
|
# The ARN of the S3 bucket. For more information, see [Amazon Resource
|
4679
|
-
# Names (ARNs) and
|
5221
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
4680
5222
|
#
|
4681
5223
|
#
|
4682
5224
|
#
|
@@ -4745,9 +5287,9 @@ module Aws::Firehose
|
|
4745
5287
|
# Describes a destination in Amazon S3.
|
4746
5288
|
#
|
4747
5289
|
# @!attribute [rw] role_arn
|
4748
|
-
# The Amazon Resource Name (ARN) of the
|
4749
|
-
# information, see [Amazon Resource Names (ARNs)
|
4750
|
-
# Namespaces][1].
|
5290
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
5291
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
5292
|
+
# and Amazon Web Services Service Namespaces][1].
|
4751
5293
|
#
|
4752
5294
|
#
|
4753
5295
|
#
|
@@ -4756,7 +5298,7 @@ module Aws::Firehose
|
|
4756
5298
|
#
|
4757
5299
|
# @!attribute [rw] bucket_arn
|
4758
5300
|
# The ARN of the S3 bucket. For more information, see [Amazon Resource
|
4759
|
-
# Names (ARNs) and
|
5301
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
4760
5302
|
#
|
4761
5303
|
#
|
4762
5304
|
#
|
@@ -4847,9 +5389,9 @@ module Aws::Firehose
|
|
4847
5389
|
# }
|
4848
5390
|
#
|
4849
5391
|
# @!attribute [rw] role_arn
|
4850
|
-
# The Amazon Resource Name (ARN) of the
|
4851
|
-
# information, see [Amazon Resource Names (ARNs)
|
4852
|
-
# Namespaces][1].
|
5392
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
5393
|
+
# credentials. For more information, see [Amazon Resource Names (ARNs)
|
5394
|
+
# and Amazon Web Services Service Namespaces][1].
|
4853
5395
|
#
|
4854
5396
|
#
|
4855
5397
|
#
|
@@ -4858,7 +5400,7 @@ module Aws::Firehose
|
|
4858
5400
|
#
|
4859
5401
|
# @!attribute [rw] bucket_arn
|
4860
5402
|
# The ARN of the S3 bucket. For more information, see [Amazon Resource
|
4861
|
-
# Names (ARNs) and
|
5403
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][1].
|
4862
5404
|
#
|
4863
5405
|
#
|
4864
5406
|
#
|
@@ -4941,9 +5483,9 @@ module Aws::Firehose
|
|
4941
5483
|
# }
|
4942
5484
|
#
|
4943
5485
|
# @!attribute [rw] role_arn
|
4944
|
-
# The role that Kinesis Data Firehose can use to access
|
4945
|
-
# role must be in the same account you use for
|
4946
|
-
# Cross-account roles aren't allowed.
|
5486
|
+
# The role that Kinesis Data Firehose can use to access Amazon Web
|
5487
|
+
# Services Glue. This role must be in the same account you use for
|
5488
|
+
# Kinesis Data Firehose. Cross-account roles aren't allowed.
|
4947
5489
|
#
|
4948
5490
|
# If the `SchemaConfiguration` request parameter is used as part of
|
4949
5491
|
# invoking the `CreateDeliveryStream` API, then the `RoleARN` property
|
@@ -4951,13 +5493,13 @@ module Aws::Firehose
|
|
4951
5493
|
# @return [String]
|
4952
5494
|
#
|
4953
5495
|
# @!attribute [rw] catalog_id
|
4954
|
-
# The ID of the
|
4955
|
-
#
|
5496
|
+
# The ID of the Amazon Web Services Glue Data Catalog. If you don't
|
5497
|
+
# supply this, the Amazon Web Services account ID is used by default.
|
4956
5498
|
# @return [String]
|
4957
5499
|
#
|
4958
5500
|
# @!attribute [rw] database_name
|
4959
|
-
# Specifies the name of the
|
4960
|
-
# for the output data.
|
5501
|
+
# Specifies the name of the Amazon Web Services Glue database that
|
5502
|
+
# contains the schema for the output data.
|
4961
5503
|
#
|
4962
5504
|
# If the `SchemaConfiguration` request parameter is used as part of
|
4963
5505
|
# invoking the `CreateDeliveryStream` API, then the `DatabaseName`
|
@@ -4965,8 +5507,8 @@ module Aws::Firehose
|
|
4965
5507
|
# @return [String]
|
4966
5508
|
#
|
4967
5509
|
# @!attribute [rw] table_name
|
4968
|
-
# Specifies the
|
4969
|
-
# that constitutes your data schema.
|
5510
|
+
# Specifies the Amazon Web Services Glue table that contains the
|
5511
|
+
# column information that constitutes your data schema.
|
4970
5512
|
#
|
4971
5513
|
# If the `SchemaConfiguration` request parameter is used as part of
|
4972
5514
|
# invoking the `CreateDeliveryStream` API, then the `TableName`
|
@@ -4974,8 +5516,8 @@ module Aws::Firehose
|
|
4974
5516
|
# @return [String]
|
4975
5517
|
#
|
4976
5518
|
# @!attribute [rw] region
|
4977
|
-
# If you don't specify an
|
4978
|
-
# Region.
|
5519
|
+
# If you don't specify an Amazon Web Services Region, the default is
|
5520
|
+
# the current Region.
|
4979
5521
|
# @return [String]
|
4980
5522
|
#
|
4981
5523
|
# @!attribute [rw] version_id
|
@@ -6047,6 +6589,59 @@ module Aws::Firehose
|
|
6047
6589
|
# },
|
6048
6590
|
# },
|
6049
6591
|
# },
|
6592
|
+
# amazon_open_search_serverless_destination_update: {
|
6593
|
+
# role_arn: "RoleARN",
|
6594
|
+
# collection_endpoint: "AmazonOpenSearchServerlessCollectionEndpoint",
|
6595
|
+
# index_name: "AmazonOpenSearchServerlessIndexName",
|
6596
|
+
# buffering_hints: {
|
6597
|
+
# interval_in_seconds: 1,
|
6598
|
+
# size_in_m_bs: 1,
|
6599
|
+
# },
|
6600
|
+
# retry_options: {
|
6601
|
+
# duration_in_seconds: 1,
|
6602
|
+
# },
|
6603
|
+
# s3_update: {
|
6604
|
+
# role_arn: "RoleARN",
|
6605
|
+
# bucket_arn: "BucketARN",
|
6606
|
+
# prefix: "Prefix",
|
6607
|
+
# error_output_prefix: "ErrorOutputPrefix",
|
6608
|
+
# buffering_hints: {
|
6609
|
+
# size_in_m_bs: 1,
|
6610
|
+
# interval_in_seconds: 1,
|
6611
|
+
# },
|
6612
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
6613
|
+
# encryption_configuration: {
|
6614
|
+
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
6615
|
+
# kms_encryption_config: {
|
6616
|
+
# awskms_key_arn: "AWSKMSKeyARN", # required
|
6617
|
+
# },
|
6618
|
+
# },
|
6619
|
+
# cloud_watch_logging_options: {
|
6620
|
+
# enabled: false,
|
6621
|
+
# log_group_name: "LogGroupName",
|
6622
|
+
# log_stream_name: "LogStreamName",
|
6623
|
+
# },
|
6624
|
+
# },
|
6625
|
+
# processing_configuration: {
|
6626
|
+
# enabled: false,
|
6627
|
+
# processors: [
|
6628
|
+
# {
|
6629
|
+
# type: "RecordDeAggregation", # required, accepts RecordDeAggregation, Lambda, MetadataExtraction, AppendDelimiterToRecord
|
6630
|
+
# parameters: [
|
6631
|
+
# {
|
6632
|
+
# parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, MetadataExtractionQuery, JsonParsingEngine, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds, SubRecordType, Delimiter
|
6633
|
+
# parameter_value: "ProcessorParameterValue", # required
|
6634
|
+
# },
|
6635
|
+
# ],
|
6636
|
+
# },
|
6637
|
+
# ],
|
6638
|
+
# },
|
6639
|
+
# cloud_watch_logging_options: {
|
6640
|
+
# enabled: false,
|
6641
|
+
# log_group_name: "LogGroupName",
|
6642
|
+
# log_stream_name: "LogStreamName",
|
6643
|
+
# },
|
6644
|
+
# },
|
6050
6645
|
# }
|
6051
6646
|
#
|
6052
6647
|
# @!attribute [rw] delivery_stream_name
|
@@ -6084,6 +6679,7 @@ module Aws::Firehose
|
|
6084
6679
|
# @return [Types::ElasticsearchDestinationUpdate]
|
6085
6680
|
#
|
6086
6681
|
# @!attribute [rw] amazonopensearchservice_destination_update
|
6682
|
+
# Describes an update for a destination in Amazon OpenSearch Service.
|
6087
6683
|
# @return [Types::AmazonopensearchserviceDestinationUpdate]
|
6088
6684
|
#
|
6089
6685
|
# @!attribute [rw] splunk_destination_update
|
@@ -6094,6 +6690,11 @@ module Aws::Firehose
|
|
6094
6690
|
# Describes an update to the specified HTTP endpoint destination.
|
6095
6691
|
# @return [Types::HttpEndpointDestinationUpdate]
|
6096
6692
|
#
|
6693
|
+
# @!attribute [rw] amazon_open_search_serverless_destination_update
|
6694
|
+
# Describes an update for a destination in the Serverless offering for
|
6695
|
+
# Amazon OpenSearch Service.
|
6696
|
+
# @return [Types::AmazonOpenSearchServerlessDestinationUpdate]
|
6697
|
+
#
|
6097
6698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UpdateDestinationInput AWS API Documentation
|
6098
6699
|
#
|
6099
6700
|
class UpdateDestinationInput < Struct.new(
|
@@ -6106,7 +6707,8 @@ module Aws::Firehose
|
|
6106
6707
|
:elasticsearch_destination_update,
|
6107
6708
|
:amazonopensearchservice_destination_update,
|
6108
6709
|
:splunk_destination_update,
|
6109
|
-
:http_endpoint_destination_update
|
6710
|
+
:http_endpoint_destination_update,
|
6711
|
+
:amazon_open_search_serverless_destination_update)
|
6110
6712
|
SENSITIVE = []
|
6111
6713
|
include Aws::Structure
|
6112
6714
|
end
|