aws-sdk-firehose 1.23.0 → 1.28.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 +5 -5
- data/lib/aws-sdk-firehose.rb +7 -4
- data/lib/aws-sdk-firehose/client.rb +225 -73
- data/lib/aws-sdk-firehose/client_api.rb +49 -0
- data/lib/aws-sdk-firehose/errors.rb +48 -5
- data/lib/aws-sdk-firehose/resource.rb +1 -0
- data/lib/aws-sdk-firehose/types.rb +353 -44
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 5fe2646635a79bf2458e4454be0d70aaefae05715601e531f4f325b8fa9765ec
|
|
4
|
+
data.tar.gz: 18bca3eb1abeada3d0ae5be06e69c7d615f7bfee4658b90a18bf9a45ce35467d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: aa417e2202d0953d4e829f4b705a7747a8227168d05be0472421394342c34f810fdca5622f153ad8de0136890a3c672a7f1cda1a879b3262987aab444c9c739d
|
|
7
|
+
data.tar.gz: 239006a576e45ce76ed83ebd3c9fc260b316db3b44f32fc552043dc3e25925ca55b2708e8da3a9657c650e60e4f54334b192b078135b917f006a59810fbe89c6
|
data/lib/aws-sdk-firehose.rb
CHANGED
|
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-firehose/customizations'
|
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
|
25
25
|
# structure.
|
|
26
26
|
#
|
|
27
|
+
# firehose = Aws::Firehose::Client.new
|
|
28
|
+
# resp = firehose.create_delivery_stream(params)
|
|
29
|
+
#
|
|
27
30
|
# See {Client} for more information.
|
|
28
31
|
#
|
|
29
32
|
# # Errors
|
|
30
33
|
#
|
|
31
|
-
# Errors returned from Amazon Kinesis Firehose
|
|
32
|
-
# extend {Errors::ServiceError}.
|
|
34
|
+
# Errors returned from Amazon Kinesis Firehose are defined in the
|
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
|
33
36
|
#
|
|
34
37
|
# begin
|
|
35
38
|
# # do stuff
|
|
36
39
|
# rescue Aws::Firehose::Errors::ServiceError
|
|
37
|
-
# # rescues all
|
|
40
|
+
# # rescues all Amazon Kinesis Firehose API errors
|
|
38
41
|
# end
|
|
39
42
|
#
|
|
40
43
|
# See {Errors} for more information.
|
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-firehose/customizations'
|
|
|
42
45
|
# @service
|
|
43
46
|
module Aws::Firehose
|
|
44
47
|
|
|
45
|
-
GEM_VERSION = '1.
|
|
48
|
+
GEM_VERSION = '1.28.0'
|
|
46
49
|
|
|
47
50
|
end
|
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:firehose)
|
|
31
31
|
|
|
32
32
|
module Aws::Firehose
|
|
33
|
+
# An API client for Firehose. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
34
|
+
#
|
|
35
|
+
# client = Aws::Firehose::Client.new(
|
|
36
|
+
# region: region_name,
|
|
37
|
+
# credentials: credentials,
|
|
38
|
+
# # ...
|
|
39
|
+
# )
|
|
40
|
+
#
|
|
41
|
+
# For details on configuring region and credentials see
|
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
|
43
|
+
#
|
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
|
33
45
|
class Client < Seahorse::Client::Base
|
|
34
46
|
|
|
35
47
|
include Aws::ClientStubs
|
|
@@ -93,7 +105,7 @@ module Aws::Firehose
|
|
|
93
105
|
# @option options [required, String] :region
|
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
|
96
|
-
# a default `:region` is
|
|
108
|
+
# a default `:region` is searched for in the following locations:
|
|
97
109
|
#
|
|
98
110
|
# * `Aws.config[:region]`
|
|
99
111
|
# * `ENV['AWS_REGION']`
|
|
@@ -108,6 +120,12 @@ module Aws::Firehose
|
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
|
110
122
|
#
|
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
127
|
+
# not retry instead of sleeping.
|
|
128
|
+
#
|
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
|
113
131
|
# this client.
|
|
@@ -132,6 +150,10 @@ module Aws::Firehose
|
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
|
133
151
|
# the required types.
|
|
134
152
|
#
|
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
|
156
|
+
#
|
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
|
137
159
|
# to default service endpoint when available.
|
|
@@ -139,7 +161,7 @@ module Aws::Firehose
|
|
|
139
161
|
# @option options [String] :endpoint
|
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
|
142
|
-
# to test endpoints. This should be
|
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
|
143
165
|
#
|
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
@@ -154,7 +176,7 @@ module Aws::Firehose
|
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
|
155
177
|
#
|
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
158
180
|
#
|
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
160
182
|
# The log formatter.
|
|
@@ -166,15 +188,29 @@ module Aws::Firehose
|
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
|
167
189
|
# is not set, logging will be disabled.
|
|
168
190
|
#
|
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
|
193
|
+
# a single request, including the initial attempt. For example,
|
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
196
|
+
#
|
|
169
197
|
# @option options [String] :profile ("default")
|
|
170
198
|
# Used when loading credentials from the shared credentials file
|
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
172
200
|
#
|
|
201
|
+
# @option options [Proc] :retry_backoff
|
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
|
204
|
+
#
|
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
|
207
|
+
# is only used in the `legacy` retry mode.
|
|
175
208
|
#
|
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
|
213
|
+
# in the `legacy` retry mode.
|
|
178
214
|
#
|
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
|
180
216
|
#
|
|
@@ -182,11 +218,30 @@ module Aws::Firehose
|
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
|
185
|
-
# checksum errors, networking errors, timeout errors
|
|
186
|
-
# errors from expired credentials.
|
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
|
187
224
|
#
|
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
|
227
|
+
# used by the default backoff function. This option is only used in the
|
|
228
|
+
# `legacy` retry mode.
|
|
229
|
+
#
|
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
|
232
|
+
#
|
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
|
234
|
+
# no retry mode is provided.
|
|
235
|
+
#
|
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
|
238
|
+
# unsuccessful retries a client can make.
|
|
239
|
+
#
|
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
|
243
|
+
# in the future.
|
|
244
|
+
#
|
|
190
245
|
#
|
|
191
246
|
# @option options [String] :secret_access_key
|
|
192
247
|
#
|
|
@@ -219,16 +274,15 @@ module Aws::Firehose
|
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
|
220
275
|
#
|
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
|
222
|
-
# seconds to wait when opening a HTTP session before
|
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
|
223
278
|
# `Timeout::Error`.
|
|
224
279
|
#
|
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
|
226
281
|
# number of seconds to wait for response data. This value can
|
|
227
|
-
# safely be set
|
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
|
282
|
+
# safely be set per-request on the session.
|
|
229
283
|
#
|
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
|
231
|
-
# seconds a connection is allowed to sit
|
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
|
232
286
|
# considered stale. Stale connections are closed and removed
|
|
233
287
|
# from the pool before making a request.
|
|
234
288
|
#
|
|
@@ -237,7 +291,7 @@ module Aws::Firehose
|
|
|
237
291
|
# request body. This option has no effect unless the request has
|
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
|
239
293
|
# disables this behaviour. This value can safely be set per
|
|
240
|
-
# request on the session
|
|
294
|
+
# request on the session.
|
|
241
295
|
#
|
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
|
@@ -271,9 +325,15 @@ module Aws::Firehose
|
|
|
271
325
|
# This is an asynchronous operation that immediately returns. The
|
|
272
326
|
# initial status of the delivery stream is `CREATING`. After the
|
|
273
327
|
# delivery stream is created, its status is `ACTIVE` and it now accepts
|
|
274
|
-
# data.
|
|
275
|
-
# `
|
|
276
|
-
#
|
|
328
|
+
# data. If the delivery stream creation fails, the status transitions to
|
|
329
|
+
# `CREATING_FAILED`. Attempts to send data to a delivery stream that is
|
|
330
|
+
# not in the `ACTIVE` state cause an exception. To check the state of a
|
|
331
|
+
# delivery stream, use DescribeDeliveryStream.
|
|
332
|
+
#
|
|
333
|
+
# If the status of a delivery stream is `CREATING_FAILED`, this status
|
|
334
|
+
# doesn't change, and you can't invoke `CreateDeliveryStream` again on
|
|
335
|
+
# it. However, you can invoke the DeleteDeliveryStream operation to
|
|
336
|
+
# delete it.
|
|
277
337
|
#
|
|
278
338
|
# A Kinesis Data Firehose delivery stream can be configured to receive
|
|
279
339
|
# records directly from providers using PutRecord or PutRecordBatch, or
|
|
@@ -283,6 +343,12 @@ module Aws::Firehose
|
|
|
283
343
|
# the Kinesis stream Amazon Resource Name (ARN) and role ARN in the
|
|
284
344
|
# `KinesisStreamSourceConfiguration` parameter.
|
|
285
345
|
#
|
|
346
|
+
# To create a delivery stream with server-side encryption (SSE) enabled,
|
|
347
|
+
# include DeliveryStreamEncryptionConfigurationInput in your request.
|
|
348
|
+
# This is optional. You can also invoke StartDeliveryStreamEncryption to
|
|
349
|
+
# turn on SSE for an existing delivery stream that doesn't have SSE
|
|
350
|
+
# enabled.
|
|
351
|
+
#
|
|
286
352
|
# A delivery stream is configured with a single destination: Amazon S3,
|
|
287
353
|
# Amazon ES, Amazon Redshift, or Splunk. You must specify only one of
|
|
288
354
|
# the following destination configuration parameters:
|
|
@@ -354,6 +420,10 @@ module Aws::Firehose
|
|
|
354
420
|
# stream Amazon Resource Name (ARN) and the role ARN for the source
|
|
355
421
|
# stream.
|
|
356
422
|
#
|
|
423
|
+
# @option params [Types::DeliveryStreamEncryptionConfigurationInput] :delivery_stream_encryption_configuration_input
|
|
424
|
+
# Used to specify the type and Amazon Resource Name (ARN) of the KMS key
|
|
425
|
+
# needed for Server-Side Encryption (SSE).
|
|
426
|
+
#
|
|
357
427
|
# @option params [Types::S3DestinationConfiguration] :s3_destination_configuration
|
|
358
428
|
# \[Deprecated\] The destination in Amazon S3. You can specify only one
|
|
359
429
|
# destination.
|
|
@@ -398,6 +468,10 @@ module Aws::Firehose
|
|
|
398
468
|
# kinesis_stream_arn: "KinesisStreamARN", # required
|
|
399
469
|
# role_arn: "RoleARN", # required
|
|
400
470
|
# },
|
|
471
|
+
# delivery_stream_encryption_configuration_input: {
|
|
472
|
+
# key_arn: "AWSKMSKeyARN",
|
|
473
|
+
# key_type: "AWS_OWNED_CMK", # required, accepts AWS_OWNED_CMK, CUSTOMER_MANAGED_CMK
|
|
474
|
+
# },
|
|
401
475
|
# s3_destination_configuration: {
|
|
402
476
|
# role_arn: "RoleARN", # required
|
|
403
477
|
# bucket_arn: "BucketARN", # required
|
|
@@ -407,7 +481,7 @@ module Aws::Firehose
|
|
|
407
481
|
# size_in_m_bs: 1,
|
|
408
482
|
# interval_in_seconds: 1,
|
|
409
483
|
# },
|
|
410
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
484
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
411
485
|
# encryption_configuration: {
|
|
412
486
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
413
487
|
# kms_encryption_config: {
|
|
@@ -429,7 +503,7 @@ module Aws::Firehose
|
|
|
429
503
|
# size_in_m_bs: 1,
|
|
430
504
|
# interval_in_seconds: 1,
|
|
431
505
|
# },
|
|
432
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
506
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
433
507
|
# encryption_configuration: {
|
|
434
508
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
435
509
|
# kms_encryption_config: {
|
|
@@ -465,7 +539,7 @@ module Aws::Firehose
|
|
|
465
539
|
# size_in_m_bs: 1,
|
|
466
540
|
# interval_in_seconds: 1,
|
|
467
541
|
# },
|
|
468
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
542
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
469
543
|
# encryption_configuration: {
|
|
470
544
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
471
545
|
# kms_encryption_config: {
|
|
@@ -550,7 +624,7 @@ module Aws::Firehose
|
|
|
550
624
|
# size_in_m_bs: 1,
|
|
551
625
|
# interval_in_seconds: 1,
|
|
552
626
|
# },
|
|
553
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
627
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
554
628
|
# encryption_configuration: {
|
|
555
629
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
556
630
|
# kms_encryption_config: {
|
|
@@ -587,7 +661,7 @@ module Aws::Firehose
|
|
|
587
661
|
# size_in_m_bs: 1,
|
|
588
662
|
# interval_in_seconds: 1,
|
|
589
663
|
# },
|
|
590
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
664
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
591
665
|
# encryption_configuration: {
|
|
592
666
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
593
667
|
# kms_encryption_config: {
|
|
@@ -630,7 +704,7 @@ module Aws::Firehose
|
|
|
630
704
|
# size_in_m_bs: 1,
|
|
631
705
|
# interval_in_seconds: 1,
|
|
632
706
|
# },
|
|
633
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
707
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
634
708
|
# encryption_configuration: {
|
|
635
709
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
636
710
|
# kms_encryption_config: {
|
|
@@ -662,6 +736,11 @@ module Aws::Firehose
|
|
|
662
736
|
# log_group_name: "LogGroupName",
|
|
663
737
|
# log_stream_name: "LogStreamName",
|
|
664
738
|
# },
|
|
739
|
+
# vpc_configuration: {
|
|
740
|
+
# subnet_ids: ["NonEmptyStringWithoutWhitespace"], # required
|
|
741
|
+
# role_arn: "RoleARN", # required
|
|
742
|
+
# security_group_ids: ["NonEmptyStringWithoutWhitespace"], # required
|
|
743
|
+
# },
|
|
665
744
|
# },
|
|
666
745
|
# splunk_destination_configuration: {
|
|
667
746
|
# hec_endpoint: "HECEndpoint", # required
|
|
@@ -681,7 +760,7 @@ module Aws::Firehose
|
|
|
681
760
|
# size_in_m_bs: 1,
|
|
682
761
|
# interval_in_seconds: 1,
|
|
683
762
|
# },
|
|
684
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
763
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
685
764
|
# encryption_configuration: {
|
|
686
765
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
687
766
|
# kms_encryption_config: {
|
|
@@ -737,27 +816,45 @@ module Aws::Firehose
|
|
|
737
816
|
|
|
738
817
|
# Deletes a delivery stream and its data.
|
|
739
818
|
#
|
|
740
|
-
# You can delete a delivery stream only if it is in `ACTIVE` or
|
|
741
|
-
# `DELETING` state, and not in the `CREATING` state. While the deletion
|
|
742
|
-
# request is in process, the delivery stream is in the `DELETING` state.
|
|
743
|
-
#
|
|
744
819
|
# To check the state of a delivery stream, use DescribeDeliveryStream.
|
|
745
|
-
#
|
|
746
|
-
#
|
|
747
|
-
#
|
|
820
|
+
# You can delete a delivery stream only if it is in one of the following
|
|
821
|
+
# states: `ACTIVE`, `DELETING`, `CREATING_FAILED`, or `DELETING_FAILED`.
|
|
822
|
+
# You can't delete a delivery stream that is in the `CREATING` state.
|
|
823
|
+
# While the deletion request is in process, the delivery stream is in
|
|
824
|
+
# the `DELETING` state.
|
|
825
|
+
#
|
|
826
|
+
# While the delivery stream is in the `DELETING` state, the service
|
|
827
|
+
# might continue to accept records, but it doesn't make any guarantees
|
|
748
828
|
# with respect to delivering the data. Therefore, as a best practice,
|
|
749
|
-
#
|
|
750
|
-
#
|
|
829
|
+
# first stop any applications that are sending records before you delete
|
|
830
|
+
# a delivery stream.
|
|
751
831
|
#
|
|
752
832
|
# @option params [required, String] :delivery_stream_name
|
|
753
833
|
# The name of the delivery stream.
|
|
754
834
|
#
|
|
835
|
+
# @option params [Boolean] :allow_force_delete
|
|
836
|
+
# Set this to true if you want to delete the delivery stream even if
|
|
837
|
+
# Kinesis Data Firehose is unable to retire the grant for the CMK.
|
|
838
|
+
# Kinesis Data Firehose might be unable to retire the grant due to a
|
|
839
|
+
# customer error, such as when the CMK or the grant are in an invalid
|
|
840
|
+
# state. If you force deletion, you can then use the [RevokeGrant][1]
|
|
841
|
+
# operation to revoke the grant you gave to Kinesis Data Firehose. If a
|
|
842
|
+
# failure to retire the grant happens due to an AWS KMS issue, Kinesis
|
|
843
|
+
# Data Firehose keeps retrying the delete operation.
|
|
844
|
+
#
|
|
845
|
+
# The default value is false.
|
|
846
|
+
#
|
|
847
|
+
#
|
|
848
|
+
#
|
|
849
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html
|
|
850
|
+
#
|
|
755
851
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
756
852
|
#
|
|
757
853
|
# @example Request syntax with placeholder values
|
|
758
854
|
#
|
|
759
855
|
# resp = client.delete_delivery_stream({
|
|
760
856
|
# delivery_stream_name: "DeliveryStreamName", # required
|
|
857
|
+
# allow_force_delete: false,
|
|
761
858
|
# })
|
|
762
859
|
#
|
|
763
860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DeleteDeliveryStream AWS API Documentation
|
|
@@ -769,10 +866,17 @@ module Aws::Firehose
|
|
|
769
866
|
req.send_request(options)
|
|
770
867
|
end
|
|
771
868
|
|
|
772
|
-
# Describes the specified delivery stream and
|
|
773
|
-
#
|
|
774
|
-
#
|
|
775
|
-
#
|
|
869
|
+
# Describes the specified delivery stream and its status. For example,
|
|
870
|
+
# after your delivery stream is created, call `DescribeDeliveryStream`
|
|
871
|
+
# to see whether the delivery stream is `ACTIVE` and therefore ready for
|
|
872
|
+
# data to be sent to it.
|
|
873
|
+
#
|
|
874
|
+
# If the status of a delivery stream is `CREATING_FAILED`, this status
|
|
875
|
+
# doesn't change, and you can't invoke CreateDeliveryStream again on
|
|
876
|
+
# it. However, you can invoke the DeleteDeliveryStream operation to
|
|
877
|
+
# delete it. If the status is `DELETING_FAILED`, you can force deletion
|
|
878
|
+
# by invoking DeleteDeliveryStream again but with
|
|
879
|
+
# DeleteDeliveryStreamInput$AllowForceDelete set to true.
|
|
776
880
|
#
|
|
777
881
|
# @option params [required, String] :delivery_stream_name
|
|
778
882
|
# The name of the delivery stream.
|
|
@@ -802,8 +906,14 @@ module Aws::Firehose
|
|
|
802
906
|
#
|
|
803
907
|
# resp.delivery_stream_description.delivery_stream_name #=> String
|
|
804
908
|
# resp.delivery_stream_description.delivery_stream_arn #=> String
|
|
805
|
-
# resp.delivery_stream_description.delivery_stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE"
|
|
806
|
-
# resp.delivery_stream_description.
|
|
909
|
+
# resp.delivery_stream_description.delivery_stream_status #=> String, one of "CREATING", "CREATING_FAILED", "DELETING", "DELETING_FAILED", "ACTIVE"
|
|
910
|
+
# resp.delivery_stream_description.failure_description.type #=> String, one of "RETIRE_KMS_GRANT_FAILED", "CREATE_KMS_GRANT_FAILED", "KMS_ACCESS_DENIED", "DISABLED_KMS_KEY", "INVALID_KMS_KEY", "KMS_KEY_NOT_FOUND", "KMS_OPT_IN_REQUIRED", "CREATE_ENI_FAILED", "DELETE_ENI_FAILED", "SUBNET_NOT_FOUND", "SECURITY_GROUP_NOT_FOUND", "ENI_ACCESS_DENIED", "SUBNET_ACCESS_DENIED", "SECURITY_GROUP_ACCESS_DENIED", "UNKNOWN_ERROR"
|
|
911
|
+
# resp.delivery_stream_description.failure_description.details #=> String
|
|
912
|
+
# resp.delivery_stream_description.delivery_stream_encryption_configuration.key_arn #=> String
|
|
913
|
+
# resp.delivery_stream_description.delivery_stream_encryption_configuration.key_type #=> String, one of "AWS_OWNED_CMK", "CUSTOMER_MANAGED_CMK"
|
|
914
|
+
# resp.delivery_stream_description.delivery_stream_encryption_configuration.status #=> String, one of "ENABLED", "ENABLING", "ENABLING_FAILED", "DISABLED", "DISABLING", "DISABLING_FAILED"
|
|
915
|
+
# resp.delivery_stream_description.delivery_stream_encryption_configuration.failure_description.type #=> String, one of "RETIRE_KMS_GRANT_FAILED", "CREATE_KMS_GRANT_FAILED", "KMS_ACCESS_DENIED", "DISABLED_KMS_KEY", "INVALID_KMS_KEY", "KMS_KEY_NOT_FOUND", "KMS_OPT_IN_REQUIRED", "CREATE_ENI_FAILED", "DELETE_ENI_FAILED", "SUBNET_NOT_FOUND", "SECURITY_GROUP_NOT_FOUND", "ENI_ACCESS_DENIED", "SUBNET_ACCESS_DENIED", "SECURITY_GROUP_ACCESS_DENIED", "UNKNOWN_ERROR"
|
|
916
|
+
# resp.delivery_stream_description.delivery_stream_encryption_configuration.failure_description.details #=> String
|
|
807
917
|
# resp.delivery_stream_description.delivery_stream_type #=> String, one of "DirectPut", "KinesisStreamAsSource"
|
|
808
918
|
# resp.delivery_stream_description.version_id #=> String
|
|
809
919
|
# resp.delivery_stream_description.create_timestamp #=> Time
|
|
@@ -819,7 +929,7 @@ module Aws::Firehose
|
|
|
819
929
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.error_output_prefix #=> String
|
|
820
930
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.buffering_hints.size_in_m_bs #=> Integer
|
|
821
931
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.buffering_hints.interval_in_seconds #=> Integer
|
|
822
|
-
# resp.delivery_stream_description.destinations[0].s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
932
|
+
# resp.delivery_stream_description.destinations[0].s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
823
933
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
824
934
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
825
935
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -831,7 +941,7 @@ module Aws::Firehose
|
|
|
831
941
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.error_output_prefix #=> String
|
|
832
942
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.buffering_hints.size_in_m_bs #=> Integer
|
|
833
943
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.buffering_hints.interval_in_seconds #=> Integer
|
|
834
|
-
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
944
|
+
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
835
945
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
836
946
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
837
947
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -850,7 +960,7 @@ module Aws::Firehose
|
|
|
850
960
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.error_output_prefix #=> String
|
|
851
961
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.buffering_hints.size_in_m_bs #=> Integer
|
|
852
962
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.buffering_hints.interval_in_seconds #=> Integer
|
|
853
|
-
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
963
|
+
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
854
964
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
855
965
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
856
966
|
# resp.delivery_stream_description.destinations[0].extended_s3_destination_description.s3_backup_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -899,7 +1009,7 @@ module Aws::Firehose
|
|
|
899
1009
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.error_output_prefix #=> String
|
|
900
1010
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.buffering_hints.size_in_m_bs #=> Integer
|
|
901
1011
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.buffering_hints.interval_in_seconds #=> Integer
|
|
902
|
-
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
1012
|
+
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
903
1013
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
904
1014
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
905
1015
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -918,7 +1028,7 @@ module Aws::Firehose
|
|
|
918
1028
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.error_output_prefix #=> String
|
|
919
1029
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.buffering_hints.size_in_m_bs #=> Integer
|
|
920
1030
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.buffering_hints.interval_in_seconds #=> Integer
|
|
921
|
-
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
1031
|
+
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
922
1032
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
923
1033
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
924
1034
|
# resp.delivery_stream_description.destinations[0].redshift_destination_description.s3_backup_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -943,7 +1053,7 @@ module Aws::Firehose
|
|
|
943
1053
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.error_output_prefix #=> String
|
|
944
1054
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.buffering_hints.size_in_m_bs #=> Integer
|
|
945
1055
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.buffering_hints.interval_in_seconds #=> Integer
|
|
946
|
-
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
1056
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
947
1057
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
948
1058
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
949
1059
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.s3_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -958,6 +1068,12 @@ module Aws::Firehose
|
|
|
958
1068
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
959
1069
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.cloud_watch_logging_options.log_group_name #=> String
|
|
960
1070
|
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.cloud_watch_logging_options.log_stream_name #=> String
|
|
1071
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.vpc_configuration_description.subnet_ids #=> Array
|
|
1072
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.vpc_configuration_description.subnet_ids[0] #=> String
|
|
1073
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.vpc_configuration_description.role_arn #=> String
|
|
1074
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.vpc_configuration_description.security_group_ids #=> Array
|
|
1075
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.vpc_configuration_description.security_group_ids[0] #=> String
|
|
1076
|
+
# resp.delivery_stream_description.destinations[0].elasticsearch_destination_description.vpc_configuration_description.vpc_id #=> String
|
|
961
1077
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.hec_endpoint #=> String
|
|
962
1078
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.hec_endpoint_type #=> String, one of "Raw", "Event"
|
|
963
1079
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.hec_token #=> String
|
|
@@ -970,7 +1086,7 @@ module Aws::Firehose
|
|
|
970
1086
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.error_output_prefix #=> String
|
|
971
1087
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.buffering_hints.size_in_m_bs #=> Integer
|
|
972
1088
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.buffering_hints.interval_in_seconds #=> Integer
|
|
973
|
-
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy"
|
|
1089
|
+
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.compression_format #=> String, one of "UNCOMPRESSED", "GZIP", "ZIP", "Snappy", "HADOOP_SNAPPY"
|
|
974
1090
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.encryption_configuration.no_encryption_config #=> String, one of "NoEncryption"
|
|
975
1091
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn #=> String
|
|
976
1092
|
# resp.delivery_stream_description.destinations[0].splunk_destination_description.s3_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
|
@@ -1302,21 +1418,44 @@ module Aws::Firehose
|
|
|
1302
1418
|
# Enables server-side encryption (SSE) for the delivery stream.
|
|
1303
1419
|
#
|
|
1304
1420
|
# This operation is asynchronous. It returns immediately. When you
|
|
1305
|
-
# invoke it, Kinesis Data Firehose first sets the status of
|
|
1306
|
-
# to `ENABLING`, and then to `ENABLED`.
|
|
1307
|
-
#
|
|
1308
|
-
#
|
|
1309
|
-
# status changes to `
|
|
1310
|
-
#
|
|
1311
|
-
#
|
|
1312
|
-
#
|
|
1313
|
-
#
|
|
1314
|
-
#
|
|
1315
|
-
#
|
|
1421
|
+
# invoke it, Kinesis Data Firehose first sets the encryption status of
|
|
1422
|
+
# the stream to `ENABLING`, and then to `ENABLED`. The encryption status
|
|
1423
|
+
# of a delivery stream is the `Status` property in
|
|
1424
|
+
# DeliveryStreamEncryptionConfiguration. If the operation fails, the
|
|
1425
|
+
# encryption status changes to `ENABLING_FAILED`. You can continue to
|
|
1426
|
+
# read and write data to your delivery stream while the encryption
|
|
1427
|
+
# status is `ENABLING`, but the data is not encrypted. It can take up to
|
|
1428
|
+
# 5 seconds after the encryption status changes to `ENABLED` before all
|
|
1429
|
+
# records written to the delivery stream are encrypted. To find out
|
|
1430
|
+
# whether a record or a batch of records was encrypted, check the
|
|
1431
|
+
# response elements PutRecordOutput$Encrypted and
|
|
1432
|
+
# PutRecordBatchOutput$Encrypted, respectively.
|
|
1433
|
+
#
|
|
1434
|
+
# To check the encryption status of a delivery stream, use
|
|
1316
1435
|
# DescribeDeliveryStream.
|
|
1317
1436
|
#
|
|
1318
|
-
#
|
|
1319
|
-
#
|
|
1437
|
+
# Even if encryption is currently enabled for a delivery stream, you can
|
|
1438
|
+
# still invoke this operation on it to change the ARN of the CMK or both
|
|
1439
|
+
# its type and ARN. If you invoke this method to change the CMK, and the
|
|
1440
|
+
# old CMK is of type `CUSTOMER_MANAGED_CMK`, Kinesis Data Firehose
|
|
1441
|
+
# schedules the grant it had on the old CMK for retirement. If the new
|
|
1442
|
+
# CMK is of type `CUSTOMER_MANAGED_CMK`, Kinesis Data Firehose creates a
|
|
1443
|
+
# grant that enables it to use the new CMK to encrypt and decrypt data
|
|
1444
|
+
# and to manage the grant.
|
|
1445
|
+
#
|
|
1446
|
+
# If a delivery stream already has encryption enabled and then you
|
|
1447
|
+
# invoke this operation to change the ARN of the CMK or both its type
|
|
1448
|
+
# and ARN and you get `ENABLING_FAILED`, this only means that the
|
|
1449
|
+
# attempt to change the CMK failed. In this case, encryption remains
|
|
1450
|
+
# enabled with the old CMK.
|
|
1451
|
+
#
|
|
1452
|
+
# If the encryption status of your delivery stream is `ENABLING_FAILED`,
|
|
1453
|
+
# you can invoke this operation again with a valid CMK. The CMK must be
|
|
1454
|
+
# enabled and the key policy mustn't explicitly deny the permission for
|
|
1455
|
+
# Kinesis Data Firehose to invoke KMS encrypt and decrypt operations.
|
|
1456
|
+
#
|
|
1457
|
+
# You can enable SSE for a delivery stream only if it's a delivery
|
|
1458
|
+
# stream that uses `DirectPut` as its source.
|
|
1320
1459
|
#
|
|
1321
1460
|
# The `StartDeliveryStreamEncryption` and `StopDeliveryStreamEncryption`
|
|
1322
1461
|
# operations have a combined limit of 25 calls per delivery stream per
|
|
@@ -1329,12 +1468,20 @@ module Aws::Firehose
|
|
|
1329
1468
|
# The name of the delivery stream for which you want to enable
|
|
1330
1469
|
# server-side encryption (SSE).
|
|
1331
1470
|
#
|
|
1471
|
+
# @option params [Types::DeliveryStreamEncryptionConfigurationInput] :delivery_stream_encryption_configuration_input
|
|
1472
|
+
# Used to specify the type and Amazon Resource Name (ARN) of the KMS key
|
|
1473
|
+
# needed for Server-Side Encryption (SSE).
|
|
1474
|
+
#
|
|
1332
1475
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1333
1476
|
#
|
|
1334
1477
|
# @example Request syntax with placeholder values
|
|
1335
1478
|
#
|
|
1336
1479
|
# resp = client.start_delivery_stream_encryption({
|
|
1337
1480
|
# delivery_stream_name: "DeliveryStreamName", # required
|
|
1481
|
+
# delivery_stream_encryption_configuration_input: {
|
|
1482
|
+
# key_arn: "AWSKMSKeyARN",
|
|
1483
|
+
# key_type: "AWS_OWNED_CMK", # required, accepts AWS_OWNED_CMK, CUSTOMER_MANAGED_CMK
|
|
1484
|
+
# },
|
|
1338
1485
|
# })
|
|
1339
1486
|
#
|
|
1340
1487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/StartDeliveryStreamEncryption AWS API Documentation
|
|
@@ -1349,19 +1496,24 @@ module Aws::Firehose
|
|
|
1349
1496
|
# Disables server-side encryption (SSE) for the delivery stream.
|
|
1350
1497
|
#
|
|
1351
1498
|
# This operation is asynchronous. It returns immediately. When you
|
|
1352
|
-
# invoke it, Kinesis Data Firehose first sets the status of
|
|
1353
|
-
# to `DISABLING`, and then to `DISABLED`. You can continue to
|
|
1354
|
-
# write data to your stream while its status is `DISABLING`. It
|
|
1355
|
-
# up to 5 seconds after the encryption status changes to
|
|
1356
|
-
# before all records written to the delivery stream are no
|
|
1357
|
-
# subject to encryption. To find out whether a record or a batch
|
|
1358
|
-
# records was encrypted, check the response elements
|
|
1499
|
+
# invoke it, Kinesis Data Firehose first sets the encryption status of
|
|
1500
|
+
# the stream to `DISABLING`, and then to `DISABLED`. You can continue to
|
|
1501
|
+
# read and write data to your stream while its status is `DISABLING`. It
|
|
1502
|
+
# can take up to 5 seconds after the encryption status changes to
|
|
1503
|
+
# `DISABLED` before all records written to the delivery stream are no
|
|
1504
|
+
# longer subject to encryption. To find out whether a record or a batch
|
|
1505
|
+
# of records was encrypted, check the response elements
|
|
1359
1506
|
# PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted,
|
|
1360
1507
|
# respectively.
|
|
1361
1508
|
#
|
|
1362
1509
|
# To check the encryption state of a delivery stream, use
|
|
1363
1510
|
# DescribeDeliveryStream.
|
|
1364
1511
|
#
|
|
1512
|
+
# If SSE is enabled using a customer managed CMK and then you invoke
|
|
1513
|
+
# `StopDeliveryStreamEncryption`, Kinesis Data Firehose schedules the
|
|
1514
|
+
# related KMS grant for retirement and then retires it after it ensures
|
|
1515
|
+
# that it is finished delivering records to the destination.
|
|
1516
|
+
#
|
|
1365
1517
|
# The `StartDeliveryStreamEncryption` and `StopDeliveryStreamEncryption`
|
|
1366
1518
|
# operations have a combined limit of 25 calls per delivery stream per
|
|
1367
1519
|
# 24 hours. For example, you reach the limit if you call
|
|
@@ -1554,7 +1706,7 @@ module Aws::Firehose
|
|
|
1554
1706
|
# size_in_m_bs: 1,
|
|
1555
1707
|
# interval_in_seconds: 1,
|
|
1556
1708
|
# },
|
|
1557
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1709
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1558
1710
|
# encryption_configuration: {
|
|
1559
1711
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1560
1712
|
# kms_encryption_config: {
|
|
@@ -1576,7 +1728,7 @@ module Aws::Firehose
|
|
|
1576
1728
|
# size_in_m_bs: 1,
|
|
1577
1729
|
# interval_in_seconds: 1,
|
|
1578
1730
|
# },
|
|
1579
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1731
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1580
1732
|
# encryption_configuration: {
|
|
1581
1733
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1582
1734
|
# kms_encryption_config: {
|
|
@@ -1612,7 +1764,7 @@ module Aws::Firehose
|
|
|
1612
1764
|
# size_in_m_bs: 1,
|
|
1613
1765
|
# interval_in_seconds: 1,
|
|
1614
1766
|
# },
|
|
1615
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1767
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1616
1768
|
# encryption_configuration: {
|
|
1617
1769
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1618
1770
|
# kms_encryption_config: {
|
|
@@ -1697,7 +1849,7 @@ module Aws::Firehose
|
|
|
1697
1849
|
# size_in_m_bs: 1,
|
|
1698
1850
|
# interval_in_seconds: 1,
|
|
1699
1851
|
# },
|
|
1700
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1852
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1701
1853
|
# encryption_configuration: {
|
|
1702
1854
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1703
1855
|
# kms_encryption_config: {
|
|
@@ -1734,7 +1886,7 @@ module Aws::Firehose
|
|
|
1734
1886
|
# size_in_m_bs: 1,
|
|
1735
1887
|
# interval_in_seconds: 1,
|
|
1736
1888
|
# },
|
|
1737
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1889
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1738
1890
|
# encryption_configuration: {
|
|
1739
1891
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1740
1892
|
# kms_encryption_config: {
|
|
@@ -1776,7 +1928,7 @@ module Aws::Firehose
|
|
|
1776
1928
|
# size_in_m_bs: 1,
|
|
1777
1929
|
# interval_in_seconds: 1,
|
|
1778
1930
|
# },
|
|
1779
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1931
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1780
1932
|
# encryption_configuration: {
|
|
1781
1933
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1782
1934
|
# kms_encryption_config: {
|
|
@@ -1827,7 +1979,7 @@ module Aws::Firehose
|
|
|
1827
1979
|
# size_in_m_bs: 1,
|
|
1828
1980
|
# interval_in_seconds: 1,
|
|
1829
1981
|
# },
|
|
1830
|
-
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
|
|
1982
|
+
# compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
|
|
1831
1983
|
# encryption_configuration: {
|
|
1832
1984
|
# no_encryption_config: "NoEncryption", # accepts NoEncryption
|
|
1833
1985
|
# kms_encryption_config: {
|
|
@@ -1884,7 +2036,7 @@ module Aws::Firehose
|
|
|
1884
2036
|
params: params,
|
|
1885
2037
|
config: config)
|
|
1886
2038
|
context[:gem_name] = 'aws-sdk-firehose'
|
|
1887
|
-
context[:gem_version] = '1.
|
|
2039
|
+
context[:gem_version] = '1.28.0'
|
|
1888
2040
|
Seahorse::Client::Request.new(handlers, context)
|
|
1889
2041
|
end
|
|
1890
2042
|
|