aws-sdk-firehose 1.85.0 → 1.87.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-firehose/client.rb +43 -5
- data/lib/aws-sdk-firehose/client_api.rb +14 -0
- data/lib/aws-sdk-firehose/types.rb +398 -90
- data/lib/aws-sdk-firehose.rb +1 -1
- data/sig/client.rbs +7 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +15 -0
- metadata +4 -4
@@ -155,7 +155,7 @@ module Aws::Firehose
|
|
155
155
|
# @return [Types::CloudWatchLoggingOptions]
|
156
156
|
#
|
157
157
|
# @!attribute [rw] vpc_configuration_description
|
158
|
-
# The details of the VPC of the Amazon
|
158
|
+
# The details of the VPC of the Amazon OpenSearch Service destination.
|
159
159
|
# @return [Types::VpcConfigurationDescription]
|
160
160
|
#
|
161
161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessDestinationDescription AWS API Documentation
|
@@ -440,7 +440,7 @@ module Aws::Firehose
|
|
440
440
|
# @return [Types::CloudWatchLoggingOptions]
|
441
441
|
#
|
442
442
|
# @!attribute [rw] vpc_configuration_description
|
443
|
-
# The details of the VPC of the Amazon
|
443
|
+
# The details of the VPC of the Amazon OpenSearch Service destination.
|
444
444
|
# @return [Types::VpcConfigurationDescription]
|
445
445
|
#
|
446
446
|
# @!attribute [rw] document_id_options
|
@@ -644,6 +644,9 @@ module Aws::Firehose
|
|
644
644
|
# @return [String]
|
645
645
|
#
|
646
646
|
# @!attribute [rw] warehouse_location
|
647
|
+
# The warehouse location for Apache Iceberg tables. You must configure
|
648
|
+
# this when schema evolution and table creation is enabled.
|
649
|
+
#
|
647
650
|
# Amazon Data Firehose is in preview release and is subject to change.
|
648
651
|
# @return [String]
|
649
652
|
#
|
@@ -767,6 +770,12 @@ module Aws::Firehose
|
|
767
770
|
# stream as a source.
|
768
771
|
# @return [String]
|
769
772
|
#
|
773
|
+
# @!attribute [rw] direct_put_source_configuration
|
774
|
+
# The structure that configures parameters such as
|
775
|
+
# `ThroughputHintInMBs` for a stream configured with Direct PUT as a
|
776
|
+
# source.
|
777
|
+
# @return [Types::DirectPutSourceConfiguration]
|
778
|
+
#
|
770
779
|
# @!attribute [rw] kinesis_stream_source_configuration
|
771
780
|
# When a Kinesis data stream is used as the source for the Firehose
|
772
781
|
# stream, a KinesisStreamSourceConfiguration containing the Kinesis
|
@@ -794,7 +803,8 @@ module Aws::Firehose
|
|
794
803
|
# @return [Types::RedshiftDestinationConfiguration]
|
795
804
|
#
|
796
805
|
# @!attribute [rw] elasticsearch_destination_configuration
|
797
|
-
# The destination in Amazon
|
806
|
+
# The destination in Amazon OpenSearch Service. You can specify only
|
807
|
+
# one destination.
|
798
808
|
# @return [Types::ElasticsearchDestinationConfiguration]
|
799
809
|
#
|
800
810
|
# @!attribute [rw] amazonopensearchservice_destination_configuration
|
@@ -826,8 +836,8 @@ module Aws::Firehose
|
|
826
836
|
# Data Firehose performs an additional authorization on the
|
827
837
|
# `firehose:TagDeliveryStream` action to verify if users have
|
828
838
|
# permissions to create tags. If you do not provide this permission,
|
829
|
-
# requests to create new Firehose
|
830
|
-
#
|
839
|
+
# requests to create new Firehose streams with IAM resource tags will
|
840
|
+
# fail with an `AccessDeniedException` such as following.
|
831
841
|
#
|
832
842
|
# **AccessDeniedException**
|
833
843
|
#
|
@@ -863,6 +873,9 @@ module Aws::Firehose
|
|
863
873
|
# @return [Types::IcebergDestinationConfiguration]
|
864
874
|
#
|
865
875
|
# @!attribute [rw] database_source_configuration
|
876
|
+
# The top level object for configuring streams with database as a
|
877
|
+
# source.
|
878
|
+
#
|
866
879
|
# Amazon Data Firehose is in preview release and is subject to change.
|
867
880
|
# @return [Types::DatabaseSourceConfiguration]
|
868
881
|
#
|
@@ -871,6 +884,7 @@ module Aws::Firehose
|
|
871
884
|
class CreateDeliveryStreamInput < Struct.new(
|
872
885
|
:delivery_stream_name,
|
873
886
|
:delivery_stream_type,
|
887
|
+
:direct_put_source_configuration,
|
874
888
|
:kinesis_stream_source_configuration,
|
875
889
|
:delivery_stream_encryption_configuration_input,
|
876
890
|
:s3_destination_configuration,
|
@@ -948,13 +962,22 @@ module Aws::Firehose
|
|
948
962
|
include Aws::Structure
|
949
963
|
end
|
950
964
|
|
965
|
+
# The structure used to configure the list of column patterns in source
|
966
|
+
# database endpoint for Firehose to read from.
|
967
|
+
#
|
951
968
|
# Amazon Data Firehose is in preview release and is subject to change.
|
952
969
|
#
|
953
970
|
# @!attribute [rw] include
|
971
|
+
# The list of column patterns in source database to be included for
|
972
|
+
# Firehose to read from.
|
973
|
+
#
|
954
974
|
# Amazon Data Firehose is in preview release and is subject to change.
|
955
975
|
# @return [Array<String>]
|
956
976
|
#
|
957
977
|
# @!attribute [rw] exclude
|
978
|
+
# The list of column patterns in source database to be excluded for
|
979
|
+
# Firehose to read from.
|
980
|
+
#
|
958
981
|
# Amazon Data Firehose is in preview release and is subject to change.
|
959
982
|
# @return [Array<String>]
|
960
983
|
#
|
@@ -967,13 +990,22 @@ module Aws::Firehose
|
|
967
990
|
include Aws::Structure
|
968
991
|
end
|
969
992
|
|
993
|
+
# The structure used to configure the list of database patterns in
|
994
|
+
# source database endpoint for Firehose to read from.
|
995
|
+
#
|
970
996
|
# Amazon Data Firehose is in preview release and is subject to change.
|
971
997
|
#
|
972
998
|
# @!attribute [rw] include
|
999
|
+
# The list of database patterns in source database endpoint to be
|
1000
|
+
# included for Firehose to read from.
|
1001
|
+
#
|
973
1002
|
# Amazon Data Firehose is in preview release and is subject to change.
|
974
1003
|
# @return [Array<String>]
|
975
1004
|
#
|
976
1005
|
# @!attribute [rw] exclude
|
1006
|
+
# The list of database patterns in source database endpoint to be
|
1007
|
+
# excluded for Firehose to read from.
|
1008
|
+
#
|
977
1009
|
# Amazon Data Firehose is in preview release and is subject to change.
|
978
1010
|
# @return [Array<String>]
|
979
1011
|
#
|
@@ -986,25 +1018,41 @@ module Aws::Firehose
|
|
986
1018
|
include Aws::Structure
|
987
1019
|
end
|
988
1020
|
|
1021
|
+
# The structure that describes the snapshot information of a table in
|
1022
|
+
# source database endpoint that Firehose reads.
|
1023
|
+
#
|
989
1024
|
# Amazon Data Firehose is in preview release and is subject to change.
|
990
1025
|
#
|
991
1026
|
# @!attribute [rw] id
|
1027
|
+
# The identifier of the current snapshot of the table in source
|
1028
|
+
# database endpoint.
|
1029
|
+
#
|
992
1030
|
# Amazon Data Firehose is in preview release and is subject to change.
|
993
1031
|
# @return [String]
|
994
1032
|
#
|
995
1033
|
# @!attribute [rw] table
|
1034
|
+
# The fully qualified name of the table in source database endpoint
|
1035
|
+
# that Firehose reads.
|
1036
|
+
#
|
996
1037
|
# Amazon Data Firehose is in preview release and is subject to change.
|
997
1038
|
# @return [String]
|
998
1039
|
#
|
999
1040
|
# @!attribute [rw] request_timestamp
|
1041
|
+
# The timestamp when the current snapshot is taken on the table.
|
1042
|
+
#
|
1000
1043
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1001
1044
|
# @return [Time]
|
1002
1045
|
#
|
1003
1046
|
# @!attribute [rw] requested_by
|
1047
|
+
# The principal that sent the request to take the current snapshot on
|
1048
|
+
# the table.
|
1049
|
+
#
|
1004
1050
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1005
1051
|
# @return [String]
|
1006
1052
|
#
|
1007
1053
|
# @!attribute [rw] status
|
1054
|
+
# The status of the current snapshot of the table.
|
1055
|
+
#
|
1008
1056
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1009
1057
|
# @return [String]
|
1010
1058
|
#
|
@@ -1028,6 +1076,9 @@ module Aws::Firehose
|
|
1028
1076
|
include Aws::Structure
|
1029
1077
|
end
|
1030
1078
|
|
1079
|
+
# The structure to configure the authentication methods for Firehose to
|
1080
|
+
# connect to source database endpoint.
|
1081
|
+
#
|
1031
1082
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1032
1083
|
#
|
1033
1084
|
# @!attribute [rw] secrets_manager_configuration
|
@@ -1042,49 +1093,92 @@ module Aws::Firehose
|
|
1042
1093
|
include Aws::Structure
|
1043
1094
|
end
|
1044
1095
|
|
1096
|
+
# The top level object for configuring streams with database as a
|
1097
|
+
# source.
|
1098
|
+
#
|
1045
1099
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1046
1100
|
#
|
1047
1101
|
# @!attribute [rw] type
|
1102
|
+
# The type of database engine. This can be one of the following
|
1103
|
+
# values.
|
1104
|
+
#
|
1105
|
+
# * MySQL
|
1106
|
+
#
|
1107
|
+
# * PostgreSQL
|
1108
|
+
#
|
1048
1109
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1049
1110
|
# @return [String]
|
1050
1111
|
#
|
1051
1112
|
# @!attribute [rw] endpoint
|
1113
|
+
# The endpoint of the database server.
|
1114
|
+
#
|
1052
1115
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1053
1116
|
# @return [String]
|
1054
1117
|
#
|
1055
1118
|
# @!attribute [rw] port
|
1119
|
+
# The port of the database. This can be one of the following values.
|
1120
|
+
#
|
1121
|
+
# * 3306 for MySQL database type
|
1122
|
+
#
|
1123
|
+
# * 5432 for PostgreSQL database type
|
1124
|
+
#
|
1056
1125
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1057
1126
|
# @return [Integer]
|
1058
1127
|
#
|
1059
1128
|
# @!attribute [rw] ssl_mode
|
1129
|
+
# The mode to enable or disable SSL when Firehose connects to the
|
1130
|
+
# database endpoint.
|
1131
|
+
#
|
1060
1132
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1061
1133
|
# @return [String]
|
1062
1134
|
#
|
1063
1135
|
# @!attribute [rw] databases
|
1136
|
+
# The list of database patterns in source database endpoint for
|
1137
|
+
# Firehose to read from.
|
1138
|
+
#
|
1064
1139
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1065
1140
|
# @return [Types::DatabaseList]
|
1066
1141
|
#
|
1067
1142
|
# @!attribute [rw] tables
|
1143
|
+
# The list of table patterns in source database endpoint for Firehose
|
1144
|
+
# to read from.
|
1145
|
+
#
|
1068
1146
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1069
1147
|
# @return [Types::DatabaseTableList]
|
1070
1148
|
#
|
1071
1149
|
# @!attribute [rw] columns
|
1150
|
+
# The list of column patterns in source database endpoint for Firehose
|
1151
|
+
# to read from.
|
1152
|
+
#
|
1072
1153
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1073
1154
|
# @return [Types::DatabaseColumnList]
|
1074
1155
|
#
|
1075
1156
|
# @!attribute [rw] surrogate_keys
|
1157
|
+
# The optional list of table and column names used as unique key
|
1158
|
+
# columns when taking snapshot if the tables don’t have primary keys
|
1159
|
+
# configured.
|
1160
|
+
#
|
1076
1161
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1077
1162
|
# @return [Array<String>]
|
1078
1163
|
#
|
1079
1164
|
# @!attribute [rw] snapshot_watermark_table
|
1165
|
+
# The fully qualified name of the table in source database endpoint
|
1166
|
+
# that Firehose uses to track snapshot progress.
|
1167
|
+
#
|
1080
1168
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1081
1169
|
# @return [String]
|
1082
1170
|
#
|
1083
1171
|
# @!attribute [rw] database_source_authentication_configuration
|
1172
|
+
# The structure to configure the authentication methods for Firehose
|
1173
|
+
# to connect to source database endpoint.
|
1174
|
+
#
|
1084
1175
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1085
1176
|
# @return [Types::DatabaseSourceAuthenticationConfiguration]
|
1086
1177
|
#
|
1087
1178
|
# @!attribute [rw] database_source_vpc_configuration
|
1179
|
+
# The details of the VPC Endpoint Service which Firehose uses to
|
1180
|
+
# create a PrivateLink to the database.
|
1181
|
+
#
|
1088
1182
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1089
1183
|
# @return [Types::DatabaseSourceVPCConfiguration]
|
1090
1184
|
#
|
@@ -1106,53 +1200,98 @@ module Aws::Firehose
|
|
1106
1200
|
include Aws::Structure
|
1107
1201
|
end
|
1108
1202
|
|
1203
|
+
# The top level object for database source description.
|
1204
|
+
#
|
1109
1205
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1110
1206
|
#
|
1111
1207
|
# @!attribute [rw] type
|
1208
|
+
# The type of database engine. This can be one of the following
|
1209
|
+
# values.
|
1210
|
+
#
|
1211
|
+
# * MySQL
|
1212
|
+
#
|
1213
|
+
# * PostgreSQL
|
1214
|
+
#
|
1112
1215
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1113
1216
|
# @return [String]
|
1114
1217
|
#
|
1115
1218
|
# @!attribute [rw] endpoint
|
1219
|
+
# The endpoint of the database server.
|
1220
|
+
#
|
1116
1221
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1117
1222
|
# @return [String]
|
1118
1223
|
#
|
1119
1224
|
# @!attribute [rw] port
|
1225
|
+
# The port of the database. This can be one of the following values.
|
1226
|
+
#
|
1227
|
+
# * 3306 for MySQL database type
|
1228
|
+
#
|
1229
|
+
# * 5432 for PostgreSQL database type
|
1230
|
+
#
|
1120
1231
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1121
1232
|
# @return [Integer]
|
1122
1233
|
#
|
1123
1234
|
# @!attribute [rw] ssl_mode
|
1235
|
+
# The mode to enable or disable SSL when Firehose connects to the
|
1236
|
+
# database endpoint.
|
1237
|
+
#
|
1124
1238
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1125
1239
|
# @return [String]
|
1126
1240
|
#
|
1127
1241
|
# @!attribute [rw] databases
|
1242
|
+
# The list of database patterns in source database endpoint for
|
1243
|
+
# Firehose to read from.
|
1244
|
+
#
|
1128
1245
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1129
1246
|
# @return [Types::DatabaseList]
|
1130
1247
|
#
|
1131
1248
|
# @!attribute [rw] tables
|
1249
|
+
# The list of table patterns in source database endpoint for Firehose
|
1250
|
+
# to read from.
|
1251
|
+
#
|
1132
1252
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1133
1253
|
# @return [Types::DatabaseTableList]
|
1134
1254
|
#
|
1135
1255
|
# @!attribute [rw] columns
|
1256
|
+
# The list of column patterns in source database endpoint for Firehose
|
1257
|
+
# to read from.
|
1258
|
+
#
|
1136
1259
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1137
1260
|
# @return [Types::DatabaseColumnList]
|
1138
1261
|
#
|
1139
1262
|
# @!attribute [rw] surrogate_keys
|
1263
|
+
# The optional list of table and column names used as unique key
|
1264
|
+
# columns when taking snapshot if the tables don’t have primary keys
|
1265
|
+
# configured.
|
1266
|
+
#
|
1140
1267
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1141
1268
|
# @return [Array<String>]
|
1142
1269
|
#
|
1143
1270
|
# @!attribute [rw] snapshot_watermark_table
|
1271
|
+
# The fully qualified name of the table in source database endpoint
|
1272
|
+
# that Firehose uses to track snapshot progress.
|
1273
|
+
#
|
1144
1274
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1145
1275
|
# @return [String]
|
1146
1276
|
#
|
1147
1277
|
# @!attribute [rw] snapshot_info
|
1278
|
+
# The structure that describes the snapshot information of a table in
|
1279
|
+
# source database endpoint that Firehose reads.
|
1280
|
+
#
|
1148
1281
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1149
1282
|
# @return [Array<Types::DatabaseSnapshotInfo>]
|
1150
1283
|
#
|
1151
1284
|
# @!attribute [rw] database_source_authentication_configuration
|
1285
|
+
# The structure to configure the authentication methods for Firehose
|
1286
|
+
# to connect to source database endpoint.
|
1287
|
+
#
|
1152
1288
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1153
1289
|
# @return [Types::DatabaseSourceAuthenticationConfiguration]
|
1154
1290
|
#
|
1155
1291
|
# @!attribute [rw] database_source_vpc_configuration
|
1292
|
+
# The details of the VPC Endpoint Service which Firehose uses to
|
1293
|
+
# create a PrivateLink to the database.
|
1294
|
+
#
|
1156
1295
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1157
1296
|
# @return [Types::DatabaseSourceVPCConfiguration]
|
1158
1297
|
#
|
@@ -1175,9 +1314,19 @@ module Aws::Firehose
|
|
1175
1314
|
include Aws::Structure
|
1176
1315
|
end
|
1177
1316
|
|
1317
|
+
# The structure for details of the VPC Endpoint Service which Firehose
|
1318
|
+
# uses to create a PrivateLink to the database.
|
1319
|
+
#
|
1178
1320
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1179
1321
|
#
|
1180
1322
|
# @!attribute [rw] vpc_endpoint_service_name
|
1323
|
+
# The VPC endpoint service name which Firehose uses to create a
|
1324
|
+
# PrivateLink to the database. The endpoint service must have the
|
1325
|
+
# Firehose service principle `firehose.amazonaws.com` as an allowed
|
1326
|
+
# principal on the VPC endpoint service. The VPC endpoint service name
|
1327
|
+
# is a string that looks like
|
1328
|
+
# `com.amazonaws.vpce.<region>.<vpc-endpoint-service-id>`.
|
1329
|
+
#
|
1181
1330
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1182
1331
|
# @return [String]
|
1183
1332
|
#
|
@@ -1189,13 +1338,22 @@ module Aws::Firehose
|
|
1189
1338
|
include Aws::Structure
|
1190
1339
|
end
|
1191
1340
|
|
1341
|
+
# The structure used to configure the list of table patterns in source
|
1342
|
+
# database endpoint for Firehose to read from.
|
1343
|
+
#
|
1192
1344
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1193
1345
|
#
|
1194
1346
|
# @!attribute [rw] include
|
1347
|
+
# The list of table patterns in source database endpoint to be
|
1348
|
+
# included for Firehose to read from.
|
1349
|
+
#
|
1195
1350
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1196
1351
|
# @return [Array<String>]
|
1197
1352
|
#
|
1198
1353
|
# @!attribute [rw] exclude
|
1354
|
+
# The list of table patterns in source database endpoint to be
|
1355
|
+
# excluded for Firehose to read from.
|
1356
|
+
#
|
1199
1357
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1200
1358
|
# @return [Array<String>]
|
1201
1359
|
#
|
@@ -1528,7 +1686,7 @@ module Aws::Firehose
|
|
1528
1686
|
# @return [Types::RedshiftDestinationDescription]
|
1529
1687
|
#
|
1530
1688
|
# @!attribute [rw] elasticsearch_destination_description
|
1531
|
-
# The destination in Amazon
|
1689
|
+
# The destination in Amazon OpenSearch Service.
|
1532
1690
|
# @return [Types::ElasticsearchDestinationDescription]
|
1533
1691
|
#
|
1534
1692
|
# @!attribute [rw] amazonopensearchservice_destination_description
|
@@ -1591,6 +1749,9 @@ module Aws::Firehose
|
|
1591
1749
|
# @return [Array<String>]
|
1592
1750
|
#
|
1593
1751
|
# @!attribute [rw] partition_spec
|
1752
|
+
# The partition spec configuration for a table that is used by
|
1753
|
+
# automatic table creation.
|
1754
|
+
#
|
1594
1755
|
# Amazon Data Firehose is in preview release and is subject to change.
|
1595
1756
|
# @return [Types::PartitionSpec]
|
1596
1757
|
#
|
@@ -1612,6 +1773,50 @@ module Aws::Firehose
|
|
1612
1773
|
include Aws::Structure
|
1613
1774
|
end
|
1614
1775
|
|
1776
|
+
# The structure that configures parameters such as `ThroughputHintInMBs`
|
1777
|
+
# for a stream configured with Direct PUT as a source.
|
1778
|
+
#
|
1779
|
+
# @!attribute [rw] throughput_hint_in_m_bs
|
1780
|
+
# The value that you configure for this parameter is for information
|
1781
|
+
# purpose only and does not affect Firehose delivery throughput limit.
|
1782
|
+
# You can use the [Firehose Limits form][1] to request a throughput
|
1783
|
+
# limit increase.
|
1784
|
+
#
|
1785
|
+
#
|
1786
|
+
#
|
1787
|
+
# [1]: https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits
|
1788
|
+
# @return [Integer]
|
1789
|
+
#
|
1790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DirectPutSourceConfiguration AWS API Documentation
|
1791
|
+
#
|
1792
|
+
class DirectPutSourceConfiguration < Struct.new(
|
1793
|
+
:throughput_hint_in_m_bs)
|
1794
|
+
SENSITIVE = []
|
1795
|
+
include Aws::Structure
|
1796
|
+
end
|
1797
|
+
|
1798
|
+
# The structure that configures parameters such as `ThroughputHintInMBs`
|
1799
|
+
# for a stream configured with Direct PUT as a source.
|
1800
|
+
#
|
1801
|
+
# @!attribute [rw] throughput_hint_in_m_bs
|
1802
|
+
# The value that you configure for this parameter is for information
|
1803
|
+
# purpose only and does not affect Firehose delivery throughput limit.
|
1804
|
+
# You can use the [Firehose Limits form][1] to request a throughput
|
1805
|
+
# limit increase.
|
1806
|
+
#
|
1807
|
+
#
|
1808
|
+
#
|
1809
|
+
# [1]: https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits
|
1810
|
+
# @return [Integer]
|
1811
|
+
#
|
1812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DirectPutSourceDescription AWS API Documentation
|
1813
|
+
#
|
1814
|
+
class DirectPutSourceDescription < Struct.new(
|
1815
|
+
:throughput_hint_in_m_bs)
|
1816
|
+
SENSITIVE = []
|
1817
|
+
include Aws::Structure
|
1818
|
+
end
|
1819
|
+
|
1615
1820
|
# Indicates the method for setting up document ID. The supported methods
|
1616
1821
|
# are Firehose generated document ID and OpenSearch Service generated
|
1617
1822
|
# document ID.
|
@@ -1654,7 +1859,7 @@ module Aws::Firehose
|
|
1654
1859
|
#
|
1655
1860
|
# @!attribute [rw] enabled
|
1656
1861
|
# Specifies that the dynamic partitioning is enabled for this Firehose
|
1657
|
-
#
|
1862
|
+
# stream.
|
1658
1863
|
# @return [Boolean]
|
1659
1864
|
#
|
1660
1865
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DynamicPartitioningConfiguration AWS API Documentation
|
@@ -1667,7 +1872,7 @@ module Aws::Firehose
|
|
1667
1872
|
end
|
1668
1873
|
|
1669
1874
|
# Describes the buffering to perform before delivering data to the
|
1670
|
-
# Amazon
|
1875
|
+
# Amazon OpenSearch Service destination.
|
1671
1876
|
#
|
1672
1877
|
# @!attribute [rw] interval_in_seconds
|
1673
1878
|
# Buffer incoming data for the specified period of time, in seconds,
|
@@ -1694,14 +1899,15 @@ module Aws::Firehose
|
|
1694
1899
|
include Aws::Structure
|
1695
1900
|
end
|
1696
1901
|
|
1697
|
-
# Describes the configuration of a destination in Amazon
|
1902
|
+
# Describes the configuration of a destination in Amazon OpenSearch
|
1903
|
+
# Service.
|
1698
1904
|
#
|
1699
1905
|
# @!attribute [rw] role_arn
|
1700
1906
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
1701
|
-
# Firehose for calling the Amazon
|
1702
|
-
# indexing documents. For more information, see [Grant
|
1703
|
-
# to an Amazon S3 Destination][1] and [Amazon Resource
|
1704
|
-
# and Amazon Web Services Service Namespaces][2].
|
1907
|
+
# Firehose for calling the Amazon OpenSearch Service Configuration API
|
1908
|
+
# and for indexing documents. For more information, see [Grant
|
1909
|
+
# Firehose Access to an Amazon S3 Destination][1] and [Amazon Resource
|
1910
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][2].
|
1705
1911
|
#
|
1706
1912
|
#
|
1707
1913
|
#
|
@@ -1710,8 +1916,8 @@ module Aws::Firehose
|
|
1710
1916
|
# @return [String]
|
1711
1917
|
#
|
1712
1918
|
# @!attribute [rw] domain_arn
|
1713
|
-
# The ARN of the Amazon
|
1714
|
-
# for `DescribeDomain`, `DescribeDomains`, and
|
1919
|
+
# The ARN of the Amazon OpenSearch Service domain. The IAM role must
|
1920
|
+
# have permissions for `DescribeDomain`, `DescribeDomains`, and
|
1715
1921
|
# `DescribeDomainConfig` after assuming the role specified in
|
1716
1922
|
# **RoleARN**. For more information, see [Amazon Resource Names (ARNs)
|
1717
1923
|
# and Amazon Web Services Service Namespaces][1].
|
@@ -1744,8 +1950,8 @@ module Aws::Firehose
|
|
1744
1950
|
# @!attribute [rw] index_rotation_period
|
1745
1951
|
# The Elasticsearch index rotation period. Index rotation appends a
|
1746
1952
|
# timestamp to the `IndexName` to facilitate the expiration of old
|
1747
|
-
# data. For more information, see [Index Rotation for the Amazon
|
1748
|
-
# Destination][1]. The default value is `OneDay`.
|
1953
|
+
# data. For more information, see [Index Rotation for the Amazon
|
1954
|
+
# OpenSearch Service Destination][1]. The default value is `OneDay`.
|
1749
1955
|
#
|
1750
1956
|
#
|
1751
1957
|
#
|
@@ -1759,7 +1965,7 @@ module Aws::Firehose
|
|
1759
1965
|
#
|
1760
1966
|
# @!attribute [rw] retry_options
|
1761
1967
|
# The retry behavior in case Firehose is unable to deliver documents
|
1762
|
-
# to Amazon
|
1968
|
+
# to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
1763
1969
|
# @return [Types::ElasticsearchRetryOptions]
|
1764
1970
|
#
|
1765
1971
|
# @!attribute [rw] s3_backup_mode
|
@@ -1770,7 +1976,7 @@ module Aws::Firehose
|
|
1770
1976
|
# set to `AllDocuments`, Firehose delivers all incoming records to
|
1771
1977
|
# Amazon S3, and also writes failed documents with
|
1772
1978
|
# `AmazonOpenSearchService-failed/` appended to the prefix. For more
|
1773
|
-
# information, see [Amazon S3 Backup for the Amazon
|
1979
|
+
# information, see [Amazon S3 Backup for the Amazon OpenSearch Service
|
1774
1980
|
# Destination][1]. Default value is `FailedDocumentsOnly`.
|
1775
1981
|
#
|
1776
1982
|
# You can't change this backup mode after you create the Firehose
|
@@ -1824,7 +2030,7 @@ module Aws::Firehose
|
|
1824
2030
|
include Aws::Structure
|
1825
2031
|
end
|
1826
2032
|
|
1827
|
-
# The destination description in Amazon
|
2033
|
+
# The destination description in Amazon OpenSearch Service.
|
1828
2034
|
#
|
1829
2035
|
# @!attribute [rw] role_arn
|
1830
2036
|
# The Amazon Resource Name (ARN) of the Amazon Web Services
|
@@ -1837,12 +2043,12 @@ module Aws::Firehose
|
|
1837
2043
|
# @return [String]
|
1838
2044
|
#
|
1839
2045
|
# @!attribute [rw] domain_arn
|
1840
|
-
# The ARN of the Amazon
|
1841
|
-
# Resource Names (ARNs) and Amazon Web
|
1842
|
-
# Namespaces][1].
|
2046
|
+
# The ARN of the Amazon OpenSearch Service domain. For more
|
2047
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web
|
2048
|
+
# Services Service Namespaces][1].
|
1843
2049
|
#
|
1844
2050
|
# Firehose uses either `ClusterEndpoint` or `DomainARN` to send data
|
1845
|
-
# to Amazon
|
2051
|
+
# to Amazon OpenSearch Service.
|
1846
2052
|
#
|
1847
2053
|
#
|
1848
2054
|
#
|
@@ -1852,7 +2058,7 @@ module Aws::Firehose
|
|
1852
2058
|
# @!attribute [rw] cluster_endpoint
|
1853
2059
|
# The endpoint to use when communicating with the cluster. Firehose
|
1854
2060
|
# uses either this `ClusterEndpoint` or the `DomainARN` field to send
|
1855
|
-
# data to Amazon
|
2061
|
+
# data to Amazon OpenSearch Service.
|
1856
2062
|
# @return [String]
|
1857
2063
|
#
|
1858
2064
|
# @!attribute [rw] index_name
|
@@ -1874,7 +2080,7 @@ module Aws::Firehose
|
|
1874
2080
|
# @return [Types::ElasticsearchBufferingHints]
|
1875
2081
|
#
|
1876
2082
|
# @!attribute [rw] retry_options
|
1877
|
-
# The Amazon
|
2083
|
+
# The Amazon OpenSearch Service retry options.
|
1878
2084
|
# @return [Types::ElasticsearchRetryOptions]
|
1879
2085
|
#
|
1880
2086
|
# @!attribute [rw] s3_backup_mode
|
@@ -1925,14 +2131,14 @@ module Aws::Firehose
|
|
1925
2131
|
include Aws::Structure
|
1926
2132
|
end
|
1927
2133
|
|
1928
|
-
# Describes an update for a destination in Amazon
|
2134
|
+
# Describes an update for a destination in Amazon OpenSearch Service.
|
1929
2135
|
#
|
1930
2136
|
# @!attribute [rw] role_arn
|
1931
2137
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
1932
|
-
# Firehose for calling the Amazon
|
1933
|
-
# indexing documents. For more information, see [Grant
|
1934
|
-
# to an Amazon S3 Destination][1] and [Amazon Resource
|
1935
|
-
# and Amazon Web Services Service Namespaces][2].
|
2138
|
+
# Firehose for calling the Amazon OpenSearch Service Configuration API
|
2139
|
+
# and for indexing documents. For more information, see [Grant
|
2140
|
+
# Firehose Access to an Amazon S3 Destination][1] and [Amazon Resource
|
2141
|
+
# Names (ARNs) and Amazon Web Services Service Namespaces][2].
|
1936
2142
|
#
|
1937
2143
|
#
|
1938
2144
|
#
|
@@ -1941,8 +2147,8 @@ module Aws::Firehose
|
|
1941
2147
|
# @return [String]
|
1942
2148
|
#
|
1943
2149
|
# @!attribute [rw] domain_arn
|
1944
|
-
# The ARN of the Amazon
|
1945
|
-
# for `DescribeDomain`, `DescribeDomains`, and
|
2150
|
+
# The ARN of the Amazon OpenSearch Service domain. The IAM role must
|
2151
|
+
# have permissions for `DescribeDomain`, `DescribeDomains`, and
|
1946
2152
|
# `DescribeDomainConfig` after assuming the IAM role specified in
|
1947
2153
|
# `RoleARN`. For more information, see [Amazon Resource Names (ARNs)
|
1948
2154
|
# and Amazon Web Services Service Namespaces][1].
|
@@ -1979,8 +2185,8 @@ module Aws::Firehose
|
|
1979
2185
|
# @!attribute [rw] index_rotation_period
|
1980
2186
|
# The Elasticsearch index rotation period. Index rotation appends a
|
1981
2187
|
# timestamp to `IndexName` to facilitate the expiration of old data.
|
1982
|
-
# For more information, see [Index Rotation for the Amazon
|
1983
|
-
# Destination][1]. Default value is `OneDay`.
|
2188
|
+
# For more information, see [Index Rotation for the Amazon OpenSearch
|
2189
|
+
# Service Destination][1]. Default value is `OneDay`.
|
1984
2190
|
#
|
1985
2191
|
#
|
1986
2192
|
#
|
@@ -1994,7 +2200,7 @@ module Aws::Firehose
|
|
1994
2200
|
#
|
1995
2201
|
# @!attribute [rw] retry_options
|
1996
2202
|
# The retry behavior in case Firehose is unable to deliver documents
|
1997
|
-
# to Amazon
|
2203
|
+
# to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
1998
2204
|
# @return [Types::ElasticsearchRetryOptions]
|
1999
2205
|
#
|
2000
2206
|
# @!attribute [rw] s3_update
|
@@ -2035,14 +2241,14 @@ module Aws::Firehose
|
|
2035
2241
|
end
|
2036
2242
|
|
2037
2243
|
# Configures retry behavior in case Firehose is unable to deliver
|
2038
|
-
# documents to Amazon
|
2244
|
+
# documents to Amazon OpenSearch Service.
|
2039
2245
|
#
|
2040
2246
|
# @!attribute [rw] duration_in_seconds
|
2041
|
-
# After an initial failure to deliver to Amazon
|
2042
|
-
# of time during which Firehose retries delivery
|
2043
|
-
# attempt). After this time has elapsed, the
|
2044
|
-
# written to Amazon S3. Default value is 300
|
2045
|
-
# value of 0 (zero) results in no retries.
|
2247
|
+
# After an initial failure to deliver to Amazon OpenSearch Service,
|
2248
|
+
# the total amount of time during which Firehose retries delivery
|
2249
|
+
# (including the first attempt). After this time has elapsed, the
|
2250
|
+
# failed documents are written to Amazon S3. Default value is 300
|
2251
|
+
# seconds (5 minutes). A value of 0 (zero) results in no retries.
|
2046
2252
|
# @return [Integer]
|
2047
2253
|
#
|
2048
2254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ElasticsearchRetryOptions AWS API Documentation
|
@@ -2862,10 +3068,14 @@ module Aws::Firehose
|
|
2862
3068
|
# @return [Array<Types::DestinationTableConfiguration>]
|
2863
3069
|
#
|
2864
3070
|
# @!attribute [rw] schema_evolution_configuration
|
3071
|
+
# The configuration to enable automatic schema evolution.
|
3072
|
+
#
|
2865
3073
|
# Amazon Data Firehose is in preview release and is subject to change.
|
2866
3074
|
# @return [Types::SchemaEvolutionConfiguration]
|
2867
3075
|
#
|
2868
3076
|
# @!attribute [rw] table_creation_configuration
|
3077
|
+
# The configuration to enable automatic table creation.
|
3078
|
+
#
|
2869
3079
|
# Amazon Data Firehose is in preview release and is subject to change.
|
2870
3080
|
# @return [Types::TableCreationConfiguration]
|
2871
3081
|
#
|
@@ -2902,6 +3112,19 @@ module Aws::Firehose
|
|
2902
3112
|
# Firehose for calling Apache Iceberg Tables.
|
2903
3113
|
# @return [String]
|
2904
3114
|
#
|
3115
|
+
# @!attribute [rw] append_only
|
3116
|
+
# Describes whether all incoming data for this delivery stream will be
|
3117
|
+
# append only (inserts only and not for updates and deletes) for
|
3118
|
+
# Iceberg delivery. This feature is only applicable for Apache Iceberg
|
3119
|
+
# Tables.
|
3120
|
+
#
|
3121
|
+
# The default value is false. If you set this value to true, Firehose
|
3122
|
+
# automatically increases the throughput limit of a stream based on
|
3123
|
+
# the throttling levels of the stream. If you set this parameter to
|
3124
|
+
# true for a stream with updates and deletes, you will see out of
|
3125
|
+
# order delivery.
|
3126
|
+
# @return [Boolean]
|
3127
|
+
#
|
2905
3128
|
# @!attribute [rw] catalog_configuration
|
2906
3129
|
# Configuration describing where the destination Apache Iceberg Tables
|
2907
3130
|
# are persisted.
|
@@ -2923,6 +3146,7 @@ module Aws::Firehose
|
|
2923
3146
|
:s3_backup_mode,
|
2924
3147
|
:retry_options,
|
2925
3148
|
:role_arn,
|
3149
|
+
:append_only,
|
2926
3150
|
:catalog_configuration,
|
2927
3151
|
:s3_configuration)
|
2928
3152
|
SENSITIVE = []
|
@@ -2939,10 +3163,14 @@ module Aws::Firehose
|
|
2939
3163
|
# @return [Array<Types::DestinationTableConfiguration>]
|
2940
3164
|
#
|
2941
3165
|
# @!attribute [rw] schema_evolution_configuration
|
3166
|
+
# The description of automatic schema evolution configuration.
|
3167
|
+
#
|
2942
3168
|
# Amazon Data Firehose is in preview release and is subject to change.
|
2943
3169
|
# @return [Types::SchemaEvolutionConfiguration]
|
2944
3170
|
#
|
2945
3171
|
# @!attribute [rw] table_creation_configuration
|
3172
|
+
# The description of table creation configuration.
|
3173
|
+
#
|
2946
3174
|
# Amazon Data Firehose is in preview release and is subject to change.
|
2947
3175
|
# @return [Types::TableCreationConfiguration]
|
2948
3176
|
#
|
@@ -2979,6 +3207,19 @@ module Aws::Firehose
|
|
2979
3207
|
# Firehose for calling Apache Iceberg Tables.
|
2980
3208
|
# @return [String]
|
2981
3209
|
#
|
3210
|
+
# @!attribute [rw] append_only
|
3211
|
+
# Describes whether all incoming data for this delivery stream will be
|
3212
|
+
# append only (inserts only and not for updates and deletes) for
|
3213
|
+
# Iceberg delivery. This feature is only applicable for Apache Iceberg
|
3214
|
+
# Tables.
|
3215
|
+
#
|
3216
|
+
# The default value is false. If you set this value to true, Firehose
|
3217
|
+
# automatically increases the throughput limit of a stream based on
|
3218
|
+
# the throttling levels of the stream. If you set this parameter to
|
3219
|
+
# true for a stream with updates and deletes, you will see out of
|
3220
|
+
# order delivery.
|
3221
|
+
# @return [Boolean]
|
3222
|
+
#
|
2982
3223
|
# @!attribute [rw] catalog_configuration
|
2983
3224
|
# Configuration describing where the destination Iceberg tables are
|
2984
3225
|
# persisted.
|
@@ -3000,6 +3241,7 @@ module Aws::Firehose
|
|
3000
3241
|
:s3_backup_mode,
|
3001
3242
|
:retry_options,
|
3002
3243
|
:role_arn,
|
3244
|
+
:append_only,
|
3003
3245
|
:catalog_configuration,
|
3004
3246
|
:s3_destination_description)
|
3005
3247
|
SENSITIVE = []
|
@@ -3016,10 +3258,14 @@ module Aws::Firehose
|
|
3016
3258
|
# @return [Array<Types::DestinationTableConfiguration>]
|
3017
3259
|
#
|
3018
3260
|
# @!attribute [rw] schema_evolution_configuration
|
3261
|
+
# The configuration to enable automatic schema evolution.
|
3262
|
+
#
|
3019
3263
|
# Amazon Data Firehose is in preview release and is subject to change.
|
3020
3264
|
# @return [Types::SchemaEvolutionConfiguration]
|
3021
3265
|
#
|
3022
3266
|
# @!attribute [rw] table_creation_configuration
|
3267
|
+
# The configuration to enable automatic table creation.
|
3268
|
+
#
|
3023
3269
|
# Amazon Data Firehose is in preview release and is subject to change.
|
3024
3270
|
# @return [Types::TableCreationConfiguration]
|
3025
3271
|
#
|
@@ -3056,6 +3302,19 @@ module Aws::Firehose
|
|
3056
3302
|
# Firehose for calling Apache Iceberg Tables.
|
3057
3303
|
# @return [String]
|
3058
3304
|
#
|
3305
|
+
# @!attribute [rw] append_only
|
3306
|
+
# Describes whether all incoming data for this delivery stream will be
|
3307
|
+
# append only (inserts only and not for updates and deletes) for
|
3308
|
+
# Iceberg delivery. This feature is only applicable for Apache Iceberg
|
3309
|
+
# Tables.
|
3310
|
+
#
|
3311
|
+
# The default value is false. If you set this value to true, Firehose
|
3312
|
+
# automatically increases the throughput limit of a stream based on
|
3313
|
+
# the throttling levels of the stream. If you set this parameter to
|
3314
|
+
# true for a stream with updates and deletes, you will see out of
|
3315
|
+
# order delivery.
|
3316
|
+
# @return [Boolean]
|
3317
|
+
#
|
3059
3318
|
# @!attribute [rw] catalog_configuration
|
3060
3319
|
# Configuration describing where the destination Iceberg tables are
|
3061
3320
|
# persisted.
|
@@ -3077,6 +3336,7 @@ module Aws::Firehose
|
|
3077
3336
|
:s3_backup_mode,
|
3078
3337
|
:retry_options,
|
3079
3338
|
:role_arn,
|
3339
|
+
:append_only,
|
3080
3340
|
:catalog_configuration,
|
3081
3341
|
:s3_configuration)
|
3082
3342
|
SENSITIVE = []
|
@@ -3207,7 +3467,7 @@ module Aws::Firehose
|
|
3207
3467
|
end
|
3208
3468
|
|
3209
3469
|
# Details about a Kinesis data stream used as the source for a Firehose
|
3210
|
-
#
|
3470
|
+
# stream.
|
3211
3471
|
#
|
3212
3472
|
# @!attribute [rw] kinesis_stream_arn
|
3213
3473
|
# The Amazon Resource Name (ARN) of the source Kinesis data stream.
|
@@ -3395,7 +3655,7 @@ module Aws::Firehose
|
|
3395
3655
|
end
|
3396
3656
|
|
3397
3657
|
# Details about the Amazon MSK cluster used as the source for a Firehose
|
3398
|
-
#
|
3658
|
+
# stream.
|
3399
3659
|
#
|
3400
3660
|
# @!attribute [rw] msk_cluster_arn
|
3401
3661
|
# The ARN of the Amazon MSK cluster.
|
@@ -3642,9 +3902,13 @@ module Aws::Firehose
|
|
3642
3902
|
include Aws::Structure
|
3643
3903
|
end
|
3644
3904
|
|
3905
|
+
# Represents a single field in a `PartitionSpec`.
|
3906
|
+
#
|
3645
3907
|
# Amazon Data Firehose is in preview release and is subject to change.
|
3646
3908
|
#
|
3647
3909
|
# @!attribute [rw] source_name
|
3910
|
+
# The column name to be configured in partition spec.
|
3911
|
+
#
|
3648
3912
|
# Amazon Data Firehose is in preview release and is subject to change.
|
3649
3913
|
# @return [String]
|
3650
3914
|
#
|
@@ -3656,10 +3920,27 @@ module Aws::Firehose
|
|
3656
3920
|
include Aws::Structure
|
3657
3921
|
end
|
3658
3922
|
|
3923
|
+
# Represents how to produce partition data for a table. Partition data
|
3924
|
+
# is produced by transforming columns in a table. Each column transform
|
3925
|
+
# is represented by a named `PartitionField`.
|
3926
|
+
#
|
3927
|
+
# Here is an example of the schema in JSON.
|
3928
|
+
#
|
3929
|
+
# `"partitionSpec": { "identity": [ {"sourceName": "column1"},
|
3930
|
+
# {"sourceName": "column2"}, {"sourceName": "column3"} ] }`
|
3931
|
+
#
|
3659
3932
|
# Amazon Data Firehose is in preview release and is subject to change.
|
3660
3933
|
#
|
3661
3934
|
# @!attribute [rw] identity
|
3935
|
+
# List of identity [transforms][1] that performs an identity
|
3936
|
+
# transformation. The transform takes the source value, and does not
|
3937
|
+
# modify it. Result type is the source type.
|
3938
|
+
#
|
3662
3939
|
# Amazon Data Firehose is in preview release and is subject to change.
|
3940
|
+
#
|
3941
|
+
#
|
3942
|
+
#
|
3943
|
+
# [1]: https://iceberg.apache.org/spec/#partition-transforms
|
3663
3944
|
# @return [Array<Types::PartitionField>]
|
3664
3945
|
#
|
3665
3946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/PartitionSpec AWS API Documentation
|
@@ -4466,9 +4747,13 @@ module Aws::Firehose
|
|
4466
4747
|
include Aws::Structure
|
4467
4748
|
end
|
4468
4749
|
|
4750
|
+
# The configuration to enable schema evolution.
|
4751
|
+
#
|
4469
4752
|
# Amazon Data Firehose is in preview release and is subject to change.
|
4470
4753
|
#
|
4471
4754
|
# @!attribute [rw] enabled
|
4755
|
+
# Specify whether you want to enable schema evolution.
|
4756
|
+
#
|
4472
4757
|
# Amazon Data Firehose is in preview release and is subject to change.
|
4473
4758
|
# @return [Boolean]
|
4474
4759
|
#
|
@@ -4518,12 +4803,7 @@ module Aws::Firehose
|
|
4518
4803
|
|
4519
4804
|
# The serializer that you want Firehose to use to convert data to the
|
4520
4805
|
# target format before writing it to Amazon S3. Firehose supports two
|
4521
|
-
# types of serializers: the
|
4522
|
-
#
|
4523
|
-
#
|
4524
|
-
#
|
4525
|
-
# [1]: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html
|
4526
|
-
# [2]: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html
|
4806
|
+
# types of serializers: the ORC SerDe and the Parquet SerDe.
|
4527
4807
|
#
|
4528
4808
|
# @!attribute [rw] parquet_ser_de
|
4529
4809
|
# A serializer to use for converting data to the Parquet format before
|
@@ -4532,7 +4812,7 @@ module Aws::Firehose
|
|
4532
4812
|
#
|
4533
4813
|
#
|
4534
4814
|
#
|
4535
|
-
# [1]: https://parquet.apache.org/
|
4815
|
+
# [1]: https://parquet.apache.org/docs/contribution-guidelines/
|
4536
4816
|
# @return [Types::ParquetSerDe]
|
4537
4817
|
#
|
4538
4818
|
# @!attribute [rw] orc_ser_de
|
@@ -4659,11 +4939,25 @@ module Aws::Firehose
|
|
4659
4939
|
# @return [String]
|
4660
4940
|
#
|
4661
4941
|
# @!attribute [rw] meta_data_column_name
|
4662
|
-
#
|
4942
|
+
# Specify a column name in the table, where the metadata information
|
4943
|
+
# has to be loaded. When you enable this field, you will see the
|
4944
|
+
# following column in the snowflake table, which differs based on the
|
4945
|
+
# source type.
|
4946
|
+
#
|
4947
|
+
# For Direct PUT as source
|
4948
|
+
#
|
4949
|
+
# `{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" :
|
4950
|
+
# "timestamp" }`
|
4951
|
+
#
|
4952
|
+
# For Kinesis Data Stream as source
|
4953
|
+
#
|
4954
|
+
# ` "kinesisStreamName" : "streamname", "kinesisShardId" : "Id",
|
4955
|
+
# "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234",
|
4956
|
+
# "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }`
|
4663
4957
|
# @return [String]
|
4664
4958
|
#
|
4665
4959
|
# @!attribute [rw] content_column_name
|
4666
|
-
# The name of the record content column
|
4960
|
+
# The name of the record content column.
|
4667
4961
|
# @return [String]
|
4668
4962
|
#
|
4669
4963
|
# @!attribute [rw] snowflake_vpc_configuration
|
@@ -5078,7 +5372,11 @@ module Aws::Firehose
|
|
5078
5372
|
end
|
5079
5373
|
|
5080
5374
|
# Details about a Kinesis data stream used as the source for a Firehose
|
5081
|
-
#
|
5375
|
+
# stream.
|
5376
|
+
#
|
5377
|
+
# @!attribute [rw] direct_put_source_description
|
5378
|
+
# Details about Direct PUT used as the source for a Firehose stream.
|
5379
|
+
# @return [Types::DirectPutSourceDescription]
|
5082
5380
|
#
|
5083
5381
|
# @!attribute [rw] kinesis_stream_source_description
|
5084
5382
|
# The KinesisStreamSourceDescription value for the source Kinesis data
|
@@ -5091,12 +5389,15 @@ module Aws::Firehose
|
|
5091
5389
|
# @return [Types::MSKSourceDescription]
|
5092
5390
|
#
|
5093
5391
|
# @!attribute [rw] database_source_description
|
5392
|
+
# Details about a database used as the source for a Firehose stream.
|
5393
|
+
#
|
5094
5394
|
# Amazon Data Firehose is in preview release and is subject to change.
|
5095
5395
|
# @return [Types::DatabaseSourceDescription]
|
5096
5396
|
#
|
5097
5397
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SourceDescription AWS API Documentation
|
5098
5398
|
#
|
5099
5399
|
class SourceDescription < Struct.new(
|
5400
|
+
:direct_put_source_description,
|
5100
5401
|
:kinesis_stream_source_description,
|
5101
5402
|
:msk_source_description,
|
5102
5403
|
:database_source_description)
|
@@ -5425,9 +5726,13 @@ module Aws::Firehose
|
|
5425
5726
|
#
|
5426
5727
|
class StopDeliveryStreamEncryptionOutput < Aws::EmptyStructure; end
|
5427
5728
|
|
5729
|
+
# The configuration to enable automatic table creation.
|
5730
|
+
#
|
5428
5731
|
# Amazon Data Firehose is in preview release and is subject to change.
|
5429
5732
|
#
|
5430
5733
|
# @!attribute [rw] enabled
|
5734
|
+
# Specify whether you want to enable automatic table creation.
|
5735
|
+
#
|
5431
5736
|
# Amazon Data Firehose is in preview release and is subject to change.
|
5432
5737
|
# @return [Boolean]
|
5433
5738
|
#
|
@@ -5537,7 +5842,7 @@ module Aws::Firehose
|
|
5537
5842
|
# @return [Types::RedshiftDestinationUpdate]
|
5538
5843
|
#
|
5539
5844
|
# @!attribute [rw] elasticsearch_destination_update
|
5540
|
-
# Describes an update for a destination in Amazon
|
5845
|
+
# Describes an update for a destination in Amazon OpenSearch Service.
|
5541
5846
|
# @return [Types::ElasticsearchDestinationUpdate]
|
5542
5847
|
#
|
5543
5848
|
# @!attribute [rw] amazonopensearchservice_destination_update
|
@@ -5594,12 +5899,12 @@ module Aws::Firehose
|
|
5594
5899
|
#
|
5595
5900
|
# @!attribute [rw] subnet_ids
|
5596
5901
|
# The IDs of the subnets that you want Firehose to use to create ENIs
|
5597
|
-
# in the VPC of the Amazon
|
5598
|
-
# tables and inbound and outbound rules allow traffic
|
5599
|
-
# subnets whose IDs are specified here to the subnets
|
5600
|
-
# destination Amazon
|
5601
|
-
# in each of the subnets that are
|
5602
|
-
# modify these ENIs.
|
5902
|
+
# in the VPC of the Amazon OpenSearch Service destination. Make sure
|
5903
|
+
# that the routing tables and inbound and outbound rules allow traffic
|
5904
|
+
# to flow from the subnets whose IDs are specified here to the subnets
|
5905
|
+
# that have the destination Amazon OpenSearch Service endpoints.
|
5906
|
+
# Firehose creates at least one ENI in each of the subnets that are
|
5907
|
+
# specified here. Do not delete or modify these ENIs.
|
5603
5908
|
#
|
5604
5909
|
# The number of ENIs that Firehose creates in the subnets specified
|
5605
5910
|
# here scales up and down automatically based on throughput. To enable
|
@@ -5648,17 +5953,18 @@ module Aws::Firehose
|
|
5648
5953
|
#
|
5649
5954
|
# @!attribute [rw] security_group_ids
|
5650
5955
|
# The IDs of the security groups that you want Firehose to use when it
|
5651
|
-
# creates ENIs in the VPC of the Amazon
|
5652
|
-
# the same security group that the Amazon
|
5653
|
-
#
|
5654
|
-
#
|
5655
|
-
#
|
5656
|
-
# group
|
5657
|
-
#
|
5658
|
-
#
|
5659
|
-
#
|
5660
|
-
#
|
5661
|
-
#
|
5956
|
+
# creates ENIs in the VPC of the Amazon OpenSearch Service
|
5957
|
+
# destination. You can use the same security group that the Amazon
|
5958
|
+
# OpenSearch Service domain uses or different ones. If you specify
|
5959
|
+
# different security groups here, ensure that they allow outbound
|
5960
|
+
# HTTPS traffic to the Amazon OpenSearch Service domain's security
|
5961
|
+
# group. Also ensure that the Amazon OpenSearch Service domain's
|
5962
|
+
# security group allows HTTPS traffic from the security groups
|
5963
|
+
# specified here. If you use the same security group for both your
|
5964
|
+
# delivery stream and the Amazon OpenSearch Service domain, make sure
|
5965
|
+
# the security group inbound rule allows HTTPS traffic. For more
|
5966
|
+
# information about security group rules, see [Security group
|
5967
|
+
# rules][1] in the Amazon VPC documentation.
|
5662
5968
|
#
|
5663
5969
|
#
|
5664
5970
|
#
|
@@ -5675,16 +5981,16 @@ module Aws::Firehose
|
|
5675
5981
|
include Aws::Structure
|
5676
5982
|
end
|
5677
5983
|
|
5678
|
-
# The details of the VPC of the Amazon
|
5984
|
+
# The details of the VPC of the Amazon OpenSearch Service destination.
|
5679
5985
|
#
|
5680
5986
|
# @!attribute [rw] subnet_ids
|
5681
5987
|
# The IDs of the subnets that Firehose uses to create ENIs in the VPC
|
5682
|
-
# of the Amazon
|
5683
|
-
# inbound and outbound rules allow traffic to flow
|
5684
|
-
# whose IDs are specified here to the subnets that
|
5685
|
-
# destination Amazon
|
5686
|
-
# in each of the subnets that are specified
|
5687
|
-
# modify these ENIs.
|
5988
|
+
# of the Amazon OpenSearch Service destination. Make sure that the
|
5989
|
+
# routing tables and inbound and outbound rules allow traffic to flow
|
5990
|
+
# from the subnets whose IDs are specified here to the subnets that
|
5991
|
+
# have the destination Amazon OpenSearch Service endpoints. Firehose
|
5992
|
+
# creates at least one ENI in each of the subnets that are specified
|
5993
|
+
# here. Do not delete or modify these ENIs.
|
5688
5994
|
#
|
5689
5995
|
# The number of ENIs that Firehose creates in the subnets specified
|
5690
5996
|
# here scales up and down automatically based on throughput. To enable
|
@@ -5730,16 +6036,18 @@ module Aws::Firehose
|
|
5730
6036
|
#
|
5731
6037
|
# @!attribute [rw] security_group_ids
|
5732
6038
|
# The IDs of the security groups that Firehose uses when it creates
|
5733
|
-
# ENIs in the VPC of the Amazon
|
5734
|
-
# security group that the Amazon ES domain uses or
|
5735
|
-
# you specify different security groups, ensure
|
5736
|
-
# outbound HTTPS traffic to the Amazon
|
5737
|
-
#
|
5738
|
-
#
|
5739
|
-
# security
|
5740
|
-
#
|
5741
|
-
#
|
5742
|
-
#
|
6039
|
+
# ENIs in the VPC of the Amazon OpenSearch Service destination. You
|
6040
|
+
# can use the same security group that the Amazon ES domain uses or
|
6041
|
+
# different ones. If you specify different security groups, ensure
|
6042
|
+
# that they allow outbound HTTPS traffic to the Amazon OpenSearch
|
6043
|
+
# Service domain's security group. Also ensure that the Amazon
|
6044
|
+
# OpenSearch Service domain's security group allows HTTPS traffic
|
6045
|
+
# from the security groups specified here. If you use the same
|
6046
|
+
# security group for both your Firehose stream and the Amazon
|
6047
|
+
# OpenSearch Service domain, make sure the security group inbound rule
|
6048
|
+
# allows HTTPS traffic. For more information about security group
|
6049
|
+
# rules, see [Security group rules][1] in the Amazon VPC
|
6050
|
+
# documentation.
|
5743
6051
|
#
|
5744
6052
|
#
|
5745
6053
|
#
|
@@ -5747,7 +6055,7 @@ module Aws::Firehose
|
|
5747
6055
|
# @return [Array<String>]
|
5748
6056
|
#
|
5749
6057
|
# @!attribute [rw] vpc_id
|
5750
|
-
# The ID of the Amazon
|
6058
|
+
# The ID of the Amazon OpenSearch Service destination's VPC.
|
5751
6059
|
# @return [String]
|
5752
6060
|
#
|
5753
6061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/VpcConfigurationDescription AWS API Documentation
|