aws-sdk-databasemigrationservice 1.29.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-databasemigrationservice.rb +7 -4
- data/lib/aws-sdk-databasemigrationservice/client.rb +479 -99
- data/lib/aws-sdk-databasemigrationservice/client_api.rb +39 -0
- data/lib/aws-sdk-databasemigrationservice/errors.rb +42 -20
- data/lib/aws-sdk-databasemigrationservice/resource.rb +1 -0
- data/lib/aws-sdk-databasemigrationservice/types.rb +696 -142
- data/lib/aws-sdk-databasemigrationservice/waiters.rb +68 -0
- metadata +3 -3
@@ -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')
|
@@ -142,6 +143,7 @@ module Aws::DatabaseMigrationService
|
|
142
143
|
ModifyReplicationTaskMessage = Shapes::StructureShape.new(name: 'ModifyReplicationTaskMessage')
|
143
144
|
ModifyReplicationTaskResponse = Shapes::StructureShape.new(name: 'ModifyReplicationTaskResponse')
|
144
145
|
MongoDbSettings = Shapes::StructureShape.new(name: 'MongoDbSettings')
|
146
|
+
NeptuneSettings = Shapes::StructureShape.new(name: 'NeptuneSettings')
|
145
147
|
NestingLevelValue = Shapes::StringShape.new(name: 'NestingLevelValue')
|
146
148
|
OrderableReplicationInstance = Shapes::StructureShape.new(name: 'OrderableReplicationInstance')
|
147
149
|
OrderableReplicationInstanceList = Shapes::ListShape.new(name: 'OrderableReplicationInstanceList')
|
@@ -292,7 +294,9 @@ module Aws::DatabaseMigrationService
|
|
292
294
|
CreateEndpointMessage.add_member(:dms_transfer_settings, Shapes::ShapeRef.new(shape: DmsTransferSettings, location_name: "DmsTransferSettings"))
|
293
295
|
CreateEndpointMessage.add_member(:mongo_db_settings, Shapes::ShapeRef.new(shape: MongoDbSettings, location_name: "MongoDbSettings"))
|
294
296
|
CreateEndpointMessage.add_member(:kinesis_settings, Shapes::ShapeRef.new(shape: KinesisSettings, location_name: "KinesisSettings"))
|
297
|
+
CreateEndpointMessage.add_member(:kafka_settings, Shapes::ShapeRef.new(shape: KafkaSettings, location_name: "KafkaSettings"))
|
295
298
|
CreateEndpointMessage.add_member(:elasticsearch_settings, Shapes::ShapeRef.new(shape: ElasticsearchSettings, location_name: "ElasticsearchSettings"))
|
299
|
+
CreateEndpointMessage.add_member(:neptune_settings, Shapes::ShapeRef.new(shape: NeptuneSettings, location_name: "NeptuneSettings"))
|
296
300
|
CreateEndpointMessage.add_member(:redshift_settings, Shapes::ShapeRef.new(shape: RedshiftSettings, location_name: "RedshiftSettings"))
|
297
301
|
CreateEndpointMessage.struct_class = Types::CreateEndpointMessage
|
298
302
|
|
@@ -350,6 +354,7 @@ module Aws::DatabaseMigrationService
|
|
350
354
|
CreateReplicationTaskMessage.add_member(:cdc_start_position, Shapes::ShapeRef.new(shape: String, location_name: "CdcStartPosition"))
|
351
355
|
CreateReplicationTaskMessage.add_member(:cdc_stop_position, Shapes::ShapeRef.new(shape: String, location_name: "CdcStopPosition"))
|
352
356
|
CreateReplicationTaskMessage.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
357
|
+
CreateReplicationTaskMessage.add_member(:task_data, Shapes::ShapeRef.new(shape: String, location_name: "TaskData"))
|
353
358
|
CreateReplicationTaskMessage.struct_class = Types::CreateReplicationTaskMessage
|
354
359
|
|
355
360
|
CreateReplicationTaskResponse.add_member(:replication_task, Shapes::ShapeRef.new(shape: ReplicationTask, location_name: "ReplicationTask"))
|
@@ -598,7 +603,9 @@ module Aws::DatabaseMigrationService
|
|
598
603
|
Endpoint.add_member(:dms_transfer_settings, Shapes::ShapeRef.new(shape: DmsTransferSettings, location_name: "DmsTransferSettings"))
|
599
604
|
Endpoint.add_member(:mongo_db_settings, Shapes::ShapeRef.new(shape: MongoDbSettings, location_name: "MongoDbSettings"))
|
600
605
|
Endpoint.add_member(:kinesis_settings, Shapes::ShapeRef.new(shape: KinesisSettings, location_name: "KinesisSettings"))
|
606
|
+
Endpoint.add_member(:kafka_settings, Shapes::ShapeRef.new(shape: KafkaSettings, location_name: "KafkaSettings"))
|
601
607
|
Endpoint.add_member(:elasticsearch_settings, Shapes::ShapeRef.new(shape: ElasticsearchSettings, location_name: "ElasticsearchSettings"))
|
608
|
+
Endpoint.add_member(:neptune_settings, Shapes::ShapeRef.new(shape: NeptuneSettings, location_name: "NeptuneSettings"))
|
602
609
|
Endpoint.add_member(:redshift_settings, Shapes::ShapeRef.new(shape: RedshiftSettings, location_name: "RedshiftSettings"))
|
603
610
|
Endpoint.struct_class = Types::Endpoint
|
604
611
|
|
@@ -681,11 +688,20 @@ module Aws::DatabaseMigrationService
|
|
681
688
|
KMSThrottlingFault.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
682
689
|
KMSThrottlingFault.struct_class = Types::KMSThrottlingFault
|
683
690
|
|
691
|
+
KafkaSettings.add_member(:broker, Shapes::ShapeRef.new(shape: String, location_name: "Broker"))
|
692
|
+
KafkaSettings.add_member(:topic, Shapes::ShapeRef.new(shape: String, location_name: "Topic"))
|
693
|
+
KafkaSettings.struct_class = Types::KafkaSettings
|
694
|
+
|
684
695
|
KeyList.member = Shapes::ShapeRef.new(shape: String)
|
685
696
|
|
686
697
|
KinesisSettings.add_member(:stream_arn, Shapes::ShapeRef.new(shape: String, location_name: "StreamArn"))
|
687
698
|
KinesisSettings.add_member(:message_format, Shapes::ShapeRef.new(shape: MessageFormatValue, location_name: "MessageFormat"))
|
688
699
|
KinesisSettings.add_member(:service_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "ServiceAccessRoleArn"))
|
700
|
+
KinesisSettings.add_member(:include_transaction_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeTransactionDetails"))
|
701
|
+
KinesisSettings.add_member(:include_partition_value, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludePartitionValue"))
|
702
|
+
KinesisSettings.add_member(:partition_include_schema_table, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "PartitionIncludeSchemaTable"))
|
703
|
+
KinesisSettings.add_member(:include_table_alter_operations, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeTableAlterOperations"))
|
704
|
+
KinesisSettings.add_member(:include_control_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeControlDetails"))
|
689
705
|
KinesisSettings.struct_class = Types::KinesisSettings
|
690
706
|
|
691
707
|
ListTagsForResourceMessage.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ResourceArn"))
|
@@ -713,7 +729,9 @@ module Aws::DatabaseMigrationService
|
|
713
729
|
ModifyEndpointMessage.add_member(:dms_transfer_settings, Shapes::ShapeRef.new(shape: DmsTransferSettings, location_name: "DmsTransferSettings"))
|
714
730
|
ModifyEndpointMessage.add_member(:mongo_db_settings, Shapes::ShapeRef.new(shape: MongoDbSettings, location_name: "MongoDbSettings"))
|
715
731
|
ModifyEndpointMessage.add_member(:kinesis_settings, Shapes::ShapeRef.new(shape: KinesisSettings, location_name: "KinesisSettings"))
|
732
|
+
ModifyEndpointMessage.add_member(:kafka_settings, Shapes::ShapeRef.new(shape: KafkaSettings, location_name: "KafkaSettings"))
|
716
733
|
ModifyEndpointMessage.add_member(:elasticsearch_settings, Shapes::ShapeRef.new(shape: ElasticsearchSettings, location_name: "ElasticsearchSettings"))
|
734
|
+
ModifyEndpointMessage.add_member(:neptune_settings, Shapes::ShapeRef.new(shape: NeptuneSettings, location_name: "NeptuneSettings"))
|
717
735
|
ModifyEndpointMessage.add_member(:redshift_settings, Shapes::ShapeRef.new(shape: RedshiftSettings, location_name: "RedshiftSettings"))
|
718
736
|
ModifyEndpointMessage.struct_class = Types::ModifyEndpointMessage
|
719
737
|
|
@@ -762,6 +780,7 @@ module Aws::DatabaseMigrationService
|
|
762
780
|
ModifyReplicationTaskMessage.add_member(:cdc_start_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "CdcStartTime"))
|
763
781
|
ModifyReplicationTaskMessage.add_member(:cdc_start_position, Shapes::ShapeRef.new(shape: String, location_name: "CdcStartPosition"))
|
764
782
|
ModifyReplicationTaskMessage.add_member(:cdc_stop_position, Shapes::ShapeRef.new(shape: String, location_name: "CdcStopPosition"))
|
783
|
+
ModifyReplicationTaskMessage.add_member(:task_data, Shapes::ShapeRef.new(shape: String, location_name: "TaskData"))
|
765
784
|
ModifyReplicationTaskMessage.struct_class = Types::ModifyReplicationTaskMessage
|
766
785
|
|
767
786
|
ModifyReplicationTaskResponse.add_member(:replication_task, Shapes::ShapeRef.new(shape: ReplicationTask, location_name: "ReplicationTask"))
|
@@ -781,6 +800,15 @@ module Aws::DatabaseMigrationService
|
|
781
800
|
MongoDbSettings.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "KmsKeyId"))
|
782
801
|
MongoDbSettings.struct_class = Types::MongoDbSettings
|
783
802
|
|
803
|
+
NeptuneSettings.add_member(:service_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "ServiceAccessRoleArn"))
|
804
|
+
NeptuneSettings.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "S3BucketName"))
|
805
|
+
NeptuneSettings.add_member(:s3_bucket_folder, Shapes::ShapeRef.new(shape: String, required: true, location_name: "S3BucketFolder"))
|
806
|
+
NeptuneSettings.add_member(:error_retry_duration, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "ErrorRetryDuration"))
|
807
|
+
NeptuneSettings.add_member(:max_file_size, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxFileSize"))
|
808
|
+
NeptuneSettings.add_member(:max_retry_count, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRetryCount"))
|
809
|
+
NeptuneSettings.add_member(:iam_auth_enabled, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IamAuthEnabled"))
|
810
|
+
NeptuneSettings.struct_class = Types::NeptuneSettings
|
811
|
+
|
784
812
|
OrderableReplicationInstance.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
785
813
|
OrderableReplicationInstance.add_member(:replication_instance_class, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationInstanceClass"))
|
786
814
|
OrderableReplicationInstance.add_member(:storage_type, Shapes::ShapeRef.new(shape: String, location_name: "StorageType"))
|
@@ -941,6 +969,7 @@ module Aws::DatabaseMigrationService
|
|
941
969
|
ReplicationTask.add_member(:recovery_checkpoint, Shapes::ShapeRef.new(shape: String, location_name: "RecoveryCheckpoint"))
|
942
970
|
ReplicationTask.add_member(:replication_task_arn, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationTaskArn"))
|
943
971
|
ReplicationTask.add_member(:replication_task_stats, Shapes::ShapeRef.new(shape: ReplicationTaskStats, location_name: "ReplicationTaskStats"))
|
972
|
+
ReplicationTask.add_member(:task_data, Shapes::ShapeRef.new(shape: String, location_name: "TaskData"))
|
944
973
|
ReplicationTask.struct_class = Types::ReplicationTask
|
945
974
|
|
946
975
|
ReplicationTaskAssessmentResult.add_member(:replication_task_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationTaskIdentifier"))
|
@@ -962,6 +991,11 @@ module Aws::DatabaseMigrationService
|
|
962
991
|
ReplicationTaskStats.add_member(:tables_loading, Shapes::ShapeRef.new(shape: Integer, location_name: "TablesLoading"))
|
963
992
|
ReplicationTaskStats.add_member(:tables_queued, Shapes::ShapeRef.new(shape: Integer, location_name: "TablesQueued"))
|
964
993
|
ReplicationTaskStats.add_member(:tables_errored, Shapes::ShapeRef.new(shape: Integer, location_name: "TablesErrored"))
|
994
|
+
ReplicationTaskStats.add_member(:fresh_start_date, Shapes::ShapeRef.new(shape: TStamp, location_name: "FreshStartDate"))
|
995
|
+
ReplicationTaskStats.add_member(:start_date, Shapes::ShapeRef.new(shape: TStamp, location_name: "StartDate"))
|
996
|
+
ReplicationTaskStats.add_member(:stop_date, Shapes::ShapeRef.new(shape: TStamp, location_name: "StopDate"))
|
997
|
+
ReplicationTaskStats.add_member(:full_load_start_date, Shapes::ShapeRef.new(shape: TStamp, location_name: "FullLoadStartDate"))
|
998
|
+
ReplicationTaskStats.add_member(:full_load_finish_date, Shapes::ShapeRef.new(shape: TStamp, location_name: "FullLoadFinishDate"))
|
965
999
|
ReplicationTaskStats.struct_class = Types::ReplicationTaskStats
|
966
1000
|
|
967
1001
|
ResourceAlreadyExistsFault.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
@@ -998,6 +1032,7 @@ module Aws::DatabaseMigrationService
|
|
998
1032
|
S3Settings.add_member(:cdc_inserts_only, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CdcInsertsOnly"))
|
999
1033
|
S3Settings.add_member(:timestamp_column_name, Shapes::ShapeRef.new(shape: String, location_name: "TimestampColumnName"))
|
1000
1034
|
S3Settings.add_member(:parquet_timestamp_in_millisecond, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ParquetTimestampInMillisecond"))
|
1035
|
+
S3Settings.add_member(:cdc_inserts_and_updates, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CdcInsertsAndUpdates"))
|
1001
1036
|
S3Settings.struct_class = Types::S3Settings
|
1002
1037
|
|
1003
1038
|
SNSInvalidTopicFault.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
@@ -1050,6 +1085,7 @@ module Aws::DatabaseMigrationService
|
|
1050
1085
|
SupportedEndpointType.add_member(:engine_name, Shapes::ShapeRef.new(shape: String, location_name: "EngineName"))
|
1051
1086
|
SupportedEndpointType.add_member(:supports_cdc, Shapes::ShapeRef.new(shape: Boolean, location_name: "SupportsCDC"))
|
1052
1087
|
SupportedEndpointType.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: ReplicationEndpointTypeValue, location_name: "EndpointType"))
|
1088
|
+
SupportedEndpointType.add_member(:replication_instance_engine_minimum_version, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationInstanceEngineMinimumVersion"))
|
1053
1089
|
SupportedEndpointType.add_member(:engine_display_name, Shapes::ShapeRef.new(shape: String, location_name: "EngineDisplayName"))
|
1054
1090
|
SupportedEndpointType.struct_class = Types::SupportedEndpointType
|
1055
1091
|
|
@@ -1066,6 +1102,9 @@ module Aws::DatabaseMigrationService
|
|
1066
1102
|
TableStatistics.add_member(:full_load_rows, Shapes::ShapeRef.new(shape: Long, location_name: "FullLoadRows"))
|
1067
1103
|
TableStatistics.add_member(:full_load_condtnl_chk_failed_rows, Shapes::ShapeRef.new(shape: Long, location_name: "FullLoadCondtnlChkFailedRows"))
|
1068
1104
|
TableStatistics.add_member(:full_load_error_rows, Shapes::ShapeRef.new(shape: Long, location_name: "FullLoadErrorRows"))
|
1105
|
+
TableStatistics.add_member(:full_load_start_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "FullLoadStartTime"))
|
1106
|
+
TableStatistics.add_member(:full_load_end_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "FullLoadEndTime"))
|
1107
|
+
TableStatistics.add_member(:full_load_reloaded, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "FullLoadReloaded"))
|
1069
1108
|
TableStatistics.add_member(:last_update_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "LastUpdateTime"))
|
1070
1109
|
TableStatistics.add_member(:table_state, Shapes::ShapeRef.new(shape: String, location_name: "TableState"))
|
1071
1110
|
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
|
@@ -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
|
@@ -330,6 +346,15 @@ module Aws::DatabaseMigrationService
|
|
330
346
|
# full_load_error_percentage: 1,
|
331
347
|
# error_retry_duration: 1,
|
332
348
|
# },
|
349
|
+
# neptune_settings: {
|
350
|
+
# service_access_role_arn: "String",
|
351
|
+
# s3_bucket_name: "String", # required
|
352
|
+
# s3_bucket_folder: "String", # required
|
353
|
+
# error_retry_duration: 1,
|
354
|
+
# max_file_size: 1,
|
355
|
+
# max_retry_count: 1,
|
356
|
+
# iam_auth_enabled: false,
|
357
|
+
# },
|
333
358
|
# redshift_settings: {
|
334
359
|
# accept_any_date: false,
|
335
360
|
# after_connect_script: "String",
|
@@ -361,8 +386,8 @@ module Aws::DatabaseMigrationService
|
|
361
386
|
#
|
362
387
|
# @!attribute [rw] endpoint_identifier
|
363
388
|
# The database endpoint identifier. Identifiers must begin with a
|
364
|
-
# letter
|
365
|
-
#
|
389
|
+
# letter and must contain only ASCII letters, digits, and hyphens.
|
390
|
+
# They can't end with a hyphen or contain two consecutive hyphens.
|
366
391
|
# @return [String]
|
367
392
|
#
|
368
393
|
# @!attribute [rw] endpoint_type
|
@@ -371,9 +396,11 @@ module Aws::DatabaseMigrationService
|
|
371
396
|
#
|
372
397
|
# @!attribute [rw] engine_name
|
373
398
|
# 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`,
|
399
|
+
# `EndpointType` value, include `"mysql"`, `"oracle"`, `"postgres"`,
|
400
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
401
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
402
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
403
|
+
# `"sqlserver"`.
|
377
404
|
# @return [String]
|
378
405
|
#
|
379
406
|
# @!attribute [rw] username
|
@@ -446,7 +473,7 @@ module Aws::DatabaseMigrationService
|
|
446
473
|
#
|
447
474
|
# @!attribute [rw] dynamo_db_settings
|
448
475
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
449
|
-
#
|
476
|
+
# information about other available settings, see [Using Object
|
450
477
|
# Mapping to Migrate Data to DynamoDB][1] in the *AWS Database
|
451
478
|
# Migration Service User Guide.*
|
452
479
|
#
|
@@ -491,27 +518,37 @@ module Aws::DatabaseMigrationService
|
|
491
518
|
#
|
492
519
|
# @!attribute [rw] mongo_db_settings
|
493
520
|
# Settings in JSON format for the source MongoDB endpoint. For more
|
494
|
-
# information about the available settings, see
|
495
|
-
#
|
496
|
-
# Migration Service
|
497
|
-
# Guide.*
|
521
|
+
# information about the available settings, see [Using MongoDB as a
|
522
|
+
# Target for AWS Database Migration Service][1] in the *AWS Database
|
523
|
+
# Migration Service User Guide.*
|
498
524
|
#
|
499
525
|
#
|
500
526
|
#
|
501
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html
|
527
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration
|
502
528
|
# @return [Types::MongoDbSettings]
|
503
529
|
#
|
504
530
|
# @!attribute [rw] kinesis_settings
|
505
|
-
# Settings in JSON format for the target Amazon Kinesis
|
506
|
-
#
|
507
|
-
# [Using
|
508
|
-
# in the *AWS Database Migration User Guide.*
|
531
|
+
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
532
|
+
# Data Streams. For more information about the available settings, see
|
533
|
+
# [Using Amazon Kinesis Data Streams as a Target for AWS Database
|
534
|
+
# Migration Service][1] in the *AWS Database Migration User Guide.*
|
509
535
|
#
|
510
536
|
#
|
511
537
|
#
|
512
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html
|
538
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html
|
513
539
|
# @return [Types::KinesisSettings]
|
514
540
|
#
|
541
|
+
# @!attribute [rw] kafka_settings
|
542
|
+
# Settings in JSON format for the target Apache Kafka endpoint. For
|
543
|
+
# more information about the available settings, see [Using Apache
|
544
|
+
# Kafka as a Target for AWS Database Migration Service][1] in the *AWS
|
545
|
+
# Database Migration User Guide.*
|
546
|
+
#
|
547
|
+
#
|
548
|
+
#
|
549
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html
|
550
|
+
# @return [Types::KafkaSettings]
|
551
|
+
#
|
515
552
|
# @!attribute [rw] elasticsearch_settings
|
516
553
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
517
554
|
# more information about the available settings, see [Extra Connection
|
@@ -523,7 +560,19 @@ module Aws::DatabaseMigrationService
|
|
523
560
|
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration
|
524
561
|
# @return [Types::ElasticsearchSettings]
|
525
562
|
#
|
563
|
+
# @!attribute [rw] neptune_settings
|
564
|
+
# Settings in JSON format for the target Amazon Neptune endpoint. For
|
565
|
+
# more information about the available settings, see
|
566
|
+
# [https://docs.aws.amazon.com/dms/latest/userguide/CHAP\_Target.Neptune.html#CHAP\_Target.Neptune.EndpointSettings][1]
|
567
|
+
# in the *AWS Database Migration Service User Guide.*
|
568
|
+
#
|
569
|
+
#
|
570
|
+
#
|
571
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings
|
572
|
+
# @return [Types::NeptuneSettings]
|
573
|
+
#
|
526
574
|
# @!attribute [rw] redshift_settings
|
575
|
+
# Provides information that defines an Amazon Redshift endpoint.
|
527
576
|
# @return [Types::RedshiftSettings]
|
528
577
|
#
|
529
578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateEndpointMessage AWS API Documentation
|
@@ -549,7 +598,9 @@ module Aws::DatabaseMigrationService
|
|
549
598
|
:dms_transfer_settings,
|
550
599
|
:mongo_db_settings,
|
551
600
|
:kinesis_settings,
|
601
|
+
:kafka_settings,
|
552
602
|
:elasticsearch_settings,
|
603
|
+
:neptune_settings,
|
553
604
|
:redshift_settings)
|
554
605
|
include Aws::Structure
|
555
606
|
end
|
@@ -598,7 +649,7 @@ module Aws::DatabaseMigrationService
|
|
598
649
|
# The type of AWS DMS resource that generates the events. For example,
|
599
650
|
# if you want to be notified of events generated by a replication
|
600
651
|
# instance, you set this parameter to `replication-instance`. If this
|
601
|
-
# value
|
652
|
+
# value isn't specified, all events are returned.
|
602
653
|
#
|
603
654
|
# Valid values: `replication-instance` \| `replication-task`
|
604
655
|
# @return [String]
|
@@ -694,7 +745,7 @@ module Aws::DatabaseMigrationService
|
|
694
745
|
#
|
695
746
|
# * First character must be a letter.
|
696
747
|
#
|
697
|
-
# *
|
748
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
698
749
|
#
|
699
750
|
# Example: `myrepinstance`
|
700
751
|
# @return [String]
|
@@ -720,7 +771,7 @@ module Aws::DatabaseMigrationService
|
|
720
771
|
# @return [Array<String>]
|
721
772
|
#
|
722
773
|
# @!attribute [rw] availability_zone
|
723
|
-
# The
|
774
|
+
# The Availability Zone where the replication instance will be
|
724
775
|
# created. The default value is a random, system-chosen Availability
|
725
776
|
# Zone in the endpoint's AWS Region, for example: `us-east-1d`
|
726
777
|
# @return [String]
|
@@ -745,7 +796,7 @@ module Aws::DatabaseMigrationService
|
|
745
796
|
#
|
746
797
|
# @!attribute [rw] multi_az
|
747
798
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
748
|
-
# You
|
799
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
749
800
|
# parameter is set to `true`.
|
750
801
|
# @return [Boolean]
|
751
802
|
#
|
@@ -754,7 +805,7 @@ module Aws::DatabaseMigrationService
|
|
754
805
|
# @return [String]
|
755
806
|
#
|
756
807
|
# @!attribute [rw] auto_minor_version_upgrade
|
757
|
-
#
|
808
|
+
# A value that indicates whether minor engine upgrades are applied
|
758
809
|
# automatically to the replication instance during the maintenance
|
759
810
|
# window. This parameter defaults to `true`.
|
760
811
|
#
|
@@ -897,6 +948,7 @@ module Aws::DatabaseMigrationService
|
|
897
948
|
# value: "String",
|
898
949
|
# },
|
899
950
|
# ],
|
951
|
+
# task_data: "String",
|
900
952
|
# }
|
901
953
|
#
|
902
954
|
# @!attribute [rw] replication_task_identifier
|
@@ -932,8 +984,8 @@ module Aws::DatabaseMigrationService
|
|
932
984
|
#
|
933
985
|
# @!attribute [rw] table_mappings
|
934
986
|
# The table mappings for the task, in JSON format. For more
|
935
|
-
# information, see [Table Mapping][1]
|
936
|
-
# User Guide.*
|
987
|
+
# information, see [Using Table Mapping to Specify Task Settings][1]
|
988
|
+
# in the *AWS Database Migration User Guide.*
|
937
989
|
#
|
938
990
|
#
|
939
991
|
#
|
@@ -942,7 +994,8 @@ module Aws::DatabaseMigrationService
|
|
942
994
|
#
|
943
995
|
# @!attribute [rw] replication_task_settings
|
944
996
|
# Overall settings for the task, in JSON format. For more information,
|
945
|
-
# see [Task Settings
|
997
|
+
# see [Specifying Task Settings for AWS Database Migration Service
|
998
|
+
# Tasks][1] in the *AWS Database Migration User Guide.*
|
946
999
|
#
|
947
1000
|
#
|
948
1001
|
#
|
@@ -972,6 +1025,19 @@ module Aws::DatabaseMigrationService
|
|
972
1025
|
# "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
|
973
1026
|
#
|
974
1027
|
# LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
|
1028
|
+
#
|
1029
|
+
# <note markdown="1"> When you use this task setting with a source PostgreSQL database, a
|
1030
|
+
# logical replication slot should already be created and associated
|
1031
|
+
# with the source endpoint. You can verify this by setting the
|
1032
|
+
# `slotName` extra connection attribute to the name of this logical
|
1033
|
+
# replication slot. For more information, see [Extra Connection
|
1034
|
+
# Attributes When Using PostgreSQL as a Source for AWS DMS][1].
|
1035
|
+
#
|
1036
|
+
# </note>
|
1037
|
+
#
|
1038
|
+
#
|
1039
|
+
#
|
1040
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib
|
975
1041
|
# @return [String]
|
976
1042
|
#
|
977
1043
|
# @!attribute [rw] cdc_stop_position
|
@@ -989,6 +1055,17 @@ module Aws::DatabaseMigrationService
|
|
989
1055
|
# One or more tags to be assigned to the replication task.
|
990
1056
|
# @return [Array<Types::Tag>]
|
991
1057
|
#
|
1058
|
+
# @!attribute [rw] task_data
|
1059
|
+
# Supplemental information that the task requires to migrate the data
|
1060
|
+
# for certain source and target endpoints. For more information, see
|
1061
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *AWS
|
1062
|
+
# Database Migration User Guide.*
|
1063
|
+
#
|
1064
|
+
#
|
1065
|
+
#
|
1066
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html
|
1067
|
+
# @return [String]
|
1068
|
+
#
|
992
1069
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateReplicationTaskMessage AWS API Documentation
|
993
1070
|
#
|
994
1071
|
class CreateReplicationTaskMessage < Struct.new(
|
@@ -1002,7 +1079,8 @@ module Aws::DatabaseMigrationService
|
|
1002
1079
|
:cdc_start_time,
|
1003
1080
|
:cdc_start_position,
|
1004
1081
|
:cdc_stop_position,
|
1005
|
-
:tags
|
1082
|
+
:tags,
|
1083
|
+
:task_data)
|
1006
1084
|
include Aws::Structure
|
1007
1085
|
end
|
1008
1086
|
|
@@ -1288,7 +1366,7 @@ module Aws::DatabaseMigrationService
|
|
1288
1366
|
# @!attribute [rw] marker
|
1289
1367
|
# An optional pagination token provided by a previous request. If this
|
1290
1368
|
# parameter is specified, the response includes only records beyond
|
1291
|
-
# the marker, up to the
|
1369
|
+
# the marker, up to the value specified by `MaxRecords`.
|
1292
1370
|
# @return [String]
|
1293
1371
|
#
|
1294
1372
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeCertificatesMessage AWS API Documentation
|
@@ -2014,6 +2092,8 @@ module Aws::DatabaseMigrationService
|
|
2014
2092
|
#
|
2015
2093
|
# @!attribute [rw] filters
|
2016
2094
|
# Filters applied to the describe action.
|
2095
|
+
#
|
2096
|
+
# Valid filter names: replication-subnet-group-id
|
2017
2097
|
# @return [Array<Types::Filter>]
|
2018
2098
|
#
|
2019
2099
|
# @!attribute [rw] max_records
|
@@ -2070,9 +2150,9 @@ module Aws::DatabaseMigrationService
|
|
2070
2150
|
# }
|
2071
2151
|
#
|
2072
2152
|
# @!attribute [rw] replication_task_arn
|
2073
|
-
#
|
2074
|
-
# task. When this input parameter is specified the API
|
2075
|
-
#
|
2153
|
+
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
2154
|
+
# task. When this input parameter is specified, the API returns only
|
2155
|
+
# one result and ignore the values of the `MaxRecords` and `Marker`
|
2076
2156
|
# parameters.
|
2077
2157
|
# @return [String]
|
2078
2158
|
#
|
@@ -2361,6 +2441,10 @@ module Aws::DatabaseMigrationService
|
|
2361
2441
|
include Aws::Structure
|
2362
2442
|
end
|
2363
2443
|
|
2444
|
+
# Provides the Amazon Resource Name (ARN) of the AWS Identity and Access
|
2445
|
+
# Management (IAM) role used to define an Amazon DynamoDB target
|
2446
|
+
# endpoint.
|
2447
|
+
#
|
2364
2448
|
# @note When making an API call, you may pass DynamoDbSettings
|
2365
2449
|
# data as a hash:
|
2366
2450
|
#
|
@@ -2379,6 +2463,8 @@ module Aws::DatabaseMigrationService
|
|
2379
2463
|
include Aws::Structure
|
2380
2464
|
end
|
2381
2465
|
|
2466
|
+
# Provides information that defines an Elasticsearch endpoint.
|
2467
|
+
#
|
2382
2468
|
# @note When making an API call, you may pass ElasticsearchSettings
|
2383
2469
|
# data as a hash:
|
2384
2470
|
#
|
@@ -2404,8 +2490,8 @@ module Aws::DatabaseMigrationService
|
|
2404
2490
|
# @return [Integer]
|
2405
2491
|
#
|
2406
2492
|
# @!attribute [rw] error_retry_duration
|
2407
|
-
# The maximum number of seconds
|
2408
|
-
# to the Elasticsearch cluster.
|
2493
|
+
# The maximum number of seconds for which DMS retries failed API
|
2494
|
+
# requests to the Elasticsearch cluster.
|
2409
2495
|
# @return [Integer]
|
2410
2496
|
#
|
2411
2497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ElasticsearchSettings AWS API Documentation
|
@@ -2418,10 +2504,21 @@ module Aws::DatabaseMigrationService
|
|
2418
2504
|
include Aws::Structure
|
2419
2505
|
end
|
2420
2506
|
|
2507
|
+
# Describes an endpoint of a database instance in response to operations
|
2508
|
+
# such as the following:
|
2509
|
+
#
|
2510
|
+
# * `CreateEndpoint`
|
2511
|
+
#
|
2512
|
+
# * `DescribeEndpoint`
|
2513
|
+
#
|
2514
|
+
# * `DescribeEndpointTypes`
|
2515
|
+
#
|
2516
|
+
# * `ModifyEndpoint`
|
2517
|
+
#
|
2421
2518
|
# @!attribute [rw] endpoint_identifier
|
2422
2519
|
# The database endpoint identifier. Identifiers must begin with a
|
2423
|
-
# letter
|
2424
|
-
#
|
2520
|
+
# letter and must contain only ASCII letters, digits, and hyphens.
|
2521
|
+
# They can't end with a hyphen or contain two consecutive hyphens.
|
2425
2522
|
# @return [String]
|
2426
2523
|
#
|
2427
2524
|
# @!attribute [rw] endpoint_type
|
@@ -2430,9 +2527,11 @@ module Aws::DatabaseMigrationService
|
|
2430
2527
|
#
|
2431
2528
|
# @!attribute [rw] engine_name
|
2432
2529
|
# The database engine name. Valid values, depending on the
|
2433
|
-
# EndpointType, include mysql
|
2434
|
-
# aurora-postgresql
|
2435
|
-
#
|
2530
|
+
# EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
|
2531
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
2532
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
2533
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
2534
|
+
# `"sqlserver"`.
|
2436
2535
|
# @return [String]
|
2437
2536
|
#
|
2438
2537
|
# @!attribute [rw] engine_display_name
|
@@ -2545,15 +2644,25 @@ module Aws::DatabaseMigrationService
|
|
2545
2644
|
# @return [Types::MongoDbSettings]
|
2546
2645
|
#
|
2547
2646
|
# @!attribute [rw] kinesis_settings
|
2548
|
-
# The settings for the Amazon Kinesis
|
2647
|
+
# The settings for the Amazon Kinesis target endpoint. For more
|
2549
2648
|
# information, see the `KinesisSettings` structure.
|
2550
2649
|
# @return [Types::KinesisSettings]
|
2551
2650
|
#
|
2651
|
+
# @!attribute [rw] kafka_settings
|
2652
|
+
# The settings for the Apache Kafka target endpoint. For more
|
2653
|
+
# information, see the `KafkaSettings` structure.
|
2654
|
+
# @return [Types::KafkaSettings]
|
2655
|
+
#
|
2552
2656
|
# @!attribute [rw] elasticsearch_settings
|
2553
2657
|
# The settings for the Elasticsearch source endpoint. For more
|
2554
2658
|
# information, see the `ElasticsearchSettings` structure.
|
2555
2659
|
# @return [Types::ElasticsearchSettings]
|
2556
2660
|
#
|
2661
|
+
# @!attribute [rw] neptune_settings
|
2662
|
+
# The settings for the MongoDB source endpoint. For more information,
|
2663
|
+
# see the `NeptuneSettings` structure.
|
2664
|
+
# @return [Types::NeptuneSettings]
|
2665
|
+
#
|
2557
2666
|
# @!attribute [rw] redshift_settings
|
2558
2667
|
# Settings for the Amazon Redshift endpoint.
|
2559
2668
|
# @return [Types::RedshiftSettings]
|
@@ -2583,11 +2692,18 @@ module Aws::DatabaseMigrationService
|
|
2583
2692
|
:dms_transfer_settings,
|
2584
2693
|
:mongo_db_settings,
|
2585
2694
|
:kinesis_settings,
|
2695
|
+
:kafka_settings,
|
2586
2696
|
:elasticsearch_settings,
|
2697
|
+
:neptune_settings,
|
2587
2698
|
:redshift_settings)
|
2588
2699
|
include Aws::Structure
|
2589
2700
|
end
|
2590
2701
|
|
2702
|
+
# Describes an identifiable significant activity that affects a
|
2703
|
+
# replication instance or task. This object can provide the message, the
|
2704
|
+
# available event categories, the date and source of the event, and the
|
2705
|
+
# AWS DMS resource type.
|
2706
|
+
#
|
2591
2707
|
# @!attribute [rw] source_identifier
|
2592
2708
|
# The identifier of an event source.
|
2593
2709
|
# @return [String]
|
@@ -2621,6 +2737,9 @@ module Aws::DatabaseMigrationService
|
|
2621
2737
|
include Aws::Structure
|
2622
2738
|
end
|
2623
2739
|
|
2740
|
+
# Lists categories of events subscribed to, and generated by, the
|
2741
|
+
# applicable AWS DMS resource type.
|
2742
|
+
#
|
2624
2743
|
# @!attribute [rw] source_type
|
2625
2744
|
# The type of AWS DMS resource that generates events.
|
2626
2745
|
#
|
@@ -2640,6 +2759,9 @@ module Aws::DatabaseMigrationService
|
|
2640
2759
|
include Aws::Structure
|
2641
2760
|
end
|
2642
2761
|
|
2762
|
+
# Describes an event notification subscription created by the
|
2763
|
+
# `CreateEventSubscription` operation.
|
2764
|
+
#
|
2643
2765
|
# @!attribute [rw] customer_aws_id
|
2644
2766
|
# The AWS customer account associated with the AWS DMS event
|
2645
2767
|
# notification subscription.
|
@@ -2705,6 +2827,10 @@ module Aws::DatabaseMigrationService
|
|
2705
2827
|
include Aws::Structure
|
2706
2828
|
end
|
2707
2829
|
|
2830
|
+
# Identifies the name and value of a source filter object used to limit
|
2831
|
+
# the number and type of records transferred from your source to your
|
2832
|
+
# target.
|
2833
|
+
#
|
2708
2834
|
# @note When making an API call, you may pass Filter
|
2709
2835
|
# data as a hash:
|
2710
2836
|
#
|
@@ -2746,8 +2872,9 @@ module Aws::DatabaseMigrationService
|
|
2746
2872
|
#
|
2747
2873
|
# @!attribute [rw] certificate_identifier
|
2748
2874
|
# A customer-assigned name for the certificate. Identifiers must begin
|
2749
|
-
# with a letter
|
2750
|
-
#
|
2875
|
+
# with a letter and must contain only ASCII letters, digits, and
|
2876
|
+
# hyphens. They can't end with a hyphen or contain two consecutive
|
2877
|
+
# hyphens.
|
2751
2878
|
# @return [String]
|
2752
2879
|
#
|
2753
2880
|
# @!attribute [rw] certificate_pem
|
@@ -2907,13 +3034,57 @@ module Aws::DatabaseMigrationService
|
|
2907
3034
|
include Aws::Structure
|
2908
3035
|
end
|
2909
3036
|
|
3037
|
+
# Provides information that describes an Apache Kafka endpoint. This
|
3038
|
+
# information includes the output format of records applied to the
|
3039
|
+
# endpoint and details of transaction and control table data
|
3040
|
+
# information.
|
3041
|
+
#
|
3042
|
+
# @note When making an API call, you may pass KafkaSettings
|
3043
|
+
# data as a hash:
|
3044
|
+
#
|
3045
|
+
# {
|
3046
|
+
# broker: "String",
|
3047
|
+
# topic: "String",
|
3048
|
+
# }
|
3049
|
+
#
|
3050
|
+
# @!attribute [rw] broker
|
3051
|
+
# The broker location and port of the Kafka broker that hosts your
|
3052
|
+
# Kafka instance. Specify the broker in the form `
|
3053
|
+
# broker-hostname-or-ip:port `. For example,
|
3054
|
+
# `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"`.
|
3055
|
+
# @return [String]
|
3056
|
+
#
|
3057
|
+
# @!attribute [rw] topic
|
3058
|
+
# The topic to which you migrate the data. If you don't specify a
|
3059
|
+
# topic, AWS DMS specifies `"kafka-default-topic"` as the migration
|
3060
|
+
# topic.
|
3061
|
+
# @return [String]
|
3062
|
+
#
|
3063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KafkaSettings AWS API Documentation
|
3064
|
+
#
|
3065
|
+
class KafkaSettings < Struct.new(
|
3066
|
+
:broker,
|
3067
|
+
:topic)
|
3068
|
+
include Aws::Structure
|
3069
|
+
end
|
3070
|
+
|
3071
|
+
# Provides information that describes an Amazon Kinesis Data Stream
|
3072
|
+
# endpoint. This information includes the output format of records
|
3073
|
+
# applied to the endpoint and details of transaction and control table
|
3074
|
+
# data information.
|
3075
|
+
#
|
2910
3076
|
# @note When making an API call, you may pass KinesisSettings
|
2911
3077
|
# data as a hash:
|
2912
3078
|
#
|
2913
3079
|
# {
|
2914
3080
|
# stream_arn: "String",
|
2915
|
-
# message_format: "json", # accepts json
|
3081
|
+
# message_format: "json", # accepts json, json-unformatted
|
2916
3082
|
# service_access_role_arn: "String",
|
3083
|
+
# include_transaction_details: false,
|
3084
|
+
# include_partition_value: false,
|
3085
|
+
# partition_include_schema_table: false,
|
3086
|
+
# include_table_alter_operations: false,
|
3087
|
+
# include_control_details: false,
|
2917
3088
|
# }
|
2918
3089
|
#
|
2919
3090
|
# @!attribute [rw] stream_arn
|
@@ -2923,20 +3094,63 @@ module Aws::DatabaseMigrationService
|
|
2923
3094
|
#
|
2924
3095
|
# @!attribute [rw] message_format
|
2925
3096
|
# The output format for the records created on the endpoint. The
|
2926
|
-
# message format is `JSON
|
3097
|
+
# message format is `JSON` (default) or `JSON_UNFORMATTED` (a single
|
3098
|
+
# line with no tab).
|
2927
3099
|
# @return [String]
|
2928
3100
|
#
|
2929
3101
|
# @!attribute [rw] service_access_role_arn
|
2930
|
-
# The Amazon Resource Name (ARN) for the
|
2931
|
-
# write to the
|
3102
|
+
# The Amazon Resource Name (ARN) for the AWS Identity and Access
|
3103
|
+
# Management (IAM) role that AWS DMS uses to write to the Kinesis data
|
3104
|
+
# stream.
|
2932
3105
|
# @return [String]
|
2933
3106
|
#
|
3107
|
+
# @!attribute [rw] include_transaction_details
|
3108
|
+
# Provides detailed transaction information from the source database.
|
3109
|
+
# This information includes a commit timestamp, a log position, and
|
3110
|
+
# values for `transaction_id`, previous `transaction_id`, and
|
3111
|
+
# `transaction_record_id` (the record offset within a transaction).
|
3112
|
+
# The default is `False`.
|
3113
|
+
# @return [Boolean]
|
3114
|
+
#
|
3115
|
+
# @!attribute [rw] include_partition_value
|
3116
|
+
# Shows the partition value within the Kinesis message output, unless
|
3117
|
+
# the partition type is `schema-table-type`. The default is `False`.
|
3118
|
+
# @return [Boolean]
|
3119
|
+
#
|
3120
|
+
# @!attribute [rw] partition_include_schema_table
|
3121
|
+
# Prefixes schema and table names to partition values, when the
|
3122
|
+
# partition type is `primary-key-type`. Doing this increases data
|
3123
|
+
# distribution among Kinesis shards. For example, suppose that a
|
3124
|
+
# SysBench schema has thousands of tables and each table has only
|
3125
|
+
# limited range for a primary key. In this case, the same primary key
|
3126
|
+
# is sent from thousands of tables to the same shard, which causes
|
3127
|
+
# throttling. The default is `False`.
|
3128
|
+
# @return [Boolean]
|
3129
|
+
#
|
3130
|
+
# @!attribute [rw] include_table_alter_operations
|
3131
|
+
# Includes any data definition language (DDL) operations that change
|
3132
|
+
# the table in the control data, such as `rename-table`, `drop-table`,
|
3133
|
+
# `add-column`, `drop-column`, and `rename-column`. The default is
|
3134
|
+
# `False`.
|
3135
|
+
# @return [Boolean]
|
3136
|
+
#
|
3137
|
+
# @!attribute [rw] include_control_details
|
3138
|
+
# Shows detailed control information for table definition, column
|
3139
|
+
# definition, and table and column changes in the Kinesis message
|
3140
|
+
# output. The default is `False`.
|
3141
|
+
# @return [Boolean]
|
3142
|
+
#
|
2934
3143
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KinesisSettings AWS API Documentation
|
2935
3144
|
#
|
2936
3145
|
class KinesisSettings < Struct.new(
|
2937
3146
|
:stream_arn,
|
2938
3147
|
:message_format,
|
2939
|
-
:service_access_role_arn
|
3148
|
+
:service_access_role_arn,
|
3149
|
+
:include_transaction_details,
|
3150
|
+
:include_partition_value,
|
3151
|
+
:partition_include_schema_table,
|
3152
|
+
:include_table_alter_operations,
|
3153
|
+
:include_control_details)
|
2940
3154
|
include Aws::Structure
|
2941
3155
|
end
|
2942
3156
|
|
@@ -3012,6 +3226,7 @@ module Aws::DatabaseMigrationService
|
|
3012
3226
|
# cdc_inserts_only: false,
|
3013
3227
|
# timestamp_column_name: "String",
|
3014
3228
|
# parquet_timestamp_in_millisecond: false,
|
3229
|
+
# cdc_inserts_and_updates: false,
|
3015
3230
|
# },
|
3016
3231
|
# dms_transfer_settings: {
|
3017
3232
|
# service_access_role_arn: "String",
|
@@ -3033,8 +3248,17 @@ module Aws::DatabaseMigrationService
|
|
3033
3248
|
# },
|
3034
3249
|
# kinesis_settings: {
|
3035
3250
|
# stream_arn: "String",
|
3036
|
-
# message_format: "json", # accepts json
|
3251
|
+
# message_format: "json", # accepts json, json-unformatted
|
3037
3252
|
# service_access_role_arn: "String",
|
3253
|
+
# include_transaction_details: false,
|
3254
|
+
# include_partition_value: false,
|
3255
|
+
# partition_include_schema_table: false,
|
3256
|
+
# include_table_alter_operations: false,
|
3257
|
+
# include_control_details: false,
|
3258
|
+
# },
|
3259
|
+
# kafka_settings: {
|
3260
|
+
# broker: "String",
|
3261
|
+
# topic: "String",
|
3038
3262
|
# },
|
3039
3263
|
# elasticsearch_settings: {
|
3040
3264
|
# service_access_role_arn: "String", # required
|
@@ -3042,6 +3266,15 @@ module Aws::DatabaseMigrationService
|
|
3042
3266
|
# full_load_error_percentage: 1,
|
3043
3267
|
# error_retry_duration: 1,
|
3044
3268
|
# },
|
3269
|
+
# neptune_settings: {
|
3270
|
+
# service_access_role_arn: "String",
|
3271
|
+
# s3_bucket_name: "String", # required
|
3272
|
+
# s3_bucket_folder: "String", # required
|
3273
|
+
# error_retry_duration: 1,
|
3274
|
+
# max_file_size: 1,
|
3275
|
+
# max_retry_count: 1,
|
3276
|
+
# iam_auth_enabled: false,
|
3277
|
+
# },
|
3045
3278
|
# redshift_settings: {
|
3046
3279
|
# accept_any_date: false,
|
3047
3280
|
# after_connect_script: "String",
|
@@ -3078,8 +3311,8 @@ module Aws::DatabaseMigrationService
|
|
3078
3311
|
#
|
3079
3312
|
# @!attribute [rw] endpoint_identifier
|
3080
3313
|
# The database endpoint identifier. Identifiers must begin with a
|
3081
|
-
# letter
|
3082
|
-
#
|
3314
|
+
# letter and must contain only ASCII letters, digits, and hyphens.
|
3315
|
+
# They can't end with a hyphen or contain two consecutive hyphens.
|
3083
3316
|
# @return [String]
|
3084
3317
|
#
|
3085
3318
|
# @!attribute [rw] endpoint_type
|
@@ -3088,9 +3321,11 @@ module Aws::DatabaseMigrationService
|
|
3088
3321
|
#
|
3089
3322
|
# @!attribute [rw] engine_name
|
3090
3323
|
# The type of engine for the endpoint. Valid values, depending on the
|
3091
|
-
# EndpointType, include mysql
|
3092
|
-
# aurora-postgresql
|
3093
|
-
#
|
3324
|
+
# EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
|
3325
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
3326
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
3327
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
3328
|
+
# `"sqlserver"`.
|
3094
3329
|
# @return [String]
|
3095
3330
|
#
|
3096
3331
|
# @!attribute [rw] username
|
@@ -3139,7 +3374,7 @@ module Aws::DatabaseMigrationService
|
|
3139
3374
|
#
|
3140
3375
|
# @!attribute [rw] dynamo_db_settings
|
3141
3376
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
3142
|
-
#
|
3377
|
+
# information about other available settings, see [Using Object
|
3143
3378
|
# Mapping to Migrate Data to DynamoDB][1] in the *AWS Database
|
3144
3379
|
# Migration Service User Guide.*
|
3145
3380
|
#
|
@@ -3165,22 +3400,22 @@ module Aws::DatabaseMigrationService
|
|
3165
3400
|
#
|
3166
3401
|
# Attributes include the following:
|
3167
3402
|
#
|
3168
|
-
# * serviceAccessRoleArn - The
|
3169
|
-
# the Amazon S3 bucket.
|
3403
|
+
# * serviceAccessRoleArn - The AWS Identity and Access Management
|
3404
|
+
# (IAM) role that has permission to access the Amazon S3 bucket.
|
3170
3405
|
#
|
3171
3406
|
# * BucketName - The name of the S3 bucket to use.
|
3172
3407
|
#
|
3173
3408
|
# * compressionType - An optional parameter to use GZIP to compress
|
3174
|
-
# the target files.
|
3175
|
-
# the files uncompressed.
|
3176
|
-
#
|
3177
|
-
# Shorthand syntax: ServiceAccessRoleArn=string
|
3178
|
-
# ,BucketName=string,CompressionType=string
|
3409
|
+
# the target files. Either set this parameter to NONE (the default)
|
3410
|
+
# or don't use it to leave the files uncompressed.
|
3179
3411
|
#
|
3180
|
-
#
|
3412
|
+
# Shorthand syntax for these settings is as follows:
|
3413
|
+
# `ServiceAccessRoleArn=string
|
3414
|
+
# ,BucketName=string,CompressionType=string`
|
3181
3415
|
#
|
3182
|
-
#
|
3183
|
-
# "string", "
|
3416
|
+
# JSON syntax for these settings is as follows: `\{
|
3417
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string",
|
3418
|
+
# "CompressionType": "none"|"gzip" \} `
|
3184
3419
|
# @return [Types::DmsTransferSettings]
|
3185
3420
|
#
|
3186
3421
|
# @!attribute [rw] mongo_db_settings
|
@@ -3196,16 +3431,27 @@ module Aws::DatabaseMigrationService
|
|
3196
3431
|
# @return [Types::MongoDbSettings]
|
3197
3432
|
#
|
3198
3433
|
# @!attribute [rw] kinesis_settings
|
3199
|
-
# Settings in JSON format for the target Amazon Kinesis
|
3200
|
-
#
|
3201
|
-
# [Using
|
3202
|
-
# in the *AWS Database Migration User Guide.*
|
3434
|
+
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
3435
|
+
# Data Streams. For more information about the available settings, see
|
3436
|
+
# [Using Amazon Kinesis Data Streams as a Target for AWS Database
|
3437
|
+
# Migration Service][1] in the *AWS Database Migration User Guide.*
|
3203
3438
|
#
|
3204
3439
|
#
|
3205
3440
|
#
|
3206
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html
|
3441
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html
|
3207
3442
|
# @return [Types::KinesisSettings]
|
3208
3443
|
#
|
3444
|
+
# @!attribute [rw] kafka_settings
|
3445
|
+
# Settings in JSON format for the target Apache Kafka endpoint. For
|
3446
|
+
# more information about the available settings, see [Using Apache
|
3447
|
+
# Kafka as a Target for AWS Database Migration Service][1] in the *AWS
|
3448
|
+
# Database Migration User Guide.*
|
3449
|
+
#
|
3450
|
+
#
|
3451
|
+
#
|
3452
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html
|
3453
|
+
# @return [Types::KafkaSettings]
|
3454
|
+
#
|
3209
3455
|
# @!attribute [rw] elasticsearch_settings
|
3210
3456
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
3211
3457
|
# more information about the available settings, see [Extra Connection
|
@@ -3217,7 +3463,19 @@ module Aws::DatabaseMigrationService
|
|
3217
3463
|
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration
|
3218
3464
|
# @return [Types::ElasticsearchSettings]
|
3219
3465
|
#
|
3466
|
+
# @!attribute [rw] neptune_settings
|
3467
|
+
# Settings in JSON format for the target Amazon Neptune endpoint. For
|
3468
|
+
# more information about the available settings, see
|
3469
|
+
# [https://docs.aws.amazon.com/dms/latest/userguide/CHAP\_Target.Neptune.html#CHAP\_Target.Neptune.EndpointSettings][1]
|
3470
|
+
# in the *AWS Database Migration Service User Guide.*
|
3471
|
+
#
|
3472
|
+
#
|
3473
|
+
#
|
3474
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings
|
3475
|
+
# @return [Types::NeptuneSettings]
|
3476
|
+
#
|
3220
3477
|
# @!attribute [rw] redshift_settings
|
3478
|
+
# Provides information that defines an Amazon Redshift endpoint.
|
3221
3479
|
# @return [Types::RedshiftSettings]
|
3222
3480
|
#
|
3223
3481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ModifyEndpointMessage AWS API Documentation
|
@@ -3242,7 +3500,9 @@ module Aws::DatabaseMigrationService
|
|
3242
3500
|
:dms_transfer_settings,
|
3243
3501
|
:mongo_db_settings,
|
3244
3502
|
:kinesis_settings,
|
3503
|
+
:kafka_settings,
|
3245
3504
|
:elasticsearch_settings,
|
3505
|
+
:neptune_settings,
|
3246
3506
|
:redshift_settings)
|
3247
3507
|
include Aws::Structure
|
3248
3508
|
end
|
@@ -3384,7 +3644,7 @@ module Aws::DatabaseMigrationService
|
|
3384
3644
|
#
|
3385
3645
|
# @!attribute [rw] multi_az
|
3386
3646
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
3387
|
-
# You
|
3647
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
3388
3648
|
# parameter is set to `true`.
|
3389
3649
|
# @return [Boolean]
|
3390
3650
|
#
|
@@ -3403,13 +3663,20 @@ module Aws::DatabaseMigrationService
|
|
3403
3663
|
# @return [Boolean]
|
3404
3664
|
#
|
3405
3665
|
# @!attribute [rw] auto_minor_version_upgrade
|
3406
|
-
#
|
3407
|
-
# to the replication instance during the maintenance
|
3408
|
-
# this parameter
|
3409
|
-
# case
|
3410
|
-
#
|
3411
|
-
#
|
3412
|
-
#
|
3666
|
+
# A value that indicates that minor version upgrades are applied
|
3667
|
+
# automatically to the replication instance during the maintenance
|
3668
|
+
# window. Changing this parameter doesn't result in an outage, except
|
3669
|
+
# in the case dsecribed following. The change is asynchronously
|
3670
|
+
# applied as soon as possible.
|
3671
|
+
#
|
3672
|
+
# An outage does result if these factors apply:
|
3673
|
+
#
|
3674
|
+
# * This parameter is set to `true` during the maintenance window.
|
3675
|
+
#
|
3676
|
+
# * A newer minor version is available.
|
3677
|
+
#
|
3678
|
+
# * AWS DMS has enabled automatic patching for the given engine
|
3679
|
+
# version.
|
3413
3680
|
# @return [Boolean]
|
3414
3681
|
#
|
3415
3682
|
# @!attribute [rw] replication_instance_identifier
|
@@ -3498,6 +3765,7 @@ module Aws::DatabaseMigrationService
|
|
3498
3765
|
# cdc_start_time: Time.now,
|
3499
3766
|
# cdc_start_position: "String",
|
3500
3767
|
# cdc_stop_position: "String",
|
3768
|
+
# task_data: "String",
|
3501
3769
|
# }
|
3502
3770
|
#
|
3503
3771
|
# @!attribute [rw] replication_task_arn
|
@@ -3529,8 +3797,8 @@ module Aws::DatabaseMigrationService
|
|
3529
3797
|
# @return [String]
|
3530
3798
|
#
|
3531
3799
|
# @!attribute [rw] replication_task_settings
|
3532
|
-
# JSON file that contains settings for the task, such as
|
3533
|
-
#
|
3800
|
+
# JSON file that contains settings for the task, such as task metadata
|
3801
|
+
# settings.
|
3534
3802
|
# @return [String]
|
3535
3803
|
#
|
3536
3804
|
# @!attribute [rw] cdc_start_time
|
@@ -3556,6 +3824,19 @@ module Aws::DatabaseMigrationService
|
|
3556
3824
|
# "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
|
3557
3825
|
#
|
3558
3826
|
# LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
|
3827
|
+
#
|
3828
|
+
# <note markdown="1"> When you use this task setting with a source PostgreSQL database, a
|
3829
|
+
# logical replication slot should already be created and associated
|
3830
|
+
# with the source endpoint. You can verify this by setting the
|
3831
|
+
# `slotName` extra connection attribute to the name of this logical
|
3832
|
+
# replication slot. For more information, see [Extra Connection
|
3833
|
+
# Attributes When Using PostgreSQL as a Source for AWS DMS][1].
|
3834
|
+
#
|
3835
|
+
# </note>
|
3836
|
+
#
|
3837
|
+
#
|
3838
|
+
#
|
3839
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib
|
3559
3840
|
# @return [String]
|
3560
3841
|
#
|
3561
3842
|
# @!attribute [rw] cdc_stop_position
|
@@ -3569,6 +3850,17 @@ module Aws::DatabaseMigrationService
|
|
3569
3850
|
# 3018-02-09T12:12:12 “
|
3570
3851
|
# @return [String]
|
3571
3852
|
#
|
3853
|
+
# @!attribute [rw] task_data
|
3854
|
+
# Supplemental information that the task requires to migrate the data
|
3855
|
+
# for certain source and target endpoints. For more information, see
|
3856
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *AWS
|
3857
|
+
# Database Migration User Guide.*
|
3858
|
+
#
|
3859
|
+
#
|
3860
|
+
#
|
3861
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html
|
3862
|
+
# @return [String]
|
3863
|
+
#
|
3572
3864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ModifyReplicationTaskMessage AWS API Documentation
|
3573
3865
|
#
|
3574
3866
|
class ModifyReplicationTaskMessage < Struct.new(
|
@@ -3579,7 +3871,8 @@ module Aws::DatabaseMigrationService
|
|
3579
3871
|
:replication_task_settings,
|
3580
3872
|
:cdc_start_time,
|
3581
3873
|
:cdc_start_position,
|
3582
|
-
:cdc_stop_position
|
3874
|
+
:cdc_stop_position,
|
3875
|
+
:task_data)
|
3583
3876
|
include Aws::Structure
|
3584
3877
|
end
|
3585
3878
|
|
@@ -3594,6 +3887,8 @@ module Aws::DatabaseMigrationService
|
|
3594
3887
|
include Aws::Structure
|
3595
3888
|
end
|
3596
3889
|
|
3890
|
+
# Provides information that defines a MongoDB endpoint.
|
3891
|
+
#
|
3597
3892
|
# @note When making an API call, you may pass MongoDbSettings
|
3598
3893
|
# data as a hash:
|
3599
3894
|
#
|
@@ -3650,7 +3945,7 @@ module Aws::DatabaseMigrationService
|
|
3650
3945
|
# Valid values: DEFAULT, MONGODB\_CR, SCRAM\_SHA\_1
|
3651
3946
|
#
|
3652
3947
|
# DEFAULT – For MongoDB version 2.x, use MONGODB\_CR. For MongoDB
|
3653
|
-
# version 3.x, use SCRAM\_SHA\_1. This setting
|
3948
|
+
# version 3.x, use SCRAM\_SHA\_1. This setting isn't used when
|
3654
3949
|
# authType=No.
|
3655
3950
|
# @return [String]
|
3656
3951
|
#
|
@@ -3679,7 +3974,7 @@ module Aws::DatabaseMigrationService
|
|
3679
3974
|
# @return [String]
|
3680
3975
|
#
|
3681
3976
|
# @!attribute [rw] auth_source
|
3682
|
-
# The MongoDB database name. This setting
|
3977
|
+
# The MongoDB database name. This setting isn't used when
|
3683
3978
|
# `authType=NO`.
|
3684
3979
|
#
|
3685
3980
|
# The default is admin.
|
@@ -3712,6 +4007,88 @@ module Aws::DatabaseMigrationService
|
|
3712
4007
|
include Aws::Structure
|
3713
4008
|
end
|
3714
4009
|
|
4010
|
+
# Provides information that defines an Amazon Neptune endpoint.
|
4011
|
+
#
|
4012
|
+
# @note When making an API call, you may pass NeptuneSettings
|
4013
|
+
# data as a hash:
|
4014
|
+
#
|
4015
|
+
# {
|
4016
|
+
# service_access_role_arn: "String",
|
4017
|
+
# s3_bucket_name: "String", # required
|
4018
|
+
# s3_bucket_folder: "String", # required
|
4019
|
+
# error_retry_duration: 1,
|
4020
|
+
# max_file_size: 1,
|
4021
|
+
# max_retry_count: 1,
|
4022
|
+
# iam_auth_enabled: false,
|
4023
|
+
# }
|
4024
|
+
#
|
4025
|
+
# @!attribute [rw] service_access_role_arn
|
4026
|
+
# The ARN of the service role you have created for the Neptune target
|
4027
|
+
# endpoint. For more information, see
|
4028
|
+
# [https://docs.aws.amazon.com/dms/latest/userguide/CHAP\_Target.Neptune.html#CHAP\_Target.Neptune.ServiceRole][1]
|
4029
|
+
# in the *AWS Database Migration Service User Guide.*
|
4030
|
+
#
|
4031
|
+
#
|
4032
|
+
#
|
4033
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole
|
4034
|
+
# @return [String]
|
4035
|
+
#
|
4036
|
+
# @!attribute [rw] s3_bucket_name
|
4037
|
+
# The name of the S3 bucket for AWS DMS to temporarily store migrated
|
4038
|
+
# graph data in CSV files before bulk-loading it to the Neptune target
|
4039
|
+
# database. AWS DMS maps the SQL source data to graph data before
|
4040
|
+
# storing it in these CSV files.
|
4041
|
+
# @return [String]
|
4042
|
+
#
|
4043
|
+
# @!attribute [rw] s3_bucket_folder
|
4044
|
+
# A folder path where you where you want AWS DMS to store migrated
|
4045
|
+
# graph data in the S3 bucket specified by `S3BucketName`
|
4046
|
+
# @return [String]
|
4047
|
+
#
|
4048
|
+
# @!attribute [rw] error_retry_duration
|
4049
|
+
# The number of milliseconds for AWS DMS to wait to retry a bulk-load
|
4050
|
+
# of migrated graph data to the Neptune target database before raising
|
4051
|
+
# an error. The default is 250.
|
4052
|
+
# @return [Integer]
|
4053
|
+
#
|
4054
|
+
# @!attribute [rw] max_file_size
|
4055
|
+
# The maximum size in KB of migrated graph data stored in a CSV file
|
4056
|
+
# before AWS DMS bulk-loads the data to the Neptune target database.
|
4057
|
+
# The default is 1048576 KB. If successful, AWS DMS clears the bucket,
|
4058
|
+
# ready to store the next batch of migrated graph data.
|
4059
|
+
# @return [Integer]
|
4060
|
+
#
|
4061
|
+
# @!attribute [rw] max_retry_count
|
4062
|
+
# The number of times for AWS DMS to retry a bulk-load of migrated
|
4063
|
+
# graph data to the Neptune target database before raising an error.
|
4064
|
+
# The default is 5.
|
4065
|
+
# @return [Integer]
|
4066
|
+
#
|
4067
|
+
# @!attribute [rw] iam_auth_enabled
|
4068
|
+
# If you want IAM authorization enabled for this endpoint, set this
|
4069
|
+
# parameter to `true` and attach the appropriate role policy document
|
4070
|
+
# to your service role specified by `ServiceAccessRoleArn`. The
|
4071
|
+
# default is `false`.
|
4072
|
+
# @return [Boolean]
|
4073
|
+
#
|
4074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/NeptuneSettings AWS API Documentation
|
4075
|
+
#
|
4076
|
+
class NeptuneSettings < Struct.new(
|
4077
|
+
:service_access_role_arn,
|
4078
|
+
:s3_bucket_name,
|
4079
|
+
:s3_bucket_folder,
|
4080
|
+
:error_retry_duration,
|
4081
|
+
:max_file_size,
|
4082
|
+
:max_retry_count,
|
4083
|
+
:iam_auth_enabled)
|
4084
|
+
include Aws::Structure
|
4085
|
+
end
|
4086
|
+
|
4087
|
+
# In response to the `DescribeOrderableReplicationInstances` operation,
|
4088
|
+
# this object describes an available replication instance. This
|
4089
|
+
# description includes the replication instance's type, engine version,
|
4090
|
+
# and allocated storage.
|
4091
|
+
#
|
3715
4092
|
# @!attribute [rw] engine_version
|
3716
4093
|
# The version of the replication engine.
|
3717
4094
|
# @return [String]
|
@@ -3778,37 +4155,41 @@ module Aws::DatabaseMigrationService
|
|
3778
4155
|
include Aws::Structure
|
3779
4156
|
end
|
3780
4157
|
|
4158
|
+
# Describes a maintenance action pending for an AWS DMS resource,
|
4159
|
+
# including when and how it will be applied. This data type is a
|
4160
|
+
# response element to the `DescribePendingMaintenanceActions` operation.
|
4161
|
+
#
|
3781
4162
|
# @!attribute [rw] action
|
3782
4163
|
# The type of pending maintenance action that is available for the
|
3783
4164
|
# resource.
|
3784
4165
|
# @return [String]
|
3785
4166
|
#
|
3786
4167
|
# @!attribute [rw] auto_applied_after_date
|
3787
|
-
# The date of the maintenance window when the action
|
3788
|
-
# The maintenance action
|
3789
|
-
#
|
3790
|
-
#
|
4168
|
+
# The date of the maintenance window when the action is to be applied.
|
4169
|
+
# The maintenance action is applied to the resource during its first
|
4170
|
+
# maintenance window after this date. If this date is specified, any
|
4171
|
+
# `next-maintenance` opt-in requests are ignored.
|
3791
4172
|
# @return [Time]
|
3792
4173
|
#
|
3793
4174
|
# @!attribute [rw] forced_apply_date
|
3794
4175
|
# The date when the maintenance action will be automatically applied.
|
3795
|
-
# The maintenance action
|
4176
|
+
# The maintenance action is applied to the resource on this date
|
3796
4177
|
# regardless of the maintenance window for the resource. If this date
|
3797
4178
|
# is specified, any `immediate` opt-in requests are ignored.
|
3798
4179
|
# @return [Time]
|
3799
4180
|
#
|
3800
4181
|
# @!attribute [rw] opt_in_status
|
3801
|
-
#
|
3802
|
-
# resource.
|
4182
|
+
# The type of opt-in request that has been received for the resource.
|
3803
4183
|
# @return [String]
|
3804
4184
|
#
|
3805
4185
|
# @!attribute [rw] current_apply_date
|
3806
4186
|
# The effective date when the pending maintenance action will be
|
3807
4187
|
# applied to the resource. This date takes into account opt-in
|
3808
|
-
# requests received from the `ApplyPendingMaintenanceAction` API
|
3809
|
-
#
|
3810
|
-
# blank if an opt-in request has not
|
3811
|
-
# been
|
4188
|
+
# requests received from the `ApplyPendingMaintenanceAction` API
|
4189
|
+
# operation, and also the `AutoAppliedAfterDate` and `ForcedApplyDate`
|
4190
|
+
# parameter values. This value is blank if an opt-in request has not
|
4191
|
+
# been received and nothing has been specified for
|
4192
|
+
# `AutoAppliedAfterDate` or `ForcedApplyDate`.
|
3812
4193
|
# @return [Time]
|
3813
4194
|
#
|
3814
4195
|
# @!attribute [rw] description
|
@@ -3864,6 +4245,8 @@ module Aws::DatabaseMigrationService
|
|
3864
4245
|
include Aws::Structure
|
3865
4246
|
end
|
3866
4247
|
|
4248
|
+
# Provides information that defines an Amazon Redshift endpoint.
|
4249
|
+
#
|
3867
4250
|
# @note When making an API call, you may pass RedshiftSettings
|
3868
4251
|
# data as a hash:
|
3869
4252
|
#
|
@@ -4119,6 +4502,9 @@ module Aws::DatabaseMigrationService
|
|
4119
4502
|
include Aws::Structure
|
4120
4503
|
end
|
4121
4504
|
|
4505
|
+
# Provides information that describes status of a schema at an endpoint
|
4506
|
+
# specified by the `DescribeRefreshSchemaStatus` operation.
|
4507
|
+
#
|
4122
4508
|
# @!attribute [rw] endpoint_arn
|
4123
4509
|
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
4124
4510
|
# endpoint.
|
@@ -4235,6 +4621,8 @@ module Aws::DatabaseMigrationService
|
|
4235
4621
|
#
|
4236
4622
|
class RemoveTagsFromResourceResponse < Aws::EmptyStructure; end
|
4237
4623
|
|
4624
|
+
# Provides information that defines a replication instance.
|
4625
|
+
#
|
4238
4626
|
# @!attribute [rw] replication_instance_identifier
|
4239
4627
|
# The replication instance identifier. This parameter is stored as a
|
4240
4628
|
# lowercase string.
|
@@ -4293,7 +4681,7 @@ module Aws::DatabaseMigrationService
|
|
4293
4681
|
#
|
4294
4682
|
# @!attribute [rw] multi_az
|
4295
4683
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
4296
|
-
# You
|
4684
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
4297
4685
|
# parameter is set to `true`.
|
4298
4686
|
# @return [Boolean]
|
4299
4687
|
#
|
@@ -4346,7 +4734,7 @@ module Aws::DatabaseMigrationService
|
|
4346
4734
|
# @return [Boolean]
|
4347
4735
|
#
|
4348
4736
|
# @!attribute [rw] secondary_availability_zone
|
4349
|
-
# The
|
4737
|
+
# The Availability Zone of the standby replication instance in a
|
4350
4738
|
# Multi-AZ deployment.
|
4351
4739
|
# @return [String]
|
4352
4740
|
#
|
@@ -4411,6 +4799,10 @@ module Aws::DatabaseMigrationService
|
|
4411
4799
|
include Aws::Structure
|
4412
4800
|
end
|
4413
4801
|
|
4802
|
+
# Provides information about the values of pending modifications to a
|
4803
|
+
# replication instance. This data type is an object of the
|
4804
|
+
# `ReplicationInstance` user-defined data type.
|
4805
|
+
#
|
4414
4806
|
# @!attribute [rw] replication_instance_class
|
4415
4807
|
# The compute and memory capacity of the replication instance.
|
4416
4808
|
#
|
@@ -4426,7 +4818,7 @@ module Aws::DatabaseMigrationService
|
|
4426
4818
|
#
|
4427
4819
|
# @!attribute [rw] multi_az
|
4428
4820
|
# Specifies whether the replication instance is a Multi-AZ deployment.
|
4429
|
-
# You
|
4821
|
+
# You can't set the `AvailabilityZone` parameter if the Multi-AZ
|
4430
4822
|
# parameter is set to `true`.
|
4431
4823
|
# @return [Boolean]
|
4432
4824
|
#
|
@@ -4444,6 +4836,9 @@ module Aws::DatabaseMigrationService
|
|
4444
4836
|
include Aws::Structure
|
4445
4837
|
end
|
4446
4838
|
|
4839
|
+
# Describes a subnet group in response to a request by the
|
4840
|
+
# `DescribeReplicationSubnetGroup` operation.
|
4841
|
+
#
|
4447
4842
|
# @!attribute [rw] replication_subnet_group_identifier
|
4448
4843
|
# The identifier of the replication instance subnet group.
|
4449
4844
|
# @return [String]
|
@@ -4488,6 +4883,9 @@ module Aws::DatabaseMigrationService
|
|
4488
4883
|
include Aws::Structure
|
4489
4884
|
end
|
4490
4885
|
|
4886
|
+
# Provides information that describes a replication task created by the
|
4887
|
+
# `CreateReplicationTask` operation.
|
4888
|
+
#
|
4491
4889
|
# @!attribute [rw] replication_task_identifier
|
4492
4890
|
# The user-assigned replication task identifier or name.
|
4493
4891
|
#
|
@@ -4590,6 +4988,17 @@ module Aws::DatabaseMigrationService
|
|
4590
4988
|
# and table errors.
|
4591
4989
|
# @return [Types::ReplicationTaskStats]
|
4592
4990
|
#
|
4991
|
+
# @!attribute [rw] task_data
|
4992
|
+
# Supplemental information that the task requires to migrate the data
|
4993
|
+
# for certain source and target endpoints. For more information, see
|
4994
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *AWS
|
4995
|
+
# Database Migration User Guide.*
|
4996
|
+
#
|
4997
|
+
#
|
4998
|
+
#
|
4999
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html
|
5000
|
+
# @return [String]
|
5001
|
+
#
|
4593
5002
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ReplicationTask AWS API Documentation
|
4594
5003
|
#
|
4595
5004
|
class ReplicationTask < Struct.new(
|
@@ -4609,7 +5018,8 @@ module Aws::DatabaseMigrationService
|
|
4609
5018
|
:cdc_stop_position,
|
4610
5019
|
:recovery_checkpoint,
|
4611
5020
|
:replication_task_arn,
|
4612
|
-
:replication_task_stats
|
5021
|
+
:replication_task_stats,
|
5022
|
+
:task_data)
|
4613
5023
|
include Aws::Structure
|
4614
5024
|
end
|
4615
5025
|
|
@@ -4657,6 +5067,10 @@ module Aws::DatabaseMigrationService
|
|
4657
5067
|
include Aws::Structure
|
4658
5068
|
end
|
4659
5069
|
|
5070
|
+
# In response to a request by the `DescribeReplicationTasks` operation,
|
5071
|
+
# this object provides a collection of statistics about a replication
|
5072
|
+
# task.
|
5073
|
+
#
|
4660
5074
|
# @!attribute [rw] full_load_progress_percent
|
4661
5075
|
# The percent complete for the full load migration task.
|
4662
5076
|
# @return [Integer]
|
@@ -4681,6 +5095,33 @@ module Aws::DatabaseMigrationService
|
|
4681
5095
|
# The number of errors that have occurred during this task.
|
4682
5096
|
# @return [Integer]
|
4683
5097
|
#
|
5098
|
+
# @!attribute [rw] fresh_start_date
|
5099
|
+
# The date the replication task was started either with a fresh start
|
5100
|
+
# or a target reload.
|
5101
|
+
# @return [Time]
|
5102
|
+
#
|
5103
|
+
# @!attribute [rw] start_date
|
5104
|
+
# The date the replication task was started either with a fresh start
|
5105
|
+
# or a resume. For more information, see
|
5106
|
+
# [StartReplicationTaskType][1].
|
5107
|
+
#
|
5108
|
+
#
|
5109
|
+
#
|
5110
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html#DMS-StartReplicationTask-request-StartReplicationTaskType
|
5111
|
+
# @return [Time]
|
5112
|
+
#
|
5113
|
+
# @!attribute [rw] stop_date
|
5114
|
+
# The date the replication task was stopped.
|
5115
|
+
# @return [Time]
|
5116
|
+
#
|
5117
|
+
# @!attribute [rw] full_load_start_date
|
5118
|
+
# The date the replication task full load was started.
|
5119
|
+
# @return [Time]
|
5120
|
+
#
|
5121
|
+
# @!attribute [rw] full_load_finish_date
|
5122
|
+
# The date the replication task full load was completed.
|
5123
|
+
# @return [Time]
|
5124
|
+
#
|
4684
5125
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ReplicationTaskStats AWS API Documentation
|
4685
5126
|
#
|
4686
5127
|
class ReplicationTaskStats < Struct.new(
|
@@ -4689,7 +5130,12 @@ module Aws::DatabaseMigrationService
|
|
4689
5130
|
:tables_loaded,
|
4690
5131
|
:tables_loading,
|
4691
5132
|
:tables_queued,
|
4692
|
-
:tables_errored
|
5133
|
+
:tables_errored,
|
5134
|
+
:fresh_start_date,
|
5135
|
+
:start_date,
|
5136
|
+
:stop_date,
|
5137
|
+
:full_load_start_date,
|
5138
|
+
:full_load_finish_date)
|
4693
5139
|
include Aws::Structure
|
4694
5140
|
end
|
4695
5141
|
|
@@ -4721,6 +5167,8 @@ module Aws::DatabaseMigrationService
|
|
4721
5167
|
include Aws::Structure
|
4722
5168
|
end
|
4723
5169
|
|
5170
|
+
# Identifies an AWS DMS resource and any pending actions for it.
|
5171
|
+
#
|
4724
5172
|
# @!attribute [rw] resource_identifier
|
4725
5173
|
# The Amazon Resource Name (ARN) of the DMS resource that the pending
|
4726
5174
|
# maintenance action applies to. For information about creating an
|
@@ -4782,6 +5230,7 @@ module Aws::DatabaseMigrationService
|
|
4782
5230
|
# cdc_inserts_only: false,
|
4783
5231
|
# timestamp_column_name: "String",
|
4784
5232
|
# parquet_timestamp_in_millisecond: false,
|
5233
|
+
# cdc_inserts_and_updates: false,
|
4785
5234
|
# }
|
4786
5235
|
#
|
4787
5236
|
# @!attribute [rw] service_access_role_arn
|
@@ -4805,7 +5254,7 @@ module Aws::DatabaseMigrationService
|
|
4805
5254
|
# @!attribute [rw] bucket_folder
|
4806
5255
|
# An optional parameter to set a folder name in the S3 bucket. If
|
4807
5256
|
# provided, tables are created in the path `
|
4808
|
-
# bucketFolder/schema_name/table_name/`. If this parameter
|
5257
|
+
# bucketFolder/schema_name/table_name/`. If this parameter isn't
|
4809
5258
|
# specified, then the path used is ` schema_name/table_name/`.
|
4810
5259
|
# @return [String]
|
4811
5260
|
#
|
@@ -4815,9 +5264,9 @@ module Aws::DatabaseMigrationService
|
|
4815
5264
|
#
|
4816
5265
|
# @!attribute [rw] compression_type
|
4817
5266
|
# An optional parameter to use GZIP to compress the target files. Set
|
4818
|
-
# to GZIP to compress the target files.
|
4819
|
-
#
|
4820
|
-
# .parquet file formats.
|
5267
|
+
# to GZIP to compress the target files. Either set this parameter to
|
5268
|
+
# NONE (the default) or don't use it to leave the files uncompressed.
|
5269
|
+
# This parameter applies to both .csv and .parquet file formats.
|
4821
5270
|
# @return [String]
|
4822
5271
|
#
|
4823
5272
|
# @!attribute [rw] encryption_mode
|
@@ -4947,11 +5396,11 @@ module Aws::DatabaseMigrationService
|
|
4947
5396
|
# file. This allows the format of your target records from a full load
|
4948
5397
|
# to be consistent with the target records from a CDC load.
|
4949
5398
|
#
|
4950
|
-
# <note markdown="1"> This setting works together with the `CdcInsertsOnly`
|
4951
|
-
# output to .csv files only. For
|
4952
|
-
# settings work together, see
|
4953
|
-
# Migrated S3 Data][1] in the *AWS
|
4954
|
-
# Guide.*.
|
5399
|
+
# <note markdown="1"> This setting works together with the `CdcInsertsOnly` and the
|
5400
|
+
# `CdcInsertsAndUpdates` parameters for output to .csv files only. For
|
5401
|
+
# more information about how these settings work together, see
|
5402
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the *AWS
|
5403
|
+
# Database Migration Service User Guide.*.
|
4955
5404
|
#
|
4956
5405
|
# </note>
|
4957
5406
|
#
|
@@ -4981,8 +5430,14 @@ module Aws::DatabaseMigrationService
|
|
4981
5430
|
# Operations in Migrated S3 Data][1] in the *AWS Database Migration
|
4982
5431
|
# Service User Guide.*.
|
4983
5432
|
#
|
4984
|
-
# <note markdown="1"> AWS DMS supports
|
4985
|
-
# `IncludeOpForFullLoad` parameters in versions
|
5433
|
+
# <note markdown="1"> AWS DMS supports the interaction described preceding between the
|
5434
|
+
# `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions
|
5435
|
+
# 3.1.4 and later.
|
5436
|
+
#
|
5437
|
+
# `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to
|
5438
|
+
# `true` for the same endpoint. Set either `CdcInsertsOnly` or
|
5439
|
+
# `CdcInsertsAndUpdates` to `true` for the same endpoint, but not
|
5440
|
+
# both.
|
4986
5441
|
#
|
4987
5442
|
# </note>
|
4988
5443
|
#
|
@@ -5052,6 +5507,39 @@ module Aws::DatabaseMigrationService
|
|
5052
5507
|
# </note>
|
5053
5508
|
# @return [Boolean]
|
5054
5509
|
#
|
5510
|
+
# @!attribute [rw] cdc_inserts_and_updates
|
5511
|
+
# A value that enables a change data capture (CDC) load to write
|
5512
|
+
# INSERT and UPDATE operations to .csv or .parquet (columnar storage)
|
5513
|
+
# output files. The default setting is `false`, but when
|
5514
|
+
# `CdcInsertsAndUpdates` is set to `true`or `y`, INSERTs and UPDATEs
|
5515
|
+
# from the source database are migrated to the .csv or .parquet file.
|
5516
|
+
#
|
5517
|
+
# For .csv file format only, how these INSERTs and UPDATEs are
|
5518
|
+
# recorded depends on the value of the `IncludeOpForFullLoad`
|
5519
|
+
# parameter. If `IncludeOpForFullLoad` is set to `true`, the first
|
5520
|
+
# field of every CDC record is set to either `I` or `U` to indicate
|
5521
|
+
# INSERT and UPDATE operations at the source. But if
|
5522
|
+
# `IncludeOpForFullLoad` is set to `false`, CDC records are written
|
5523
|
+
# without an indication of INSERT or UPDATE operations at the source.
|
5524
|
+
# For more information about how these settings work together, see
|
5525
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the *AWS
|
5526
|
+
# Database Migration Service User Guide.*.
|
5527
|
+
#
|
5528
|
+
# <note markdown="1"> AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in
|
5529
|
+
# versions 3.3.1 and later.
|
5530
|
+
#
|
5531
|
+
# `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to
|
5532
|
+
# `true` for the same endpoint. Set either `CdcInsertsOnly` or
|
5533
|
+
# `CdcInsertsAndUpdates` to `true` for the same endpoint, but not
|
5534
|
+
# both.
|
5535
|
+
#
|
5536
|
+
# </note>
|
5537
|
+
#
|
5538
|
+
#
|
5539
|
+
#
|
5540
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps
|
5541
|
+
# @return [Boolean]
|
5542
|
+
#
|
5055
5543
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/S3Settings AWS API Documentation
|
5056
5544
|
#
|
5057
5545
|
class S3Settings < Struct.new(
|
@@ -5074,7 +5562,8 @@ module Aws::DatabaseMigrationService
|
|
5074
5562
|
:include_op_for_full_load,
|
5075
5563
|
:cdc_inserts_only,
|
5076
5564
|
:timestamp_column_name,
|
5077
|
-
:parquet_timestamp_in_millisecond
|
5565
|
+
:parquet_timestamp_in_millisecond,
|
5566
|
+
:cdc_inserts_and_updates)
|
5078
5567
|
include Aws::Structure
|
5079
5568
|
end
|
5080
5569
|
|
@@ -5174,6 +5663,19 @@ module Aws::DatabaseMigrationService
|
|
5174
5663
|
# "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
|
5175
5664
|
#
|
5176
5665
|
# LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
|
5666
|
+
#
|
5667
|
+
# <note markdown="1"> When you use this task setting with a source PostgreSQL database, a
|
5668
|
+
# logical replication slot should already be created and associated
|
5669
|
+
# with the source endpoint. You can verify this by setting the
|
5670
|
+
# `slotName` extra connection attribute to the name of this logical
|
5671
|
+
# replication slot. For more information, see [Extra Connection
|
5672
|
+
# Attributes When Using PostgreSQL as a Source for AWS DMS][1].
|
5673
|
+
#
|
5674
|
+
# </note>
|
5675
|
+
#
|
5676
|
+
#
|
5677
|
+
#
|
5678
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib
|
5177
5679
|
# @return [String]
|
5178
5680
|
#
|
5179
5681
|
# @!attribute [rw] cdc_stop_position
|
@@ -5250,6 +5752,10 @@ module Aws::DatabaseMigrationService
|
|
5250
5752
|
include Aws::Structure
|
5251
5753
|
end
|
5252
5754
|
|
5755
|
+
# In response to a request by the `DescribeReplicationSubnetGroup`
|
5756
|
+
# operation, this object identifies a subnet by its given Availability
|
5757
|
+
# Zone, subnet identifier, and status.
|
5758
|
+
#
|
5253
5759
|
# @!attribute [rw] subnet_identifier
|
5254
5760
|
# The subnet identifier.
|
5255
5761
|
# @return [String]
|
@@ -5283,11 +5789,18 @@ module Aws::DatabaseMigrationService
|
|
5283
5789
|
include Aws::Structure
|
5284
5790
|
end
|
5285
5791
|
|
5792
|
+
# Provides information about types of supported endpoints in response to
|
5793
|
+
# a request by the `DescribeEndpointTypes` operation. This information
|
5794
|
+
# includes the type of endpoint, the database engine name, and whether
|
5795
|
+
# change data capture (CDC) is supported.
|
5796
|
+
#
|
5286
5797
|
# @!attribute [rw] engine_name
|
5287
5798
|
# The database engine name. Valid values, depending on the
|
5288
|
-
# EndpointType, include mysql
|
5289
|
-
# aurora-postgresql
|
5290
|
-
#
|
5799
|
+
# EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`,
|
5800
|
+
# `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`,
|
5801
|
+
# `"s3"`, `"db2"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`,
|
5802
|
+
# `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, and
|
5803
|
+
# `"sqlserver"`.
|
5291
5804
|
# @return [String]
|
5292
5805
|
#
|
5293
5806
|
# @!attribute [rw] supports_cdc
|
@@ -5298,6 +5811,12 @@ module Aws::DatabaseMigrationService
|
|
5298
5811
|
# The type of endpoint. Valid values are `source` and `target`.
|
5299
5812
|
# @return [String]
|
5300
5813
|
#
|
5814
|
+
# @!attribute [rw] replication_instance_engine_minimum_version
|
5815
|
+
# The earliest AWS DMS engine version that supports this endpoint
|
5816
|
+
# engine. Note that endpoint engines released with AWS DMS versions
|
5817
|
+
# earlier than 3.1.1 do not return a value for this parameter.
|
5818
|
+
# @return [String]
|
5819
|
+
#
|
5301
5820
|
# @!attribute [rw] engine_display_name
|
5302
5821
|
# The expanded name for the engine name. For example, if the
|
5303
5822
|
# `EngineName` parameter is "aurora," this value would be "Amazon
|
@@ -5310,10 +5829,14 @@ module Aws::DatabaseMigrationService
|
|
5310
5829
|
:engine_name,
|
5311
5830
|
:supports_cdc,
|
5312
5831
|
:endpoint_type,
|
5832
|
+
:replication_instance_engine_minimum_version,
|
5313
5833
|
:engine_display_name)
|
5314
5834
|
include Aws::Structure
|
5315
5835
|
end
|
5316
5836
|
|
5837
|
+
# Provides a collection of table statistics in response to a request by
|
5838
|
+
# the `DescribeTableStatistics` operation.
|
5839
|
+
#
|
5317
5840
|
# @!attribute [rw] schema_name
|
5318
5841
|
# The schema name.
|
5319
5842
|
# @return [String]
|
@@ -5335,26 +5858,40 @@ module Aws::DatabaseMigrationService
|
|
5335
5858
|
# @return [Integer]
|
5336
5859
|
#
|
5337
5860
|
# @!attribute [rw] ddls
|
5338
|
-
# The
|
5861
|
+
# The data definition language (DDL) used to build and modify the
|
5339
5862
|
# structure of your tables.
|
5340
5863
|
# @return [Integer]
|
5341
5864
|
#
|
5342
5865
|
# @!attribute [rw] full_load_rows
|
5343
|
-
# The number of rows added during the
|
5866
|
+
# The number of rows added during the full load operation.
|
5344
5867
|
# @return [Integer]
|
5345
5868
|
#
|
5346
5869
|
# @!attribute [rw] full_load_condtnl_chk_failed_rows
|
5347
|
-
# The number of rows that failed conditional checks during the
|
5348
|
-
#
|
5870
|
+
# The number of rows that failed conditional checks during the full
|
5871
|
+
# load operation (valid only for migrations where DynamoDB is the
|
5872
|
+
# target).
|
5349
5873
|
# @return [Integer]
|
5350
5874
|
#
|
5351
5875
|
# @!attribute [rw] full_load_error_rows
|
5352
|
-
# The number of rows that failed to load during the
|
5353
|
-
# operation (valid only for DynamoDB
|
5876
|
+
# The number of rows that failed to load during the full load
|
5877
|
+
# operation (valid only for migrations where DynamoDB is the target).
|
5354
5878
|
# @return [Integer]
|
5355
5879
|
#
|
5880
|
+
# @!attribute [rw] full_load_start_time
|
5881
|
+
# The time when the full load operation started.
|
5882
|
+
# @return [Time]
|
5883
|
+
#
|
5884
|
+
# @!attribute [rw] full_load_end_time
|
5885
|
+
# The time when the full load operation completed.
|
5886
|
+
# @return [Time]
|
5887
|
+
#
|
5888
|
+
# @!attribute [rw] full_load_reloaded
|
5889
|
+
# A value that indicates if the table was reloaded (`true`) or loaded
|
5890
|
+
# as part of a new full load operation (`false`).
|
5891
|
+
# @return [Boolean]
|
5892
|
+
#
|
5356
5893
|
# @!attribute [rw] last_update_time
|
5357
|
-
# The last time
|
5894
|
+
# The last time a table was updated.
|
5358
5895
|
# @return [Time]
|
5359
5896
|
#
|
5360
5897
|
# @!attribute [rw] table_state
|
@@ -5374,36 +5911,36 @@ module Aws::DatabaseMigrationService
|
|
5374
5911
|
# @return [Integer]
|
5375
5912
|
#
|
5376
5913
|
# @!attribute [rw] validation_suspended_records
|
5377
|
-
# The number of records that
|
5914
|
+
# The number of records that couldn't be validated.
|
5378
5915
|
# @return [Integer]
|
5379
5916
|
#
|
5380
5917
|
# @!attribute [rw] validation_state
|
5381
5918
|
# The validation state of the table.
|
5382
5919
|
#
|
5383
|
-
#
|
5920
|
+
# This parameter can have the following values:
|
5384
5921
|
#
|
5385
|
-
# * Not enabled
|
5922
|
+
# * Not enabled - Validation isn't enabled for the table in the
|
5386
5923
|
# migration task.
|
5387
5924
|
#
|
5388
|
-
# * Pending records
|
5925
|
+
# * Pending records - Some records in the table are waiting for
|
5389
5926
|
# validation.
|
5390
5927
|
#
|
5391
|
-
# * Mismatched records
|
5392
|
-
# the source and target.
|
5928
|
+
# * Mismatched records - Some records in the table don't match
|
5929
|
+
# between the source and target.
|
5393
5930
|
#
|
5394
|
-
# * Suspended records
|
5931
|
+
# * Suspended records - Some records in the table couldn't be
|
5395
5932
|
# validated.
|
5396
5933
|
#
|
5397
|
-
# * No primary key
|
5398
|
-
# primary key.
|
5934
|
+
# * No primary key - The table couldn't be validated because it has
|
5935
|
+
# no primary key.
|
5399
5936
|
#
|
5400
|
-
# * Table error
|
5401
|
-
# state and some data
|
5937
|
+
# * Table error - The table wasn't validated because it's in an
|
5938
|
+
# error state and some data wasn't migrated.
|
5402
5939
|
#
|
5403
|
-
# * Validated
|
5940
|
+
# * Validated - All rows in the table are validated. If the table is
|
5404
5941
|
# updated, the status can change from Validated.
|
5405
5942
|
#
|
5406
|
-
# * Error
|
5943
|
+
# * Error - The table couldn't be validated because of an unexpected
|
5407
5944
|
# error.
|
5408
5945
|
# @return [String]
|
5409
5946
|
#
|
@@ -5423,6 +5960,9 @@ module Aws::DatabaseMigrationService
|
|
5423
5960
|
:full_load_rows,
|
5424
5961
|
:full_load_condtnl_chk_failed_rows,
|
5425
5962
|
:full_load_error_rows,
|
5963
|
+
:full_load_start_time,
|
5964
|
+
:full_load_end_time,
|
5965
|
+
:full_load_reloaded,
|
5426
5966
|
:last_update_time,
|
5427
5967
|
:table_state,
|
5428
5968
|
:validation_pending_records,
|
@@ -5433,6 +5973,8 @@ module Aws::DatabaseMigrationService
|
|
5433
5973
|
include Aws::Structure
|
5434
5974
|
end
|
5435
5975
|
|
5976
|
+
# Provides the name of the schema and table to be reloaded.
|
5977
|
+
#
|
5436
5978
|
# @note When making an API call, you may pass TableToReload
|
5437
5979
|
# data as a hash:
|
5438
5980
|
#
|
@@ -5457,6 +5999,15 @@ module Aws::DatabaseMigrationService
|
|
5457
5999
|
include Aws::Structure
|
5458
6000
|
end
|
5459
6001
|
|
6002
|
+
# A user-defined key-value pair that describes metadata added to an AWS
|
6003
|
+
# DMS resource and that is used by operations such as the following:
|
6004
|
+
#
|
6005
|
+
# * `AddTagsToResource`
|
6006
|
+
#
|
6007
|
+
# * `ListTagsForResource`
|
6008
|
+
#
|
6009
|
+
# * `RemoveTagsFromResource`
|
6010
|
+
#
|
5460
6011
|
# @note When making an API call, you may pass Tag
|
5461
6012
|
# data as a hash:
|
5462
6013
|
#
|
@@ -5467,7 +6018,7 @@ module Aws::DatabaseMigrationService
|
|
5467
6018
|
#
|
5468
6019
|
# @!attribute [rw] key
|
5469
6020
|
# A key is the required name of the tag. The string value can be from
|
5470
|
-
# 1 to 128 Unicode characters in length and
|
6021
|
+
# 1 to 128 Unicode characters in length and can't be prefixed with
|
5471
6022
|
# "aws:" or "dms:". The string can only contain only the set of
|
5472
6023
|
# Unicode letters, digits, white-space, '\_', '.', '/', '=',
|
5473
6024
|
# '+', '-' (Java regex:
|
@@ -5476,7 +6027,7 @@ module Aws::DatabaseMigrationService
|
|
5476
6027
|
#
|
5477
6028
|
# @!attribute [rw] value
|
5478
6029
|
# A value is the optional value of the tag. The string value can be
|
5479
|
-
# from 1 to 256 Unicode characters in length and
|
6030
|
+
# from 1 to 256 Unicode characters in length and can't be prefixed
|
5480
6031
|
# with "aws:" or "dms:". The string can only contain only the set
|
5481
6032
|
# of Unicode letters, digits, white-space, '\_', '.', '/',
|
5482
6033
|
# '=', '+', '-' (Java regex:
|
@@ -5539,6 +6090,9 @@ module Aws::DatabaseMigrationService
|
|
5539
6090
|
include Aws::Structure
|
5540
6091
|
end
|
5541
6092
|
|
6093
|
+
# Describes status of a security group associated with the virtual
|
6094
|
+
# private cloud hosting your replication and DB instances.
|
6095
|
+
#
|
5542
6096
|
# @!attribute [rw] vpc_security_group_id
|
5543
6097
|
# The VPC security group Id.
|
5544
6098
|
# @return [String]
|