aws-sdk-databasemigrationservice 1.30.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-databasemigrationservice.rb +7 -4
- data/lib/aws-sdk-databasemigrationservice/client.rb +211 -72
- data/lib/aws-sdk-databasemigrationservice/client_api.rb +17 -0
- data/lib/aws-sdk-databasemigrationservice/errors.rb +42 -20
- data/lib/aws-sdk-databasemigrationservice/resource.rb +7 -0
- data/lib/aws-sdk-databasemigrationservice/types.rb +435 -124
- metadata +2 -2
@@ -124,6 +124,7 @@ module Aws::DatabaseMigrationService
|
|
124
124
|
KMSKeyNotAccessibleFault = Shapes::StructureShape.new(name: 'KMSKeyNotAccessibleFault')
|
125
125
|
KMSNotFoundFault = Shapes::StructureShape.new(name: 'KMSNotFoundFault')
|
126
126
|
KMSThrottlingFault = Shapes::StructureShape.new(name: 'KMSThrottlingFault')
|
127
|
+
KafkaSettings = Shapes::StructureShape.new(name: 'KafkaSettings')
|
127
128
|
KeyList = Shapes::ListShape.new(name: 'KeyList')
|
128
129
|
KinesisSettings = Shapes::StructureShape.new(name: 'KinesisSettings')
|
129
130
|
ListTagsForResourceMessage = Shapes::StructureShape.new(name: 'ListTagsForResourceMessage')
|
@@ -292,6 +293,7 @@ module Aws::DatabaseMigrationService
|
|
292
293
|
CreateEndpointMessage.add_member(:dms_transfer_settings, Shapes::ShapeRef.new(shape: DmsTransferSettings, location_name: "DmsTransferSettings"))
|
293
294
|
CreateEndpointMessage.add_member(:mongo_db_settings, Shapes::ShapeRef.new(shape: MongoDbSettings, location_name: "MongoDbSettings"))
|
294
295
|
CreateEndpointMessage.add_member(:kinesis_settings, Shapes::ShapeRef.new(shape: KinesisSettings, location_name: "KinesisSettings"))
|
296
|
+
CreateEndpointMessage.add_member(:kafka_settings, Shapes::ShapeRef.new(shape: KafkaSettings, location_name: "KafkaSettings"))
|
295
297
|
CreateEndpointMessage.add_member(:elasticsearch_settings, Shapes::ShapeRef.new(shape: ElasticsearchSettings, location_name: "ElasticsearchSettings"))
|
296
298
|
CreateEndpointMessage.add_member(:redshift_settings, Shapes::ShapeRef.new(shape: RedshiftSettings, location_name: "RedshiftSettings"))
|
297
299
|
CreateEndpointMessage.struct_class = Types::CreateEndpointMessage
|
@@ -598,6 +600,7 @@ module Aws::DatabaseMigrationService
|
|
598
600
|
Endpoint.add_member(:dms_transfer_settings, Shapes::ShapeRef.new(shape: DmsTransferSettings, location_name: "DmsTransferSettings"))
|
599
601
|
Endpoint.add_member(:mongo_db_settings, Shapes::ShapeRef.new(shape: MongoDbSettings, location_name: "MongoDbSettings"))
|
600
602
|
Endpoint.add_member(:kinesis_settings, Shapes::ShapeRef.new(shape: KinesisSettings, location_name: "KinesisSettings"))
|
603
|
+
Endpoint.add_member(:kafka_settings, Shapes::ShapeRef.new(shape: KafkaSettings, location_name: "KafkaSettings"))
|
601
604
|
Endpoint.add_member(:elasticsearch_settings, Shapes::ShapeRef.new(shape: ElasticsearchSettings, location_name: "ElasticsearchSettings"))
|
602
605
|
Endpoint.add_member(:redshift_settings, Shapes::ShapeRef.new(shape: RedshiftSettings, location_name: "RedshiftSettings"))
|
603
606
|
Endpoint.struct_class = Types::Endpoint
|
@@ -681,11 +684,20 @@ module Aws::DatabaseMigrationService
|
|
681
684
|
KMSThrottlingFault.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
682
685
|
KMSThrottlingFault.struct_class = Types::KMSThrottlingFault
|
683
686
|
|
687
|
+
KafkaSettings.add_member(:broker, Shapes::ShapeRef.new(shape: String, location_name: "Broker"))
|
688
|
+
KafkaSettings.add_member(:topic, Shapes::ShapeRef.new(shape: String, location_name: "Topic"))
|
689
|
+
KafkaSettings.struct_class = Types::KafkaSettings
|
690
|
+
|
684
691
|
KeyList.member = Shapes::ShapeRef.new(shape: String)
|
685
692
|
|
686
693
|
KinesisSettings.add_member(:stream_arn, Shapes::ShapeRef.new(shape: String, location_name: "StreamArn"))
|
687
694
|
KinesisSettings.add_member(:message_format, Shapes::ShapeRef.new(shape: MessageFormatValue, location_name: "MessageFormat"))
|
688
695
|
KinesisSettings.add_member(:service_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "ServiceAccessRoleArn"))
|
696
|
+
KinesisSettings.add_member(:include_transaction_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeTransactionDetails"))
|
697
|
+
KinesisSettings.add_member(:include_partition_value, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludePartitionValue"))
|
698
|
+
KinesisSettings.add_member(:partition_include_schema_table, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "PartitionIncludeSchemaTable"))
|
699
|
+
KinesisSettings.add_member(:include_table_alter_operations, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeTableAlterOperations"))
|
700
|
+
KinesisSettings.add_member(:include_control_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeControlDetails"))
|
689
701
|
KinesisSettings.struct_class = Types::KinesisSettings
|
690
702
|
|
691
703
|
ListTagsForResourceMessage.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ResourceArn"))
|
@@ -713,6 +725,7 @@ module Aws::DatabaseMigrationService
|
|
713
725
|
ModifyEndpointMessage.add_member(:dms_transfer_settings, Shapes::ShapeRef.new(shape: DmsTransferSettings, location_name: "DmsTransferSettings"))
|
714
726
|
ModifyEndpointMessage.add_member(:mongo_db_settings, Shapes::ShapeRef.new(shape: MongoDbSettings, location_name: "MongoDbSettings"))
|
715
727
|
ModifyEndpointMessage.add_member(:kinesis_settings, Shapes::ShapeRef.new(shape: KinesisSettings, location_name: "KinesisSettings"))
|
728
|
+
ModifyEndpointMessage.add_member(:kafka_settings, Shapes::ShapeRef.new(shape: KafkaSettings, location_name: "KafkaSettings"))
|
716
729
|
ModifyEndpointMessage.add_member(:elasticsearch_settings, Shapes::ShapeRef.new(shape: ElasticsearchSettings, location_name: "ElasticsearchSettings"))
|
717
730
|
ModifyEndpointMessage.add_member(:redshift_settings, Shapes::ShapeRef.new(shape: RedshiftSettings, location_name: "RedshiftSettings"))
|
718
731
|
ModifyEndpointMessage.struct_class = Types::ModifyEndpointMessage
|
@@ -1003,6 +1016,7 @@ module Aws::DatabaseMigrationService
|
|
1003
1016
|
S3Settings.add_member(:cdc_inserts_only, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CdcInsertsOnly"))
|
1004
1017
|
S3Settings.add_member(:timestamp_column_name, Shapes::ShapeRef.new(shape: String, location_name: "TimestampColumnName"))
|
1005
1018
|
S3Settings.add_member(:parquet_timestamp_in_millisecond, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ParquetTimestampInMillisecond"))
|
1019
|
+
S3Settings.add_member(:cdc_inserts_and_updates, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CdcInsertsAndUpdates"))
|
1006
1020
|
S3Settings.struct_class = Types::S3Settings
|
1007
1021
|
|
1008
1022
|
SNSInvalidTopicFault.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
@@ -1071,6 +1085,9 @@ module Aws::DatabaseMigrationService
|
|
1071
1085
|
TableStatistics.add_member(:full_load_rows, Shapes::ShapeRef.new(shape: Long, location_name: "FullLoadRows"))
|
1072
1086
|
TableStatistics.add_member(:full_load_condtnl_chk_failed_rows, Shapes::ShapeRef.new(shape: Long, location_name: "FullLoadCondtnlChkFailedRows"))
|
1073
1087
|
TableStatistics.add_member(:full_load_error_rows, Shapes::ShapeRef.new(shape: Long, location_name: "FullLoadErrorRows"))
|
1088
|
+
TableStatistics.add_member(:full_load_start_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "FullLoadStartTime"))
|
1089
|
+
TableStatistics.add_member(:full_load_end_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "FullLoadEndTime"))
|
1090
|
+
TableStatistics.add_member(:full_load_reloaded, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "FullLoadReloaded"))
|
1074
1091
|
TableStatistics.add_member(:last_update_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "LastUpdateTime"))
|
1075
1092
|
TableStatistics.add_member(:table_state, Shapes::ShapeRef.new(shape: String, location_name: "TableState"))
|
1076
1093
|
TableStatistics.add_member(:validation_pending_records, Shapes::ShapeRef.new(shape: Long, location_name: "ValidationPendingRecords"))
|
@@ -6,6 +6,48 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::DatabaseMigrationService
|
9
|
+
|
10
|
+
# When DatabaseMigrationService returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::DatabaseMigrationService::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all DatabaseMigrationService errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::DatabaseMigrationService::Errors::ServiceError
|
18
|
+
# # rescues all DatabaseMigrationService API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {AccessDeniedFault}
|
29
|
+
# * {InsufficientResourceCapacityFault}
|
30
|
+
# * {InvalidCertificateFault}
|
31
|
+
# * {InvalidResourceStateFault}
|
32
|
+
# * {InvalidSubnet}
|
33
|
+
# * {KMSAccessDeniedFault}
|
34
|
+
# * {KMSDisabledFault}
|
35
|
+
# * {KMSInvalidStateFault}
|
36
|
+
# * {KMSKeyNotAccessibleFault}
|
37
|
+
# * {KMSNotFoundFault}
|
38
|
+
# * {KMSThrottlingFault}
|
39
|
+
# * {ReplicationSubnetGroupDoesNotCoverEnoughAZs}
|
40
|
+
# * {ResourceAlreadyExistsFault}
|
41
|
+
# * {ResourceNotFoundFault}
|
42
|
+
# * {ResourceQuotaExceededFault}
|
43
|
+
# * {SNSInvalidTopicFault}
|
44
|
+
# * {SNSNoAuthorizationFault}
|
45
|
+
# * {StorageQuotaExceededFault}
|
46
|
+
# * {SubnetAlreadyInUse}
|
47
|
+
# * {UpgradeDependencyFailureFault}
|
48
|
+
#
|
49
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
50
|
+
# if they are not defined above.
|
9
51
|
module Errors
|
10
52
|
|
11
53
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +65,6 @@ module Aws::DatabaseMigrationService
|
|
23
65
|
def message
|
24
66
|
@message || @data[:message]
|
25
67
|
end
|
26
|
-
|
27
68
|
end
|
28
69
|
|
29
70
|
class InsufficientResourceCapacityFault < ServiceError
|
@@ -39,7 +80,6 @@ module Aws::DatabaseMigrationService
|
|
39
80
|
def message
|
40
81
|
@message || @data[:message]
|
41
82
|
end
|
42
|
-
|
43
83
|
end
|
44
84
|
|
45
85
|
class InvalidCertificateFault < ServiceError
|
@@ -55,7 +95,6 @@ module Aws::DatabaseMigrationService
|
|
55
95
|
def message
|
56
96
|
@message || @data[:message]
|
57
97
|
end
|
58
|
-
|
59
98
|
end
|
60
99
|
|
61
100
|
class InvalidResourceStateFault < ServiceError
|
@@ -71,7 +110,6 @@ module Aws::DatabaseMigrationService
|
|
71
110
|
def message
|
72
111
|
@message || @data[:message]
|
73
112
|
end
|
74
|
-
|
75
113
|
end
|
76
114
|
|
77
115
|
class InvalidSubnet < ServiceError
|
@@ -87,7 +125,6 @@ module Aws::DatabaseMigrationService
|
|
87
125
|
def message
|
88
126
|
@message || @data[:message]
|
89
127
|
end
|
90
|
-
|
91
128
|
end
|
92
129
|
|
93
130
|
class KMSAccessDeniedFault < ServiceError
|
@@ -103,7 +140,6 @@ module Aws::DatabaseMigrationService
|
|
103
140
|
def message
|
104
141
|
@message || @data[:message]
|
105
142
|
end
|
106
|
-
|
107
143
|
end
|
108
144
|
|
109
145
|
class KMSDisabledFault < ServiceError
|
@@ -119,7 +155,6 @@ module Aws::DatabaseMigrationService
|
|
119
155
|
def message
|
120
156
|
@message || @data[:message]
|
121
157
|
end
|
122
|
-
|
123
158
|
end
|
124
159
|
|
125
160
|
class KMSInvalidStateFault < ServiceError
|
@@ -135,7 +170,6 @@ module Aws::DatabaseMigrationService
|
|
135
170
|
def message
|
136
171
|
@message || @data[:message]
|
137
172
|
end
|
138
|
-
|
139
173
|
end
|
140
174
|
|
141
175
|
class KMSKeyNotAccessibleFault < ServiceError
|
@@ -151,7 +185,6 @@ module Aws::DatabaseMigrationService
|
|
151
185
|
def message
|
152
186
|
@message || @data[:message]
|
153
187
|
end
|
154
|
-
|
155
188
|
end
|
156
189
|
|
157
190
|
class KMSNotFoundFault < ServiceError
|
@@ -167,7 +200,6 @@ module Aws::DatabaseMigrationService
|
|
167
200
|
def message
|
168
201
|
@message || @data[:message]
|
169
202
|
end
|
170
|
-
|
171
203
|
end
|
172
204
|
|
173
205
|
class KMSThrottlingFault < ServiceError
|
@@ -183,7 +215,6 @@ module Aws::DatabaseMigrationService
|
|
183
215
|
def message
|
184
216
|
@message || @data[:message]
|
185
217
|
end
|
186
|
-
|
187
218
|
end
|
188
219
|
|
189
220
|
class ReplicationSubnetGroupDoesNotCoverEnoughAZs < ServiceError
|
@@ -199,7 +230,6 @@ module Aws::DatabaseMigrationService
|
|
199
230
|
def message
|
200
231
|
@message || @data[:message]
|
201
232
|
end
|
202
|
-
|
203
233
|
end
|
204
234
|
|
205
235
|
class ResourceAlreadyExistsFault < ServiceError
|
@@ -220,7 +250,6 @@ module Aws::DatabaseMigrationService
|
|
220
250
|
def resource_arn
|
221
251
|
@data[:resource_arn]
|
222
252
|
end
|
223
|
-
|
224
253
|
end
|
225
254
|
|
226
255
|
class ResourceNotFoundFault < ServiceError
|
@@ -236,7 +265,6 @@ module Aws::DatabaseMigrationService
|
|
236
265
|
def message
|
237
266
|
@message || @data[:message]
|
238
267
|
end
|
239
|
-
|
240
268
|
end
|
241
269
|
|
242
270
|
class ResourceQuotaExceededFault < ServiceError
|
@@ -252,7 +280,6 @@ module Aws::DatabaseMigrationService
|
|
252
280
|
def message
|
253
281
|
@message || @data[:message]
|
254
282
|
end
|
255
|
-
|
256
283
|
end
|
257
284
|
|
258
285
|
class SNSInvalidTopicFault < ServiceError
|
@@ -268,7 +295,6 @@ module Aws::DatabaseMigrationService
|
|
268
295
|
def message
|
269
296
|
@message || @data[:message]
|
270
297
|
end
|
271
|
-
|
272
298
|
end
|
273
299
|
|
274
300
|
class SNSNoAuthorizationFault < ServiceError
|
@@ -284,7 +310,6 @@ module Aws::DatabaseMigrationService
|
|
284
310
|
def message
|
285
311
|
@message || @data[:message]
|
286
312
|
end
|
287
|
-
|
288
313
|
end
|
289
314
|
|
290
315
|
class StorageQuotaExceededFault < ServiceError
|
@@ -300,7 +325,6 @@ module Aws::DatabaseMigrationService
|
|
300
325
|
def message
|
301
326
|
@message || @data[:message]
|
302
327
|
end
|
303
|
-
|
304
328
|
end
|
305
329
|
|
306
330
|
class SubnetAlreadyInUse < ServiceError
|
@@ -316,7 +340,6 @@ module Aws::DatabaseMigrationService
|
|
316
340
|
def message
|
317
341
|
@message || @data[:message]
|
318
342
|
end
|
319
|
-
|
320
343
|
end
|
321
344
|
|
322
345
|
class UpgradeDependencyFailureFault < ServiceError
|
@@ -332,7 +355,6 @@ module Aws::DatabaseMigrationService
|
|
332
355
|
def message
|
333
356
|
@message || @data[:message]
|
334
357
|
end
|
335
|
-
|
336
358
|
end
|
337
359
|
|
338
360
|
end
|
@@ -6,6 +6,13 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::DatabaseMigrationService
|
9
|
+
# This class provides a resource oriented interface for DatabaseMigrationService.
|
10
|
+
# To create a resource object:
|
11
|
+
# resource = Aws::DatabaseMigrationService::Resource.new(region: 'us-west-2')
|
12
|
+
# You can supply a client object with custom configuration that will be used for all resource operations.
|
13
|
+
# If you do not pass +:client+, a default client will be constructed.
|
14
|
+
# client = Aws::DatabaseMigrationService::Client.new(region: 'us-west-2')
|
15
|
+
# resource = Aws::DatabaseMigrationService::Resource.new(client: client)
|
9
16
|
class Resource
|
10
17
|
|
11
18
|
# @param options ({})
|
@@ -139,8 +139,10 @@ module Aws::DatabaseMigrationService
|
|
139
139
|
include Aws::Structure
|
140
140
|
end
|
141
141
|
|
142
|
+
# The name of the Availability Zone for use during database migration.
|
143
|
+
#
|
142
144
|
# @!attribute [rw] name
|
143
|
-
# The name of the
|
145
|
+
# The name of the Availability Zone.
|
144
146
|
# @return [String]
|
145
147
|
#
|
146
148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/AvailabilityZone AWS API Documentation
|
@@ -155,8 +157,9 @@ module Aws::DatabaseMigrationService
|
|
155
157
|
#
|
156
158
|
# @!attribute [rw] certificate_identifier
|
157
159
|
# A customer-assigned name for the certificate. Identifiers must begin
|
158
|
-
# with a letter
|
159
|
-
#
|
160
|
+
# with a letter and must contain only ASCII letters, digits, and
|
161
|
+
# hyphens. They can't end with a hyphen or contain two consecutive
|
162
|
+
# hyphens.
|
160
163
|
# @return [String]
|
161
164
|
#
|
162
165
|
# @!attribute [rw] certificate_creation_date
|
@@ -212,13 +215,16 @@ module Aws::DatabaseMigrationService
|
|
212
215
|
include Aws::Structure
|
213
216
|
end
|
214
217
|
|
218
|
+
# Status of the connection between an endpoint and a replication
|
219
|
+
# instance, including Amazon Resource Names (ARNs) and the last error
|
220
|
+
# message issued.
|
221
|
+
#
|
215
222
|
# @!attribute [rw] replication_instance_arn
|
216
|
-
# The
|
223
|
+
# The ARN of the replication instance.
|
217
224
|
# @return [String]
|
218
225
|
#
|
219
226
|
# @!attribute [rw] endpoint_arn
|
220
|
-
# The
|
221
|
-
# endpoint.
|
227
|
+
# The ARN string that uniquely identifies the endpoint.
|
222
228
|
# @return [String]
|
223
229
|
#
|
224
230
|
# @!attribute [rw] status
|
@@ -230,9 +236,9 @@ module Aws::DatabaseMigrationService
|
|
230
236
|
# @return [String]
|
231
237
|
#
|
232
238
|
# @!attribute [rw] endpoint_identifier
|
233
|
-
# The identifier of the endpoint. Identifiers must begin with a
|
234
|
-
#
|
235
|
-
#
|
239
|
+
# The identifier of the endpoint. Identifiers must begin with a letter
|
240
|
+
# and must contain only ASCII letters, digits, and hyphens. They
|
241
|
+
# can't end with a hyphen or contain two consecutive hyphens.
|
236
242
|
# @return [String]
|
237
243
|
#
|
238
244
|
# @!attribute [rw] replication_instance_identifier
|
@@ -300,6 +306,7 @@ module Aws::DatabaseMigrationService
|
|
300
306
|
# cdc_inserts_only: false,
|
301
307
|
# timestamp_column_name: "String",
|
302
308
|
# parquet_timestamp_in_millisecond: false,
|
309
|
+
# cdc_inserts_and_updates: false,
|
303
310
|
# },
|
304
311
|
# dms_transfer_settings: {
|
305
312
|
# service_access_role_arn: "String",
|
@@ -321,8 +328,17 @@ module Aws::DatabaseMigrationService
|
|
321
328
|
# },
|
322
329
|
# kinesis_settings: {
|
323
330
|
# stream_arn: "String",
|
324
|
-
# message_format: "json", # accepts json
|
331
|
+
# message_format: "json", # accepts json, json-unformatted
|
325
332
|
# service_access_role_arn: "String",
|
333
|
+
# include_transaction_details: false,
|
334
|
+
# include_partition_value: false,
|
335
|
+
# partition_include_schema_table: false,
|
336
|
+
# include_table_alter_operations: false,
|
337
|
+
# include_control_details: false,
|
338
|
+
# },
|
339
|
+
# kafka_settings: {
|
340
|
+
# broker: "String",
|
341
|
+
# topic: "String",
|
326
342
|
# },
|
327
343
|
# elasticsearch_settings: {
|
328
344
|
# service_access_role_arn: "String", # required
|
@@ -361,8 +377,8 @@ module Aws::DatabaseMigrationService
|
|
361
377
|
#
|
362
378
|
# @!attribute [rw] endpoint_identifier
|
363
379
|
# The database endpoint identifier. Identifiers must begin with a
|
364
|
-
# letter
|
365
|
-
#
|
380
|
+
# letter and must contain only ASCII letters, digits, and hyphens.
|
381
|
+
# They can't end with a hyphen or contain two consecutive hyphens.
|
366
382
|
# @return [String]
|
367
383
|
#
|
368
384
|
# @!attribute [rw] endpoint_type
|
@@ -371,9 +387,11 @@ module Aws::DatabaseMigrationService
|
|
371
387
|
#
|
372
388
|
# @!attribute [rw] engine_name
|
373
389
|
# The type of engine for the endpoint. Valid values, depending on the
|
374
|
-
# `EndpointType` value, include `mysql`, `oracle`, `postgres`,
|
375
|
-
# `mariadb`, `aurora`, `aurora-postgresql`, `redshift`,
|
376
|
-
# `azuredb`, `sybase`, `dynamodb`, `mongodb`,
|
390
|
+
# `EndpointType` value, include `"mysql"`, `"oracle"`, `"postgres"`,
|
391
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
392
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
393
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
394
|
+
# `"sqlserver"`.
|
377
395
|
# @return [String]
|
378
396
|
#
|
379
397
|
# @!attribute [rw] username
|
@@ -446,7 +464,7 @@ module Aws::DatabaseMigrationService
|
|
446
464
|
#
|
447
465
|
# @!attribute [rw] dynamo_db_settings
|
448
466
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
449
|
-
#
|
467
|
+
# information about other available settings, see [Using Object
|
450
468
|
# Mapping to Migrate Data to DynamoDB][1] in the *AWS Database
|
451
469
|
# Migration Service User Guide.*
|
452
470
|
#
|
@@ -492,7 +510,7 @@ module Aws::DatabaseMigrationService
|
|
492
510
|
# @!attribute [rw] mongo_db_settings
|
493
511
|
# Settings in JSON format for the source MongoDB endpoint. For more
|
494
512
|
# information about the available settings, see the configuration
|
495
|
-
# properties section in [
|
513
|
+
# properties section in [Using MongoDB as a Target for AWS Database
|
496
514
|
# Migration Service][1] in the *AWS Database Migration Service User
|
497
515
|
# Guide.*
|
498
516
|
#
|
@@ -502,8 +520,8 @@ module Aws::DatabaseMigrationService
|
|
502
520
|
# @return [Types::MongoDbSettings]
|
503
521
|
#
|
504
522
|
# @!attribute [rw] kinesis_settings
|
505
|
-
# Settings in JSON format for the target Amazon Kinesis
|
506
|
-
#
|
523
|
+
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
524
|
+
# Data Streams. For information about other available settings, see
|
507
525
|
# [Using Object Mapping to Migrate Data to a Kinesis Data Stream][1]
|
508
526
|
# in the *AWS Database Migration User Guide.*
|
509
527
|
#
|
@@ -512,6 +530,17 @@ module Aws::DatabaseMigrationService
|
|
512
530
|
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping
|
513
531
|
# @return [Types::KinesisSettings]
|
514
532
|
#
|
533
|
+
# @!attribute [rw] kafka_settings
|
534
|
+
# Settings in JSON format for the target Apache Kafka endpoint. For
|
535
|
+
# information about other available settings, see [Using Object
|
536
|
+
# Mapping to Migrate Data to Apache Kafka][1] in the *AWS Database
|
537
|
+
# Migration User Guide.*
|
538
|
+
#
|
539
|
+
#
|
540
|
+
#
|
541
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping
|
542
|
+
# @return [Types::KafkaSettings]
|
543
|
+
#
|
515
544
|
# @!attribute [rw] elasticsearch_settings
|
516
545
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
517
546
|
# more information about the available settings, see [Extra Connection
|
@@ -524,6 +553,7 @@ module Aws::DatabaseMigrationService
|
|
524
553
|
# @return [Types::ElasticsearchSettings]
|
525
554
|
#
|
526
555
|
# @!attribute [rw] redshift_settings
|
556
|
+
# Provides information that defines an Amazon Redshift endpoint.
|
527
557
|
# @return [Types::RedshiftSettings]
|
528
558
|
#
|
529
559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateEndpointMessage AWS API Documentation
|
@@ -549,6 +579,7 @@ module Aws::DatabaseMigrationService
|
|
549
579
|
:dms_transfer_settings,
|
550
580
|
:mongo_db_settings,
|
551
581
|
:kinesis_settings,
|
582
|
+
:kafka_settings,
|
552
583
|
:elasticsearch_settings,
|
553
584
|
:redshift_settings)
|
554
585
|
include Aws::Structure
|
@@ -598,7 +629,7 @@ module Aws::DatabaseMigrationService
|
|
598
629
|
# The type of AWS DMS resource that generates the events. For example,
|
599
630
|
# if you want to be notified of events generated by a replication
|
600
631
|
# instance, you set this parameter to `replication-instance`. If this
|
601
|
-
# value
|
632
|
+
# value isn't specified, all events are returned.
|
602
633
|
#
|
603
634
|
# Valid values: `replication-instance` \| `replication-task`
|
604
635
|
# @return [String]
|
@@ -694,7 +725,7 @@ module Aws::DatabaseMigrationService
|
|
694
725
|
#
|
695
726
|
# * First character must be a letter.
|
696
727
|
#
|
697
|
-
# *
|
728
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
698
729
|
#
|
699
730
|
# Example: `myrepinstance`
|
700
731
|
# @return [String]
|
@@ -720,7 +751,7 @@ module Aws::DatabaseMigrationService
|
|
720
751
|
# @return [Array<String>]
|
721
752
|
#
|
722
753
|
# @!attribute [rw] availability_zone
|
723
|
-
# The
|
754
|
+
# The Availability Zone where the replication instance will be
|
724
755
|
# created. The default value is a random, system-chosen Availability
|
725
756
|
# Zone in the endpoint's AWS Region, for example: `us-east-1d`
|
726
757
|
# @return [String]
|
@@ -745,7 +776,7 @@ module Aws::DatabaseMigrationService
|
|
745
776
|
#
|
746
777
|
# @!attribute [rw] multi_az
|
747
778
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
748
|
-
# You
|
779
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
749
780
|
# parameter is set to `true`.
|
750
781
|
# @return [Boolean]
|
751
782
|
#
|
@@ -754,7 +785,7 @@ module Aws::DatabaseMigrationService
|
|
754
785
|
# @return [String]
|
755
786
|
#
|
756
787
|
# @!attribute [rw] auto_minor_version_upgrade
|
757
|
-
#
|
788
|
+
# A value that indicates whether minor engine upgrades are applied
|
758
789
|
# automatically to the replication instance during the maintenance
|
759
790
|
# window. This parameter defaults to `true`.
|
760
791
|
#
|
@@ -1301,7 +1332,7 @@ module Aws::DatabaseMigrationService
|
|
1301
1332
|
# @!attribute [rw] marker
|
1302
1333
|
# An optional pagination token provided by a previous request. If this
|
1303
1334
|
# parameter is specified, the response includes only records beyond
|
1304
|
-
# the marker, up to the
|
1335
|
+
# the marker, up to the value specified by `MaxRecords`.
|
1305
1336
|
# @return [String]
|
1306
1337
|
#
|
1307
1338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeCertificatesMessage AWS API Documentation
|
@@ -2083,9 +2114,9 @@ module Aws::DatabaseMigrationService
|
|
2083
2114
|
# }
|
2084
2115
|
#
|
2085
2116
|
# @!attribute [rw] replication_task_arn
|
2086
|
-
#
|
2087
|
-
# task. When this input parameter is specified the API
|
2088
|
-
#
|
2117
|
+
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
2118
|
+
# task. When this input parameter is specified, the API returns only
|
2119
|
+
# one result and ignore the values of the `MaxRecords` and `Marker`
|
2089
2120
|
# parameters.
|
2090
2121
|
# @return [String]
|
2091
2122
|
#
|
@@ -2374,6 +2405,10 @@ module Aws::DatabaseMigrationService
|
|
2374
2405
|
include Aws::Structure
|
2375
2406
|
end
|
2376
2407
|
|
2408
|
+
# Provides the Amazon Resource Name (ARN) of the AWS Identity and Access
|
2409
|
+
# Management (IAM) role used to define an Amazon DynamoDB target
|
2410
|
+
# endpoint.
|
2411
|
+
#
|
2377
2412
|
# @note When making an API call, you may pass DynamoDbSettings
|
2378
2413
|
# data as a hash:
|
2379
2414
|
#
|
@@ -2392,6 +2427,8 @@ module Aws::DatabaseMigrationService
|
|
2392
2427
|
include Aws::Structure
|
2393
2428
|
end
|
2394
2429
|
|
2430
|
+
# Provides information that defines an Elasticsearch endpoint.
|
2431
|
+
#
|
2395
2432
|
# @note When making an API call, you may pass ElasticsearchSettings
|
2396
2433
|
# data as a hash:
|
2397
2434
|
#
|
@@ -2417,8 +2454,8 @@ module Aws::DatabaseMigrationService
|
|
2417
2454
|
# @return [Integer]
|
2418
2455
|
#
|
2419
2456
|
# @!attribute [rw] error_retry_duration
|
2420
|
-
# The maximum number of seconds
|
2421
|
-
# to the Elasticsearch cluster.
|
2457
|
+
# The maximum number of seconds for which DMS retries failed API
|
2458
|
+
# requests to the Elasticsearch cluster.
|
2422
2459
|
# @return [Integer]
|
2423
2460
|
#
|
2424
2461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ElasticsearchSettings AWS API Documentation
|
@@ -2431,10 +2468,21 @@ module Aws::DatabaseMigrationService
|
|
2431
2468
|
include Aws::Structure
|
2432
2469
|
end
|
2433
2470
|
|
2471
|
+
# Describes an endpoint of a database instance in response to operations
|
2472
|
+
# such as the following:
|
2473
|
+
#
|
2474
|
+
# * `CreateEndpoint`
|
2475
|
+
#
|
2476
|
+
# * `DescribeEndpoint`
|
2477
|
+
#
|
2478
|
+
# * `DescribeEndpointTypes`
|
2479
|
+
#
|
2480
|
+
# * `ModifyEndpoint`
|
2481
|
+
#
|
2434
2482
|
# @!attribute [rw] endpoint_identifier
|
2435
2483
|
# The database endpoint identifier. Identifiers must begin with a
|
2436
|
-
# letter
|
2437
|
-
#
|
2484
|
+
# letter and must contain only ASCII letters, digits, and hyphens.
|
2485
|
+
# They can't end with a hyphen or contain two consecutive hyphens.
|
2438
2486
|
# @return [String]
|
2439
2487
|
#
|
2440
2488
|
# @!attribute [rw] endpoint_type
|
@@ -2443,9 +2491,11 @@ module Aws::DatabaseMigrationService
|
|
2443
2491
|
#
|
2444
2492
|
# @!attribute [rw] engine_name
|
2445
2493
|
# The database engine name. Valid values, depending on the
|
2446
|
-
# EndpointType, include mysql
|
2447
|
-
# aurora-postgresql
|
2448
|
-
#
|
2494
|
+
# EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
|
2495
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
2496
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
2497
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
2498
|
+
# `"sqlserver"`.
|
2449
2499
|
# @return [String]
|
2450
2500
|
#
|
2451
2501
|
# @!attribute [rw] engine_display_name
|
@@ -2558,10 +2608,15 @@ module Aws::DatabaseMigrationService
|
|
2558
2608
|
# @return [Types::MongoDbSettings]
|
2559
2609
|
#
|
2560
2610
|
# @!attribute [rw] kinesis_settings
|
2561
|
-
# The settings for the Amazon Kinesis
|
2611
|
+
# The settings for the Amazon Kinesis target endpoint. For more
|
2562
2612
|
# information, see the `KinesisSettings` structure.
|
2563
2613
|
# @return [Types::KinesisSettings]
|
2564
2614
|
#
|
2615
|
+
# @!attribute [rw] kafka_settings
|
2616
|
+
# The settings for the Apache Kafka target endpoint. For more
|
2617
|
+
# information, see the `KafkaSettings` structure.
|
2618
|
+
# @return [Types::KafkaSettings]
|
2619
|
+
#
|
2565
2620
|
# @!attribute [rw] elasticsearch_settings
|
2566
2621
|
# The settings for the Elasticsearch source endpoint. For more
|
2567
2622
|
# information, see the `ElasticsearchSettings` structure.
|
@@ -2596,11 +2651,17 @@ module Aws::DatabaseMigrationService
|
|
2596
2651
|
:dms_transfer_settings,
|
2597
2652
|
:mongo_db_settings,
|
2598
2653
|
:kinesis_settings,
|
2654
|
+
:kafka_settings,
|
2599
2655
|
:elasticsearch_settings,
|
2600
2656
|
:redshift_settings)
|
2601
2657
|
include Aws::Structure
|
2602
2658
|
end
|
2603
2659
|
|
2660
|
+
# Describes an identifiable significant activity that affects a
|
2661
|
+
# replication instance or task. This object can provide the message, the
|
2662
|
+
# available event categories, the date and source of the event, and the
|
2663
|
+
# AWS DMS resource type.
|
2664
|
+
#
|
2604
2665
|
# @!attribute [rw] source_identifier
|
2605
2666
|
# The identifier of an event source.
|
2606
2667
|
# @return [String]
|
@@ -2634,6 +2695,9 @@ module Aws::DatabaseMigrationService
|
|
2634
2695
|
include Aws::Structure
|
2635
2696
|
end
|
2636
2697
|
|
2698
|
+
# Lists categories of events subscribed to, and generated by, the
|
2699
|
+
# applicable AWS DMS resource type.
|
2700
|
+
#
|
2637
2701
|
# @!attribute [rw] source_type
|
2638
2702
|
# The type of AWS DMS resource that generates events.
|
2639
2703
|
#
|
@@ -2653,6 +2717,9 @@ module Aws::DatabaseMigrationService
|
|
2653
2717
|
include Aws::Structure
|
2654
2718
|
end
|
2655
2719
|
|
2720
|
+
# Describes an event notification subscription created by the
|
2721
|
+
# `CreateEventSubscription` operation.
|
2722
|
+
#
|
2656
2723
|
# @!attribute [rw] customer_aws_id
|
2657
2724
|
# The AWS customer account associated with the AWS DMS event
|
2658
2725
|
# notification subscription.
|
@@ -2718,6 +2785,10 @@ module Aws::DatabaseMigrationService
|
|
2718
2785
|
include Aws::Structure
|
2719
2786
|
end
|
2720
2787
|
|
2788
|
+
# Identifies the name and value of a source filter object used to limit
|
2789
|
+
# the number and type of records transferred from your source to your
|
2790
|
+
# target.
|
2791
|
+
#
|
2721
2792
|
# @note When making an API call, you may pass Filter
|
2722
2793
|
# data as a hash:
|
2723
2794
|
#
|
@@ -2759,8 +2830,9 @@ module Aws::DatabaseMigrationService
|
|
2759
2830
|
#
|
2760
2831
|
# @!attribute [rw] certificate_identifier
|
2761
2832
|
# A customer-assigned name for the certificate. Identifiers must begin
|
2762
|
-
# with a letter
|
2763
|
-
#
|
2833
|
+
# with a letter and must contain only ASCII letters, digits, and
|
2834
|
+
# hyphens. They can't end with a hyphen or contain two consecutive
|
2835
|
+
# hyphens.
|
2764
2836
|
# @return [String]
|
2765
2837
|
#
|
2766
2838
|
# @!attribute [rw] certificate_pem
|
@@ -2920,13 +2992,57 @@ module Aws::DatabaseMigrationService
|
|
2920
2992
|
include Aws::Structure
|
2921
2993
|
end
|
2922
2994
|
|
2995
|
+
# Provides information that describes an Apache Kafka endpoint. This
|
2996
|
+
# information includes the output format of records applied to the
|
2997
|
+
# endpoint and details of transaction and control table data
|
2998
|
+
# information.
|
2999
|
+
#
|
3000
|
+
# @note When making an API call, you may pass KafkaSettings
|
3001
|
+
# data as a hash:
|
3002
|
+
#
|
3003
|
+
# {
|
3004
|
+
# broker: "String",
|
3005
|
+
# topic: "String",
|
3006
|
+
# }
|
3007
|
+
#
|
3008
|
+
# @!attribute [rw] broker
|
3009
|
+
# The broker location and port of the Kafka broker that hosts your
|
3010
|
+
# Kafka instance. Specify the broker in the form `
|
3011
|
+
# broker-hostname-or-ip:port `. For example,
|
3012
|
+
# `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"`.
|
3013
|
+
# @return [String]
|
3014
|
+
#
|
3015
|
+
# @!attribute [rw] topic
|
3016
|
+
# The topic to which you migrate the data. If you don't specify a
|
3017
|
+
# topic, AWS DMS specifies `"kafka-default-topic"` as the migration
|
3018
|
+
# topic.
|
3019
|
+
# @return [String]
|
3020
|
+
#
|
3021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KafkaSettings AWS API Documentation
|
3022
|
+
#
|
3023
|
+
class KafkaSettings < Struct.new(
|
3024
|
+
:broker,
|
3025
|
+
:topic)
|
3026
|
+
include Aws::Structure
|
3027
|
+
end
|
3028
|
+
|
3029
|
+
# Provides information that describes an Amazon Kinesis Data Stream
|
3030
|
+
# endpoint. This information includes the output format of records
|
3031
|
+
# applied to the endpoint and details of transaction and control table
|
3032
|
+
# data information.
|
3033
|
+
#
|
2923
3034
|
# @note When making an API call, you may pass KinesisSettings
|
2924
3035
|
# data as a hash:
|
2925
3036
|
#
|
2926
3037
|
# {
|
2927
3038
|
# stream_arn: "String",
|
2928
|
-
# message_format: "json", # accepts json
|
3039
|
+
# message_format: "json", # accepts json, json-unformatted
|
2929
3040
|
# service_access_role_arn: "String",
|
3041
|
+
# include_transaction_details: false,
|
3042
|
+
# include_partition_value: false,
|
3043
|
+
# partition_include_schema_table: false,
|
3044
|
+
# include_table_alter_operations: false,
|
3045
|
+
# include_control_details: false,
|
2930
3046
|
# }
|
2931
3047
|
#
|
2932
3048
|
# @!attribute [rw] stream_arn
|
@@ -2936,20 +3052,63 @@ module Aws::DatabaseMigrationService
|
|
2936
3052
|
#
|
2937
3053
|
# @!attribute [rw] message_format
|
2938
3054
|
# The output format for the records created on the endpoint. The
|
2939
|
-
# message format is `JSON
|
3055
|
+
# message format is `JSON` (default) or `JSON_UNFORMATTED` (a single
|
3056
|
+
# line with no tab).
|
2940
3057
|
# @return [String]
|
2941
3058
|
#
|
2942
3059
|
# @!attribute [rw] service_access_role_arn
|
2943
|
-
# The Amazon Resource Name (ARN) for the
|
2944
|
-
# write to the
|
3060
|
+
# The Amazon Resource Name (ARN) for the AWS Identity and Access
|
3061
|
+
# Management (IAM) role that AWS DMS uses to write to the Kinesis data
|
3062
|
+
# stream.
|
2945
3063
|
# @return [String]
|
2946
3064
|
#
|
3065
|
+
# @!attribute [rw] include_transaction_details
|
3066
|
+
# Provides detailed transaction information from the source database.
|
3067
|
+
# This information includes a commit timestamp, a log position, and
|
3068
|
+
# values for `transaction_id`, previous `transaction_id`, and
|
3069
|
+
# `transaction_record_id` (the record offset within a transaction).
|
3070
|
+
# The default is `False`.
|
3071
|
+
# @return [Boolean]
|
3072
|
+
#
|
3073
|
+
# @!attribute [rw] include_partition_value
|
3074
|
+
# Shows the partition value within the Kinesis message output, unless
|
3075
|
+
# the partition type is `schema-table-type`. The default is `False`.
|
3076
|
+
# @return [Boolean]
|
3077
|
+
#
|
3078
|
+
# @!attribute [rw] partition_include_schema_table
|
3079
|
+
# Prefixes schema and table names to partition values, when the
|
3080
|
+
# partition type is `primary-key-type`. Doing this increases data
|
3081
|
+
# distribution among Kinesis shards. For example, suppose that a
|
3082
|
+
# SysBench schema has thousands of tables and each table has only
|
3083
|
+
# limited range for a primary key. In this case, the same primary key
|
3084
|
+
# is sent from thousands of tables to the same shard, which causes
|
3085
|
+
# throttling. The default is `False`.
|
3086
|
+
# @return [Boolean]
|
3087
|
+
#
|
3088
|
+
# @!attribute [rw] include_table_alter_operations
|
3089
|
+
# Includes any data definition language (DDL) operations that change
|
3090
|
+
# the table in the control data, such as `rename-table`, `drop-table`,
|
3091
|
+
# `add-column`, `drop-column`, and `rename-column`. The default is
|
3092
|
+
# `False`.
|
3093
|
+
# @return [Boolean]
|
3094
|
+
#
|
3095
|
+
# @!attribute [rw] include_control_details
|
3096
|
+
# Shows detailed control information for table definition, column
|
3097
|
+
# definition, and table and column changes in the Kinesis message
|
3098
|
+
# output. The default is `False`.
|
3099
|
+
# @return [Boolean]
|
3100
|
+
#
|
2947
3101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KinesisSettings AWS API Documentation
|
2948
3102
|
#
|
2949
3103
|
class KinesisSettings < Struct.new(
|
2950
3104
|
:stream_arn,
|
2951
3105
|
:message_format,
|
2952
|
-
:service_access_role_arn
|
3106
|
+
:service_access_role_arn,
|
3107
|
+
:include_transaction_details,
|
3108
|
+
:include_partition_value,
|
3109
|
+
:partition_include_schema_table,
|
3110
|
+
:include_table_alter_operations,
|
3111
|
+
:include_control_details)
|
2953
3112
|
include Aws::Structure
|
2954
3113
|
end
|
2955
3114
|
|
@@ -3025,6 +3184,7 @@ module Aws::DatabaseMigrationService
|
|
3025
3184
|
# cdc_inserts_only: false,
|
3026
3185
|
# timestamp_column_name: "String",
|
3027
3186
|
# parquet_timestamp_in_millisecond: false,
|
3187
|
+
# cdc_inserts_and_updates: false,
|
3028
3188
|
# },
|
3029
3189
|
# dms_transfer_settings: {
|
3030
3190
|
# service_access_role_arn: "String",
|
@@ -3046,8 +3206,17 @@ module Aws::DatabaseMigrationService
|
|
3046
3206
|
# },
|
3047
3207
|
# kinesis_settings: {
|
3048
3208
|
# stream_arn: "String",
|
3049
|
-
# message_format: "json", # accepts json
|
3209
|
+
# message_format: "json", # accepts json, json-unformatted
|
3050
3210
|
# service_access_role_arn: "String",
|
3211
|
+
# include_transaction_details: false,
|
3212
|
+
# include_partition_value: false,
|
3213
|
+
# partition_include_schema_table: false,
|
3214
|
+
# include_table_alter_operations: false,
|
3215
|
+
# include_control_details: false,
|
3216
|
+
# },
|
3217
|
+
# kafka_settings: {
|
3218
|
+
# broker: "String",
|
3219
|
+
# topic: "String",
|
3051
3220
|
# },
|
3052
3221
|
# elasticsearch_settings: {
|
3053
3222
|
# service_access_role_arn: "String", # required
|
@@ -3091,8 +3260,8 @@ module Aws::DatabaseMigrationService
|
|
3091
3260
|
#
|
3092
3261
|
# @!attribute [rw] endpoint_identifier
|
3093
3262
|
# The database endpoint identifier. Identifiers must begin with a
|
3094
|
-
# letter
|
3095
|
-
#
|
3263
|
+
# letter and must contain only ASCII letters, digits, and hyphens.
|
3264
|
+
# They can't end with a hyphen or contain two consecutive hyphens.
|
3096
3265
|
# @return [String]
|
3097
3266
|
#
|
3098
3267
|
# @!attribute [rw] endpoint_type
|
@@ -3101,9 +3270,11 @@ module Aws::DatabaseMigrationService
|
|
3101
3270
|
#
|
3102
3271
|
# @!attribute [rw] engine_name
|
3103
3272
|
# The type of engine for the endpoint. Valid values, depending on the
|
3104
|
-
# EndpointType, include mysql
|
3105
|
-
# aurora-postgresql
|
3106
|
-
#
|
3273
|
+
# EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
|
3274
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
3275
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
3276
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
3277
|
+
# `"sqlserver"`.
|
3107
3278
|
# @return [String]
|
3108
3279
|
#
|
3109
3280
|
# @!attribute [rw] username
|
@@ -3152,7 +3323,7 @@ module Aws::DatabaseMigrationService
|
|
3152
3323
|
#
|
3153
3324
|
# @!attribute [rw] dynamo_db_settings
|
3154
3325
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
3155
|
-
#
|
3326
|
+
# information about other available settings, see [Using Object
|
3156
3327
|
# Mapping to Migrate Data to DynamoDB][1] in the *AWS Database
|
3157
3328
|
# Migration Service User Guide.*
|
3158
3329
|
#
|
@@ -3178,22 +3349,22 @@ module Aws::DatabaseMigrationService
|
|
3178
3349
|
#
|
3179
3350
|
# Attributes include the following:
|
3180
3351
|
#
|
3181
|
-
# * serviceAccessRoleArn - The
|
3182
|
-
# the Amazon S3 bucket.
|
3352
|
+
# * serviceAccessRoleArn - The AWS Identity and Access Management
|
3353
|
+
# (IAM) role that has permission to access the Amazon S3 bucket.
|
3183
3354
|
#
|
3184
3355
|
# * BucketName - The name of the S3 bucket to use.
|
3185
3356
|
#
|
3186
3357
|
# * compressionType - An optional parameter to use GZIP to compress
|
3187
|
-
# the target files.
|
3188
|
-
# the files uncompressed.
|
3189
|
-
#
|
3190
|
-
# Shorthand syntax: ServiceAccessRoleArn=string
|
3191
|
-
# ,BucketName=string,CompressionType=string
|
3358
|
+
# the target files. Either set this parameter to NONE (the default)
|
3359
|
+
# or don't use it to leave the files uncompressed.
|
3192
3360
|
#
|
3193
|
-
#
|
3361
|
+
# Shorthand syntax for these settings is as follows:
|
3362
|
+
# `ServiceAccessRoleArn=string
|
3363
|
+
# ,BucketName=string,CompressionType=string`
|
3194
3364
|
#
|
3195
|
-
#
|
3196
|
-
# "string", "
|
3365
|
+
# JSON syntax for these settings is as follows: `\{
|
3366
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string",
|
3367
|
+
# "CompressionType": "none"|"gzip" \} `
|
3197
3368
|
# @return [Types::DmsTransferSettings]
|
3198
3369
|
#
|
3199
3370
|
# @!attribute [rw] mongo_db_settings
|
@@ -3209,8 +3380,8 @@ module Aws::DatabaseMigrationService
|
|
3209
3380
|
# @return [Types::MongoDbSettings]
|
3210
3381
|
#
|
3211
3382
|
# @!attribute [rw] kinesis_settings
|
3212
|
-
# Settings in JSON format for the target Amazon Kinesis
|
3213
|
-
#
|
3383
|
+
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
3384
|
+
# Data Streams. For information about other available settings, see
|
3214
3385
|
# [Using Object Mapping to Migrate Data to a Kinesis Data Stream][1]
|
3215
3386
|
# in the *AWS Database Migration User Guide.*
|
3216
3387
|
#
|
@@ -3219,6 +3390,17 @@ module Aws::DatabaseMigrationService
|
|
3219
3390
|
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping
|
3220
3391
|
# @return [Types::KinesisSettings]
|
3221
3392
|
#
|
3393
|
+
# @!attribute [rw] kafka_settings
|
3394
|
+
# Settings in JSON format for the target Apache Kafka endpoint. For
|
3395
|
+
# information about other available settings, see [Using Object
|
3396
|
+
# Mapping to Migrate Data to Apache Kafka][1] in the *AWS Database
|
3397
|
+
# Migration User Guide.*
|
3398
|
+
#
|
3399
|
+
#
|
3400
|
+
#
|
3401
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping
|
3402
|
+
# @return [Types::KafkaSettings]
|
3403
|
+
#
|
3222
3404
|
# @!attribute [rw] elasticsearch_settings
|
3223
3405
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
3224
3406
|
# more information about the available settings, see [Extra Connection
|
@@ -3231,6 +3413,7 @@ module Aws::DatabaseMigrationService
|
|
3231
3413
|
# @return [Types::ElasticsearchSettings]
|
3232
3414
|
#
|
3233
3415
|
# @!attribute [rw] redshift_settings
|
3416
|
+
# Provides information that defines an Amazon Redshift endpoint.
|
3234
3417
|
# @return [Types::RedshiftSettings]
|
3235
3418
|
#
|
3236
3419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ModifyEndpointMessage AWS API Documentation
|
@@ -3255,6 +3438,7 @@ module Aws::DatabaseMigrationService
|
|
3255
3438
|
:dms_transfer_settings,
|
3256
3439
|
:mongo_db_settings,
|
3257
3440
|
:kinesis_settings,
|
3441
|
+
:kafka_settings,
|
3258
3442
|
:elasticsearch_settings,
|
3259
3443
|
:redshift_settings)
|
3260
3444
|
include Aws::Structure
|
@@ -3397,7 +3581,7 @@ module Aws::DatabaseMigrationService
|
|
3397
3581
|
#
|
3398
3582
|
# @!attribute [rw] multi_az
|
3399
3583
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
3400
|
-
# You
|
3584
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
3401
3585
|
# parameter is set to `true`.
|
3402
3586
|
# @return [Boolean]
|
3403
3587
|
#
|
@@ -3416,13 +3600,20 @@ module Aws::DatabaseMigrationService
|
|
3416
3600
|
# @return [Boolean]
|
3417
3601
|
#
|
3418
3602
|
# @!attribute [rw] auto_minor_version_upgrade
|
3419
|
-
#
|
3420
|
-
# to the replication instance during the maintenance
|
3421
|
-
# this parameter
|
3422
|
-
# case
|
3423
|
-
#
|
3424
|
-
#
|
3425
|
-
#
|
3603
|
+
# A value that indicates that minor version upgrades are applied
|
3604
|
+
# automatically to the replication instance during the maintenance
|
3605
|
+
# window. Changing this parameter doesn't result in an outage, except
|
3606
|
+
# in the case dsecribed following. The change is asynchronously
|
3607
|
+
# applied as soon as possible.
|
3608
|
+
#
|
3609
|
+
# An outage does result if these factors apply:
|
3610
|
+
#
|
3611
|
+
# * This parameter is set to `true` during the maintenance window.
|
3612
|
+
#
|
3613
|
+
# * A newer minor version is available.
|
3614
|
+
#
|
3615
|
+
# * AWS DMS has enabled automatic patching for the given engine
|
3616
|
+
# version.
|
3426
3617
|
# @return [Boolean]
|
3427
3618
|
#
|
3428
3619
|
# @!attribute [rw] replication_instance_identifier
|
@@ -3620,6 +3811,8 @@ module Aws::DatabaseMigrationService
|
|
3620
3811
|
include Aws::Structure
|
3621
3812
|
end
|
3622
3813
|
|
3814
|
+
# Provides information that defines a MongoDB endpoint.
|
3815
|
+
#
|
3623
3816
|
# @note When making an API call, you may pass MongoDbSettings
|
3624
3817
|
# data as a hash:
|
3625
3818
|
#
|
@@ -3676,7 +3869,7 @@ module Aws::DatabaseMigrationService
|
|
3676
3869
|
# Valid values: DEFAULT, MONGODB\_CR, SCRAM\_SHA\_1
|
3677
3870
|
#
|
3678
3871
|
# DEFAULT – For MongoDB version 2.x, use MONGODB\_CR. For MongoDB
|
3679
|
-
# version 3.x, use SCRAM\_SHA\_1. This setting
|
3872
|
+
# version 3.x, use SCRAM\_SHA\_1. This setting isn't used when
|
3680
3873
|
# authType=No.
|
3681
3874
|
# @return [String]
|
3682
3875
|
#
|
@@ -3705,7 +3898,7 @@ module Aws::DatabaseMigrationService
|
|
3705
3898
|
# @return [String]
|
3706
3899
|
#
|
3707
3900
|
# @!attribute [rw] auth_source
|
3708
|
-
# The MongoDB database name. This setting
|
3901
|
+
# The MongoDB database name. This setting isn't used when
|
3709
3902
|
# `authType=NO`.
|
3710
3903
|
#
|
3711
3904
|
# The default is admin.
|
@@ -3738,6 +3931,11 @@ module Aws::DatabaseMigrationService
|
|
3738
3931
|
include Aws::Structure
|
3739
3932
|
end
|
3740
3933
|
|
3934
|
+
# In response to the `DescribeOrderableReplicationInstances` operation,
|
3935
|
+
# this object describes an available replication instance. This
|
3936
|
+
# description includes the replication instance's type, engine version,
|
3937
|
+
# and allocated storage.
|
3938
|
+
#
|
3741
3939
|
# @!attribute [rw] engine_version
|
3742
3940
|
# The version of the replication engine.
|
3743
3941
|
# @return [String]
|
@@ -3804,37 +4002,41 @@ module Aws::DatabaseMigrationService
|
|
3804
4002
|
include Aws::Structure
|
3805
4003
|
end
|
3806
4004
|
|
4005
|
+
# Describes a maintenance action pending for an AWS DMS resource,
|
4006
|
+
# including when and how it will be applied. This data type is a
|
4007
|
+
# response element to the `DescribePendingMaintenanceActions` operation.
|
4008
|
+
#
|
3807
4009
|
# @!attribute [rw] action
|
3808
4010
|
# The type of pending maintenance action that is available for the
|
3809
4011
|
# resource.
|
3810
4012
|
# @return [String]
|
3811
4013
|
#
|
3812
4014
|
# @!attribute [rw] auto_applied_after_date
|
3813
|
-
# The date of the maintenance window when the action
|
3814
|
-
# The maintenance action
|
3815
|
-
#
|
3816
|
-
#
|
4015
|
+
# The date of the maintenance window when the action is to be applied.
|
4016
|
+
# The maintenance action is applied to the resource during its first
|
4017
|
+
# maintenance window after this date. If this date is specified, any
|
4018
|
+
# `next-maintenance` opt-in requests are ignored.
|
3817
4019
|
# @return [Time]
|
3818
4020
|
#
|
3819
4021
|
# @!attribute [rw] forced_apply_date
|
3820
4022
|
# The date when the maintenance action will be automatically applied.
|
3821
|
-
# The maintenance action
|
4023
|
+
# The maintenance action is applied to the resource on this date
|
3822
4024
|
# regardless of the maintenance window for the resource. If this date
|
3823
4025
|
# is specified, any `immediate` opt-in requests are ignored.
|
3824
4026
|
# @return [Time]
|
3825
4027
|
#
|
3826
4028
|
# @!attribute [rw] opt_in_status
|
3827
|
-
#
|
3828
|
-
# resource.
|
4029
|
+
# The type of opt-in request that has been received for the resource.
|
3829
4030
|
# @return [String]
|
3830
4031
|
#
|
3831
4032
|
# @!attribute [rw] current_apply_date
|
3832
4033
|
# The effective date when the pending maintenance action will be
|
3833
4034
|
# applied to the resource. This date takes into account opt-in
|
3834
|
-
# requests received from the `ApplyPendingMaintenanceAction` API
|
3835
|
-
#
|
3836
|
-
# blank if an opt-in request has not
|
3837
|
-
# been
|
4035
|
+
# requests received from the `ApplyPendingMaintenanceAction` API
|
4036
|
+
# operation, and also the `AutoAppliedAfterDate` and `ForcedApplyDate`
|
4037
|
+
# parameter values. This value is blank if an opt-in request has not
|
4038
|
+
# been received and nothing has been specified for
|
4039
|
+
# `AutoAppliedAfterDate` or `ForcedApplyDate`.
|
3838
4040
|
# @return [Time]
|
3839
4041
|
#
|
3840
4042
|
# @!attribute [rw] description
|
@@ -3890,6 +4092,8 @@ module Aws::DatabaseMigrationService
|
|
3890
4092
|
include Aws::Structure
|
3891
4093
|
end
|
3892
4094
|
|
4095
|
+
# Provides information that defines an Amazon Redshift endpoint.
|
4096
|
+
#
|
3893
4097
|
# @note When making an API call, you may pass RedshiftSettings
|
3894
4098
|
# data as a hash:
|
3895
4099
|
#
|
@@ -4145,6 +4349,9 @@ module Aws::DatabaseMigrationService
|
|
4145
4349
|
include Aws::Structure
|
4146
4350
|
end
|
4147
4351
|
|
4352
|
+
# Provides information that describes status of a schema at an endpoint
|
4353
|
+
# specified by the `DescribeRefreshSchemaStatus` operation.
|
4354
|
+
#
|
4148
4355
|
# @!attribute [rw] endpoint_arn
|
4149
4356
|
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
4150
4357
|
# endpoint.
|
@@ -4261,6 +4468,8 @@ module Aws::DatabaseMigrationService
|
|
4261
4468
|
#
|
4262
4469
|
class RemoveTagsFromResourceResponse < Aws::EmptyStructure; end
|
4263
4470
|
|
4471
|
+
# Provides information that defines a replication instance.
|
4472
|
+
#
|
4264
4473
|
# @!attribute [rw] replication_instance_identifier
|
4265
4474
|
# The replication instance identifier. This parameter is stored as a
|
4266
4475
|
# lowercase string.
|
@@ -4319,7 +4528,7 @@ module Aws::DatabaseMigrationService
|
|
4319
4528
|
#
|
4320
4529
|
# @!attribute [rw] multi_az
|
4321
4530
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
4322
|
-
# You
|
4531
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
4323
4532
|
# parameter is set to `true`.
|
4324
4533
|
# @return [Boolean]
|
4325
4534
|
#
|
@@ -4372,7 +4581,7 @@ module Aws::DatabaseMigrationService
|
|
4372
4581
|
# @return [Boolean]
|
4373
4582
|
#
|
4374
4583
|
# @!attribute [rw] secondary_availability_zone
|
4375
|
-
# The
|
4584
|
+
# The Availability Zone of the standby replication instance in a
|
4376
4585
|
# Multi-AZ deployment.
|
4377
4586
|
# @return [String]
|
4378
4587
|
#
|
@@ -4437,6 +4646,10 @@ module Aws::DatabaseMigrationService
|
|
4437
4646
|
include Aws::Structure
|
4438
4647
|
end
|
4439
4648
|
|
4649
|
+
# Provides information about the values of pending modifications to a
|
4650
|
+
# replication instance. This data type is an object of the
|
4651
|
+
# `ReplicationInstance` user-defined data type.
|
4652
|
+
#
|
4440
4653
|
# @!attribute [rw] replication_instance_class
|
4441
4654
|
# The compute and memory capacity of the replication instance.
|
4442
4655
|
#
|
@@ -4452,7 +4665,7 @@ module Aws::DatabaseMigrationService
|
|
4452
4665
|
#
|
4453
4666
|
# @!attribute [rw] multi_az
|
4454
4667
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
4455
|
-
# You
|
4668
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
4456
4669
|
# parameter is set to `true`.
|
4457
4670
|
# @return [Boolean]
|
4458
4671
|
#
|
@@ -4470,6 +4683,9 @@ module Aws::DatabaseMigrationService
|
|
4470
4683
|
include Aws::Structure
|
4471
4684
|
end
|
4472
4685
|
|
4686
|
+
# Describes a subnet group in response to a request by the
|
4687
|
+
# `DescribeReplicationSubnetGroup` operation.
|
4688
|
+
#
|
4473
4689
|
# @!attribute [rw] replication_subnet_group_identifier
|
4474
4690
|
# The identifier of the replication instance subnet group.
|
4475
4691
|
# @return [String]
|
@@ -4514,6 +4730,9 @@ module Aws::DatabaseMigrationService
|
|
4514
4730
|
include Aws::Structure
|
4515
4731
|
end
|
4516
4732
|
|
4733
|
+
# Provides information that describes a replication task created by the
|
4734
|
+
# `CreateReplicationTask` operation.
|
4735
|
+
#
|
4517
4736
|
# @!attribute [rw] replication_task_identifier
|
4518
4737
|
# The user-assigned replication task identifier or name.
|
4519
4738
|
#
|
@@ -4683,6 +4902,10 @@ module Aws::DatabaseMigrationService
|
|
4683
4902
|
include Aws::Structure
|
4684
4903
|
end
|
4685
4904
|
|
4905
|
+
# In response to a request by the `DescribeReplicationTasks` operation,
|
4906
|
+
# this object provides a collection of statistics about a replication
|
4907
|
+
# task.
|
4908
|
+
#
|
4686
4909
|
# @!attribute [rw] full_load_progress_percent
|
4687
4910
|
# The percent complete for the full load migration task.
|
4688
4911
|
# @return [Integer]
|
@@ -4727,7 +4950,7 @@ module Aws::DatabaseMigrationService
|
|
4727
4950
|
# @return [Time]
|
4728
4951
|
#
|
4729
4952
|
# @!attribute [rw] full_load_start_date
|
4730
|
-
# The date the
|
4953
|
+
# The date the replication task full load was started.
|
4731
4954
|
# @return [Time]
|
4732
4955
|
#
|
4733
4956
|
# @!attribute [rw] full_load_finish_date
|
@@ -4779,6 +5002,8 @@ module Aws::DatabaseMigrationService
|
|
4779
5002
|
include Aws::Structure
|
4780
5003
|
end
|
4781
5004
|
|
5005
|
+
# Identifies an AWS DMS resource and any pending actions for it.
|
5006
|
+
#
|
4782
5007
|
# @!attribute [rw] resource_identifier
|
4783
5008
|
# The Amazon Resource Name (ARN) of the DMS resource that the pending
|
4784
5009
|
# maintenance action applies to. For information about creating an
|
@@ -4840,6 +5065,7 @@ module Aws::DatabaseMigrationService
|
|
4840
5065
|
# cdc_inserts_only: false,
|
4841
5066
|
# timestamp_column_name: "String",
|
4842
5067
|
# parquet_timestamp_in_millisecond: false,
|
5068
|
+
# cdc_inserts_and_updates: false,
|
4843
5069
|
# }
|
4844
5070
|
#
|
4845
5071
|
# @!attribute [rw] service_access_role_arn
|
@@ -4863,7 +5089,7 @@ module Aws::DatabaseMigrationService
|
|
4863
5089
|
# @!attribute [rw] bucket_folder
|
4864
5090
|
# An optional parameter to set a folder name in the S3 bucket. If
|
4865
5091
|
# provided, tables are created in the path `
|
4866
|
-
# bucketFolder/schema_name/table_name/`. If this parameter
|
5092
|
+
# bucketFolder/schema_name/table_name/`. If this parameter isn't
|
4867
5093
|
# specified, then the path used is ` schema_name/table_name/`.
|
4868
5094
|
# @return [String]
|
4869
5095
|
#
|
@@ -4873,9 +5099,9 @@ module Aws::DatabaseMigrationService
|
|
4873
5099
|
#
|
4874
5100
|
# @!attribute [rw] compression_type
|
4875
5101
|
# An optional parameter to use GZIP to compress the target files. Set
|
4876
|
-
# to GZIP to compress the target files.
|
4877
|
-
#
|
4878
|
-
# .parquet file formats.
|
5102
|
+
# to GZIP to compress the target files. Either set this parameter to
|
5103
|
+
# NONE (the default) or don't use it to leave the files uncompressed.
|
5104
|
+
# This parameter applies to both .csv and .parquet file formats.
|
4879
5105
|
# @return [String]
|
4880
5106
|
#
|
4881
5107
|
# @!attribute [rw] encryption_mode
|
@@ -5005,11 +5231,11 @@ module Aws::DatabaseMigrationService
|
|
5005
5231
|
# file. This allows the format of your target records from a full load
|
5006
5232
|
# to be consistent with the target records from a CDC load.
|
5007
5233
|
#
|
5008
|
-
# <note markdown="1"> This setting works together with the `CdcInsertsOnly`
|
5009
|
-
# output to .csv files only. For
|
5010
|
-
# settings work together, see
|
5011
|
-
# Migrated S3 Data][1] in the *AWS
|
5012
|
-
# Guide.*.
|
5234
|
+
# <note markdown="1"> This setting works together with the `CdcInsertsOnly` and the
|
5235
|
+
# `CdcInsertsAndUpdates` parameters for output to .csv files only. For
|
5236
|
+
# more information about how these settings work together, see
|
5237
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the *AWS
|
5238
|
+
# Database Migration Service User Guide.*.
|
5013
5239
|
#
|
5014
5240
|
# </note>
|
5015
5241
|
#
|
@@ -5039,8 +5265,14 @@ module Aws::DatabaseMigrationService
|
|
5039
5265
|
# Operations in Migrated S3 Data][1] in the *AWS Database Migration
|
5040
5266
|
# Service User Guide.*.
|
5041
5267
|
#
|
5042
|
-
# <note markdown="1"> AWS DMS supports
|
5043
|
-
# `IncludeOpForFullLoad` parameters in versions
|
5268
|
+
# <note markdown="1"> AWS DMS supports the interaction described preceding between the
|
5269
|
+
# `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions
|
5270
|
+
# 3.1.4 and later.
|
5271
|
+
#
|
5272
|
+
# `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to
|
5273
|
+
# `true` for the same endpoint. Set either `CdcInsertsOnly` or
|
5274
|
+
# `CdcInsertsAndUpdates` to `true` for the same endpoint, but not
|
5275
|
+
# both.
|
5044
5276
|
#
|
5045
5277
|
# </note>
|
5046
5278
|
#
|
@@ -5110,6 +5342,39 @@ module Aws::DatabaseMigrationService
|
|
5110
5342
|
# </note>
|
5111
5343
|
# @return [Boolean]
|
5112
5344
|
#
|
5345
|
+
# @!attribute [rw] cdc_inserts_and_updates
|
5346
|
+
# A value that enables a change data capture (CDC) load to write
|
5347
|
+
# INSERT and UPDATE operations to .csv or .parquet (columnar storage)
|
5348
|
+
# output files. The default setting is `false`, but when
|
5349
|
+
# `CdcInsertsAndUpdates` is set to `true`or `y`, INSERTs and UPDATEs
|
5350
|
+
# from the source database are migrated to the .csv or .parquet file.
|
5351
|
+
#
|
5352
|
+
# For .csv file format only, how these INSERTs and UPDATEs are
|
5353
|
+
# recorded depends on the value of the `IncludeOpForFullLoad`
|
5354
|
+
# parameter. If `IncludeOpForFullLoad` is set to `true`, the first
|
5355
|
+
# field of every CDC record is set to either `I` or `U` to indicate
|
5356
|
+
# INSERT and UPDATE operations at the source. But if
|
5357
|
+
# `IncludeOpForFullLoad` is set to `false`, CDC records are written
|
5358
|
+
# without an indication of INSERT or UPDATE operations at the source.
|
5359
|
+
# For more information about how these settings work together, see
|
5360
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the *AWS
|
5361
|
+
# Database Migration Service User Guide.*.
|
5362
|
+
#
|
5363
|
+
# <note markdown="1"> AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in
|
5364
|
+
# versions 3.3.1 and later.
|
5365
|
+
#
|
5366
|
+
# `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to
|
5367
|
+
# `true` for the same endpoint. Set either `CdcInsertsOnly` or
|
5368
|
+
# `CdcInsertsAndUpdates` to `true` for the same endpoint, but not
|
5369
|
+
# both.
|
5370
|
+
#
|
5371
|
+
# </note>
|
5372
|
+
#
|
5373
|
+
#
|
5374
|
+
#
|
5375
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps
|
5376
|
+
# @return [Boolean]
|
5377
|
+
#
|
5113
5378
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/S3Settings AWS API Documentation
|
5114
5379
|
#
|
5115
5380
|
class S3Settings < Struct.new(
|
@@ -5132,7 +5397,8 @@ module Aws::DatabaseMigrationService
|
|
5132
5397
|
:include_op_for_full_load,
|
5133
5398
|
:cdc_inserts_only,
|
5134
5399
|
:timestamp_column_name,
|
5135
|
-
:parquet_timestamp_in_millisecond
|
5400
|
+
:parquet_timestamp_in_millisecond,
|
5401
|
+
:cdc_inserts_and_updates)
|
5136
5402
|
include Aws::Structure
|
5137
5403
|
end
|
5138
5404
|
|
@@ -5321,6 +5587,10 @@ module Aws::DatabaseMigrationService
|
|
5321
5587
|
include Aws::Structure
|
5322
5588
|
end
|
5323
5589
|
|
5590
|
+
# In response to a request by the `DescribeReplicationSubnetGroup`
|
5591
|
+
# operation, this object identifies a subnet by its given Availability
|
5592
|
+
# Zone, subnet identifier, and status.
|
5593
|
+
#
|
5324
5594
|
# @!attribute [rw] subnet_identifier
|
5325
5595
|
# The subnet identifier.
|
5326
5596
|
# @return [String]
|
@@ -5354,11 +5624,18 @@ module Aws::DatabaseMigrationService
|
|
5354
5624
|
include Aws::Structure
|
5355
5625
|
end
|
5356
5626
|
|
5627
|
+
# Provides information about types of supported endpoints in response to
|
5628
|
+
# a request by the `DescribeEndpointTypes` operation. This information
|
5629
|
+
# includes the type of endpoint, the database engine name, and whether
|
5630
|
+
# change data capture (CDC) is supported.
|
5631
|
+
#
|
5357
5632
|
# @!attribute [rw] engine_name
|
5358
5633
|
# The database engine name. Valid values, depending on the
|
5359
|
-
# EndpointType, include mysql
|
5360
|
-
# aurora-postgresql
|
5361
|
-
#
|
5634
|
+
# EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
|
5635
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
5636
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
5637
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
5638
|
+
# `"sqlserver"`.
|
5362
5639
|
# @return [String]
|
5363
5640
|
#
|
5364
5641
|
# @!attribute [rw] supports_cdc
|
@@ -5385,6 +5662,9 @@ module Aws::DatabaseMigrationService
|
|
5385
5662
|
include Aws::Structure
|
5386
5663
|
end
|
5387
5664
|
|
5665
|
+
# Provides a collection of table statistics in response to a request by
|
5666
|
+
# the `DescribeTableStatistics` operation.
|
5667
|
+
#
|
5388
5668
|
# @!attribute [rw] schema_name
|
5389
5669
|
# The schema name.
|
5390
5670
|
# @return [String]
|
@@ -5406,26 +5686,40 @@ module Aws::DatabaseMigrationService
|
|
5406
5686
|
# @return [Integer]
|
5407
5687
|
#
|
5408
5688
|
# @!attribute [rw] ddls
|
5409
|
-
# The
|
5689
|
+
# The data definition language (DDL) used to build and modify the
|
5410
5690
|
# structure of your tables.
|
5411
5691
|
# @return [Integer]
|
5412
5692
|
#
|
5413
5693
|
# @!attribute [rw] full_load_rows
|
5414
|
-
# The number of rows added during the
|
5694
|
+
# The number of rows added during the full load operation.
|
5415
5695
|
# @return [Integer]
|
5416
5696
|
#
|
5417
5697
|
# @!attribute [rw] full_load_condtnl_chk_failed_rows
|
5418
|
-
# The number of rows that failed conditional checks during the
|
5419
|
-
#
|
5698
|
+
# The number of rows that failed conditional checks during the full
|
5699
|
+
# load operation (valid only for migrations where DynamoDB is the
|
5700
|
+
# target).
|
5420
5701
|
# @return [Integer]
|
5421
5702
|
#
|
5422
5703
|
# @!attribute [rw] full_load_error_rows
|
5423
|
-
# The number of rows that failed to load during the
|
5424
|
-
# operation (valid only for DynamoDB
|
5704
|
+
# The number of rows that failed to load during the full load
|
5705
|
+
# operation (valid only for migrations where DynamoDB is the target).
|
5425
5706
|
# @return [Integer]
|
5426
5707
|
#
|
5708
|
+
# @!attribute [rw] full_load_start_time
|
5709
|
+
# The time when the full load operation started.
|
5710
|
+
# @return [Time]
|
5711
|
+
#
|
5712
|
+
# @!attribute [rw] full_load_end_time
|
5713
|
+
# The time when the full load operation completed.
|
5714
|
+
# @return [Time]
|
5715
|
+
#
|
5716
|
+
# @!attribute [rw] full_load_reloaded
|
5717
|
+
# A value that indicates if the table was reloaded (`true`) or loaded
|
5718
|
+
# as part of a new full load operation (`false`).
|
5719
|
+
# @return [Boolean]
|
5720
|
+
#
|
5427
5721
|
# @!attribute [rw] last_update_time
|
5428
|
-
# The last time
|
5722
|
+
# The last time a table was updated.
|
5429
5723
|
# @return [Time]
|
5430
5724
|
#
|
5431
5725
|
# @!attribute [rw] table_state
|
@@ -5445,36 +5739,36 @@ module Aws::DatabaseMigrationService
|
|
5445
5739
|
# @return [Integer]
|
5446
5740
|
#
|
5447
5741
|
# @!attribute [rw] validation_suspended_records
|
5448
|
-
# The number of records that
|
5742
|
+
# The number of records that couldn't be validated.
|
5449
5743
|
# @return [Integer]
|
5450
5744
|
#
|
5451
5745
|
# @!attribute [rw] validation_state
|
5452
5746
|
# The validation state of the table.
|
5453
5747
|
#
|
5454
|
-
#
|
5748
|
+
# This parameter can have the following values:
|
5455
5749
|
#
|
5456
|
-
# * Not enabled
|
5750
|
+
# * Not enabled - Validation isn't enabled for the table in the
|
5457
5751
|
# migration task.
|
5458
5752
|
#
|
5459
|
-
# * Pending records
|
5753
|
+
# * Pending records - Some records in the table are waiting for
|
5460
5754
|
# validation.
|
5461
5755
|
#
|
5462
|
-
# * Mismatched records
|
5463
|
-
# the source and target.
|
5756
|
+
# * Mismatched records - Some records in the table don't match
|
5757
|
+
# between the source and target.
|
5464
5758
|
#
|
5465
|
-
# * Suspended records
|
5759
|
+
# * Suspended records - Some records in the table couldn't be
|
5466
5760
|
# validated.
|
5467
5761
|
#
|
5468
|
-
# * No primary key
|
5469
|
-
# primary key.
|
5762
|
+
# * No primary key - The table couldn't be validated because it has
|
5763
|
+
# no primary key.
|
5470
5764
|
#
|
5471
|
-
# * Table error
|
5472
|
-
# state and some data
|
5765
|
+
# * Table error - The table wasn't validated because it's in an
|
5766
|
+
# error state and some data wasn't migrated.
|
5473
5767
|
#
|
5474
|
-
# * Validated
|
5768
|
+
# * Validated - All rows in the table are validated. If the table is
|
5475
5769
|
# updated, the status can change from Validated.
|
5476
5770
|
#
|
5477
|
-
# * Error
|
5771
|
+
# * Error - The table couldn't be validated because of an unexpected
|
5478
5772
|
# error.
|
5479
5773
|
# @return [String]
|
5480
5774
|
#
|
@@ -5494,6 +5788,9 @@ module Aws::DatabaseMigrationService
|
|
5494
5788
|
:full_load_rows,
|
5495
5789
|
:full_load_condtnl_chk_failed_rows,
|
5496
5790
|
:full_load_error_rows,
|
5791
|
+
:full_load_start_time,
|
5792
|
+
:full_load_end_time,
|
5793
|
+
:full_load_reloaded,
|
5497
5794
|
:last_update_time,
|
5498
5795
|
:table_state,
|
5499
5796
|
:validation_pending_records,
|
@@ -5504,6 +5801,8 @@ module Aws::DatabaseMigrationService
|
|
5504
5801
|
include Aws::Structure
|
5505
5802
|
end
|
5506
5803
|
|
5804
|
+
# Provides the name of the schema and table to be reloaded.
|
5805
|
+
#
|
5507
5806
|
# @note When making an API call, you may pass TableToReload
|
5508
5807
|
# data as a hash:
|
5509
5808
|
#
|
@@ -5528,6 +5827,15 @@ module Aws::DatabaseMigrationService
|
|
5528
5827
|
include Aws::Structure
|
5529
5828
|
end
|
5530
5829
|
|
5830
|
+
# A user-defined key-value pair that describes metadata added to an AWS
|
5831
|
+
# DMS resource and that is used by operations such as the following:
|
5832
|
+
#
|
5833
|
+
# * `AddTagsToResource`
|
5834
|
+
#
|
5835
|
+
# * `ListTagsForResource`
|
5836
|
+
#
|
5837
|
+
# * `RemoveTagsFromResource`
|
5838
|
+
#
|
5531
5839
|
# @note When making an API call, you may pass Tag
|
5532
5840
|
# data as a hash:
|
5533
5841
|
#
|
@@ -5538,7 +5846,7 @@ module Aws::DatabaseMigrationService
|
|
5538
5846
|
#
|
5539
5847
|
# @!attribute [rw] key
|
5540
5848
|
# A key is the required name of the tag. The string value can be from
|
5541
|
-
# 1 to 128 Unicode characters in length and
|
5849
|
+
# 1 to 128 Unicode characters in length and can't be prefixed with
|
5542
5850
|
# "aws:" or "dms:". The string can only contain only the set of
|
5543
5851
|
# Unicode letters, digits, white-space, '\_', '.', '/', '=',
|
5544
5852
|
# '+', '-' (Java regex:
|
@@ -5547,7 +5855,7 @@ module Aws::DatabaseMigrationService
|
|
5547
5855
|
#
|
5548
5856
|
# @!attribute [rw] value
|
5549
5857
|
# A value is the optional value of the tag. The string value can be
|
5550
|
-
# from 1 to 256 Unicode characters in length and
|
5858
|
+
# from 1 to 256 Unicode characters in length and can't be prefixed
|
5551
5859
|
# with "aws:" or "dms:". The string can only contain only the set
|
5552
5860
|
# of Unicode letters, digits, white-space, '\_', '.', '/',
|
5553
5861
|
# '=', '+', '-' (Java regex:
|
@@ -5610,6 +5918,9 @@ module Aws::DatabaseMigrationService
|
|
5610
5918
|
include Aws::Structure
|
5611
5919
|
end
|
5612
5920
|
|
5921
|
+
# Describes status of a security group associated with the virtual
|
5922
|
+
# private cloud hosting your replication and DB instances.
|
5923
|
+
#
|
5613
5924
|
# @!attribute [rw] vpc_security_group_id
|
5614
5925
|
# The VPC security group Id.
|
5615
5926
|
# @return [String]
|