aws-sdk-databasemigrationservice 1.52.0 → 1.56.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-databasemigrationservice.rb +1 -1
- data/lib/aws-sdk-databasemigrationservice/client.rb +456 -237
- data/lib/aws-sdk-databasemigrationservice/client_api.rb +71 -1
- data/lib/aws-sdk-databasemigrationservice/customizations.rb +1 -1
- data/lib/aws-sdk-databasemigrationservice/types.rb +929 -538
- data/lib/aws-sdk-databasemigrationservice/waiters.rb +0 -6
- metadata +7 -8
@@ -72,6 +72,8 @@ module Aws::DatabaseMigrationService
|
|
72
72
|
DescribeCertificatesResponse = Shapes::StructureShape.new(name: 'DescribeCertificatesResponse')
|
73
73
|
DescribeConnectionsMessage = Shapes::StructureShape.new(name: 'DescribeConnectionsMessage')
|
74
74
|
DescribeConnectionsResponse = Shapes::StructureShape.new(name: 'DescribeConnectionsResponse')
|
75
|
+
DescribeEndpointSettingsMessage = Shapes::StructureShape.new(name: 'DescribeEndpointSettingsMessage')
|
76
|
+
DescribeEndpointSettingsResponse = Shapes::StructureShape.new(name: 'DescribeEndpointSettingsResponse')
|
75
77
|
DescribeEndpointTypesMessage = Shapes::StructureShape.new(name: 'DescribeEndpointTypesMessage')
|
76
78
|
DescribeEndpointTypesResponse = Shapes::StructureShape.new(name: 'DescribeEndpointTypesResponse')
|
77
79
|
DescribeEndpointsMessage = Shapes::StructureShape.new(name: 'DescribeEndpointsMessage')
|
@@ -115,6 +117,10 @@ module Aws::DatabaseMigrationService
|
|
115
117
|
EncryptionModeValue = Shapes::StringShape.new(name: 'EncryptionModeValue')
|
116
118
|
Endpoint = Shapes::StructureShape.new(name: 'Endpoint')
|
117
119
|
EndpointList = Shapes::ListShape.new(name: 'EndpointList')
|
120
|
+
EndpointSetting = Shapes::StructureShape.new(name: 'EndpointSetting')
|
121
|
+
EndpointSettingEnumValues = Shapes::ListShape.new(name: 'EndpointSettingEnumValues')
|
122
|
+
EndpointSettingTypeValue = Shapes::StringShape.new(name: 'EndpointSettingTypeValue')
|
123
|
+
EndpointSettingsList = Shapes::ListShape.new(name: 'EndpointSettingsList')
|
118
124
|
Event = Shapes::StructureShape.new(name: 'Event')
|
119
125
|
EventCategoriesList = Shapes::ListShape.new(name: 'EventCategoriesList')
|
120
126
|
EventCategoryGroup = Shapes::StructureShape.new(name: 'EventCategoryGroup')
|
@@ -145,6 +151,7 @@ module Aws::DatabaseMigrationService
|
|
145
151
|
KMSKeyNotAccessibleFault = Shapes::StructureShape.new(name: 'KMSKeyNotAccessibleFault')
|
146
152
|
KMSNotFoundFault = Shapes::StructureShape.new(name: 'KMSNotFoundFault')
|
147
153
|
KMSThrottlingFault = Shapes::StructureShape.new(name: 'KMSThrottlingFault')
|
154
|
+
KafkaSecurityProtocol = Shapes::StringShape.new(name: 'KafkaSecurityProtocol')
|
148
155
|
KafkaSettings = Shapes::StructureShape.new(name: 'KafkaSettings')
|
149
156
|
KeyList = Shapes::ListShape.new(name: 'KeyList')
|
150
157
|
KinesisSettings = Shapes::StructureShape.new(name: 'KinesisSettings')
|
@@ -177,6 +184,7 @@ module Aws::DatabaseMigrationService
|
|
177
184
|
PendingMaintenanceAction = Shapes::StructureShape.new(name: 'PendingMaintenanceAction')
|
178
185
|
PendingMaintenanceActionDetails = Shapes::ListShape.new(name: 'PendingMaintenanceActionDetails')
|
179
186
|
PendingMaintenanceActions = Shapes::ListShape.new(name: 'PendingMaintenanceActions')
|
187
|
+
PluginNameValue = Shapes::StringShape.new(name: 'PluginNameValue')
|
180
188
|
PostgreSQLSettings = Shapes::StructureShape.new(name: 'PostgreSQLSettings')
|
181
189
|
RebootReplicationInstanceMessage = Shapes::StructureShape.new(name: 'RebootReplicationInstanceMessage')
|
182
190
|
RebootReplicationInstanceResponse = Shapes::StructureShape.new(name: 'RebootReplicationInstanceResponse')
|
@@ -500,6 +508,15 @@ module Aws::DatabaseMigrationService
|
|
500
508
|
DescribeConnectionsResponse.add_member(:connections, Shapes::ShapeRef.new(shape: ConnectionList, location_name: "Connections"))
|
501
509
|
DescribeConnectionsResponse.struct_class = Types::DescribeConnectionsResponse
|
502
510
|
|
511
|
+
DescribeEndpointSettingsMessage.add_member(:engine_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "EngineName"))
|
512
|
+
DescribeEndpointSettingsMessage.add_member(:max_records, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRecords"))
|
513
|
+
DescribeEndpointSettingsMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker"))
|
514
|
+
DescribeEndpointSettingsMessage.struct_class = Types::DescribeEndpointSettingsMessage
|
515
|
+
|
516
|
+
DescribeEndpointSettingsResponse.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker"))
|
517
|
+
DescribeEndpointSettingsResponse.add_member(:endpoint_settings, Shapes::ShapeRef.new(shape: EndpointSettingsList, location_name: "EndpointSettings"))
|
518
|
+
DescribeEndpointSettingsResponse.struct_class = Types::DescribeEndpointSettingsResponse
|
519
|
+
|
503
520
|
DescribeEndpointTypesMessage.add_member(:filters, Shapes::ShapeRef.new(shape: FilterList, location_name: "Filters"))
|
504
521
|
DescribeEndpointTypesMessage.add_member(:max_records, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRecords"))
|
505
522
|
DescribeEndpointTypesMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker"))
|
@@ -723,6 +740,21 @@ module Aws::DatabaseMigrationService
|
|
723
740
|
|
724
741
|
EndpointList.member = Shapes::ShapeRef.new(shape: Endpoint)
|
725
742
|
|
743
|
+
EndpointSetting.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
744
|
+
EndpointSetting.add_member(:type, Shapes::ShapeRef.new(shape: EndpointSettingTypeValue, location_name: "Type"))
|
745
|
+
EndpointSetting.add_member(:enum_values, Shapes::ShapeRef.new(shape: EndpointSettingEnumValues, location_name: "EnumValues"))
|
746
|
+
EndpointSetting.add_member(:sensitive, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "Sensitive"))
|
747
|
+
EndpointSetting.add_member(:units, Shapes::ShapeRef.new(shape: String, location_name: "Units"))
|
748
|
+
EndpointSetting.add_member(:applicability, Shapes::ShapeRef.new(shape: String, location_name: "Applicability"))
|
749
|
+
EndpointSetting.add_member(:int_value_min, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "IntValueMin"))
|
750
|
+
EndpointSetting.add_member(:int_value_max, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "IntValueMax"))
|
751
|
+
EndpointSetting.add_member(:default_value, Shapes::ShapeRef.new(shape: String, location_name: "DefaultValue"))
|
752
|
+
EndpointSetting.struct_class = Types::EndpointSetting
|
753
|
+
|
754
|
+
EndpointSettingEnumValues.member = Shapes::ShapeRef.new(shape: String)
|
755
|
+
|
756
|
+
EndpointSettingsList.member = Shapes::ShapeRef.new(shape: EndpointSetting)
|
757
|
+
|
726
758
|
Event.add_member(:source_identifier, Shapes::ShapeRef.new(shape: String, location_name: "SourceIdentifier"))
|
727
759
|
Event.add_member(:source_type, Shapes::ShapeRef.new(shape: SourceType, location_name: "SourceType"))
|
728
760
|
Event.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
@@ -776,7 +808,7 @@ module Aws::DatabaseMigrationService
|
|
776
808
|
IBMDb2Settings.struct_class = Types::IBMDb2Settings
|
777
809
|
|
778
810
|
ImportCertificateMessage.add_member(:certificate_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "CertificateIdentifier"))
|
779
|
-
ImportCertificateMessage.add_member(:certificate_pem, Shapes::ShapeRef.new(shape:
|
811
|
+
ImportCertificateMessage.add_member(:certificate_pem, Shapes::ShapeRef.new(shape: SecretString, location_name: "CertificatePem"))
|
780
812
|
ImportCertificateMessage.add_member(:certificate_wallet, Shapes::ShapeRef.new(shape: CertificateWallet, location_name: "CertificateWallet"))
|
781
813
|
ImportCertificateMessage.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
782
814
|
ImportCertificateMessage.struct_class = Types::ImportCertificateMessage
|
@@ -831,6 +863,14 @@ module Aws::DatabaseMigrationService
|
|
831
863
|
KafkaSettings.add_member(:include_control_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeControlDetails"))
|
832
864
|
KafkaSettings.add_member(:message_max_bytes, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MessageMaxBytes"))
|
833
865
|
KafkaSettings.add_member(:include_null_and_empty, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeNullAndEmpty"))
|
866
|
+
KafkaSettings.add_member(:security_protocol, Shapes::ShapeRef.new(shape: KafkaSecurityProtocol, location_name: "SecurityProtocol"))
|
867
|
+
KafkaSettings.add_member(:ssl_client_certificate_arn, Shapes::ShapeRef.new(shape: String, location_name: "SslClientCertificateArn"))
|
868
|
+
KafkaSettings.add_member(:ssl_client_key_arn, Shapes::ShapeRef.new(shape: String, location_name: "SslClientKeyArn"))
|
869
|
+
KafkaSettings.add_member(:ssl_client_key_password, Shapes::ShapeRef.new(shape: SecretString, location_name: "SslClientKeyPassword"))
|
870
|
+
KafkaSettings.add_member(:ssl_ca_certificate_arn, Shapes::ShapeRef.new(shape: String, location_name: "SslCaCertificateArn"))
|
871
|
+
KafkaSettings.add_member(:sasl_username, Shapes::ShapeRef.new(shape: String, location_name: "SaslUsername"))
|
872
|
+
KafkaSettings.add_member(:sasl_password, Shapes::ShapeRef.new(shape: SecretString, location_name: "SaslPassword"))
|
873
|
+
KafkaSettings.add_member(:no_hex_prefix, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "NoHexPrefix"))
|
834
874
|
KafkaSettings.struct_class = Types::KafkaSettings
|
835
875
|
|
836
876
|
KeyList.member = Shapes::ShapeRef.new(shape: String)
|
@@ -844,6 +884,7 @@ module Aws::DatabaseMigrationService
|
|
844
884
|
KinesisSettings.add_member(:include_table_alter_operations, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeTableAlterOperations"))
|
845
885
|
KinesisSettings.add_member(:include_control_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeControlDetails"))
|
846
886
|
KinesisSettings.add_member(:include_null_and_empty, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeNullAndEmpty"))
|
887
|
+
KinesisSettings.add_member(:no_hex_prefix, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "NoHexPrefix"))
|
847
888
|
KinesisSettings.struct_class = Types::KinesisSettings
|
848
889
|
|
849
890
|
ListTagsForResourceMessage.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ResourceArn"))
|
@@ -857,11 +898,13 @@ module Aws::DatabaseMigrationService
|
|
857
898
|
MicrosoftSQLServerSettings.add_member(:database_name, Shapes::ShapeRef.new(shape: String, location_name: "DatabaseName"))
|
858
899
|
MicrosoftSQLServerSettings.add_member(:control_tables_file_group, Shapes::ShapeRef.new(shape: String, location_name: "ControlTablesFileGroup"))
|
859
900
|
MicrosoftSQLServerSettings.add_member(:password, Shapes::ShapeRef.new(shape: SecretString, location_name: "Password"))
|
901
|
+
MicrosoftSQLServerSettings.add_member(:query_single_always_on_node, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "QuerySingleAlwaysOnNode"))
|
860
902
|
MicrosoftSQLServerSettings.add_member(:read_backup_only, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ReadBackupOnly"))
|
861
903
|
MicrosoftSQLServerSettings.add_member(:safeguard_policy, Shapes::ShapeRef.new(shape: SafeguardPolicy, location_name: "SafeguardPolicy"))
|
862
904
|
MicrosoftSQLServerSettings.add_member(:server_name, Shapes::ShapeRef.new(shape: String, location_name: "ServerName"))
|
863
905
|
MicrosoftSQLServerSettings.add_member(:username, Shapes::ShapeRef.new(shape: String, location_name: "Username"))
|
864
906
|
MicrosoftSQLServerSettings.add_member(:use_bcp_full_load, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "UseBcpFullLoad"))
|
907
|
+
MicrosoftSQLServerSettings.add_member(:use_third_party_backup_device, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "UseThirdPartyBackupDevice"))
|
865
908
|
MicrosoftSQLServerSettings.add_member(:secrets_manager_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerAccessRoleArn"))
|
866
909
|
MicrosoftSQLServerSettings.add_member(:secrets_manager_secret_id, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerSecretId"))
|
867
910
|
MicrosoftSQLServerSettings.struct_class = Types::MicrosoftSQLServerSettings
|
@@ -896,6 +939,7 @@ module Aws::DatabaseMigrationService
|
|
896
939
|
ModifyEndpointMessage.add_member(:microsoft_sql_server_settings, Shapes::ShapeRef.new(shape: MicrosoftSQLServerSettings, location_name: "MicrosoftSQLServerSettings"))
|
897
940
|
ModifyEndpointMessage.add_member(:ibm_db_2_settings, Shapes::ShapeRef.new(shape: IBMDb2Settings, location_name: "IBMDb2Settings"))
|
898
941
|
ModifyEndpointMessage.add_member(:doc_db_settings, Shapes::ShapeRef.new(shape: DocDbSettings, location_name: "DocDbSettings"))
|
942
|
+
ModifyEndpointMessage.add_member(:exact_settings, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ExactSettings"))
|
899
943
|
ModifyEndpointMessage.struct_class = Types::ModifyEndpointMessage
|
900
944
|
|
901
945
|
ModifyEndpointResponse.add_member(:endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "Endpoint"))
|
@@ -973,6 +1017,7 @@ module Aws::DatabaseMigrationService
|
|
973
1017
|
MoveReplicationTaskResponse.struct_class = Types::MoveReplicationTaskResponse
|
974
1018
|
|
975
1019
|
MySQLSettings.add_member(:after_connect_script, Shapes::ShapeRef.new(shape: String, location_name: "AfterConnectScript"))
|
1020
|
+
MySQLSettings.add_member(:clean_source_metadata_on_mismatch, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CleanSourceMetadataOnMismatch"))
|
976
1021
|
MySQLSettings.add_member(:database_name, Shapes::ShapeRef.new(shape: String, location_name: "DatabaseName"))
|
977
1022
|
MySQLSettings.add_member(:events_poll_interval, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "EventsPollInterval"))
|
978
1023
|
MySQLSettings.add_member(:target_db_type, Shapes::ShapeRef.new(shape: TargetDbType, location_name: "TargetDbType"))
|
@@ -1025,7 +1070,12 @@ module Aws::DatabaseMigrationService
|
|
1025
1070
|
OracleSettings.add_member(:security_db_encryption, Shapes::ShapeRef.new(shape: SecretString, location_name: "SecurityDbEncryption"))
|
1026
1071
|
OracleSettings.add_member(:security_db_encryption_name, Shapes::ShapeRef.new(shape: String, location_name: "SecurityDbEncryptionName"))
|
1027
1072
|
OracleSettings.add_member(:server_name, Shapes::ShapeRef.new(shape: String, location_name: "ServerName"))
|
1073
|
+
OracleSettings.add_member(:spatial_data_option_to_geo_json_function_name, Shapes::ShapeRef.new(shape: String, location_name: "SpatialDataOptionToGeoJsonFunctionName"))
|
1074
|
+
OracleSettings.add_member(:standby_delay_time, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "StandbyDelayTime"))
|
1028
1075
|
OracleSettings.add_member(:username, Shapes::ShapeRef.new(shape: String, location_name: "Username"))
|
1076
|
+
OracleSettings.add_member(:use_b_file, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "UseBFile"))
|
1077
|
+
OracleSettings.add_member(:use_direct_path_full_load, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "UseDirectPathFullLoad"))
|
1078
|
+
OracleSettings.add_member(:use_logminer_reader, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "UseLogminerReader"))
|
1029
1079
|
OracleSettings.add_member(:secrets_manager_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerAccessRoleArn"))
|
1030
1080
|
OracleSettings.add_member(:secrets_manager_secret_id, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerSecretId"))
|
1031
1081
|
OracleSettings.add_member(:secrets_manager_oracle_asm_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerOracleAsmAccessRoleArn"))
|
@@ -1064,11 +1114,15 @@ module Aws::DatabaseMigrationService
|
|
1064
1114
|
PostgreSQLSettings.add_member(:ddl_artifacts_schema, Shapes::ShapeRef.new(shape: String, location_name: "DdlArtifactsSchema"))
|
1065
1115
|
PostgreSQLSettings.add_member(:execute_timeout, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "ExecuteTimeout"))
|
1066
1116
|
PostgreSQLSettings.add_member(:fail_tasks_on_lob_truncation, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "FailTasksOnLobTruncation"))
|
1117
|
+
PostgreSQLSettings.add_member(:heartbeat_enable, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "HeartbeatEnable"))
|
1118
|
+
PostgreSQLSettings.add_member(:heartbeat_schema, Shapes::ShapeRef.new(shape: String, location_name: "HeartbeatSchema"))
|
1119
|
+
PostgreSQLSettings.add_member(:heartbeat_frequency, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "HeartbeatFrequency"))
|
1067
1120
|
PostgreSQLSettings.add_member(:password, Shapes::ShapeRef.new(shape: SecretString, location_name: "Password"))
|
1068
1121
|
PostgreSQLSettings.add_member(:port, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Port"))
|
1069
1122
|
PostgreSQLSettings.add_member(:server_name, Shapes::ShapeRef.new(shape: String, location_name: "ServerName"))
|
1070
1123
|
PostgreSQLSettings.add_member(:username, Shapes::ShapeRef.new(shape: String, location_name: "Username"))
|
1071
1124
|
PostgreSQLSettings.add_member(:slot_name, Shapes::ShapeRef.new(shape: String, location_name: "SlotName"))
|
1125
|
+
PostgreSQLSettings.add_member(:plugin_name, Shapes::ShapeRef.new(shape: PluginNameValue, location_name: "PluginName"))
|
1072
1126
|
PostgreSQLSettings.add_member(:secrets_manager_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerAccessRoleArn"))
|
1073
1127
|
PostgreSQLSettings.add_member(:secrets_manager_secret_id, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerSecretId"))
|
1074
1128
|
PostgreSQLSettings.struct_class = Types::PostgreSQLSettings
|
@@ -1717,6 +1771,20 @@ module Aws::DatabaseMigrationService
|
|
1717
1771
|
)
|
1718
1772
|
end)
|
1719
1773
|
|
1774
|
+
api.add_operation(:describe_endpoint_settings, Seahorse::Model::Operation.new.tap do |o|
|
1775
|
+
o.name = "DescribeEndpointSettings"
|
1776
|
+
o.http_method = "POST"
|
1777
|
+
o.http_request_uri = "/"
|
1778
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeEndpointSettingsMessage)
|
1779
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeEndpointSettingsResponse)
|
1780
|
+
o[:pager] = Aws::Pager.new(
|
1781
|
+
limit_key: "max_records",
|
1782
|
+
tokens: {
|
1783
|
+
"marker" => "marker"
|
1784
|
+
}
|
1785
|
+
)
|
1786
|
+
end)
|
1787
|
+
|
1720
1788
|
api.add_operation(:describe_endpoint_types, Seahorse::Model::Operation.new.tap do |o|
|
1721
1789
|
o.name = "DescribeEndpointTypes"
|
1722
1790
|
o.http_method = "POST"
|
@@ -2060,6 +2128,7 @@ module Aws::DatabaseMigrationService
|
|
2060
2128
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedFault)
|
2061
2129
|
o.errors << Shapes::ShapeRef.new(shape: InvalidResourceStateFault)
|
2062
2130
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundFault)
|
2131
|
+
o.errors << Shapes::ShapeRef.new(shape: KMSKeyNotAccessibleFault)
|
2063
2132
|
end)
|
2064
2133
|
|
2065
2134
|
api.add_operation(:reboot_replication_instance, Seahorse::Model::Operation.new.tap do |o|
|
@@ -2164,6 +2233,7 @@ module Aws::DatabaseMigrationService
|
|
2164
2233
|
o.errors << Shapes::ShapeRef.new(shape: InvalidResourceStateFault)
|
2165
2234
|
o.errors << Shapes::ShapeRef.new(shape: KMSKeyNotAccessibleFault)
|
2166
2235
|
o.errors << Shapes::ShapeRef.new(shape: ResourceQuotaExceededFault)
|
2236
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedFault)
|
2167
2237
|
end)
|
2168
2238
|
end
|
2169
2239
|
|
@@ -2,7 +2,7 @@
|
|
2
2
|
# WARNING ABOUT GENERATED CODE
|
3
3
|
#
|
4
4
|
# This file is generated. See the contributing for info on making contributions:
|
5
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
5
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
6
6
|
#
|
7
7
|
# WARNING ABOUT GENERATED CODE
|
8
8
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::DatabaseMigrationService
|
11
11
|
module Types
|
12
12
|
|
13
|
-
#
|
13
|
+
# DMS was denied access to the endpoint. Check that the role is
|
14
14
|
# correctly configured.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] message
|
@@ -24,11 +24,11 @@ module Aws::DatabaseMigrationService
|
|
24
24
|
include Aws::Structure
|
25
25
|
end
|
26
26
|
|
27
|
-
# Describes a quota for an
|
27
|
+
# Describes a quota for an account, for example the number of
|
28
28
|
# replication instances allowed.
|
29
29
|
#
|
30
30
|
# @!attribute [rw] account_quota_name
|
31
|
-
# The name of the
|
31
|
+
# The name of the DMS quota for this account.
|
32
32
|
# @return [String]
|
33
33
|
#
|
34
34
|
# @!attribute [rw] used
|
@@ -49,7 +49,7 @@ module Aws::DatabaseMigrationService
|
|
49
49
|
include Aws::Structure
|
50
50
|
end
|
51
51
|
|
52
|
-
# Associates a set of tags with an
|
52
|
+
# Associates a set of tags with an DMS resource.
|
53
53
|
#
|
54
54
|
# @note When making an API call, you may pass AddTagsToResourceMessage
|
55
55
|
# data as a hash:
|
@@ -65,10 +65,10 @@ module Aws::DatabaseMigrationService
|
|
65
65
|
# }
|
66
66
|
#
|
67
67
|
# @!attribute [rw] resource_arn
|
68
|
-
# Identifies the
|
69
|
-
#
|
68
|
+
# Identifies the DMS resource to which tags should be added. The value
|
69
|
+
# for this parameter is an Amazon Resource Name (ARN).
|
70
70
|
#
|
71
|
-
# For
|
71
|
+
# For DMS, you can tag a replication instance, an endpoint, or a
|
72
72
|
# replication task.
|
73
73
|
# @return [String]
|
74
74
|
#
|
@@ -99,8 +99,8 @@ module Aws::DatabaseMigrationService
|
|
99
99
|
# }
|
100
100
|
#
|
101
101
|
# @!attribute [rw] replication_instance_arn
|
102
|
-
# The Amazon Resource Name (ARN) of the
|
103
|
-
#
|
102
|
+
# The Amazon Resource Name (ARN) of the DMS resource that the pending
|
103
|
+
# maintenance action applies to.
|
104
104
|
# @return [String]
|
105
105
|
#
|
106
106
|
# @!attribute [rw] apply_action
|
@@ -134,8 +134,8 @@ module Aws::DatabaseMigrationService
|
|
134
134
|
end
|
135
135
|
|
136
136
|
# @!attribute [rw] resource_pending_maintenance_actions
|
137
|
-
# The
|
138
|
-
#
|
137
|
+
# The DMS resource that the pending maintenance action will be applied
|
138
|
+
# to.
|
139
139
|
# @return [Types::ResourcePendingMaintenanceActions]
|
140
140
|
#
|
141
141
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ApplyPendingMaintenanceActionResponse AWS API Documentation
|
@@ -149,8 +149,8 @@ module Aws::DatabaseMigrationService
|
|
149
149
|
# The name of an Availability Zone for use during database migration.
|
150
150
|
# `AvailabilityZone` is an optional parameter to the [
|
151
151
|
# `CreateReplicationInstance` ][1] operation, and it’s value relates to
|
152
|
-
# the
|
153
|
-
#
|
152
|
+
# the Region of an endpoint. For example, the availability zone of an
|
153
|
+
# endpoint in the us-east-1 region might be us-east-1a, us-east-1b,
|
154
154
|
# us-east-1c, or us-east-1d.
|
155
155
|
#
|
156
156
|
#
|
@@ -406,6 +406,7 @@ module Aws::DatabaseMigrationService
|
|
406
406
|
# include_table_alter_operations: false,
|
407
407
|
# include_control_details: false,
|
408
408
|
# include_null_and_empty: false,
|
409
|
+
# no_hex_prefix: false,
|
409
410
|
# },
|
410
411
|
# kafka_settings: {
|
411
412
|
# broker: "String",
|
@@ -418,6 +419,14 @@ module Aws::DatabaseMigrationService
|
|
418
419
|
# include_control_details: false,
|
419
420
|
# message_max_bytes: 1,
|
420
421
|
# include_null_and_empty: false,
|
422
|
+
# security_protocol: "plaintext", # accepts plaintext, ssl-authentication, ssl-encryption, sasl-ssl
|
423
|
+
# ssl_client_certificate_arn: "String",
|
424
|
+
# ssl_client_key_arn: "String",
|
425
|
+
# ssl_client_key_password: "SecretString",
|
426
|
+
# ssl_ca_certificate_arn: "String",
|
427
|
+
# sasl_username: "String",
|
428
|
+
# sasl_password: "SecretString",
|
429
|
+
# no_hex_prefix: false,
|
421
430
|
# },
|
422
431
|
# elasticsearch_settings: {
|
423
432
|
# service_access_role_arn: "String", # required
|
@@ -474,16 +483,21 @@ module Aws::DatabaseMigrationService
|
|
474
483
|
# ddl_artifacts_schema: "String",
|
475
484
|
# execute_timeout: 1,
|
476
485
|
# fail_tasks_on_lob_truncation: false,
|
486
|
+
# heartbeat_enable: false,
|
487
|
+
# heartbeat_schema: "String",
|
488
|
+
# heartbeat_frequency: 1,
|
477
489
|
# password: "SecretString",
|
478
490
|
# port: 1,
|
479
491
|
# server_name: "String",
|
480
492
|
# username: "String",
|
481
493
|
# slot_name: "String",
|
494
|
+
# plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
|
482
495
|
# secrets_manager_access_role_arn: "String",
|
483
496
|
# secrets_manager_secret_id: "String",
|
484
497
|
# },
|
485
498
|
# my_sql_settings: {
|
486
499
|
# after_connect_script: "String",
|
500
|
+
# clean_source_metadata_on_mismatch: false,
|
487
501
|
# database_name: "String",
|
488
502
|
# events_poll_interval: 1,
|
489
503
|
# target_db_type: "specific-database", # accepts specific-database, multiple-databases
|
@@ -527,7 +541,12 @@ module Aws::DatabaseMigrationService
|
|
527
541
|
# security_db_encryption: "SecretString",
|
528
542
|
# security_db_encryption_name: "String",
|
529
543
|
# server_name: "String",
|
544
|
+
# spatial_data_option_to_geo_json_function_name: "String",
|
545
|
+
# standby_delay_time: 1,
|
530
546
|
# username: "String",
|
547
|
+
# use_b_file: false,
|
548
|
+
# use_direct_path_full_load: false,
|
549
|
+
# use_logminer_reader: false,
|
531
550
|
# secrets_manager_access_role_arn: "String",
|
532
551
|
# secrets_manager_secret_id: "String",
|
533
552
|
# secrets_manager_oracle_asm_access_role_arn: "String",
|
@@ -548,11 +567,13 @@ module Aws::DatabaseMigrationService
|
|
548
567
|
# database_name: "String",
|
549
568
|
# control_tables_file_group: "String",
|
550
569
|
# password: "SecretString",
|
570
|
+
# query_single_always_on_node: false,
|
551
571
|
# read_backup_only: false,
|
552
572
|
# safeguard_policy: "rely-on-sql-server-replication-agent", # accepts rely-on-sql-server-replication-agent, exclusive-automatic-truncation, shared-automatic-truncation
|
553
573
|
# server_name: "String",
|
554
574
|
# username: "String",
|
555
575
|
# use_bcp_full_load: false,
|
576
|
+
# use_third_party_backup_device: false,
|
556
577
|
# secrets_manager_access_role_arn: "String",
|
557
578
|
# secrets_manager_secret_id: "String",
|
558
579
|
# },
|
@@ -620,7 +641,8 @@ module Aws::DatabaseMigrationService
|
|
620
641
|
# @return [Integer]
|
621
642
|
#
|
622
643
|
# @!attribute [rw] database_name
|
623
|
-
# The name of the endpoint database.
|
644
|
+
# The name of the endpoint database. For a MySQL source or target
|
645
|
+
# endpoint, do not specify DatabaseName.
|
624
646
|
# @return [String]
|
625
647
|
#
|
626
648
|
# @!attribute [rw] extra_connection_attributes
|
@@ -628,9 +650,8 @@ module Aws::DatabaseMigrationService
|
|
628
650
|
# is specified as a name-value pair associated by an equal sign (=).
|
629
651
|
# Multiple attributes are separated by a semicolon (;) with no
|
630
652
|
# additional white space. For information on the attributes available
|
631
|
-
# for connecting your source or target endpoint, see [Working with
|
632
|
-
#
|
633
|
-
# Guide.*
|
653
|
+
# for connecting your source or target endpoint, see [Working with DMS
|
654
|
+
# Endpoints][1] in the *Database Migration Service User Guide.*
|
634
655
|
#
|
635
656
|
#
|
636
657
|
#
|
@@ -638,15 +659,14 @@ module Aws::DatabaseMigrationService
|
|
638
659
|
# @return [String]
|
639
660
|
#
|
640
661
|
# @!attribute [rw] kms_key_id
|
641
|
-
# An
|
662
|
+
# An KMS key identifier that is used to encrypt the connection
|
642
663
|
# parameters for the endpoint.
|
643
664
|
#
|
644
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
645
|
-
#
|
665
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
666
|
+
# uses your default encryption key.
|
646
667
|
#
|
647
|
-
#
|
648
|
-
#
|
649
|
-
# Region.
|
668
|
+
# KMS creates the default encryption key for your account. Your
|
669
|
+
# account has a different default encryption key for each Region.
|
650
670
|
# @return [String]
|
651
671
|
#
|
652
672
|
# @!attribute [rw] tags
|
@@ -664,7 +684,8 @@ module Aws::DatabaseMigrationService
|
|
664
684
|
#
|
665
685
|
# @!attribute [rw] service_access_role_arn
|
666
686
|
# The Amazon Resource Name (ARN) for the service access role that you
|
667
|
-
# want to use to create the endpoint.
|
687
|
+
# want to use to create the endpoint. The role must allow the
|
688
|
+
# `iam:PassRole` action.
|
668
689
|
# @return [String]
|
669
690
|
#
|
670
691
|
# @!attribute [rw] external_table_definition
|
@@ -674,19 +695,19 @@ module Aws::DatabaseMigrationService
|
|
674
695
|
# @!attribute [rw] dynamo_db_settings
|
675
696
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
676
697
|
# information about other available settings, see [Using Object
|
677
|
-
# Mapping to Migrate Data to DynamoDB][1] in the *
|
678
|
-
#
|
698
|
+
# Mapping to Migrate Data to DynamoDB][1] in the *Database Migration
|
699
|
+
# Service User Guide.*
|
679
700
|
#
|
680
701
|
#
|
681
702
|
#
|
682
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html
|
703
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping
|
683
704
|
# @return [Types::DynamoDbSettings]
|
684
705
|
#
|
685
706
|
# @!attribute [rw] s3_settings
|
686
707
|
# Settings in JSON format for the target Amazon S3 endpoint. For more
|
687
708
|
# information about the available settings, see [Extra Connection
|
688
|
-
# Attributes When Using Amazon S3 as a Target for
|
689
|
-
# *
|
709
|
+
# Attributes When Using Amazon S3 as a Target for DMS][1] in the
|
710
|
+
# *Database Migration Service User Guide.*
|
690
711
|
#
|
691
712
|
#
|
692
713
|
#
|
@@ -700,27 +721,24 @@ module Aws::DatabaseMigrationService
|
|
700
721
|
# Possible settings include the following:
|
701
722
|
#
|
702
723
|
# * `ServiceAccessRoleArn` - The IAM role that has permission to
|
703
|
-
# access the Amazon S3 bucket.
|
724
|
+
# access the Amazon S3 bucket. The role must allow the
|
725
|
+
# `iam:PassRole` action.
|
704
726
|
#
|
705
727
|
# * `BucketName` - The name of the S3 bucket to use.
|
706
728
|
#
|
707
|
-
# * `CompressionType` - An optional parameter to use GZIP to compress
|
708
|
-
# the target files. To use GZIP, set this value to `NONE` (the
|
709
|
-
# default). To keep the files uncompressed, don't use this value.
|
710
|
-
#
|
711
729
|
# Shorthand syntax for these settings is as follows:
|
712
|
-
# `ServiceAccessRoleArn=string,BucketName=string
|
730
|
+
# `ServiceAccessRoleArn=string,BucketName=string`
|
713
731
|
#
|
714
732
|
# JSON syntax for these settings is as follows: `\{
|
715
|
-
# "ServiceAccessRoleArn": "string", "BucketName": "string",
|
716
|
-
# "CompressionType": "none"|"gzip" \} `
|
733
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string", \} `
|
717
734
|
# @return [Types::DmsTransferSettings]
|
718
735
|
#
|
719
736
|
# @!attribute [rw] mongo_db_settings
|
720
737
|
# Settings in JSON format for the source MongoDB endpoint. For more
|
721
|
-
# information about the available settings, see [
|
722
|
-
#
|
723
|
-
# Migration Service User
|
738
|
+
# information about the available settings, see [Endpoint
|
739
|
+
# configuration settings when using MongoDB as a source for Database
|
740
|
+
# Migration Service][1] in the *Database Migration Service User
|
741
|
+
# Guide.*
|
724
742
|
#
|
725
743
|
#
|
726
744
|
#
|
@@ -730,31 +748,30 @@ module Aws::DatabaseMigrationService
|
|
730
748
|
# @!attribute [rw] kinesis_settings
|
731
749
|
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
732
750
|
# Data Streams. For more information about the available settings, see
|
733
|
-
# [Using
|
734
|
-
#
|
735
|
-
# Guide.*
|
751
|
+
# [Using object mapping to migrate data to a Kinesis data stream][1]
|
752
|
+
# in the *Database Migration Service User Guide.*
|
736
753
|
#
|
737
754
|
#
|
738
755
|
#
|
739
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html
|
756
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping
|
740
757
|
# @return [Types::KinesisSettings]
|
741
758
|
#
|
742
759
|
# @!attribute [rw] kafka_settings
|
743
760
|
# Settings in JSON format for the target Apache Kafka endpoint. For
|
744
|
-
# more information about the available settings, see [Using
|
745
|
-
#
|
746
|
-
#
|
761
|
+
# more information about the available settings, see [Using object
|
762
|
+
# mapping to migrate data to a Kafka topic][1] in the *Database
|
763
|
+
# Migration Service User Guide.*
|
747
764
|
#
|
748
765
|
#
|
749
766
|
#
|
750
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html
|
767
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping
|
751
768
|
# @return [Types::KafkaSettings]
|
752
769
|
#
|
753
770
|
# @!attribute [rw] elasticsearch_settings
|
754
771
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
755
772
|
# more information about the available settings, see [Extra Connection
|
756
|
-
# Attributes When Using Elasticsearch as a Target for
|
757
|
-
#
|
773
|
+
# Attributes When Using Elasticsearch as a Target for DMS][1] in the
|
774
|
+
# *Database Migration Service User Guide*.
|
758
775
|
#
|
759
776
|
#
|
760
777
|
#
|
@@ -764,8 +781,8 @@ module Aws::DatabaseMigrationService
|
|
764
781
|
# @!attribute [rw] neptune_settings
|
765
782
|
# Settings in JSON format for the target Amazon Neptune endpoint. For
|
766
783
|
# more information about the available settings, see [Specifying
|
767
|
-
#
|
768
|
-
# Database Migration Service User Guide.*
|
784
|
+
# graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a
|
785
|
+
# target][1] in the *Database Migration Service User Guide.*
|
769
786
|
#
|
770
787
|
#
|
771
788
|
#
|
@@ -779,80 +796,78 @@ module Aws::DatabaseMigrationService
|
|
779
796
|
# @!attribute [rw] postgre_sql_settings
|
780
797
|
# Settings in JSON format for the source and target PostgreSQL
|
781
798
|
# endpoint. For information about other available settings, see [Extra
|
782
|
-
# connection attributes when using PostgreSQL as a source for
|
783
|
-
#
|
784
|
-
#
|
785
|
-
# Guide.*
|
799
|
+
# connection attributes when using PostgreSQL as a source for DMS][1]
|
800
|
+
# and [ Extra connection attributes when using PostgreSQL as a target
|
801
|
+
# for DMS][2] in the *Database Migration Service User Guide.*
|
786
802
|
#
|
787
803
|
#
|
788
804
|
#
|
789
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html
|
790
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html
|
805
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib
|
806
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib
|
791
807
|
# @return [Types::PostgreSQLSettings]
|
792
808
|
#
|
793
809
|
# @!attribute [rw] my_sql_settings
|
794
810
|
# Settings in JSON format for the source and target MySQL endpoint.
|
795
811
|
# For information about other available settings, see [Extra
|
796
|
-
# connection attributes when using MySQL as a source for
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
812
|
+
# connection attributes when using MySQL as a source for DMS][1] and
|
813
|
+
# [Extra connection attributes when using a MySQL-compatible database
|
814
|
+
# as a target for DMS][2] in the *Database Migration Service User
|
815
|
+
# Guide.*
|
800
816
|
#
|
801
817
|
#
|
802
818
|
#
|
803
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html
|
804
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html
|
819
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib
|
820
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib
|
805
821
|
# @return [Types::MySQLSettings]
|
806
822
|
#
|
807
823
|
# @!attribute [rw] oracle_settings
|
808
824
|
# Settings in JSON format for the source and target Oracle endpoint.
|
809
825
|
# For information about other available settings, see [Extra
|
810
|
-
# connection attributes when using Oracle as a source for
|
811
|
-
#
|
812
|
-
#
|
826
|
+
# connection attributes when using Oracle as a source for DMS][1] and
|
827
|
+
# [ Extra connection attributes when using Oracle as a target for
|
828
|
+
# DMS][2] in the *Database Migration Service User Guide.*
|
813
829
|
#
|
814
830
|
#
|
815
831
|
#
|
816
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html
|
817
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html
|
832
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib
|
833
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib
|
818
834
|
# @return [Types::OracleSettings]
|
819
835
|
#
|
820
836
|
# @!attribute [rw] sybase_settings
|
821
837
|
# Settings in JSON format for the source and target SAP ASE endpoint.
|
822
838
|
# For information about other available settings, see [Extra
|
823
|
-
# connection attributes when using SAP ASE as a source for
|
824
|
-
#
|
825
|
-
#
|
839
|
+
# connection attributes when using SAP ASE as a source for DMS][1] and
|
840
|
+
# [Extra connection attributes when using SAP ASE as a target for
|
841
|
+
# DMS][2] in the *Database Migration Service User Guide.*
|
826
842
|
#
|
827
843
|
#
|
828
844
|
#
|
829
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html
|
830
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html
|
845
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib
|
846
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib
|
831
847
|
# @return [Types::SybaseSettings]
|
832
848
|
#
|
833
849
|
# @!attribute [rw] microsoft_sql_server_settings
|
834
850
|
# Settings in JSON format for the source and target Microsoft SQL
|
835
851
|
# Server endpoint. For information about other available settings, see
|
836
852
|
# [Extra connection attributes when using SQL Server as a source for
|
837
|
-
#
|
838
|
-
#
|
839
|
-
# User Guide.*
|
853
|
+
# DMS][1] and [ Extra connection attributes when using SQL Server as a
|
854
|
+
# target for DMS][2] in the *Database Migration Service User Guide.*
|
840
855
|
#
|
841
856
|
#
|
842
857
|
#
|
843
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html
|
844
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html
|
858
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib
|
859
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib
|
845
860
|
# @return [Types::MicrosoftSQLServerSettings]
|
846
861
|
#
|
847
862
|
# @!attribute [rw] ibm_db_2_settings
|
848
863
|
# Settings in JSON format for the source IBM Db2 LUW endpoint. For
|
849
864
|
# information about other available settings, see [Extra connection
|
850
|
-
# attributes when using Db2 LUW as a source for
|
851
|
-
# *
|
865
|
+
# attributes when using Db2 LUW as a source for DMS][1] in the
|
866
|
+
# *Database Migration Service User Guide.*
|
852
867
|
#
|
853
868
|
#
|
854
869
|
#
|
855
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html
|
870
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib
|
856
871
|
# @return [Types::IBMDb2Settings]
|
857
872
|
#
|
858
873
|
# @!attribute [rw] resource_identifier
|
@@ -865,8 +880,8 @@ module Aws::DatabaseMigrationService
|
|
865
880
|
# `Example-App-ARN1`. For example, this value might result in the
|
866
881
|
# `EndpointArn` value
|
867
882
|
# `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you
|
868
|
-
# don't specify a `ResourceIdentifier` value,
|
869
|
-
#
|
883
|
+
# don't specify a `ResourceIdentifier` value, DMS generates a default
|
884
|
+
# identifier value for the end of `EndpointArn`.
|
870
885
|
# @return [String]
|
871
886
|
#
|
872
887
|
# @!attribute [rw] doc_db_settings
|
@@ -943,8 +958,8 @@ module Aws::DatabaseMigrationService
|
|
943
958
|
# }
|
944
959
|
#
|
945
960
|
# @!attribute [rw] subscription_name
|
946
|
-
# The name of the
|
947
|
-
#
|
961
|
+
# The name of the DMS event notification subscription. This name must
|
962
|
+
# be less than 255 characters.
|
948
963
|
# @return [String]
|
949
964
|
#
|
950
965
|
# @!attribute [rw] sns_topic_arn
|
@@ -954,8 +969,8 @@ module Aws::DatabaseMigrationService
|
|
954
969
|
# @return [String]
|
955
970
|
#
|
956
971
|
# @!attribute [rw] source_type
|
957
|
-
# The type of
|
958
|
-
#
|
972
|
+
# The type of DMS resource that generates the events. For example, if
|
973
|
+
# you want to be notified of events generated by a replication
|
959
974
|
# instance, you set this parameter to `replication-instance`. If this
|
960
975
|
# value isn't specified, all events are returned.
|
961
976
|
#
|
@@ -965,8 +980,7 @@ module Aws::DatabaseMigrationService
|
|
965
980
|
# @!attribute [rw] event_categories
|
966
981
|
# A list of event categories for a source type that you want to
|
967
982
|
# subscribe to. For more information, see [Working with Events and
|
968
|
-
# Notifications][1] in the *
|
969
|
-
# Guide.*
|
983
|
+
# Notifications][1] in the *Database Migration Service User Guide.*
|
970
984
|
#
|
971
985
|
#
|
972
986
|
#
|
@@ -974,8 +988,7 @@ module Aws::DatabaseMigrationService
|
|
974
988
|
# @return [Array<String>]
|
975
989
|
#
|
976
990
|
# @!attribute [rw] source_ids
|
977
|
-
# A list of identifiers for which
|
978
|
-
# events.
|
991
|
+
# A list of identifiers for which DMS provides notification events.
|
979
992
|
#
|
980
993
|
# If you don't specify a value, notifications are provided for all
|
981
994
|
# sources.
|
@@ -1074,7 +1087,7 @@ module Aws::DatabaseMigrationService
|
|
1074
1087
|
#
|
1075
1088
|
# For more information on the settings and capacities for the
|
1076
1089
|
# available replication instance classes, see [ Selecting the right
|
1077
|
-
#
|
1090
|
+
# DMS replication instance for your migration][1].
|
1078
1091
|
#
|
1079
1092
|
#
|
1080
1093
|
#
|
@@ -1090,7 +1103,7 @@ module Aws::DatabaseMigrationService
|
|
1090
1103
|
# @!attribute [rw] availability_zone
|
1091
1104
|
# The Availability Zone where the replication instance will be
|
1092
1105
|
# created. The default value is a random, system-chosen Availability
|
1093
|
-
# Zone in the endpoint's
|
1106
|
+
# Zone in the endpoint's Region, for example: `us-east-1d`
|
1094
1107
|
# @return [String]
|
1095
1108
|
#
|
1096
1109
|
# @!attribute [rw] replication_subnet_group_identifier
|
@@ -1104,7 +1117,7 @@ module Aws::DatabaseMigrationService
|
|
1104
1117
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1105
1118
|
#
|
1106
1119
|
# Default: A 30-minute window selected at random from an 8-hour block
|
1107
|
-
# of time per
|
1120
|
+
# of time per Region, occurring on a random day of the week.
|
1108
1121
|
#
|
1109
1122
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1110
1123
|
#
|
@@ -1138,15 +1151,14 @@ module Aws::DatabaseMigrationService
|
|
1138
1151
|
# @return [Array<Types::Tag>]
|
1139
1152
|
#
|
1140
1153
|
# @!attribute [rw] kms_key_id
|
1141
|
-
# An
|
1154
|
+
# An KMS key identifier that is used to encrypt the data on the
|
1142
1155
|
# replication instance.
|
1143
1156
|
#
|
1144
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
1145
|
-
#
|
1157
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
1158
|
+
# uses your default encryption key.
|
1146
1159
|
#
|
1147
|
-
#
|
1148
|
-
#
|
1149
|
-
# Region.
|
1160
|
+
# KMS creates the default encryption key for your account. Your
|
1161
|
+
# account has a different default encryption key for each Region.
|
1150
1162
|
# @return [String]
|
1151
1163
|
#
|
1152
1164
|
# @!attribute [rw] publicly_accessible
|
@@ -1175,8 +1187,8 @@ module Aws::DatabaseMigrationService
|
|
1175
1187
|
# `Example-App-ARN1`. For example, this value might result in the
|
1176
1188
|
# `EndpointArn` value
|
1177
1189
|
# `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you
|
1178
|
-
# don't specify a `ResourceIdentifier` value,
|
1179
|
-
#
|
1190
|
+
# don't specify a `ResourceIdentifier` value, DMS generates a default
|
1191
|
+
# identifier value for the end of `EndpointArn`.
|
1180
1192
|
# @return [String]
|
1181
1193
|
#
|
1182
1194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateReplicationInstanceMessage AWS API Documentation
|
@@ -1331,7 +1343,7 @@ module Aws::DatabaseMigrationService
|
|
1331
1343
|
# @!attribute [rw] table_mappings
|
1332
1344
|
# The table mappings for the task, in JSON format. For more
|
1333
1345
|
# information, see [Using Table Mapping to Specify Task Settings][1]
|
1334
|
-
# in the *
|
1346
|
+
# in the *Database Migration Service User Guide.*
|
1335
1347
|
#
|
1336
1348
|
#
|
1337
1349
|
#
|
@@ -1340,8 +1352,8 @@ module Aws::DatabaseMigrationService
|
|
1340
1352
|
#
|
1341
1353
|
# @!attribute [rw] replication_task_settings
|
1342
1354
|
# Overall settings for the task, in JSON format. For more information,
|
1343
|
-
# see [Specifying Task Settings for
|
1344
|
-
# Tasks][1] in the *
|
1355
|
+
# see [Specifying Task Settings for Database Migration Service
|
1356
|
+
# Tasks][1] in the *Database Migration Service User Guide.*
|
1345
1357
|
#
|
1346
1358
|
#
|
1347
1359
|
#
|
@@ -1377,7 +1389,7 @@ module Aws::DatabaseMigrationService
|
|
1377
1389
|
# with the source endpoint. You can verify this by setting the
|
1378
1390
|
# `slotName` extra connection attribute to the name of this logical
|
1379
1391
|
# replication slot. For more information, see [Extra Connection
|
1380
|
-
# Attributes When Using PostgreSQL as a Source for
|
1392
|
+
# Attributes When Using PostgreSQL as a Source for DMS][1].
|
1381
1393
|
#
|
1382
1394
|
# </note>
|
1383
1395
|
#
|
@@ -1404,8 +1416,8 @@ module Aws::DatabaseMigrationService
|
|
1404
1416
|
# @!attribute [rw] task_data
|
1405
1417
|
# Supplemental information that the task requires to migrate the data
|
1406
1418
|
# for certain source and target endpoints. For more information, see
|
1407
|
-
# [Specifying Supplemental Data for Task Settings][1] in the *
|
1408
|
-
#
|
1419
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *Database
|
1420
|
+
# Migration Service User Guide.*
|
1409
1421
|
#
|
1410
1422
|
#
|
1411
1423
|
#
|
@@ -1422,8 +1434,8 @@ module Aws::DatabaseMigrationService
|
|
1422
1434
|
# `Example-App-ARN1`. For example, this value might result in the
|
1423
1435
|
# `EndpointArn` value
|
1424
1436
|
# `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you
|
1425
|
-
# don't specify a `ResourceIdentifier` value,
|
1426
|
-
#
|
1437
|
+
# don't specify a `ResourceIdentifier` value, DMS generates a default
|
1438
|
+
# identifier value for the end of `EndpointArn`.
|
1427
1439
|
# @return [String]
|
1428
1440
|
#
|
1429
1441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateReplicationTaskMessage AWS API Documentation
|
@@ -1721,16 +1733,16 @@ module Aws::DatabaseMigrationService
|
|
1721
1733
|
# @return [Array<Types::AccountQuota>]
|
1722
1734
|
#
|
1723
1735
|
# @!attribute [rw] unique_account_identifier
|
1724
|
-
# A unique
|
1725
|
-
#
|
1726
|
-
#
|
1727
|
-
#
|
1728
|
-
#
|
1729
|
-
#
|
1736
|
+
# A unique DMS identifier for an account in a particular Region. The
|
1737
|
+
# value of this identifier has the following format: `c99999999999`.
|
1738
|
+
# DMS uses this identifier to name artifacts. For example, DMS uses
|
1739
|
+
# this identifier to name the default Amazon S3 bucket for storing
|
1740
|
+
# task assessment reports in a given Region. The format of this S3
|
1741
|
+
# bucket name is the following:
|
1730
1742
|
# `dms-AccountNumber-UniqueAccountIdentifier.` Here is an example name
|
1731
1743
|
# for this default S3 bucket: `dms-111122223333-c44445555666`.
|
1732
1744
|
#
|
1733
|
-
# <note markdown="1">
|
1745
|
+
# <note markdown="1"> DMS supports the `UniqueAccountIdentifier` parameter in versions
|
1734
1746
|
# 3.1.4 and later.
|
1735
1747
|
#
|
1736
1748
|
# </note>
|
@@ -1816,7 +1828,7 @@ module Aws::DatabaseMigrationService
|
|
1816
1828
|
# request parameters. For more information on the available individual
|
1817
1829
|
# assessments, including compatibility with different migration task
|
1818
1830
|
# configurations, see [Working with premigration assessment runs][1]
|
1819
|
-
# in the *
|
1831
|
+
# in the *Database Migration Service User Guide.*
|
1820
1832
|
#
|
1821
1833
|
#
|
1822
1834
|
#
|
@@ -1967,6 +1979,62 @@ module Aws::DatabaseMigrationService
|
|
1967
1979
|
include Aws::Structure
|
1968
1980
|
end
|
1969
1981
|
|
1982
|
+
# @note When making an API call, you may pass DescribeEndpointSettingsMessage
|
1983
|
+
# data as a hash:
|
1984
|
+
#
|
1985
|
+
# {
|
1986
|
+
# engine_name: "String", # required
|
1987
|
+
# max_records: 1,
|
1988
|
+
# marker: "String",
|
1989
|
+
# }
|
1990
|
+
#
|
1991
|
+
# @!attribute [rw] engine_name
|
1992
|
+
# The databse engine used for your source or target endpoint.
|
1993
|
+
# @return [String]
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] max_records
|
1996
|
+
# The maximum number of records to include in the response. If more
|
1997
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
1998
|
+
# token called a marker is included in the response so that the
|
1999
|
+
# remaining results can be retrieved.
|
2000
|
+
# @return [Integer]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] marker
|
2003
|
+
# An optional pagination token provided by a previous request. If this
|
2004
|
+
# parameter is specified, the response includes only records beyond
|
2005
|
+
# the marker, up to the value specified by `MaxRecords`.
|
2006
|
+
# @return [String]
|
2007
|
+
#
|
2008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeEndpointSettingsMessage AWS API Documentation
|
2009
|
+
#
|
2010
|
+
class DescribeEndpointSettingsMessage < Struct.new(
|
2011
|
+
:engine_name,
|
2012
|
+
:max_records,
|
2013
|
+
:marker)
|
2014
|
+
SENSITIVE = []
|
2015
|
+
include Aws::Structure
|
2016
|
+
end
|
2017
|
+
|
2018
|
+
# @!attribute [rw] marker
|
2019
|
+
# An optional pagination token provided by a previous request. If this
|
2020
|
+
# parameter is specified, the response includes only records beyond
|
2021
|
+
# the marker, up to the value specified by `MaxRecords`.
|
2022
|
+
# @return [String]
|
2023
|
+
#
|
2024
|
+
# @!attribute [rw] endpoint_settings
|
2025
|
+
# Descriptions of the endpoint settings available for your source or
|
2026
|
+
# target database engine.
|
2027
|
+
# @return [Array<Types::EndpointSetting>]
|
2028
|
+
#
|
2029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeEndpointSettingsResponse AWS API Documentation
|
2030
|
+
#
|
2031
|
+
class DescribeEndpointSettingsResponse < Struct.new(
|
2032
|
+
:marker,
|
2033
|
+
:endpoint_settings)
|
2034
|
+
SENSITIVE = []
|
2035
|
+
include Aws::Structure
|
2036
|
+
end
|
2037
|
+
|
1970
2038
|
# @note When making an API call, you may pass DescribeEndpointTypesMessage
|
1971
2039
|
# data as a hash:
|
1972
2040
|
#
|
@@ -2114,7 +2182,7 @@ module Aws::DatabaseMigrationService
|
|
2114
2182
|
# }
|
2115
2183
|
#
|
2116
2184
|
# @!attribute [rw] source_type
|
2117
|
-
# The type of
|
2185
|
+
# The type of DMS resource that generates events.
|
2118
2186
|
#
|
2119
2187
|
# Valid values: replication-instance \| replication-task
|
2120
2188
|
# @return [String]
|
@@ -2160,7 +2228,7 @@ module Aws::DatabaseMigrationService
|
|
2160
2228
|
# }
|
2161
2229
|
#
|
2162
2230
|
# @!attribute [rw] subscription_name
|
2163
|
-
# The name of the
|
2231
|
+
# The name of the DMS event subscription to be described.
|
2164
2232
|
# @return [String]
|
2165
2233
|
#
|
2166
2234
|
# @!attribute [rw] filters
|
@@ -2239,7 +2307,7 @@ module Aws::DatabaseMigrationService
|
|
2239
2307
|
# @return [String]
|
2240
2308
|
#
|
2241
2309
|
# @!attribute [rw] source_type
|
2242
|
-
# The type of
|
2310
|
+
# The type of DMS resource that generates events.
|
2243
2311
|
#
|
2244
2312
|
# Valid values: replication-instance \| replication-task
|
2245
2313
|
# @return [String]
|
@@ -3095,6 +3163,9 @@ module Aws::DatabaseMigrationService
|
|
3095
3163
|
#
|
3096
3164
|
# @!attribute [rw] service_access_role_arn
|
3097
3165
|
# The IAM role that has permission to access the Amazon S3 bucket.
|
3166
|
+
# When specified as part of request syntax, such as for the
|
3167
|
+
# `CreateEndpoint` and `ModifyEndpoint` actions, the role must allow
|
3168
|
+
# the `iam:PassRole` action.
|
3098
3169
|
# @return [String]
|
3099
3170
|
#
|
3100
3171
|
# @!attribute [rw] bucket_name
|
@@ -3173,20 +3244,20 @@ module Aws::DatabaseMigrationService
|
|
3173
3244
|
# @return [Integer]
|
3174
3245
|
#
|
3175
3246
|
# @!attribute [rw] kms_key_id
|
3176
|
-
# The
|
3177
|
-
#
|
3178
|
-
# `KmsKeyId` parameter, then
|
3179
|
-
#
|
3180
|
-
#
|
3181
|
-
# Region.
|
3247
|
+
# The KMS key identifier that is used to encrypt the content on the
|
3248
|
+
# replication instance. If you don't specify a value for the
|
3249
|
+
# `KmsKeyId` parameter, then DMS uses your default encryption key. KMS
|
3250
|
+
# creates the default encryption key for your account. Your account
|
3251
|
+
# has a different default encryption key for each Region.
|
3182
3252
|
# @return [String]
|
3183
3253
|
#
|
3184
3254
|
# @!attribute [rw] secrets_manager_access_role_arn
|
3185
3255
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
3186
|
-
#
|
3187
|
-
# access the value in `SecretsManagerSecret`.
|
3188
|
-
# has the value of the
|
3189
|
-
# to the
|
3256
|
+
# DMS as the trusted entity and grants the required permissions to
|
3257
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
3258
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
3259
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
3260
|
+
# DocumentDB endpoint.
|
3190
3261
|
#
|
3191
3262
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
3192
3263
|
# can specify the values for this setting and
|
@@ -3194,15 +3265,15 @@ module Aws::DatabaseMigrationService
|
|
3194
3265
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
3195
3266
|
# both. For more information on creating this `SecretsManagerSecret`
|
3196
3267
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
3197
|
-
# required to access it, see [Using secrets to access
|
3198
|
-
# Migration Service resources][1] in the *
|
3199
|
-
#
|
3268
|
+
# required to access it, see [Using secrets to access Database
|
3269
|
+
# Migration Service resources][1] in the *Database Migration Service
|
3270
|
+
# User Guide*.
|
3200
3271
|
#
|
3201
3272
|
# </note>
|
3202
3273
|
#
|
3203
3274
|
#
|
3204
3275
|
#
|
3205
|
-
# [1]: https://docs.aws.amazon.com/
|
3276
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
3206
3277
|
# @return [String]
|
3207
3278
|
#
|
3208
3279
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -3229,7 +3300,7 @@ module Aws::DatabaseMigrationService
|
|
3229
3300
|
include Aws::Structure
|
3230
3301
|
end
|
3231
3302
|
|
3232
|
-
# Provides the Amazon Resource Name (ARN) of the
|
3303
|
+
# Provides the Amazon Resource Name (ARN) of the Identity and Access
|
3233
3304
|
# Management (IAM) role used to define an Amazon DynamoDB target
|
3234
3305
|
# endpoint.
|
3235
3306
|
#
|
@@ -3241,7 +3312,8 @@ module Aws::DatabaseMigrationService
|
|
3241
3312
|
# }
|
3242
3313
|
#
|
3243
3314
|
# @!attribute [rw] service_access_role_arn
|
3244
|
-
# The Amazon Resource Name (ARN) used by the service access IAM
|
3315
|
+
# The Amazon Resource Name (ARN) used by the service to access the IAM
|
3316
|
+
# role. The role must allow the `iam:PassRole` action.
|
3245
3317
|
# @return [String]
|
3246
3318
|
#
|
3247
3319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DynamoDbSettings AWS API Documentation
|
@@ -3265,12 +3337,12 @@ module Aws::DatabaseMigrationService
|
|
3265
3337
|
# }
|
3266
3338
|
#
|
3267
3339
|
# @!attribute [rw] service_access_role_arn
|
3268
|
-
# The Amazon Resource Name (ARN) used by service to access the IAM
|
3269
|
-
# role.
|
3340
|
+
# The Amazon Resource Name (ARN) used by the service to access the IAM
|
3341
|
+
# role. The role must allow the `iam:PassRole` action.
|
3270
3342
|
# @return [String]
|
3271
3343
|
#
|
3272
3344
|
# @!attribute [rw] endpoint_uri
|
3273
|
-
# The endpoint for the Elasticsearch cluster.
|
3345
|
+
# The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a
|
3274
3346
|
# transport protocol (http/https) is not specified.
|
3275
3347
|
# @return [String]
|
3276
3348
|
#
|
@@ -3308,8 +3380,6 @@ module Aws::DatabaseMigrationService
|
|
3308
3380
|
#
|
3309
3381
|
# * `DescribeEndpoint`
|
3310
3382
|
#
|
3311
|
-
# * `DescribeEndpointTypes`
|
3312
|
-
#
|
3313
3383
|
# * `ModifyEndpoint`
|
3314
3384
|
#
|
3315
3385
|
# @!attribute [rw] endpoint_identifier
|
@@ -3362,15 +3432,14 @@ module Aws::DatabaseMigrationService
|
|
3362
3432
|
# @return [String]
|
3363
3433
|
#
|
3364
3434
|
# @!attribute [rw] kms_key_id
|
3365
|
-
# An
|
3435
|
+
# An KMS key identifier that is used to encrypt the connection
|
3366
3436
|
# parameters for the endpoint.
|
3367
3437
|
#
|
3368
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
3369
|
-
#
|
3438
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
3439
|
+
# uses your default encryption key.
|
3370
3440
|
#
|
3371
|
-
#
|
3372
|
-
#
|
3373
|
-
# Region.
|
3441
|
+
# KMS creates the default encryption key for your account. Your
|
3442
|
+
# account has a different default encryption key for each Region.
|
3374
3443
|
# @return [String]
|
3375
3444
|
#
|
3376
3445
|
# @!attribute [rw] endpoint_arn
|
@@ -3389,7 +3458,8 @@ module Aws::DatabaseMigrationService
|
|
3389
3458
|
# @return [String]
|
3390
3459
|
#
|
3391
3460
|
# @!attribute [rw] service_access_role_arn
|
3392
|
-
# The Amazon Resource Name (ARN) used by the service access IAM
|
3461
|
+
# The Amazon Resource Name (ARN) used by the service to access the IAM
|
3462
|
+
# role. The role must allow the `iam:PassRole` action.
|
3393
3463
|
# @return [String]
|
3394
3464
|
#
|
3395
3465
|
# @!attribute [rw] external_table_definition
|
@@ -3419,20 +3489,16 @@ module Aws::DatabaseMigrationService
|
|
3419
3489
|
# Possible settings include the following:
|
3420
3490
|
#
|
3421
3491
|
# * `ServiceAccessRoleArn` - The IAM role that has permission to
|
3422
|
-
# access the Amazon S3 bucket.
|
3492
|
+
# access the Amazon S3 bucket. The role must allow the
|
3493
|
+
# `iam:PassRole` action.
|
3423
3494
|
#
|
3424
3495
|
# * `BucketName` - The name of the S3 bucket to use.
|
3425
3496
|
#
|
3426
|
-
# * `CompressionType` - An optional parameter to use GZIP to compress
|
3427
|
-
# the target files. To use GZIP, set this value to `NONE` (the
|
3428
|
-
# default). To keep the files uncompressed, don't use this value.
|
3429
|
-
#
|
3430
3497
|
# Shorthand syntax for these settings is as follows:
|
3431
|
-
# `ServiceAccessRoleArn=string,BucketName=string
|
3498
|
+
# `ServiceAccessRoleArn=string,BucketName=string,`
|
3432
3499
|
#
|
3433
3500
|
# JSON syntax for these settings is as follows: `\{
|
3434
|
-
# "ServiceAccessRoleArn": "string", "BucketName": "string"
|
3435
|
-
# "CompressionType": "none"|"gzip" \} `
|
3501
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string"\} `
|
3436
3502
|
# @return [Types::DmsTransferSettings]
|
3437
3503
|
#
|
3438
3504
|
# @!attribute [rw] mongo_db_settings
|
@@ -3539,17 +3605,73 @@ module Aws::DatabaseMigrationService
|
|
3539
3605
|
include Aws::Structure
|
3540
3606
|
end
|
3541
3607
|
|
3608
|
+
# Endpoint settings.
|
3609
|
+
#
|
3610
|
+
# @!attribute [rw] name
|
3611
|
+
# The name that you want to give the endpoint settings.
|
3612
|
+
# @return [String]
|
3613
|
+
#
|
3614
|
+
# @!attribute [rw] type
|
3615
|
+
# The type of endpoint. Valid values are `source` and `target`.
|
3616
|
+
# @return [String]
|
3617
|
+
#
|
3618
|
+
# @!attribute [rw] enum_values
|
3619
|
+
# Enumerated values to use for this endpoint.
|
3620
|
+
# @return [Array<String>]
|
3621
|
+
#
|
3622
|
+
# @!attribute [rw] sensitive
|
3623
|
+
# A value that marks this endpoint setting as sensitive.
|
3624
|
+
# @return [Boolean]
|
3625
|
+
#
|
3626
|
+
# @!attribute [rw] units
|
3627
|
+
# The unit of measure for this endpoint setting.
|
3628
|
+
# @return [String]
|
3629
|
+
#
|
3630
|
+
# @!attribute [rw] applicability
|
3631
|
+
# The relevance or validity of an endpoint setting for an engine name
|
3632
|
+
# and its endpoint type.
|
3633
|
+
# @return [String]
|
3634
|
+
#
|
3635
|
+
# @!attribute [rw] int_value_min
|
3636
|
+
# The minimum value of an endpoint setting that is of type `int`.
|
3637
|
+
# @return [Integer]
|
3638
|
+
#
|
3639
|
+
# @!attribute [rw] int_value_max
|
3640
|
+
# The maximum value of an endpoint setting that is of type `int`.
|
3641
|
+
# @return [Integer]
|
3642
|
+
#
|
3643
|
+
# @!attribute [rw] default_value
|
3644
|
+
# The default value of the endpoint setting if no value is specified
|
3645
|
+
# using `CreateEndpoint` or `ModifyEndpoint`.
|
3646
|
+
# @return [String]
|
3647
|
+
#
|
3648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/EndpointSetting AWS API Documentation
|
3649
|
+
#
|
3650
|
+
class EndpointSetting < Struct.new(
|
3651
|
+
:name,
|
3652
|
+
:type,
|
3653
|
+
:enum_values,
|
3654
|
+
:sensitive,
|
3655
|
+
:units,
|
3656
|
+
:applicability,
|
3657
|
+
:int_value_min,
|
3658
|
+
:int_value_max,
|
3659
|
+
:default_value)
|
3660
|
+
SENSITIVE = []
|
3661
|
+
include Aws::Structure
|
3662
|
+
end
|
3663
|
+
|
3542
3664
|
# Describes an identifiable significant activity that affects a
|
3543
3665
|
# replication instance or task. This object can provide the message, the
|
3544
3666
|
# available event categories, the date and source of the event, and the
|
3545
|
-
#
|
3667
|
+
# DMS resource type.
|
3546
3668
|
#
|
3547
3669
|
# @!attribute [rw] source_identifier
|
3548
3670
|
# The identifier of an event source.
|
3549
3671
|
# @return [String]
|
3550
3672
|
#
|
3551
3673
|
# @!attribute [rw] source_type
|
3552
|
-
# The type of
|
3674
|
+
# The type of DMS resource that generates events.
|
3553
3675
|
#
|
3554
3676
|
# Valid values: replication-instance \| endpoint \| replication-task
|
3555
3677
|
# @return [String]
|
@@ -3579,15 +3701,15 @@ module Aws::DatabaseMigrationService
|
|
3579
3701
|
end
|
3580
3702
|
|
3581
3703
|
# Lists categories of events subscribed to, and generated by, the
|
3582
|
-
# applicable
|
3583
|
-
#
|
3704
|
+
# applicable DMS resource type. This data type appears in response to
|
3705
|
+
# the [ `DescribeEventCategories` ][1] action.
|
3584
3706
|
#
|
3585
3707
|
#
|
3586
3708
|
#
|
3587
3709
|
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html
|
3588
3710
|
#
|
3589
3711
|
# @!attribute [rw] source_type
|
3590
|
-
# The type of
|
3712
|
+
# The type of DMS resource that generates events.
|
3591
3713
|
#
|
3592
3714
|
# Valid values: replication-instance \| replication-server \|
|
3593
3715
|
# security-group \| replication-task
|
@@ -3610,38 +3732,38 @@ module Aws::DatabaseMigrationService
|
|
3610
3732
|
# `CreateEventSubscription` operation.
|
3611
3733
|
#
|
3612
3734
|
# @!attribute [rw] customer_aws_id
|
3613
|
-
# The
|
3614
|
-
# notification subscription.
|
3735
|
+
# The Amazon Web Services customer account associated with the DMS
|
3736
|
+
# event notification subscription.
|
3615
3737
|
# @return [String]
|
3616
3738
|
#
|
3617
3739
|
# @!attribute [rw] cust_subscription_id
|
3618
|
-
# The
|
3740
|
+
# The DMS event notification subscription Id.
|
3619
3741
|
# @return [String]
|
3620
3742
|
#
|
3621
3743
|
# @!attribute [rw] sns_topic_arn
|
3622
|
-
# The topic ARN of the
|
3744
|
+
# The topic ARN of the DMS event notification subscription.
|
3623
3745
|
# @return [String]
|
3624
3746
|
#
|
3625
3747
|
# @!attribute [rw] status
|
3626
|
-
# The status of the
|
3748
|
+
# The status of the DMS event notification subscription.
|
3627
3749
|
#
|
3628
3750
|
# Constraints:
|
3629
3751
|
#
|
3630
3752
|
# Can be one of the following: creating \| modifying \| deleting \|
|
3631
3753
|
# active \| no-permission \| topic-not-exist
|
3632
3754
|
#
|
3633
|
-
# The status "no-permission" indicates that
|
3755
|
+
# The status "no-permission" indicates that DMS no longer has
|
3634
3756
|
# permission to post to the SNS topic. The status "topic-not-exist"
|
3635
3757
|
# indicates that the topic was deleted after the subscription was
|
3636
3758
|
# created.
|
3637
3759
|
# @return [String]
|
3638
3760
|
#
|
3639
3761
|
# @!attribute [rw] subscription_creation_time
|
3640
|
-
# The time the
|
3762
|
+
# The time the DMS event notification subscription was created.
|
3641
3763
|
# @return [String]
|
3642
3764
|
#
|
3643
3765
|
# @!attribute [rw] source_type
|
3644
|
-
# The type of
|
3766
|
+
# The type of DMS resource that generates events.
|
3645
3767
|
#
|
3646
3768
|
# Valid values: replication-instance \| replication-server \|
|
3647
3769
|
# security-group \| replication-task
|
@@ -3676,9 +3798,9 @@ module Aws::DatabaseMigrationService
|
|
3676
3798
|
end
|
3677
3799
|
|
3678
3800
|
# Identifies the name and value of a filter object. This filter is used
|
3679
|
-
# to limit the number and type of
|
3680
|
-
#
|
3681
|
-
#
|
3801
|
+
# to limit the number and type of DMS objects that are returned for a
|
3802
|
+
# particular `Describe*` call or similar operation. Filters are used as
|
3803
|
+
# an optional parameter for certain API operations.
|
3682
3804
|
#
|
3683
3805
|
# @note When making an API call, you may pass Filter
|
3684
3806
|
# data as a hash:
|
@@ -3734,7 +3856,7 @@ module Aws::DatabaseMigrationService
|
|
3734
3856
|
# @return [String]
|
3735
3857
|
#
|
3736
3858
|
# @!attribute [rw] port
|
3737
|
-
# Endpoint TCP port.
|
3859
|
+
# Endpoint TCP port. The default value is 50000.
|
3738
3860
|
# @return [Integer]
|
3739
3861
|
#
|
3740
3862
|
# @!attribute [rw] server_name
|
@@ -3762,10 +3884,11 @@ module Aws::DatabaseMigrationService
|
|
3762
3884
|
#
|
3763
3885
|
# @!attribute [rw] secrets_manager_access_role_arn
|
3764
3886
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
3765
|
-
#
|
3766
|
-
# access the value in `SecretsManagerSecret`.
|
3767
|
-
# has the value of the
|
3768
|
-
#
|
3887
|
+
# DMS as the trusted entity and grants the required permissions to
|
3888
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
3889
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
3890
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
3891
|
+
# Db2 LUW endpoint.
|
3769
3892
|
#
|
3770
3893
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
3771
3894
|
# can specify the values for this setting and
|
@@ -3773,15 +3896,15 @@ module Aws::DatabaseMigrationService
|
|
3773
3896
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
3774
3897
|
# both. For more information on creating this `SecretsManagerSecret`
|
3775
3898
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
3776
|
-
# required to access it, see [Using secrets to access
|
3777
|
-
# Migration Service resources][1] in the *
|
3778
|
-
#
|
3899
|
+
# required to access it, see [Using secrets to access Database
|
3900
|
+
# Migration Service resources][1] in the *Database Migration Service
|
3901
|
+
# User Guide*.
|
3779
3902
|
#
|
3780
3903
|
# </note>
|
3781
3904
|
#
|
3782
3905
|
#
|
3783
3906
|
#
|
3784
|
-
# [1]: https://docs.aws.amazon.com/
|
3907
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
3785
3908
|
# @return [String]
|
3786
3909
|
#
|
3787
3910
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -3812,7 +3935,7 @@ module Aws::DatabaseMigrationService
|
|
3812
3935
|
#
|
3813
3936
|
# {
|
3814
3937
|
# certificate_identifier: "String", # required
|
3815
|
-
# certificate_pem: "
|
3938
|
+
# certificate_pem: "SecretString",
|
3816
3939
|
# certificate_wallet: "data",
|
3817
3940
|
# tags: [
|
3818
3941
|
# {
|
@@ -3835,7 +3958,8 @@ module Aws::DatabaseMigrationService
|
|
3835
3958
|
#
|
3836
3959
|
# @!attribute [rw] certificate_wallet
|
3837
3960
|
# The location of an imported Oracle Wallet certificate for use with
|
3838
|
-
# SSL.
|
3961
|
+
# SSL. Provide the name of a `.sso` file using the `fileb://` prefix.
|
3962
|
+
# You can't provide the certificate inline.
|
3839
3963
|
# @return [String]
|
3840
3964
|
#
|
3841
3965
|
# @!attribute [rw] tags
|
@@ -3849,7 +3973,7 @@ module Aws::DatabaseMigrationService
|
|
3849
3973
|
:certificate_pem,
|
3850
3974
|
:certificate_wallet,
|
3851
3975
|
:tags)
|
3852
|
-
SENSITIVE = []
|
3976
|
+
SENSITIVE = [:certificate_pem]
|
3853
3977
|
include Aws::Structure
|
3854
3978
|
end
|
3855
3979
|
|
@@ -3945,8 +4069,7 @@ module Aws::DatabaseMigrationService
|
|
3945
4069
|
include Aws::Structure
|
3946
4070
|
end
|
3947
4071
|
|
3948
|
-
# An
|
3949
|
-
# AWS KMS.
|
4072
|
+
# An Key Management Service (KMS) error is preventing access to KMS.
|
3950
4073
|
#
|
3951
4074
|
# @!attribute [rw] message
|
3952
4075
|
# @return [String]
|
@@ -3959,8 +4082,7 @@ module Aws::DatabaseMigrationService
|
|
3959
4082
|
include Aws::Structure
|
3960
4083
|
end
|
3961
4084
|
|
3962
|
-
# The state of the specified
|
3963
|
-
# request.
|
4085
|
+
# The state of the specified KMS resource isn't valid for this request.
|
3964
4086
|
#
|
3965
4087
|
# @!attribute [rw] message
|
3966
4088
|
# @return [String]
|
@@ -3973,7 +4095,7 @@ module Aws::DatabaseMigrationService
|
|
3973
4095
|
include Aws::Structure
|
3974
4096
|
end
|
3975
4097
|
|
3976
|
-
#
|
4098
|
+
# DMS cannot access the KMS key.
|
3977
4099
|
#
|
3978
4100
|
# @!attribute [rw] message
|
3979
4101
|
# @return [String]
|
@@ -3986,7 +4108,7 @@ module Aws::DatabaseMigrationService
|
|
3986
4108
|
include Aws::Structure
|
3987
4109
|
end
|
3988
4110
|
|
3989
|
-
# The specified
|
4111
|
+
# The specified KMS entity or resource can't be found.
|
3990
4112
|
#
|
3991
4113
|
# @!attribute [rw] message
|
3992
4114
|
# @return [String]
|
@@ -3999,7 +4121,7 @@ module Aws::DatabaseMigrationService
|
|
3999
4121
|
include Aws::Structure
|
4000
4122
|
end
|
4001
4123
|
|
4002
|
-
# This request triggered
|
4124
|
+
# This request triggered KMS request throttling.
|
4003
4125
|
#
|
4004
4126
|
# @!attribute [rw] message
|
4005
4127
|
# @return [String]
|
@@ -4031,19 +4153,33 @@ module Aws::DatabaseMigrationService
|
|
4031
4153
|
# include_control_details: false,
|
4032
4154
|
# message_max_bytes: 1,
|
4033
4155
|
# include_null_and_empty: false,
|
4156
|
+
# security_protocol: "plaintext", # accepts plaintext, ssl-authentication, ssl-encryption, sasl-ssl
|
4157
|
+
# ssl_client_certificate_arn: "String",
|
4158
|
+
# ssl_client_key_arn: "String",
|
4159
|
+
# ssl_client_key_password: "SecretString",
|
4160
|
+
# ssl_ca_certificate_arn: "String",
|
4161
|
+
# sasl_username: "String",
|
4162
|
+
# sasl_password: "SecretString",
|
4163
|
+
# no_hex_prefix: false,
|
4034
4164
|
# }
|
4035
4165
|
#
|
4036
4166
|
# @!attribute [rw] broker
|
4037
|
-
#
|
4038
|
-
# Kafka instance. Specify
|
4039
|
-
# broker-hostname-or-ip:port `. For example,
|
4040
|
-
# `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"`.
|
4167
|
+
# A comma-separated list of one or more broker locations in your Kafka
|
4168
|
+
# cluster that host your Kafka instance. Specify each broker location
|
4169
|
+
# in the form ` broker-hostname-or-ip:port `. For example,
|
4170
|
+
# `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"`. For more
|
4171
|
+
# information and examples of specifying a list of broker locations,
|
4172
|
+
# see [Using Apache Kafka as a target for Database Migration
|
4173
|
+
# Service][1] in the *Database Migration Service User Guide*.
|
4174
|
+
#
|
4175
|
+
#
|
4176
|
+
#
|
4177
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html
|
4041
4178
|
# @return [String]
|
4042
4179
|
#
|
4043
4180
|
# @!attribute [rw] topic
|
4044
4181
|
# The topic to which you migrate the data. If you don't specify a
|
4045
|
-
# topic,
|
4046
|
-
# topic.
|
4182
|
+
# topic, DMS specifies `"kafka-default-topic"` as the migration topic.
|
4047
4183
|
# @return [String]
|
4048
4184
|
#
|
4049
4185
|
# @!attribute [rw] message_format
|
@@ -4061,8 +4197,8 @@ module Aws::DatabaseMigrationService
|
|
4061
4197
|
# @return [Boolean]
|
4062
4198
|
#
|
4063
4199
|
# @!attribute [rw] include_partition_value
|
4064
|
-
# Shows the partition value within the Kafka message output
|
4065
|
-
#
|
4200
|
+
# Shows the partition value within the Kafka message output unless the
|
4201
|
+
# partition type is `schema-table-type`. The default is `false`.
|
4066
4202
|
# @return [Boolean]
|
4067
4203
|
#
|
4068
4204
|
# @!attribute [rw] partition_include_schema_table
|
@@ -4098,6 +4234,53 @@ module Aws::DatabaseMigrationService
|
|
4098
4234
|
# The default is `false`.
|
4099
4235
|
# @return [Boolean]
|
4100
4236
|
#
|
4237
|
+
# @!attribute [rw] security_protocol
|
4238
|
+
# Set secure connection to a Kafka target endpoint using Transport
|
4239
|
+
# Layer Security (TLS). Options include `ssl-encryption`,
|
4240
|
+
# `ssl-authentication`, and `sasl-ssl`. `sasl-ssl` requires
|
4241
|
+
# `SaslUsername` and `SaslPassword`.
|
4242
|
+
# @return [String]
|
4243
|
+
#
|
4244
|
+
# @!attribute [rw] ssl_client_certificate_arn
|
4245
|
+
# The Amazon Resource Name (ARN) of the client certificate used to
|
4246
|
+
# securely connect to a Kafka target endpoint.
|
4247
|
+
# @return [String]
|
4248
|
+
#
|
4249
|
+
# @!attribute [rw] ssl_client_key_arn
|
4250
|
+
# The Amazon Resource Name (ARN) for the client private key used to
|
4251
|
+
# securely connect to a Kafka target endpoint.
|
4252
|
+
# @return [String]
|
4253
|
+
#
|
4254
|
+
# @!attribute [rw] ssl_client_key_password
|
4255
|
+
# The password for the client private key used to securely connect to
|
4256
|
+
# a Kafka target endpoint.
|
4257
|
+
# @return [String]
|
4258
|
+
#
|
4259
|
+
# @!attribute [rw] ssl_ca_certificate_arn
|
4260
|
+
# The Amazon Resource Name (ARN) for the private Certification
|
4261
|
+
# Authority (CA) cert that DMS uses to securely connect to your Kafka
|
4262
|
+
# target endpoint.
|
4263
|
+
# @return [String]
|
4264
|
+
#
|
4265
|
+
# @!attribute [rw] sasl_username
|
4266
|
+
# The secure user name you created when you first set up your MSK
|
4267
|
+
# cluster to validate a client identity and make an encrypted
|
4268
|
+
# connection between server and client using SASL-SSL authentication.
|
4269
|
+
# @return [String]
|
4270
|
+
#
|
4271
|
+
# @!attribute [rw] sasl_password
|
4272
|
+
# The secure password you created when you first set up your MSK
|
4273
|
+
# cluster to validate a client identity and make an encrypted
|
4274
|
+
# connection between server and client using SASL-SSL authentication.
|
4275
|
+
# @return [String]
|
4276
|
+
#
|
4277
|
+
# @!attribute [rw] no_hex_prefix
|
4278
|
+
# If this attribute is Y, it allows hexadecimal values that don't
|
4279
|
+
# have the `0x` prefix when migrated to a Kafka target. If this
|
4280
|
+
# attribute is N, all hexadecimal values include this prefix when
|
4281
|
+
# migrated to Kafka.
|
4282
|
+
# @return [Boolean]
|
4283
|
+
#
|
4101
4284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KafkaSettings AWS API Documentation
|
4102
4285
|
#
|
4103
4286
|
class KafkaSettings < Struct.new(
|
@@ -4110,8 +4293,16 @@ module Aws::DatabaseMigrationService
|
|
4110
4293
|
:include_table_alter_operations,
|
4111
4294
|
:include_control_details,
|
4112
4295
|
:message_max_bytes,
|
4113
|
-
:include_null_and_empty
|
4114
|
-
|
4296
|
+
:include_null_and_empty,
|
4297
|
+
:security_protocol,
|
4298
|
+
:ssl_client_certificate_arn,
|
4299
|
+
:ssl_client_key_arn,
|
4300
|
+
:ssl_client_key_password,
|
4301
|
+
:ssl_ca_certificate_arn,
|
4302
|
+
:sasl_username,
|
4303
|
+
:sasl_password,
|
4304
|
+
:no_hex_prefix)
|
4305
|
+
SENSITIVE = [:ssl_client_key_password, :sasl_password]
|
4115
4306
|
include Aws::Structure
|
4116
4307
|
end
|
4117
4308
|
|
@@ -4133,6 +4324,7 @@ module Aws::DatabaseMigrationService
|
|
4133
4324
|
# include_table_alter_operations: false,
|
4134
4325
|
# include_control_details: false,
|
4135
4326
|
# include_null_and_empty: false,
|
4327
|
+
# no_hex_prefix: false,
|
4136
4328
|
# }
|
4137
4329
|
#
|
4138
4330
|
# @!attribute [rw] stream_arn
|
@@ -4147,9 +4339,9 @@ module Aws::DatabaseMigrationService
|
|
4147
4339
|
# @return [String]
|
4148
4340
|
#
|
4149
4341
|
# @!attribute [rw] service_access_role_arn
|
4150
|
-
# The Amazon Resource Name (ARN) for the
|
4151
|
-
#
|
4152
|
-
#
|
4342
|
+
# The Amazon Resource Name (ARN) for the IAM role that DMS uses to
|
4343
|
+
# write to the Kinesis data stream. The role must allow the
|
4344
|
+
# `iam:PassRole` action.
|
4153
4345
|
# @return [String]
|
4154
4346
|
#
|
4155
4347
|
# @!attribute [rw] include_transaction_details
|
@@ -4193,6 +4385,13 @@ module Aws::DatabaseMigrationService
|
|
4193
4385
|
# The default is `false`.
|
4194
4386
|
# @return [Boolean]
|
4195
4387
|
#
|
4388
|
+
# @!attribute [rw] no_hex_prefix
|
4389
|
+
# If this attribute is Y, it allows hexadecimal values that don't
|
4390
|
+
# have the `0x` prefix when migrated to a Kinesis target. If this
|
4391
|
+
# attribute is N, all hexadecimal values include this prefix when
|
4392
|
+
# migrated to Kinesis.
|
4393
|
+
# @return [Boolean]
|
4394
|
+
#
|
4196
4395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KinesisSettings AWS API Documentation
|
4197
4396
|
#
|
4198
4397
|
class KinesisSettings < Struct.new(
|
@@ -4204,7 +4403,8 @@ module Aws::DatabaseMigrationService
|
|
4204
4403
|
:partition_include_schema_table,
|
4205
4404
|
:include_table_alter_operations,
|
4206
4405
|
:include_control_details,
|
4207
|
-
:include_null_and_empty
|
4406
|
+
:include_null_and_empty,
|
4407
|
+
:no_hex_prefix)
|
4208
4408
|
SENSITIVE = []
|
4209
4409
|
include Aws::Structure
|
4210
4410
|
end
|
@@ -4218,7 +4418,7 @@ module Aws::DatabaseMigrationService
|
|
4218
4418
|
#
|
4219
4419
|
# @!attribute [rw] resource_arn
|
4220
4420
|
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
4221
|
-
#
|
4421
|
+
# DMS resource.
|
4222
4422
|
# @return [String]
|
4223
4423
|
#
|
4224
4424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ListTagsForResourceMessage AWS API Documentation
|
@@ -4252,11 +4452,13 @@ module Aws::DatabaseMigrationService
|
|
4252
4452
|
# database_name: "String",
|
4253
4453
|
# control_tables_file_group: "String",
|
4254
4454
|
# password: "SecretString",
|
4455
|
+
# query_single_always_on_node: false,
|
4255
4456
|
# read_backup_only: false,
|
4256
4457
|
# safeguard_policy: "rely-on-sql-server-replication-agent", # accepts rely-on-sql-server-replication-agent, exclusive-automatic-truncation, shared-automatic-truncation
|
4257
4458
|
# server_name: "String",
|
4258
4459
|
# username: "String",
|
4259
4460
|
# use_bcp_full_load: false,
|
4461
|
+
# use_third_party_backup_device: false,
|
4260
4462
|
# secrets_manager_access_role_arn: "String",
|
4261
4463
|
# secrets_manager_secret_id: "String",
|
4262
4464
|
# }
|
@@ -4275,8 +4477,8 @@ module Aws::DatabaseMigrationService
|
|
4275
4477
|
# @return [String]
|
4276
4478
|
#
|
4277
4479
|
# @!attribute [rw] control_tables_file_group
|
4278
|
-
# Specifies a file group for the
|
4279
|
-
# replication task starts, all the internal
|
4480
|
+
# Specifies a file group for the DMS internal tables. When the
|
4481
|
+
# replication task starts, all the internal DMS control tables
|
4280
4482
|
# (awsdms\_ apply\_exception, awsdms\_apply, awsdms\_changes) are
|
4281
4483
|
# created for the specified file group.
|
4282
4484
|
# @return [String]
|
@@ -4285,8 +4487,15 @@ module Aws::DatabaseMigrationService
|
|
4285
4487
|
# Endpoint connection password.
|
4286
4488
|
# @return [String]
|
4287
4489
|
#
|
4490
|
+
# @!attribute [rw] query_single_always_on_node
|
4491
|
+
# Cleans and recreates table metadata information on the replication
|
4492
|
+
# instance when a mismatch occurs. An example is a situation where
|
4493
|
+
# running an alter DDL statement on a table might result in different
|
4494
|
+
# information about the table cached in the replication instance.
|
4495
|
+
# @return [Boolean]
|
4496
|
+
#
|
4288
4497
|
# @!attribute [rw] read_backup_only
|
4289
|
-
# When this attribute is set to `Y`,
|
4498
|
+
# When this attribute is set to `Y`, DMS only reads changes from
|
4290
4499
|
# transaction log backups and doesn't read from the active
|
4291
4500
|
# transaction log file during ongoing replication. Setting this
|
4292
4501
|
# parameter to `Y` enables you to control active transaction log file
|
@@ -4296,24 +4505,24 @@ module Aws::DatabaseMigrationService
|
|
4296
4505
|
#
|
4297
4506
|
# @!attribute [rw] safeguard_policy
|
4298
4507
|
# Use this attribute to minimize the need to access the backup log and
|
4299
|
-
# enable
|
4508
|
+
# enable DMS to prevent truncation using one of the following two
|
4300
4509
|
# methods.
|
4301
4510
|
#
|
4302
4511
|
# *Start transactions in the database:* This is the default method.
|
4303
|
-
# When this method is used,
|
4304
|
-
#
|
4305
|
-
#
|
4306
|
-
#
|
4307
|
-
#
|
4512
|
+
# When this method is used, DMS prevents TLOG truncation by mimicking
|
4513
|
+
# a transaction in the database. As long as such a transaction is
|
4514
|
+
# open, changes that appear after the transaction started aren't
|
4515
|
+
# truncated. If you need Microsoft Replication to be enabled in your
|
4516
|
+
# database, then you must choose this method.
|
4308
4517
|
#
|
4309
4518
|
# *Exclusively use sp\_repldone within a single task*\: When this
|
4310
|
-
# method is used,
|
4311
|
-
#
|
4519
|
+
# method is used, DMS reads the changes and then uses sp\_repldone to
|
4520
|
+
# mark the TLOG transactions as ready for truncation. Although this
|
4312
4521
|
# method doesn't involve any transactional activities, it can only be
|
4313
4522
|
# used when Microsoft Replication isn't running. Also, when using
|
4314
|
-
# this method, only one
|
4315
|
-
#
|
4316
|
-
#
|
4523
|
+
# this method, only one DMS task can access the database at any given
|
4524
|
+
# time. Therefore, if you need to run parallel DMS tasks against the
|
4525
|
+
# same database, use the default method.
|
4317
4526
|
# @return [String]
|
4318
4527
|
#
|
4319
4528
|
# @!attribute [rw] server_name
|
@@ -4331,12 +4540,18 @@ module Aws::DatabaseMigrationService
|
|
4331
4540
|
# loading table option.
|
4332
4541
|
# @return [Boolean]
|
4333
4542
|
#
|
4543
|
+
# @!attribute [rw] use_third_party_backup_device
|
4544
|
+
# When this attribute is set to `Y`, DMS processes third-party
|
4545
|
+
# transaction log backups if they are created in native format.
|
4546
|
+
# @return [Boolean]
|
4547
|
+
#
|
4334
4548
|
# @!attribute [rw] secrets_manager_access_role_arn
|
4335
4549
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
4336
|
-
#
|
4337
|
-
# access the value in `SecretsManagerSecret`.
|
4338
|
-
# has the value of the
|
4339
|
-
#
|
4550
|
+
# DMS as the trusted entity and grants the required permissions to
|
4551
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
4552
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
4553
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
4554
|
+
# SQL Server endpoint.
|
4340
4555
|
#
|
4341
4556
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
4342
4557
|
# can specify the values for this setting and
|
@@ -4344,15 +4559,15 @@ module Aws::DatabaseMigrationService
|
|
4344
4559
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
4345
4560
|
# both. For more information on creating this `SecretsManagerSecret`
|
4346
4561
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
4347
|
-
# required to access it, see [Using secrets to access
|
4348
|
-
# Migration Service resources][1] in the *
|
4349
|
-
#
|
4562
|
+
# required to access it, see [Using secrets to access Database
|
4563
|
+
# Migration Service resources][1] in the *Database Migration Service
|
4564
|
+
# User Guide*.
|
4350
4565
|
#
|
4351
4566
|
# </note>
|
4352
4567
|
#
|
4353
4568
|
#
|
4354
4569
|
#
|
4355
|
-
# [1]: https://docs.aws.amazon.com/
|
4570
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
4356
4571
|
# @return [String]
|
4357
4572
|
#
|
4358
4573
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -4369,11 +4584,13 @@ module Aws::DatabaseMigrationService
|
|
4369
4584
|
:database_name,
|
4370
4585
|
:control_tables_file_group,
|
4371
4586
|
:password,
|
4587
|
+
:query_single_always_on_node,
|
4372
4588
|
:read_backup_only,
|
4373
4589
|
:safeguard_policy,
|
4374
4590
|
:server_name,
|
4375
4591
|
:username,
|
4376
4592
|
:use_bcp_full_load,
|
4593
|
+
:use_third_party_backup_device,
|
4377
4594
|
:secrets_manager_access_role_arn,
|
4378
4595
|
:secrets_manager_secret_id)
|
4379
4596
|
SENSITIVE = [:password]
|
@@ -4461,6 +4678,7 @@ module Aws::DatabaseMigrationService
|
|
4461
4678
|
# include_table_alter_operations: false,
|
4462
4679
|
# include_control_details: false,
|
4463
4680
|
# include_null_and_empty: false,
|
4681
|
+
# no_hex_prefix: false,
|
4464
4682
|
# },
|
4465
4683
|
# kafka_settings: {
|
4466
4684
|
# broker: "String",
|
@@ -4473,6 +4691,14 @@ module Aws::DatabaseMigrationService
|
|
4473
4691
|
# include_control_details: false,
|
4474
4692
|
# message_max_bytes: 1,
|
4475
4693
|
# include_null_and_empty: false,
|
4694
|
+
# security_protocol: "plaintext", # accepts plaintext, ssl-authentication, ssl-encryption, sasl-ssl
|
4695
|
+
# ssl_client_certificate_arn: "String",
|
4696
|
+
# ssl_client_key_arn: "String",
|
4697
|
+
# ssl_client_key_password: "SecretString",
|
4698
|
+
# ssl_ca_certificate_arn: "String",
|
4699
|
+
# sasl_username: "String",
|
4700
|
+
# sasl_password: "SecretString",
|
4701
|
+
# no_hex_prefix: false,
|
4476
4702
|
# },
|
4477
4703
|
# elasticsearch_settings: {
|
4478
4704
|
# service_access_role_arn: "String", # required
|
@@ -4529,16 +4755,21 @@ module Aws::DatabaseMigrationService
|
|
4529
4755
|
# ddl_artifacts_schema: "String",
|
4530
4756
|
# execute_timeout: 1,
|
4531
4757
|
# fail_tasks_on_lob_truncation: false,
|
4758
|
+
# heartbeat_enable: false,
|
4759
|
+
# heartbeat_schema: "String",
|
4760
|
+
# heartbeat_frequency: 1,
|
4532
4761
|
# password: "SecretString",
|
4533
4762
|
# port: 1,
|
4534
4763
|
# server_name: "String",
|
4535
4764
|
# username: "String",
|
4536
4765
|
# slot_name: "String",
|
4766
|
+
# plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
|
4537
4767
|
# secrets_manager_access_role_arn: "String",
|
4538
4768
|
# secrets_manager_secret_id: "String",
|
4539
4769
|
# },
|
4540
4770
|
# my_sql_settings: {
|
4541
4771
|
# after_connect_script: "String",
|
4772
|
+
# clean_source_metadata_on_mismatch: false,
|
4542
4773
|
# database_name: "String",
|
4543
4774
|
# events_poll_interval: 1,
|
4544
4775
|
# target_db_type: "specific-database", # accepts specific-database, multiple-databases
|
@@ -4582,7 +4813,12 @@ module Aws::DatabaseMigrationService
|
|
4582
4813
|
# security_db_encryption: "SecretString",
|
4583
4814
|
# security_db_encryption_name: "String",
|
4584
4815
|
# server_name: "String",
|
4816
|
+
# spatial_data_option_to_geo_json_function_name: "String",
|
4817
|
+
# standby_delay_time: 1,
|
4585
4818
|
# username: "String",
|
4819
|
+
# use_b_file: false,
|
4820
|
+
# use_direct_path_full_load: false,
|
4821
|
+
# use_logminer_reader: false,
|
4586
4822
|
# secrets_manager_access_role_arn: "String",
|
4587
4823
|
# secrets_manager_secret_id: "String",
|
4588
4824
|
# secrets_manager_oracle_asm_access_role_arn: "String",
|
@@ -4603,11 +4839,13 @@ module Aws::DatabaseMigrationService
|
|
4603
4839
|
# database_name: "String",
|
4604
4840
|
# control_tables_file_group: "String",
|
4605
4841
|
# password: "SecretString",
|
4842
|
+
# query_single_always_on_node: false,
|
4606
4843
|
# read_backup_only: false,
|
4607
4844
|
# safeguard_policy: "rely-on-sql-server-replication-agent", # accepts rely-on-sql-server-replication-agent, exclusive-automatic-truncation, shared-automatic-truncation
|
4608
4845
|
# server_name: "String",
|
4609
4846
|
# username: "String",
|
4610
4847
|
# use_bcp_full_load: false,
|
4848
|
+
# use_third_party_backup_device: false,
|
4611
4849
|
# secrets_manager_access_role_arn: "String",
|
4612
4850
|
# secrets_manager_secret_id: "String",
|
4613
4851
|
# },
|
@@ -4636,6 +4874,7 @@ module Aws::DatabaseMigrationService
|
|
4636
4874
|
# secrets_manager_access_role_arn: "String",
|
4637
4875
|
# secrets_manager_secret_id: "String",
|
4638
4876
|
# },
|
4877
|
+
# exact_settings: false,
|
4639
4878
|
# }
|
4640
4879
|
#
|
4641
4880
|
# @!attribute [rw] endpoint_arn
|
@@ -4679,7 +4918,8 @@ module Aws::DatabaseMigrationService
|
|
4679
4918
|
# @return [Integer]
|
4680
4919
|
#
|
4681
4920
|
# @!attribute [rw] database_name
|
4682
|
-
# The name of the endpoint database.
|
4921
|
+
# The name of the endpoint database. For a MySQL source or target
|
4922
|
+
# endpoint, do not specify DatabaseName.
|
4683
4923
|
# @return [String]
|
4684
4924
|
#
|
4685
4925
|
# @!attribute [rw] extra_connection_attributes
|
@@ -4698,8 +4938,8 @@ module Aws::DatabaseMigrationService
|
|
4698
4938
|
# @return [String]
|
4699
4939
|
#
|
4700
4940
|
# @!attribute [rw] service_access_role_arn
|
4701
|
-
# The Amazon Resource Name (ARN) for the
|
4702
|
-
#
|
4941
|
+
# The Amazon Resource Name (ARN) for the IAM role you want to use to
|
4942
|
+
# modify the endpoint. The role must allow the `iam:PassRole` action.
|
4703
4943
|
# @return [String]
|
4704
4944
|
#
|
4705
4945
|
# @!attribute [rw] external_table_definition
|
@@ -4709,19 +4949,19 @@ module Aws::DatabaseMigrationService
|
|
4709
4949
|
# @!attribute [rw] dynamo_db_settings
|
4710
4950
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
4711
4951
|
# information about other available settings, see [Using Object
|
4712
|
-
# Mapping to Migrate Data to DynamoDB][1] in the *
|
4713
|
-
#
|
4952
|
+
# Mapping to Migrate Data to DynamoDB][1] in the *Database Migration
|
4953
|
+
# Service User Guide.*
|
4714
4954
|
#
|
4715
4955
|
#
|
4716
4956
|
#
|
4717
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html
|
4957
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping
|
4718
4958
|
# @return [Types::DynamoDbSettings]
|
4719
4959
|
#
|
4720
4960
|
# @!attribute [rw] s3_settings
|
4721
4961
|
# Settings in JSON format for the target Amazon S3 endpoint. For more
|
4722
4962
|
# information about the available settings, see [Extra Connection
|
4723
|
-
# Attributes When Using Amazon S3 as a Target for
|
4724
|
-
# *
|
4963
|
+
# Attributes When Using Amazon S3 as a Target for DMS][1] in the
|
4964
|
+
# *Database Migration Service User Guide.*
|
4725
4965
|
#
|
4726
4966
|
#
|
4727
4967
|
#
|
@@ -4734,64 +4974,58 @@ module Aws::DatabaseMigrationService
|
|
4734
4974
|
#
|
4735
4975
|
# Attributes include the following:
|
4736
4976
|
#
|
4737
|
-
# * serviceAccessRoleArn - The
|
4738
|
-
#
|
4977
|
+
# * serviceAccessRoleArn - The Identity and Access Management (IAM)
|
4978
|
+
# role that has permission to access the Amazon S3 bucket. The role
|
4979
|
+
# must allow the `iam:PassRole` action.
|
4739
4980
|
#
|
4740
4981
|
# * BucketName - The name of the S3 bucket to use.
|
4741
4982
|
#
|
4742
|
-
# * compressionType - An optional parameter to use GZIP to compress
|
4743
|
-
# the target files. Either set this parameter to NONE (the default)
|
4744
|
-
# or don't use it to leave the files uncompressed.
|
4745
|
-
#
|
4746
4983
|
# Shorthand syntax for these settings is as follows:
|
4747
|
-
# `ServiceAccessRoleArn=string
|
4748
|
-
# ,BucketName=string,CompressionType=string`
|
4984
|
+
# `ServiceAccessRoleArn=string ,BucketName=string`
|
4749
4985
|
#
|
4750
4986
|
# JSON syntax for these settings is as follows: `\{
|
4751
|
-
# "ServiceAccessRoleArn": "string", "BucketName": "string"
|
4752
|
-
# "CompressionType": "none"|"gzip" \} `
|
4987
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string"\} `
|
4753
4988
|
# @return [Types::DmsTransferSettings]
|
4754
4989
|
#
|
4755
4990
|
# @!attribute [rw] mongo_db_settings
|
4756
4991
|
# Settings in JSON format for the source MongoDB endpoint. For more
|
4757
4992
|
# information about the available settings, see the configuration
|
4758
|
-
# properties section in [
|
4759
|
-
# Migration Service][1] in the
|
4760
|
-
# Guide.*
|
4993
|
+
# properties section in [Endpoint configuration settings when using
|
4994
|
+
# MongoDB as a source for Database Migration Service][1] in the
|
4995
|
+
# *Database Migration Service User Guide.*
|
4761
4996
|
#
|
4762
4997
|
#
|
4763
4998
|
#
|
4764
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html
|
4999
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration
|
4765
5000
|
# @return [Types::MongoDbSettings]
|
4766
5001
|
#
|
4767
5002
|
# @!attribute [rw] kinesis_settings
|
4768
5003
|
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
4769
5004
|
# Data Streams. For more information about the available settings, see
|
4770
|
-
# [Using
|
4771
|
-
#
|
4772
|
-
# Guide.*
|
5005
|
+
# [Using object mapping to migrate data to a Kinesis data stream][1]
|
5006
|
+
# in the *Database Migration Service User Guide.*
|
4773
5007
|
#
|
4774
5008
|
#
|
4775
5009
|
#
|
4776
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html
|
5010
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping
|
4777
5011
|
# @return [Types::KinesisSettings]
|
4778
5012
|
#
|
4779
5013
|
# @!attribute [rw] kafka_settings
|
4780
5014
|
# Settings in JSON format for the target Apache Kafka endpoint. For
|
4781
|
-
# more information about the available settings, see [Using
|
4782
|
-
#
|
4783
|
-
#
|
5015
|
+
# more information about the available settings, see [Using object
|
5016
|
+
# mapping to migrate data to a Kafka topic][1] in the *Database
|
5017
|
+
# Migration Service User Guide.*
|
4784
5018
|
#
|
4785
5019
|
#
|
4786
5020
|
#
|
4787
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html
|
5021
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping
|
4788
5022
|
# @return [Types::KafkaSettings]
|
4789
5023
|
#
|
4790
5024
|
# @!attribute [rw] elasticsearch_settings
|
4791
5025
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
4792
5026
|
# more information about the available settings, see [Extra Connection
|
4793
|
-
# Attributes When Using Elasticsearch as a Target for
|
4794
|
-
#
|
5027
|
+
# Attributes When Using Elasticsearch as a Target for DMS][1] in the
|
5028
|
+
# *Database Migration Service User Guide.*
|
4795
5029
|
#
|
4796
5030
|
#
|
4797
5031
|
#
|
@@ -4801,8 +5035,8 @@ module Aws::DatabaseMigrationService
|
|
4801
5035
|
# @!attribute [rw] neptune_settings
|
4802
5036
|
# Settings in JSON format for the target Amazon Neptune endpoint. For
|
4803
5037
|
# more information about the available settings, see [Specifying
|
4804
|
-
#
|
4805
|
-
# Database Migration Service User Guide.*
|
5038
|
+
# graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a
|
5039
|
+
# target][1] in the *Database Migration Service User Guide.*
|
4806
5040
|
#
|
4807
5041
|
#
|
4808
5042
|
#
|
@@ -4816,94 +5050,117 @@ module Aws::DatabaseMigrationService
|
|
4816
5050
|
# @!attribute [rw] postgre_sql_settings
|
4817
5051
|
# Settings in JSON format for the source and target PostgreSQL
|
4818
5052
|
# endpoint. For information about other available settings, see [Extra
|
4819
|
-
# connection attributes when using PostgreSQL as a source for
|
4820
|
-
#
|
4821
|
-
#
|
4822
|
-
# Guide.*
|
5053
|
+
# connection attributes when using PostgreSQL as a source for DMS][1]
|
5054
|
+
# and [ Extra connection attributes when using PostgreSQL as a target
|
5055
|
+
# for DMS][2] in the *Database Migration Service User Guide.*
|
4823
5056
|
#
|
4824
5057
|
#
|
4825
5058
|
#
|
4826
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.ConnectionAttrib
|
4827
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.ConnectionAttrib
|
5059
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib
|
5060
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib
|
4828
5061
|
# @return [Types::PostgreSQLSettings]
|
4829
5062
|
#
|
4830
5063
|
# @!attribute [rw] my_sql_settings
|
4831
5064
|
# Settings in JSON format for the source and target MySQL endpoint.
|
4832
5065
|
# For information about other available settings, see [Extra
|
4833
|
-
# connection attributes when using MySQL as a source for
|
4834
|
-
#
|
4835
|
-
#
|
4836
|
-
#
|
5066
|
+
# connection attributes when using MySQL as a source for DMS][1] and
|
5067
|
+
# [Extra connection attributes when using a MySQL-compatible database
|
5068
|
+
# as a target for DMS][2] in the *Database Migration Service User
|
5069
|
+
# Guide.*
|
4837
5070
|
#
|
4838
5071
|
#
|
4839
5072
|
#
|
4840
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.ConnectionAttrib
|
4841
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.ConnectionAttrib
|
5073
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib
|
5074
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib
|
4842
5075
|
# @return [Types::MySQLSettings]
|
4843
5076
|
#
|
4844
5077
|
# @!attribute [rw] oracle_settings
|
4845
5078
|
# Settings in JSON format for the source and target Oracle endpoint.
|
4846
5079
|
# For information about other available settings, see [Extra
|
4847
|
-
# connection attributes when using Oracle as a source for
|
4848
|
-
#
|
4849
|
-
#
|
5080
|
+
# connection attributes when using Oracle as a source for DMS][1] and
|
5081
|
+
# [ Extra connection attributes when using Oracle as a target for
|
5082
|
+
# DMS][2] in the *Database Migration Service User Guide.*
|
4850
5083
|
#
|
4851
5084
|
#
|
4852
5085
|
#
|
4853
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.ConnectionAttrib
|
4854
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.ConnectionAttrib
|
5086
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib
|
5087
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib
|
4855
5088
|
# @return [Types::OracleSettings]
|
4856
5089
|
#
|
4857
5090
|
# @!attribute [rw] sybase_settings
|
4858
5091
|
# Settings in JSON format for the source and target SAP ASE endpoint.
|
4859
5092
|
# For information about other available settings, see [Extra
|
4860
|
-
# connection attributes when using SAP ASE as a source for
|
4861
|
-
#
|
4862
|
-
#
|
5093
|
+
# connection attributes when using SAP ASE as a source for DMS][1] and
|
5094
|
+
# [Extra connection attributes when using SAP ASE as a target for
|
5095
|
+
# DMS][2] in the *Database Migration Service User Guide.*
|
4863
5096
|
#
|
4864
5097
|
#
|
4865
5098
|
#
|
4866
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.ConnectionAttrib
|
4867
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.ConnectionAttrib
|
5099
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib
|
5100
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib
|
4868
5101
|
# @return [Types::SybaseSettings]
|
4869
5102
|
#
|
4870
5103
|
# @!attribute [rw] microsoft_sql_server_settings
|
4871
5104
|
# Settings in JSON format for the source and target Microsoft SQL
|
4872
5105
|
# Server endpoint. For information about other available settings, see
|
4873
5106
|
# [Extra connection attributes when using SQL Server as a source for
|
4874
|
-
#
|
4875
|
-
#
|
4876
|
-
# User Guide.*
|
5107
|
+
# DMS][1] and [ Extra connection attributes when using SQL Server as a
|
5108
|
+
# target for DMS][2] in the *Database Migration Service User Guide.*
|
4877
5109
|
#
|
4878
5110
|
#
|
4879
5111
|
#
|
4880
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.ConnectionAttrib
|
4881
|
-
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.ConnectionAttrib
|
5112
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib
|
5113
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib
|
4882
5114
|
# @return [Types::MicrosoftSQLServerSettings]
|
4883
5115
|
#
|
4884
5116
|
# @!attribute [rw] ibm_db_2_settings
|
4885
5117
|
# Settings in JSON format for the source IBM Db2 LUW endpoint. For
|
4886
5118
|
# information about other available settings, see [Extra connection
|
4887
|
-
# attributes when using Db2 LUW as a source for
|
4888
|
-
# *
|
5119
|
+
# attributes when using Db2 LUW as a source for DMS][1] in the
|
5120
|
+
# *Database Migration Service User Guide.*
|
4889
5121
|
#
|
4890
5122
|
#
|
4891
5123
|
#
|
4892
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.ConnectionAttrib
|
5124
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib
|
4893
5125
|
# @return [Types::IBMDb2Settings]
|
4894
5126
|
#
|
4895
5127
|
# @!attribute [rw] doc_db_settings
|
4896
5128
|
# Settings in JSON format for the source DocumentDB endpoint. For more
|
4897
5129
|
# information about the available settings, see the configuration
|
4898
|
-
# properties section in [ Using DocumentDB as a Target for
|
4899
|
-
#
|
4900
|
-
#
|
5130
|
+
# properties section in [ Using DocumentDB as a Target for Database
|
5131
|
+
# Migration Service ][1] in the *Database Migration Service User
|
5132
|
+
# Guide.*
|
4901
5133
|
#
|
4902
5134
|
#
|
4903
5135
|
#
|
4904
5136
|
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html
|
4905
5137
|
# @return [Types::DocDbSettings]
|
4906
5138
|
#
|
5139
|
+
# @!attribute [rw] exact_settings
|
5140
|
+
# If this attribute is Y, the current call to `ModifyEndpoint`
|
5141
|
+
# replaces all existing endpoint settings with the exact settings that
|
5142
|
+
# you specify in this call. If this attribute is N, the current call
|
5143
|
+
# to `ModifyEndpoint` does two things:
|
5144
|
+
#
|
5145
|
+
# * It replaces any endpoint settings that already exist with new
|
5146
|
+
# values, for settings with the same names.
|
5147
|
+
#
|
5148
|
+
# * It creates new endpoint settings that you specify in the call, for
|
5149
|
+
# settings with different names.
|
5150
|
+
#
|
5151
|
+
# For example, if you call `create-endpoint ... --endpoint-settings
|
5152
|
+
# '\{"a":1\}' ...`, the endpoint has the following endpoint settings:
|
5153
|
+
# `'\{"a":1\}'`. If you then call `modify-endpoint ...
|
5154
|
+
# --endpoint-settings '\{"b":2\}' ...` for the same endpoint, the
|
5155
|
+
# endpoint has the following settings: `'\{"a":1,"b":2\}'`.
|
5156
|
+
#
|
5157
|
+
# However, suppose that you follow this with a call to
|
5158
|
+
# `modify-endpoint ... --endpoint-settings '\{"b":2\}'
|
5159
|
+
# --exact-settings ...` for that same endpoint again. Then the
|
5160
|
+
# endpoint has the following settings: `'\{"b":2\}'`. All existing
|
5161
|
+
# settings are replaced with the exact settings that you specify.
|
5162
|
+
# @return [Boolean]
|
5163
|
+
#
|
4907
5164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ModifyEndpointMessage AWS API Documentation
|
4908
5165
|
#
|
4909
5166
|
class ModifyEndpointMessage < Struct.new(
|
@@ -4936,7 +5193,8 @@ module Aws::DatabaseMigrationService
|
|
4936
5193
|
:sybase_settings,
|
4937
5194
|
:microsoft_sql_server_settings,
|
4938
5195
|
:ibm_db_2_settings,
|
4939
|
-
:doc_db_settings
|
5196
|
+
:doc_db_settings,
|
5197
|
+
:exact_settings)
|
4940
5198
|
SENSITIVE = [:password]
|
4941
5199
|
include Aws::Structure
|
4942
5200
|
end
|
@@ -4965,8 +5223,7 @@ module Aws::DatabaseMigrationService
|
|
4965
5223
|
# }
|
4966
5224
|
#
|
4967
5225
|
# @!attribute [rw] subscription_name
|
4968
|
-
# The name of the
|
4969
|
-
# modified.
|
5226
|
+
# The name of the DMS event notification subscription to be modified.
|
4970
5227
|
# @return [String]
|
4971
5228
|
#
|
4972
5229
|
# @!attribute [rw] sns_topic_arn
|
@@ -4976,7 +5233,7 @@ module Aws::DatabaseMigrationService
|
|
4976
5233
|
# @return [String]
|
4977
5234
|
#
|
4978
5235
|
# @!attribute [rw] source_type
|
4979
|
-
# The type of
|
5236
|
+
# The type of DMS resource that generates the events you want to
|
4980
5237
|
# subscribe to.
|
4981
5238
|
#
|
4982
5239
|
# Valid values: replication-instance \| replication-task
|
@@ -5055,7 +5312,7 @@ module Aws::DatabaseMigrationService
|
|
5055
5312
|
#
|
5056
5313
|
# For more information on the settings and capacities for the
|
5057
5314
|
# available replication instance classes, see [ Selecting the right
|
5058
|
-
#
|
5315
|
+
# DMS replication instance for your migration][1].
|
5059
5316
|
#
|
5060
5317
|
#
|
5061
5318
|
#
|
@@ -5122,8 +5379,7 @@ module Aws::DatabaseMigrationService
|
|
5122
5379
|
#
|
5123
5380
|
# * A newer minor version is available.
|
5124
5381
|
#
|
5125
|
-
# *
|
5126
|
-
# version.
|
5382
|
+
# * DMS has enabled automatic patching for the given engine version.
|
5127
5383
|
# @return [Boolean]
|
5128
5384
|
#
|
5129
5385
|
# @!attribute [rw] replication_instance_identifier
|
@@ -5241,10 +5497,10 @@ module Aws::DatabaseMigrationService
|
|
5241
5497
|
# @return [String]
|
5242
5498
|
#
|
5243
5499
|
# @!attribute [rw] table_mappings
|
5244
|
-
# When using the
|
5245
|
-
#
|
5246
|
-
#
|
5247
|
-
#
|
5500
|
+
# When using the CLI or boto3, provide the path of the JSON file that
|
5501
|
+
# contains the table mappings. Precede the path with `file://`. For
|
5502
|
+
# example, `--table-mappings file://mappingfile.json`. When working
|
5503
|
+
# with the DMS API, provide the JSON as the parameter value.
|
5248
5504
|
# @return [String]
|
5249
5505
|
#
|
5250
5506
|
# @!attribute [rw] replication_task_settings
|
@@ -5281,7 +5537,7 @@ module Aws::DatabaseMigrationService
|
|
5281
5537
|
# with the source endpoint. You can verify this by setting the
|
5282
5538
|
# `slotName` extra connection attribute to the name of this logical
|
5283
5539
|
# replication slot. For more information, see [Extra Connection
|
5284
|
-
# Attributes When Using PostgreSQL as a Source for
|
5540
|
+
# Attributes When Using PostgreSQL as a Source for DMS][1].
|
5285
5541
|
#
|
5286
5542
|
# </note>
|
5287
5543
|
#
|
@@ -5304,8 +5560,8 @@ module Aws::DatabaseMigrationService
|
|
5304
5560
|
# @!attribute [rw] task_data
|
5305
5561
|
# Supplemental information that the task requires to migrate the data
|
5306
5562
|
# for certain source and target endpoints. For more information, see
|
5307
|
-
# [Specifying Supplemental Data for Task Settings][1] in the *
|
5308
|
-
#
|
5563
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *Database
|
5564
|
+
# Migration Service User Guide.*
|
5309
5565
|
#
|
5310
5566
|
#
|
5311
5567
|
#
|
@@ -5431,20 +5687,20 @@ module Aws::DatabaseMigrationService
|
|
5431
5687
|
# @return [String]
|
5432
5688
|
#
|
5433
5689
|
# @!attribute [rw] kms_key_id
|
5434
|
-
# The
|
5435
|
-
#
|
5436
|
-
# `KmsKeyId` parameter, then
|
5437
|
-
#
|
5438
|
-
#
|
5439
|
-
# Region.
|
5690
|
+
# The KMS key identifier that is used to encrypt the content on the
|
5691
|
+
# replication instance. If you don't specify a value for the
|
5692
|
+
# `KmsKeyId` parameter, then DMS uses your default encryption key. KMS
|
5693
|
+
# creates the default encryption key for your account. Your account
|
5694
|
+
# has a different default encryption key for each Region.
|
5440
5695
|
# @return [String]
|
5441
5696
|
#
|
5442
5697
|
# @!attribute [rw] secrets_manager_access_role_arn
|
5443
5698
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
5444
|
-
#
|
5445
|
-
# access the value in `SecretsManagerSecret`.
|
5446
|
-
# has the value of the
|
5447
|
-
# to the
|
5699
|
+
# DMS as the trusted entity and grants the required permissions to
|
5700
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
5701
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
5702
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
5703
|
+
# MongoDB endpoint.
|
5448
5704
|
#
|
5449
5705
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
5450
5706
|
# can specify the values for this setting and
|
@@ -5452,15 +5708,15 @@ module Aws::DatabaseMigrationService
|
|
5452
5708
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
5453
5709
|
# both. For more information on creating this `SecretsManagerSecret`
|
5454
5710
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
5455
|
-
# required to access it, see [Using secrets to access
|
5456
|
-
# Migration Service resources][1] in the *
|
5457
|
-
#
|
5711
|
+
# required to access it, see [Using secrets to access Database
|
5712
|
+
# Migration Service resources][1] in the *Database Migration Service
|
5713
|
+
# User Guide*.
|
5458
5714
|
#
|
5459
5715
|
# </note>
|
5460
5716
|
#
|
5461
5717
|
#
|
5462
5718
|
#
|
5463
|
-
# [1]: https://docs.aws.amazon.com/
|
5719
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
5464
5720
|
# @return [String]
|
5465
5721
|
#
|
5466
5722
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -5535,6 +5791,7 @@ module Aws::DatabaseMigrationService
|
|
5535
5791
|
#
|
5536
5792
|
# {
|
5537
5793
|
# after_connect_script: "String",
|
5794
|
+
# clean_source_metadata_on_mismatch: false,
|
5538
5795
|
# database_name: "String",
|
5539
5796
|
# events_poll_interval: 1,
|
5540
5797
|
# target_db_type: "specific-database", # accepts specific-database, multiple-databases
|
@@ -5550,13 +5807,30 @@ module Aws::DatabaseMigrationService
|
|
5550
5807
|
# }
|
5551
5808
|
#
|
5552
5809
|
# @!attribute [rw] after_connect_script
|
5553
|
-
# Specifies a script to run immediately after
|
5810
|
+
# Specifies a script to run immediately after DMS connects to the
|
5554
5811
|
# endpoint. The migration task continues running regardless if the SQL
|
5555
5812
|
# statement succeeds or fails.
|
5813
|
+
#
|
5814
|
+
# For this parameter, provide the code of the script itself, not the
|
5815
|
+
# name of a file containing the script.
|
5556
5816
|
# @return [String]
|
5557
5817
|
#
|
5818
|
+
# @!attribute [rw] clean_source_metadata_on_mismatch
|
5819
|
+
# Adjusts the behavior of DMS when migrating from an SQL Server source
|
5820
|
+
# database that is hosted as part of an Always On availability group
|
5821
|
+
# cluster. If you need DMS to poll all the nodes in the Always On
|
5822
|
+
# cluster for transaction backups, set this attribute to `false`.
|
5823
|
+
# @return [Boolean]
|
5824
|
+
#
|
5558
5825
|
# @!attribute [rw] database_name
|
5559
|
-
# Database name for the endpoint.
|
5826
|
+
# Database name for the endpoint. For a MySQL source or target
|
5827
|
+
# endpoint, don't explicitly specify the database using the
|
5828
|
+
# `DatabaseName` request parameter on either the `CreateEndpoint` or
|
5829
|
+
# `ModifyEndpoint` API call. Specifying `DatabaseName` when you create
|
5830
|
+
# or modify a MySQL endpoint replicates all the task tables to this
|
5831
|
+
# single database. For MySQL endpoints, you specify the database only
|
5832
|
+
# when you specify the schema in the table-mapping rules of the DMS
|
5833
|
+
# task.
|
5560
5834
|
# @return [String]
|
5561
5835
|
#
|
5562
5836
|
# @!attribute [rw] events_poll_interval
|
@@ -5565,8 +5839,8 @@ module Aws::DatabaseMigrationService
|
|
5565
5839
|
#
|
5566
5840
|
# Example: `eventsPollInterval=5;`
|
5567
5841
|
#
|
5568
|
-
# In the example,
|
5569
|
-
#
|
5842
|
+
# In the example, DMS checks for changes in the binary logs every five
|
5843
|
+
# seconds.
|
5570
5844
|
# @return [Integer]
|
5571
5845
|
#
|
5572
5846
|
# @!attribute [rw] target_db_type
|
@@ -5619,10 +5893,11 @@ module Aws::DatabaseMigrationService
|
|
5619
5893
|
#
|
5620
5894
|
# @!attribute [rw] secrets_manager_access_role_arn
|
5621
5895
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
5622
|
-
#
|
5623
|
-
# access the value in `SecretsManagerSecret`.
|
5624
|
-
# has the value of the
|
5625
|
-
# to the
|
5896
|
+
# DMS as the trusted entity and grants the required permissions to
|
5897
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
5898
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
5899
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
5900
|
+
# MySQL endpoint.
|
5626
5901
|
#
|
5627
5902
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
5628
5903
|
# can specify the values for this setting and
|
@@ -5630,15 +5905,15 @@ module Aws::DatabaseMigrationService
|
|
5630
5905
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
5631
5906
|
# both. For more information on creating this `SecretsManagerSecret`
|
5632
5907
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
5633
|
-
# required to access it, see [Using secrets to access
|
5634
|
-
# Migration Service resources][1] in the *
|
5635
|
-
#
|
5908
|
+
# required to access it, see [Using secrets to access Database
|
5909
|
+
# Migration Service resources][1] in the *Database Migration Service
|
5910
|
+
# User Guide*.
|
5636
5911
|
#
|
5637
5912
|
# </note>
|
5638
5913
|
#
|
5639
5914
|
#
|
5640
5915
|
#
|
5641
|
-
# [1]: https://docs.aws.amazon.com/
|
5916
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
5642
5917
|
# @return [String]
|
5643
5918
|
#
|
5644
5919
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -5651,6 +5926,7 @@ module Aws::DatabaseMigrationService
|
|
5651
5926
|
#
|
5652
5927
|
class MySQLSettings < Struct.new(
|
5653
5928
|
:after_connect_script,
|
5929
|
+
:clean_source_metadata_on_mismatch,
|
5654
5930
|
:database_name,
|
5655
5931
|
:events_poll_interval,
|
5656
5932
|
:target_db_type,
|
@@ -5684,9 +5960,10 @@ module Aws::DatabaseMigrationService
|
|
5684
5960
|
#
|
5685
5961
|
# @!attribute [rw] service_access_role_arn
|
5686
5962
|
# The Amazon Resource Name (ARN) of the service role that you created
|
5687
|
-
# for the Neptune target endpoint.
|
5688
|
-
#
|
5689
|
-
#
|
5963
|
+
# for the Neptune target endpoint. The role must allow the
|
5964
|
+
# `iam:PassRole` action. For more information, see [Creating an IAM
|
5965
|
+
# Service Role for Accessing Amazon Neptune as a Target][1] in the
|
5966
|
+
# <i>Database Migration Service User Guide. </i>
|
5690
5967
|
#
|
5691
5968
|
#
|
5692
5969
|
#
|
@@ -5694,39 +5971,39 @@ module Aws::DatabaseMigrationService
|
|
5694
5971
|
# @return [String]
|
5695
5972
|
#
|
5696
5973
|
# @!attribute [rw] s3_bucket_name
|
5697
|
-
# The name of the Amazon S3 bucket where
|
5974
|
+
# The name of the Amazon S3 bucket where DMS can temporarily store
|
5698
5975
|
# migrated graph data in .csv files before bulk-loading it to the
|
5699
|
-
# Neptune target database.
|
5700
|
-
#
|
5976
|
+
# Neptune target database. DMS maps the SQL source data to graph data
|
5977
|
+
# before storing it in these .csv files.
|
5701
5978
|
# @return [String]
|
5702
5979
|
#
|
5703
5980
|
# @!attribute [rw] s3_bucket_folder
|
5704
|
-
# A folder path where you want
|
5705
|
-
#
|
5981
|
+
# A folder path where you want DMS to store migrated graph data in the
|
5982
|
+
# S3 bucket specified by `S3BucketName`
|
5706
5983
|
# @return [String]
|
5707
5984
|
#
|
5708
5985
|
# @!attribute [rw] error_retry_duration
|
5709
|
-
# The number of milliseconds for
|
5710
|
-
#
|
5711
|
-
#
|
5986
|
+
# The number of milliseconds for DMS to wait to retry a bulk-load of
|
5987
|
+
# migrated graph data to the Neptune target database before raising an
|
5988
|
+
# error. The default is 250.
|
5712
5989
|
# @return [Integer]
|
5713
5990
|
#
|
5714
5991
|
# @!attribute [rw] max_file_size
|
5715
5992
|
# The maximum size in kilobytes of migrated graph data stored in a
|
5716
|
-
# .csv file before
|
5993
|
+
# .csv file before DMS bulk-loads the data to the Neptune target
|
5717
5994
|
# database. The default is 1,048,576 KB. If the bulk load is
|
5718
|
-
# successful,
|
5719
|
-
#
|
5995
|
+
# successful, DMS clears the bucket, ready to store the next batch of
|
5996
|
+
# migrated graph data.
|
5720
5997
|
# @return [Integer]
|
5721
5998
|
#
|
5722
5999
|
# @!attribute [rw] max_retry_count
|
5723
|
-
# The number of times for
|
5724
|
-
#
|
5725
|
-
#
|
6000
|
+
# The number of times for DMS to retry a bulk load of migrated graph
|
6001
|
+
# data to the Neptune target database before raising an error. The
|
6002
|
+
# default is 5.
|
5726
6003
|
# @return [Integer]
|
5727
6004
|
#
|
5728
6005
|
# @!attribute [rw] iam_auth_enabled
|
5729
|
-
# If you want
|
6006
|
+
# If you want Identity and Access Management (IAM) authorization
|
5730
6007
|
# enabled for this endpoint, set this parameter to `true`. Then attach
|
5731
6008
|
# the appropriate IAM policy document to your service role specified
|
5732
6009
|
# by `ServiceAccessRoleArn`. The default is `false`.
|
@@ -5781,7 +6058,12 @@ module Aws::DatabaseMigrationService
|
|
5781
6058
|
# security_db_encryption: "SecretString",
|
5782
6059
|
# security_db_encryption_name: "String",
|
5783
6060
|
# server_name: "String",
|
6061
|
+
# spatial_data_option_to_geo_json_function_name: "String",
|
6062
|
+
# standby_delay_time: 1,
|
5784
6063
|
# username: "String",
|
6064
|
+
# use_b_file: false,
|
6065
|
+
# use_direct_path_full_load: false,
|
6066
|
+
# use_logminer_reader: false,
|
5785
6067
|
# secrets_manager_access_role_arn: "String",
|
5786
6068
|
# secrets_manager_secret_id: "String",
|
5787
6069
|
# secrets_manager_oracle_asm_access_role_arn: "String",
|
@@ -5798,20 +6080,30 @@ module Aws::DatabaseMigrationService
|
|
5798
6080
|
# @return [Boolean]
|
5799
6081
|
#
|
5800
6082
|
# @!attribute [rw] archived_log_dest_id
|
5801
|
-
# Specifies the
|
5802
|
-
# should be the same as
|
5803
|
-
#
|
5804
|
-
#
|
5805
|
-
#
|
5806
|
-
# correct logs are accessed from the outset.
|
6083
|
+
# Specifies the ID of the destination for the archived redo logs. This
|
6084
|
+
# value should be the same as a number in the dest\_id column of the
|
6085
|
+
# v$archived\_log view. If you work with an additional redo log
|
6086
|
+
# destination, use the `AdditionalArchivedLogDestId` option to specify
|
6087
|
+
# the additional destination ID. Doing this improves performance by
|
6088
|
+
# ensuring that the correct logs are accessed from the outset.
|
5807
6089
|
# @return [Integer]
|
5808
6090
|
#
|
5809
6091
|
# @!attribute [rw] additional_archived_log_dest_id
|
5810
|
-
# Set this attribute with `
|
6092
|
+
# Set this attribute with `ArchivedLogDestId` in a primary/ standby
|
5811
6093
|
# setup. This attribute is useful in the case of a switchover. In this
|
5812
|
-
# case,
|
5813
|
-
#
|
5814
|
-
#
|
6094
|
+
# case, DMS needs to know which destination to get archive redo logs
|
6095
|
+
# from to read changes. This need arises because the previous primary
|
6096
|
+
# instance is now a standby instance after switchover.
|
6097
|
+
#
|
6098
|
+
# Although DMS supports the use of the Oracle `RESETLOGS` option to
|
6099
|
+
# open the database, never use `RESETLOGS` unless necessary. For
|
6100
|
+
# additional information about `RESETLOGS`, see [RMAN Data Repair
|
6101
|
+
# Concepts][1] in the *Oracle Database Backup and Recovery User's
|
6102
|
+
# Guide*.
|
6103
|
+
#
|
6104
|
+
#
|
6105
|
+
#
|
6106
|
+
# [1]: https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B
|
5815
6107
|
# @return [Integer]
|
5816
6108
|
#
|
5817
6109
|
# @!attribute [rw] allow_select_nested_tables
|
@@ -5821,7 +6113,7 @@ module Aws::DatabaseMigrationService
|
|
5821
6113
|
#
|
5822
6114
|
# @!attribute [rw] parallel_asm_read_threads
|
5823
6115
|
# Set this attribute to change the number of threads that DMS
|
5824
|
-
# configures to perform a
|
6116
|
+
# configures to perform a change data capture (CDC) load using Oracle
|
5825
6117
|
# Automatic Storage Management (ASM). You can specify an integer value
|
5826
6118
|
# between 2 (the default) and 8 (the maximum). Use this attribute
|
5827
6119
|
# together with the `readAheadBlocks` attribute.
|
@@ -5829,7 +6121,7 @@ module Aws::DatabaseMigrationService
|
|
5829
6121
|
#
|
5830
6122
|
# @!attribute [rw] read_ahead_blocks
|
5831
6123
|
# Set this attribute to change the number of read-ahead blocks that
|
5832
|
-
# DMS configures to perform a
|
6124
|
+
# DMS configures to perform a change data capture (CDC) load using
|
5833
6125
|
# Oracle Automatic Storage Management (ASM). You can specify an
|
5834
6126
|
# integer value between 1000 (the default) and 200,000 (the maximum).
|
5835
6127
|
# @return [Integer]
|
@@ -5882,9 +6174,9 @@ module Aws::DatabaseMigrationService
|
|
5882
6174
|
# @return [Boolean]
|
5883
6175
|
#
|
5884
6176
|
# @!attribute [rw] archived_logs_only
|
5885
|
-
# When this field is set to `Y`,
|
5886
|
-
#
|
5887
|
-
#
|
6177
|
+
# When this field is set to `Y`, DMS only accesses the archived redo
|
6178
|
+
# logs. If the archived redo logs are stored on Oracle ASM only, the
|
6179
|
+
# DMS user account needs to be granted ASM privileges.
|
5888
6180
|
# @return [Boolean]
|
5889
6181
|
#
|
5890
6182
|
# @!attribute [rw] asm_password
|
@@ -5943,8 +6235,8 @@ module Aws::DatabaseMigrationService
|
|
5943
6235
|
# @!attribute [rw] direct_path_parallel_load
|
5944
6236
|
# When set to `true`, this attribute specifies a parallel load when
|
5945
6237
|
# `useDirectPathFullLoad` is set to `Y`. This attribute also only
|
5946
|
-
# applies when you use the
|
5947
|
-
#
|
6238
|
+
# applies when you use the DMS parallel load feature. Note that the
|
6239
|
+
# target table cannot have any constraints or indexes.
|
5948
6240
|
# @return [Boolean]
|
5949
6241
|
#
|
5950
6242
|
# @!attribute [rw] fail_tasks_on_lob_truncation
|
@@ -5991,7 +6283,7 @@ module Aws::DatabaseMigrationService
|
|
5991
6283
|
# when you create the endpoint. The `SecurityDbEncryptian` setting is
|
5992
6284
|
# related to this `SecurityDbEncryptionName` setting. For more
|
5993
6285
|
# information, see [ Supported encryption methods for using Oracle as
|
5994
|
-
# a source for
|
6286
|
+
# a source for DMS ][1] in the *Database Migration Service User
|
5995
6287
|
# Guide*.
|
5996
6288
|
#
|
5997
6289
|
#
|
@@ -6007,8 +6299,8 @@ module Aws::DatabaseMigrationService
|
|
6007
6299
|
# information on setting the key name value of
|
6008
6300
|
# `SecurityDbEncryptionName`, see the information and example for
|
6009
6301
|
# setting the `securityDbEncryptionName` extra connection attribute in
|
6010
|
-
# [ Supported encryption methods for using Oracle as a source for
|
6011
|
-
#
|
6302
|
+
# [ Supported encryption methods for using Oracle as a source for DMS
|
6303
|
+
# ][1] in the *Database Migration Service User Guide*.
|
6012
6304
|
#
|
6013
6305
|
#
|
6014
6306
|
#
|
@@ -6019,16 +6311,70 @@ module Aws::DatabaseMigrationService
|
|
6019
6311
|
# Fully qualified domain name of the endpoint.
|
6020
6312
|
# @return [String]
|
6021
6313
|
#
|
6314
|
+
# @!attribute [rw] spatial_data_option_to_geo_json_function_name
|
6315
|
+
# Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format. By
|
6316
|
+
# default, DMS calls the `SDO2GEOJSON` custom function if present and
|
6317
|
+
# accessible. Or you can create your own custom function that mimics
|
6318
|
+
# the operation of `SDOGEOJSON` and set
|
6319
|
+
# `SpatialDataOptionToGeoJsonFunctionName` to call it instead.
|
6320
|
+
# @return [String]
|
6321
|
+
#
|
6322
|
+
# @!attribute [rw] standby_delay_time
|
6323
|
+
# Use this attribute to specify a time in minutes for the delay in
|
6324
|
+
# standby sync. If the source is an Oracle Active Data Guard standby
|
6325
|
+
# database, use this attribute to specify the time lag between primary
|
6326
|
+
# and standby databases.
|
6327
|
+
#
|
6328
|
+
# In DMS, you can create an Oracle CDC task that uses an Active Data
|
6329
|
+
# Guard standby instance as a source for replicating ongoing changes.
|
6330
|
+
# Doing this eliminates the need to connect to an active database that
|
6331
|
+
# might be in production.
|
6332
|
+
# @return [Integer]
|
6333
|
+
#
|
6022
6334
|
# @!attribute [rw] username
|
6023
6335
|
# Endpoint connection user name.
|
6024
6336
|
# @return [String]
|
6025
6337
|
#
|
6338
|
+
# @!attribute [rw] use_b_file
|
6339
|
+
# Set this attribute to Y to capture change data using the Binary
|
6340
|
+
# Reader utility. Set `UseLogminerReader` to N to set this attribute
|
6341
|
+
# to Y. To use Binary Reader with Amazon RDS for Oracle as the source,
|
6342
|
+
# you set additional attributes. For more information about using this
|
6343
|
+
# setting with Oracle Automatic Storage Management (ASM), see [ Using
|
6344
|
+
# Oracle LogMiner or DMS Binary Reader for CDC][1].
|
6345
|
+
#
|
6346
|
+
#
|
6347
|
+
#
|
6348
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC
|
6349
|
+
# @return [Boolean]
|
6350
|
+
#
|
6351
|
+
# @!attribute [rw] use_direct_path_full_load
|
6352
|
+
# Set this attribute to Y to have DMS use a direct path full load.
|
6353
|
+
# Specify this value to use the direct path protocol in the Oracle
|
6354
|
+
# Call Interface (OCI). By using this OCI protocol, you can bulk-load
|
6355
|
+
# Oracle target tables during a full load.
|
6356
|
+
# @return [Boolean]
|
6357
|
+
#
|
6358
|
+
# @!attribute [rw] use_logminer_reader
|
6359
|
+
# Set this attribute to Y to capture change data using the Oracle
|
6360
|
+
# LogMiner utility (the default). Set this attribute to N if you want
|
6361
|
+
# to access the redo logs as a binary file. When you set
|
6362
|
+
# `UseLogminerReader` to N, also set `UseBfile` to Y. For more
|
6363
|
+
# information on this setting and using Oracle ASM, see [ Using Oracle
|
6364
|
+
# LogMiner or DMS Binary Reader for CDC][1] in the *DMS User Guide*.
|
6365
|
+
#
|
6366
|
+
#
|
6367
|
+
#
|
6368
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC
|
6369
|
+
# @return [Boolean]
|
6370
|
+
#
|
6026
6371
|
# @!attribute [rw] secrets_manager_access_role_arn
|
6027
6372
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
6028
|
-
#
|
6029
|
-
# access the value in `SecretsManagerSecret`.
|
6030
|
-
# has the value of the
|
6031
|
-
# to the
|
6373
|
+
# DMS as the trusted entity and grants the required permissions to
|
6374
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
6375
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
6376
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
6377
|
+
# Oracle endpoint.
|
6032
6378
|
#
|
6033
6379
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
6034
6380
|
# can specify the values for this setting and
|
@@ -6036,15 +6382,15 @@ module Aws::DatabaseMigrationService
|
|
6036
6382
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
6037
6383
|
# both. For more information on creating this `SecretsManagerSecret`
|
6038
6384
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
6039
|
-
# required to access it, see [Using secrets to access
|
6040
|
-
# Migration Service resources][1] in the *
|
6041
|
-
#
|
6385
|
+
# required to access it, see [Using secrets to access Database
|
6386
|
+
# Migration Service resources][1] in the *Database Migration Service
|
6387
|
+
# User Guide*.
|
6042
6388
|
#
|
6043
6389
|
# </note>
|
6044
6390
|
#
|
6045
6391
|
#
|
6046
6392
|
#
|
6047
|
-
# [1]: https://docs.aws.amazon.com/
|
6393
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6048
6394
|
# @return [String]
|
6049
6395
|
#
|
6050
6396
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -6055,7 +6401,7 @@ module Aws::DatabaseMigrationService
|
|
6055
6401
|
#
|
6056
6402
|
# @!attribute [rw] secrets_manager_oracle_asm_access_role_arn
|
6057
6403
|
# Required only if your Oracle endpoint uses Advanced Storage Manager
|
6058
|
-
# (ASM). The full ARN of the IAM role that specifies
|
6404
|
+
# (ASM). The full ARN of the IAM role that specifies DMS as the
|
6059
6405
|
# trusted entity and grants the required permissions to access the
|
6060
6406
|
# `SecretsManagerOracleAsmSecret`. This
|
6061
6407
|
# `SecretsManagerOracleAsmSecret` has the secret value that allows
|
@@ -6069,14 +6415,14 @@ module Aws::DatabaseMigrationService
|
|
6069
6415
|
# `SecretsManagerOracleAsmSecret` and the
|
6070
6416
|
# `SecretsManagerOracleAsmAccessRoleArn` and
|
6071
6417
|
# `SecretsManagerOracleAsmSecretId` required to access it, see [Using
|
6072
|
-
# secrets to access
|
6073
|
-
#
|
6418
|
+
# secrets to access Database Migration Service resources][1] in the
|
6419
|
+
# *Database Migration Service User Guide*.
|
6074
6420
|
#
|
6075
6421
|
# </note>
|
6076
6422
|
#
|
6077
6423
|
#
|
6078
6424
|
#
|
6079
|
-
# [1]: https://docs.aws.amazon.com/
|
6425
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6080
6426
|
# @return [String]
|
6081
6427
|
#
|
6082
6428
|
# @!attribute [rw] secrets_manager_oracle_asm_secret_id
|
@@ -6118,7 +6464,12 @@ module Aws::DatabaseMigrationService
|
|
6118
6464
|
:security_db_encryption,
|
6119
6465
|
:security_db_encryption_name,
|
6120
6466
|
:server_name,
|
6467
|
+
:spatial_data_option_to_geo_json_function_name,
|
6468
|
+
:standby_delay_time,
|
6121
6469
|
:username,
|
6470
|
+
:use_b_file,
|
6471
|
+
:use_direct_path_full_load,
|
6472
|
+
:use_logminer_reader,
|
6122
6473
|
:secrets_manager_access_role_arn,
|
6123
6474
|
:secrets_manager_secret_id,
|
6124
6475
|
:secrets_manager_oracle_asm_access_role_arn,
|
@@ -6144,7 +6495,7 @@ module Aws::DatabaseMigrationService
|
|
6144
6495
|
#
|
6145
6496
|
# For more information on the settings and capacities for the
|
6146
6497
|
# available replication instance classes, see [ Selecting the right
|
6147
|
-
#
|
6498
|
+
# DMS replication instance for your migration][1].
|
6148
6499
|
#
|
6149
6500
|
#
|
6150
6501
|
#
|
@@ -6184,7 +6535,7 @@ module Aws::DatabaseMigrationService
|
|
6184
6535
|
# replication instance is in Beta or test mode. This indicates some
|
6185
6536
|
# features might not work as expected.
|
6186
6537
|
#
|
6187
|
-
# <note markdown="1">
|
6538
|
+
# <note markdown="1"> DMS supports the `ReleaseStatus` parameter in versions 3.1.4 and
|
6188
6539
|
# later.
|
6189
6540
|
#
|
6190
6541
|
# </note>
|
@@ -6206,9 +6557,9 @@ module Aws::DatabaseMigrationService
|
|
6206
6557
|
include Aws::Structure
|
6207
6558
|
end
|
6208
6559
|
|
6209
|
-
# Describes a maintenance action pending for an
|
6210
|
-
#
|
6211
|
-
#
|
6560
|
+
# Describes a maintenance action pending for an DMS resource, including
|
6561
|
+
# when and how it will be applied. This data type is a response element
|
6562
|
+
# to the `DescribePendingMaintenanceActions` operation.
|
6212
6563
|
#
|
6213
6564
|
# @!attribute [rw] action
|
6214
6565
|
# The type of pending maintenance action that is available for the
|
@@ -6273,25 +6624,29 @@ module Aws::DatabaseMigrationService
|
|
6273
6624
|
# ddl_artifacts_schema: "String",
|
6274
6625
|
# execute_timeout: 1,
|
6275
6626
|
# fail_tasks_on_lob_truncation: false,
|
6627
|
+
# heartbeat_enable: false,
|
6628
|
+
# heartbeat_schema: "String",
|
6629
|
+
# heartbeat_frequency: 1,
|
6276
6630
|
# password: "SecretString",
|
6277
6631
|
# port: 1,
|
6278
6632
|
# server_name: "String",
|
6279
6633
|
# username: "String",
|
6280
6634
|
# slot_name: "String",
|
6635
|
+
# plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
|
6281
6636
|
# secrets_manager_access_role_arn: "String",
|
6282
6637
|
# secrets_manager_secret_id: "String",
|
6283
6638
|
# }
|
6284
6639
|
#
|
6285
6640
|
# @!attribute [rw] after_connect_script
|
6286
|
-
# For use with change data capture (CDC) only, this attribute has
|
6287
|
-
#
|
6288
|
-
#
|
6641
|
+
# For use with change data capture (CDC) only, this attribute has DMS
|
6642
|
+
# bypass foreign keys and user triggers to reduce the time it takes to
|
6643
|
+
# bulk load data.
|
6289
6644
|
#
|
6290
6645
|
# Example: `afterConnectScript=SET session_replication_role='replica'`
|
6291
6646
|
# @return [String]
|
6292
6647
|
#
|
6293
6648
|
# @!attribute [rw] capture_ddls
|
6294
|
-
# To capture DDL events,
|
6649
|
+
# To capture DDL events, DMS creates various artifacts in the
|
6295
6650
|
# PostgreSQL database when the task starts. You can later remove these
|
6296
6651
|
# artifacts.
|
6297
6652
|
#
|
@@ -6332,6 +6687,22 @@ module Aws::DatabaseMigrationService
|
|
6332
6687
|
# the task fails instead of truncating the LOB data.
|
6333
6688
|
# @return [Boolean]
|
6334
6689
|
#
|
6690
|
+
# @!attribute [rw] heartbeat_enable
|
6691
|
+
# If this attribute is set to true, the write-ahead log (WAL)
|
6692
|
+
# heartbeat keeps `restart_lsn` moving and prevents storage full
|
6693
|
+
# scenarios. The WAL heartbeat mimics a dummy transaction, so that
|
6694
|
+
# idle logical replication slots don't hold onto old WAL logs that
|
6695
|
+
# result in storage full situations on the source.
|
6696
|
+
# @return [Boolean]
|
6697
|
+
#
|
6698
|
+
# @!attribute [rw] heartbeat_schema
|
6699
|
+
# Sets the schema in which the heartbeat artifacts are created.
|
6700
|
+
# @return [String]
|
6701
|
+
#
|
6702
|
+
# @!attribute [rw] heartbeat_frequency
|
6703
|
+
# Sets the WAL heartbeat frequency (in minutes).
|
6704
|
+
# @return [Integer]
|
6705
|
+
#
|
6335
6706
|
# @!attribute [rw] password
|
6336
6707
|
# Endpoint connection password.
|
6337
6708
|
# @return [String]
|
@@ -6352,16 +6723,21 @@ module Aws::DatabaseMigrationService
|
|
6352
6723
|
# Sets the name of a previously created logical replication slot for a
|
6353
6724
|
# CDC load of the PostgreSQL source instance.
|
6354
6725
|
#
|
6355
|
-
# When used with the
|
6726
|
+
# When used with the DMS API `CdcStartPosition` request parameter,
|
6356
6727
|
# this attribute also enables using native CDC start points.
|
6357
6728
|
# @return [String]
|
6358
6729
|
#
|
6730
|
+
# @!attribute [rw] plugin_name
|
6731
|
+
# Specifies the plugin to use to create a replication slot.
|
6732
|
+
# @return [String]
|
6733
|
+
#
|
6359
6734
|
# @!attribute [rw] secrets_manager_access_role_arn
|
6360
6735
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
6361
|
-
#
|
6362
|
-
# access the value in `SecretsManagerSecret`.
|
6363
|
-
# has the value of the
|
6364
|
-
# to the
|
6736
|
+
# DMS as the trusted entity and grants the required permissions to
|
6737
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
6738
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
6739
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
6740
|
+
# PostgreSQL endpoint.
|
6365
6741
|
#
|
6366
6742
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
6367
6743
|
# can specify the values for this setting and
|
@@ -6369,15 +6745,15 @@ module Aws::DatabaseMigrationService
|
|
6369
6745
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
6370
6746
|
# both. For more information on creating this `SecretsManagerSecret`
|
6371
6747
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
6372
|
-
# required to access it, see [Using secrets to access
|
6373
|
-
# Migration Service resources][1] in the *
|
6374
|
-
#
|
6748
|
+
# required to access it, see [Using secrets to access Database
|
6749
|
+
# Migration Service resources][1] in the *Database Migration Service
|
6750
|
+
# User Guide*.
|
6375
6751
|
#
|
6376
6752
|
# </note>
|
6377
6753
|
#
|
6378
6754
|
#
|
6379
6755
|
#
|
6380
|
-
# [1]: https://docs.aws.amazon.com/
|
6756
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6381
6757
|
# @return [String]
|
6382
6758
|
#
|
6383
6759
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -6396,11 +6772,15 @@ module Aws::DatabaseMigrationService
|
|
6396
6772
|
:ddl_artifacts_schema,
|
6397
6773
|
:execute_timeout,
|
6398
6774
|
:fail_tasks_on_lob_truncation,
|
6775
|
+
:heartbeat_enable,
|
6776
|
+
:heartbeat_schema,
|
6777
|
+
:heartbeat_frequency,
|
6399
6778
|
:password,
|
6400
6779
|
:port,
|
6401
6780
|
:server_name,
|
6402
6781
|
:username,
|
6403
6782
|
:slot_name,
|
6783
|
+
:plugin_name,
|
6404
6784
|
:secrets_manager_access_role_arn,
|
6405
6785
|
:secrets_manager_secret_id)
|
6406
6786
|
SENSITIVE = [:password]
|
@@ -6504,14 +6884,14 @@ module Aws::DatabaseMigrationService
|
|
6504
6884
|
# An S3 folder where the comma-separated-value (.csv) files are stored
|
6505
6885
|
# before being uploaded to the target Redshift cluster.
|
6506
6886
|
#
|
6507
|
-
# For full load mode,
|
6508
|
-
#
|
6509
|
-
#
|
6510
|
-
#
|
6511
|
-
#
|
6887
|
+
# For full load mode, DMS converts source records into .csv files and
|
6888
|
+
# loads them to the *BucketFolder/TableID* path. DMS uses the Redshift
|
6889
|
+
# `COPY` command to upload the .csv files to the target table. The
|
6890
|
+
# files are deleted once the `COPY` operation has finished. For more
|
6891
|
+
# information, see [COPY][1] in the *Amazon Redshift Database
|
6512
6892
|
# Developer Guide*.
|
6513
6893
|
#
|
6514
|
-
# For change-data-capture (CDC) mode,
|
6894
|
+
# For change-data-capture (CDC) mode, DMS creates a *NetChanges*
|
6515
6895
|
# table, and loads the .csv files to this
|
6516
6896
|
# *BucketFolder/NetChangesTableID* path.
|
6517
6897
|
#
|
@@ -6561,7 +6941,7 @@ module Aws::DatabaseMigrationService
|
|
6561
6941
|
# @return [String]
|
6562
6942
|
#
|
6563
6943
|
# @!attribute [rw] empty_as_null
|
6564
|
-
# A value that specifies whether
|
6944
|
+
# A value that specifies whether DMS should migrate empty CHAR and
|
6565
6945
|
# VARCHAR fields as NULL. A value of `true` sets empty CHAR and
|
6566
6946
|
# VARCHAR fields to null. The default is `false`.
|
6567
6947
|
# @return [Boolean]
|
@@ -6578,9 +6958,9 @@ module Aws::DatabaseMigrationService
|
|
6578
6958
|
#
|
6579
6959
|
# </note>
|
6580
6960
|
#
|
6581
|
-
# To use `SSE_S3`, create an
|
6582
|
-
#
|
6583
|
-
#
|
6961
|
+
# To use `SSE_S3`, create an Identity and Access Management (IAM) role
|
6962
|
+
# with a policy that allows `"arn:aws:s3:::*"` to use the following
|
6963
|
+
# actions: `"s3:PutObject", "s3:ListBucket"`
|
6584
6964
|
# @return [String]
|
6585
6965
|
#
|
6586
6966
|
# @!attribute [rw] explicit_ids
|
@@ -6609,8 +6989,8 @@ module Aws::DatabaseMigrationService
|
|
6609
6989
|
#
|
6610
6990
|
# @!attribute [rw] load_timeout
|
6611
6991
|
# The amount of time to wait (in milliseconds) before timing out of
|
6612
|
-
# operations performed by
|
6613
|
-
#
|
6992
|
+
# operations performed by DMS on a Redshift cluster, such as Redshift
|
6993
|
+
# COPY, INSERT, DELETE, and UPDATE.
|
6614
6994
|
# @return [Integer]
|
6615
6995
|
#
|
6616
6996
|
# @!attribute [rw] max_file_size
|
@@ -6651,14 +7031,14 @@ module Aws::DatabaseMigrationService
|
|
6651
7031
|
#
|
6652
7032
|
# @!attribute [rw] service_access_role_arn
|
6653
7033
|
# The Amazon Resource Name (ARN) of the IAM role that has access to
|
6654
|
-
# the Amazon Redshift service.
|
7034
|
+
# the Amazon Redshift service. The role must allow the `iam:PassRole`
|
7035
|
+
# action.
|
6655
7036
|
# @return [String]
|
6656
7037
|
#
|
6657
7038
|
# @!attribute [rw] server_side_encryption_kms_key_id
|
6658
|
-
# The
|
6659
|
-
#
|
6660
|
-
#
|
6661
|
-
# the key.
|
7039
|
+
# The KMS key ID. If you are using `SSE_KMS` for the `EncryptionMode`,
|
7040
|
+
# provide this key ID. The key that you use needs an attached policy
|
7041
|
+
# that enables IAM user permissions and allows use of the key.
|
6662
7042
|
# @return [String]
|
6663
7043
|
#
|
6664
7044
|
# @!attribute [rw] time_format
|
@@ -6699,10 +7079,11 @@ module Aws::DatabaseMigrationService
|
|
6699
7079
|
#
|
6700
7080
|
# @!attribute [rw] secrets_manager_access_role_arn
|
6701
7081
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
6702
|
-
#
|
6703
|
-
# access the value in `SecretsManagerSecret`.
|
6704
|
-
# has the value of the
|
6705
|
-
#
|
7082
|
+
# DMS as the trusted entity and grants the required permissions to
|
7083
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
7084
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
7085
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
7086
|
+
# Amazon Redshift endpoint.
|
6706
7087
|
#
|
6707
7088
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
6708
7089
|
# can specify the values for this setting and
|
@@ -6710,15 +7091,15 @@ module Aws::DatabaseMigrationService
|
|
6710
7091
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
6711
7092
|
# both. For more information on creating this `SecretsManagerSecret`
|
6712
7093
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
6713
|
-
# required to access it, see [Using secrets to access
|
6714
|
-
# Migration Service resources][1] in the *
|
6715
|
-
#
|
7094
|
+
# required to access it, see [Using secrets to access Database
|
7095
|
+
# Migration Service resources][1] in the *Database Migration Service
|
7096
|
+
# User Guide*.
|
6716
7097
|
#
|
6717
7098
|
# </note>
|
6718
7099
|
#
|
6719
7100
|
#
|
6720
7101
|
#
|
6721
|
-
# [1]: https://docs.aws.amazon.com/
|
7102
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6722
7103
|
# @return [String]
|
6723
7104
|
#
|
6724
7105
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -6893,7 +7274,7 @@ module Aws::DatabaseMigrationService
|
|
6893
7274
|
include Aws::Structure
|
6894
7275
|
end
|
6895
7276
|
|
6896
|
-
# Removes one or more tags from an
|
7277
|
+
# Removes one or more tags from an DMS resource.
|
6897
7278
|
#
|
6898
7279
|
# @note When making an API call, you may pass RemoveTagsFromResourceMessage
|
6899
7280
|
# data as a hash:
|
@@ -6904,8 +7285,8 @@ module Aws::DatabaseMigrationService
|
|
6904
7285
|
# }
|
6905
7286
|
#
|
6906
7287
|
# @!attribute [rw] resource_arn
|
6907
|
-
# An
|
6908
|
-
#
|
7288
|
+
# An DMS resource from which you want to remove tag(s). The value for
|
7289
|
+
# this parameter is an Amazon Resource Name (ARN).
|
6909
7290
|
# @return [String]
|
6910
7291
|
#
|
6911
7292
|
# @!attribute [rw] tag_keys
|
@@ -6945,12 +7326,12 @@ module Aws::DatabaseMigrationService
|
|
6945
7326
|
# @!attribute [rw] replication_instance_class
|
6946
7327
|
# The compute and memory capacity of the replication instance as
|
6947
7328
|
# defined for the specified replication instance class. It is a
|
6948
|
-
# required parameter, although a
|
7329
|
+
# required parameter, although a default value is pre-selected in the
|
6949
7330
|
# DMS console.
|
6950
7331
|
#
|
6951
7332
|
# For more information on the settings and capacities for the
|
6952
7333
|
# available replication instance classes, see [ Selecting the right
|
6953
|
-
#
|
7334
|
+
# DMS replication instance for your migration][1].
|
6954
7335
|
#
|
6955
7336
|
#
|
6956
7337
|
#
|
@@ -7042,15 +7423,14 @@ module Aws::DatabaseMigrationService
|
|
7042
7423
|
# @return [Boolean]
|
7043
7424
|
#
|
7044
7425
|
# @!attribute [rw] kms_key_id
|
7045
|
-
# An
|
7426
|
+
# An KMS key identifier that is used to encrypt the data on the
|
7046
7427
|
# replication instance.
|
7047
7428
|
#
|
7048
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
7049
|
-
#
|
7429
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
7430
|
+
# uses your default encryption key.
|
7050
7431
|
#
|
7051
|
-
#
|
7052
|
-
#
|
7053
|
-
# Region.
|
7432
|
+
# KMS creates the default encryption key for your account. Your
|
7433
|
+
# account has a different default encryption key for each Region.
|
7054
7434
|
# @return [String]
|
7055
7435
|
#
|
7056
7436
|
# @!attribute [rw] replication_instance_arn
|
@@ -7163,7 +7543,7 @@ module Aws::DatabaseMigrationService
|
|
7163
7543
|
#
|
7164
7544
|
# For more information on the settings and capacities for the
|
7165
7545
|
# available replication instance classes, see [ Selecting the right
|
7166
|
-
#
|
7546
|
+
# DMS replication instance for your migration][1].
|
7167
7547
|
#
|
7168
7548
|
#
|
7169
7549
|
#
|
@@ -7431,8 +7811,8 @@ module Aws::DatabaseMigrationService
|
|
7431
7811
|
# @!attribute [rw] task_data
|
7432
7812
|
# Supplemental information that the task requires to migrate the data
|
7433
7813
|
# for certain source and target endpoints. For more information, see
|
7434
|
-
# [Specifying Supplemental Data for Task Settings][1] in the *
|
7435
|
-
#
|
7814
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *Database
|
7815
|
+
# Migration Service User Guide.*
|
7436
7816
|
#
|
7437
7817
|
#
|
7438
7818
|
#
|
@@ -7501,10 +7881,18 @@ module Aws::DatabaseMigrationService
|
|
7501
7881
|
#
|
7502
7882
|
# @!attribute [rw] assessment_results
|
7503
7883
|
# The task assessment results in JSON format.
|
7884
|
+
#
|
7885
|
+
# The response object only contains this field if you provide
|
7886
|
+
# DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn
|
7887
|
+
# in the request.
|
7504
7888
|
# @return [String]
|
7505
7889
|
#
|
7506
7890
|
# @!attribute [rw] s3_object_url
|
7507
7891
|
# The URL of the S3 object containing the task assessment results.
|
7892
|
+
#
|
7893
|
+
# The response object only contains this field if you provide
|
7894
|
+
# DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn
|
7895
|
+
# in the request.
|
7508
7896
|
# @return [String]
|
7509
7897
|
#
|
7510
7898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ReplicationTaskAssessmentResult AWS API Documentation
|
@@ -7587,17 +7975,18 @@ module Aws::DatabaseMigrationService
|
|
7587
7975
|
#
|
7588
7976
|
# @!attribute [rw] service_access_role_arn
|
7589
7977
|
# ARN of the service role used to start the assessment run using the
|
7590
|
-
# `StartReplicationTaskAssessmentRun` operation.
|
7978
|
+
# `StartReplicationTaskAssessmentRun` operation. The role must allow
|
7979
|
+
# the `iam:PassRole` action.
|
7591
7980
|
# @return [String]
|
7592
7981
|
#
|
7593
7982
|
# @!attribute [rw] result_location_bucket
|
7594
|
-
# Amazon S3 bucket where
|
7983
|
+
# Amazon S3 bucket where DMS stores the results of this assessment
|
7595
7984
|
# run.
|
7596
7985
|
# @return [String]
|
7597
7986
|
#
|
7598
7987
|
# @!attribute [rw] result_location_folder
|
7599
|
-
# Folder in an Amazon S3 bucket where
|
7600
|
-
#
|
7988
|
+
# Folder in an Amazon S3 bucket where DMS stores the results of this
|
7989
|
+
# assessment run.
|
7601
7990
|
# @return [String]
|
7602
7991
|
#
|
7603
7992
|
# @!attribute [rw] result_encryption_mode
|
@@ -7605,7 +7994,7 @@ module Aws::DatabaseMigrationService
|
|
7605
7994
|
# @return [String]
|
7606
7995
|
#
|
7607
7996
|
# @!attribute [rw] result_kms_key_arn
|
7608
|
-
# ARN of the
|
7997
|
+
# ARN of the KMS encryption key used to encrypt the assessment run
|
7609
7998
|
# results.
|
7610
7999
|
# @return [String]
|
7611
8000
|
#
|
@@ -7807,13 +8196,13 @@ module Aws::DatabaseMigrationService
|
|
7807
8196
|
include Aws::Structure
|
7808
8197
|
end
|
7809
8198
|
|
7810
|
-
# Identifies an
|
8199
|
+
# Identifies an DMS resource and any pending actions for it.
|
7811
8200
|
#
|
7812
8201
|
# @!attribute [rw] resource_identifier
|
7813
8202
|
# The Amazon Resource Name (ARN) of the DMS resource that the pending
|
7814
8203
|
# maintenance action applies to. For information about creating an
|
7815
|
-
# ARN, see [ Constructing an Amazon Resource Name (ARN) for
|
7816
|
-
#
|
8204
|
+
# ARN, see [ Constructing an Amazon Resource Name (ARN) for DMS][1] in
|
8205
|
+
# the DMS documentation.
|
7817
8206
|
#
|
7818
8207
|
#
|
7819
8208
|
#
|
@@ -7910,9 +8299,10 @@ module Aws::DatabaseMigrationService
|
|
7910
8299
|
# }
|
7911
8300
|
#
|
7912
8301
|
# @!attribute [rw] service_access_role_arn
|
7913
|
-
# The Amazon Resource Name (ARN) used by the service access IAM
|
7914
|
-
#
|
7915
|
-
#
|
8302
|
+
# The Amazon Resource Name (ARN) used by the service to access the IAM
|
8303
|
+
# role. The role must allow the `iam:PassRole` action. It is a
|
8304
|
+
# required parameter that enables DMS to write and read objects from
|
8305
|
+
# an S3 bucket.
|
7916
8306
|
# @return [String]
|
7917
8307
|
#
|
7918
8308
|
# @!attribute [rw] external_table_definition
|
@@ -7959,9 +8349,9 @@ module Aws::DatabaseMigrationService
|
|
7959
8349
|
#
|
7960
8350
|
# </note>
|
7961
8351
|
#
|
7962
|
-
# To use `SSE_S3`, you need an
|
7963
|
-
#
|
7964
|
-
#
|
8352
|
+
# To use `SSE_S3`, you need an Identity and Access Management (IAM)
|
8353
|
+
# role with permission to allow `"arn:aws:s3:::dms-*"` to use the
|
8354
|
+
# following actions:
|
7965
8355
|
#
|
7966
8356
|
# * `s3:CreateBucket`
|
7967
8357
|
#
|
@@ -7987,10 +8377,10 @@ module Aws::DatabaseMigrationService
|
|
7987
8377
|
# @return [String]
|
7988
8378
|
#
|
7989
8379
|
# @!attribute [rw] server_side_encryption_kms_key_id
|
7990
|
-
# If you are using `SSE_KMS` for the `EncryptionMode`, provide the
|
7991
|
-
#
|
7992
|
-
#
|
7993
|
-
#
|
8380
|
+
# If you are using `SSE_KMS` for the `EncryptionMode`, provide the KMS
|
8381
|
+
# key ID. The key that you use needs an attached policy that enables
|
8382
|
+
# Identity and Access Management (IAM) user permissions and allows use
|
8383
|
+
# of the key.
|
7994
8384
|
#
|
7995
8385
|
# Here is a CLI example: `aws dms create-endpoint
|
7996
8386
|
# --endpoint-identifier value --endpoint-type target --engine-name s3
|
@@ -8069,8 +8459,8 @@ module Aws::DatabaseMigrationService
|
|
8069
8459
|
# comma-separated value (.csv) output files only to indicate how the
|
8070
8460
|
# rows were added to the source database.
|
8071
8461
|
#
|
8072
|
-
# <note markdown="1">
|
8073
|
-
#
|
8462
|
+
# <note markdown="1"> DMS supports the `IncludeOpForFullLoad` parameter in versions 3.1.4
|
8463
|
+
# and later.
|
8074
8464
|
#
|
8075
8465
|
# </note>
|
8076
8466
|
#
|
@@ -8085,8 +8475,8 @@ module Aws::DatabaseMigrationService
|
|
8085
8475
|
# <note markdown="1"> This setting works together with the `CdcInsertsOnly` and the
|
8086
8476
|
# `CdcInsertsAndUpdates` parameters for output to .csv files only. For
|
8087
8477
|
# more information about how these settings work together, see
|
8088
|
-
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8089
|
-
# Database Migration Service User Guide.*.
|
8478
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8479
|
+
# *Database Migration Service User Guide.*.
|
8090
8480
|
#
|
8091
8481
|
# </note>
|
8092
8482
|
#
|
@@ -8113,10 +8503,10 @@ module Aws::DatabaseMigrationService
|
|
8113
8503
|
# `false`, every CDC record is written without a first field to
|
8114
8504
|
# indicate the INSERT operation at the source. For more information
|
8115
8505
|
# about how these settings work together, see [Indicating Source DB
|
8116
|
-
# Operations in Migrated S3 Data][1] in the *
|
8506
|
+
# Operations in Migrated S3 Data][1] in the *Database Migration
|
8117
8507
|
# Service User Guide.*.
|
8118
8508
|
#
|
8119
|
-
# <note markdown="1">
|
8509
|
+
# <note markdown="1"> DMS supports the interaction described preceding between the
|
8120
8510
|
# `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions
|
8121
8511
|
# 3.1.4 and later.
|
8122
8512
|
#
|
@@ -8133,11 +8523,11 @@ module Aws::DatabaseMigrationService
|
|
8133
8523
|
# @return [Boolean]
|
8134
8524
|
#
|
8135
8525
|
# @!attribute [rw] timestamp_column_name
|
8136
|
-
# A value that when nonblank causes
|
8137
|
-
#
|
8526
|
+
# A value that when nonblank causes DMS to add a column with timestamp
|
8527
|
+
# information to the endpoint data for an Amazon S3 target.
|
8138
8528
|
#
|
8139
|
-
# <note markdown="1">
|
8140
|
-
#
|
8529
|
+
# <note markdown="1"> DMS supports the `TimestampColumnName` parameter in versions 3.1.4
|
8530
|
+
# and later.
|
8141
8531
|
#
|
8142
8532
|
# </note>
|
8143
8533
|
#
|
@@ -8168,23 +8558,23 @@ module Aws::DatabaseMigrationService
|
|
8168
8558
|
# values that are written to an Amazon S3 object file in .parquet
|
8169
8559
|
# format.
|
8170
8560
|
#
|
8171
|
-
# <note markdown="1">
|
8561
|
+
# <note markdown="1"> DMS supports the `ParquetTimestampInMillisecond` parameter in
|
8172
8562
|
# versions 3.1.4 and later.
|
8173
8563
|
#
|
8174
8564
|
# </note>
|
8175
8565
|
#
|
8176
|
-
# When `ParquetTimestampInMillisecond` is set to `true` or `y`,
|
8177
|
-
#
|
8566
|
+
# When `ParquetTimestampInMillisecond` is set to `true` or `y`, DMS
|
8567
|
+
# writes all `TIMESTAMP` columns in a .parquet formatted file with
|
8178
8568
|
# millisecond precision. Otherwise, DMS writes them with microsecond
|
8179
8569
|
# precision.
|
8180
8570
|
#
|
8181
|
-
# Currently, Amazon Athena and
|
8571
|
+
# Currently, Amazon Athena and Glue can handle only millisecond
|
8182
8572
|
# precision for `TIMESTAMP` values. Set this parameter to `true` for
|
8183
8573
|
# S3 endpoint object files that are .parquet formatted only if you
|
8184
|
-
# plan to query or process the data with Athena or
|
8574
|
+
# plan to query or process the data with Athena or Glue.
|
8185
8575
|
#
|
8186
|
-
# <note markdown="1">
|
8187
|
-
#
|
8576
|
+
# <note markdown="1"> DMS writes any `TIMESTAMP` column values written to an S3 file in
|
8577
|
+
# .csv format with microsecond precision.
|
8188
8578
|
#
|
8189
8579
|
# Setting `ParquetTimestampInMillisecond` has no effect on the string
|
8190
8580
|
# format of the timestamp column value that is inserted by setting the
|
@@ -8209,10 +8599,10 @@ module Aws::DatabaseMigrationService
|
|
8209
8599
|
# `IncludeOpForFullLoad` is set to `false`, CDC records are written
|
8210
8600
|
# without an indication of INSERT or UPDATE operations at the source.
|
8211
8601
|
# For more information about how these settings work together, see
|
8212
|
-
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8213
|
-
# Database Migration Service User Guide.*.
|
8602
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8603
|
+
# *Database Migration Service User Guide.*.
|
8214
8604
|
#
|
8215
|
-
# <note markdown="1">
|
8605
|
+
# <note markdown="1"> DMS supports the use of the `CdcInsertsAndUpdates` parameter in
|
8216
8606
|
# versions 3.3.1 and later.
|
8217
8607
|
#
|
8218
8608
|
# `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to
|
@@ -8230,7 +8620,7 @@ module Aws::DatabaseMigrationService
|
|
8230
8620
|
# @!attribute [rw] date_partition_enabled
|
8231
8621
|
# When set to `true`, this parameter partitions S3 bucket folders
|
8232
8622
|
# based on transaction commit dates. The default value is `false`. For
|
8233
|
-
# more information about date-based folder
|
8623
|
+
# more information about date-based folder partitioning, see [Using
|
8234
8624
|
# date-based folder partitioning][1].
|
8235
8625
|
#
|
8236
8626
|
#
|
@@ -8253,11 +8643,11 @@ module Aws::DatabaseMigrationService
|
|
8253
8643
|
# @!attribute [rw] use_csv_no_sup_value
|
8254
8644
|
# This setting applies if the S3 output files during a change data
|
8255
8645
|
# capture (CDC) load are written in .csv format. If set to `true` for
|
8256
|
-
# columns not included in the supplemental log,
|
8646
|
+
# columns not included in the supplemental log, DMS uses the value
|
8257
8647
|
# specified by [ `CsvNoSupValue` ][1]. If not set or set to `false`,
|
8258
|
-
#
|
8648
|
+
# DMS uses the null value for these columns.
|
8259
8649
|
#
|
8260
|
-
# <note markdown="1"> This setting is supported in
|
8650
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.1 and later.
|
8261
8651
|
#
|
8262
8652
|
# </note>
|
8263
8653
|
#
|
@@ -8270,12 +8660,11 @@ module Aws::DatabaseMigrationService
|
|
8270
8660
|
# This setting only applies if your Amazon S3 output files during a
|
8271
8661
|
# change data capture (CDC) load are written in .csv format. If [
|
8272
8662
|
# `UseCsvNoSupValue` ][1] is set to true, specify a string value that
|
8273
|
-
# you want
|
8274
|
-
#
|
8275
|
-
#
|
8276
|
-
# `UseCsvNoSupValue` setting.
|
8663
|
+
# you want DMS to use for all columns not included in the supplemental
|
8664
|
+
# log. If you do not specify a string value, DMS uses the null value
|
8665
|
+
# for these columns regardless of the `UseCsvNoSupValue` setting.
|
8277
8666
|
#
|
8278
|
-
# <note markdown="1"> This setting is supported in
|
8667
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.1 and later.
|
8279
8668
|
#
|
8280
8669
|
# </note>
|
8281
8670
|
#
|
@@ -8285,12 +8674,12 @@ module Aws::DatabaseMigrationService
|
|
8285
8674
|
# @return [String]
|
8286
8675
|
#
|
8287
8676
|
# @!attribute [rw] preserve_transactions
|
8288
|
-
# If set to `true`,
|
8289
|
-
#
|
8290
|
-
#
|
8291
|
-
#
|
8677
|
+
# If set to `true`, DMS saves the transaction order for a change data
|
8678
|
+
# capture (CDC) load on the Amazon S3 target specified by [ `CdcPath`
|
8679
|
+
# ][1]. For more information, see [Capturing data changes (CDC)
|
8680
|
+
# including transaction order on the S3 target][2].
|
8292
8681
|
#
|
8293
|
-
# <note markdown="1"> This setting is supported in
|
8682
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.2 and later.
|
8294
8683
|
#
|
8295
8684
|
# </note>
|
8296
8685
|
#
|
@@ -8303,30 +8692,30 @@ module Aws::DatabaseMigrationService
|
|
8303
8692
|
# @!attribute [rw] cdc_path
|
8304
8693
|
# Specifies the folder path of CDC files. For an S3 source, this
|
8305
8694
|
# setting is required if a task captures change data; otherwise, it's
|
8306
|
-
# optional. If `CdcPath` is set,
|
8307
|
-
#
|
8308
|
-
#
|
8309
|
-
#
|
8310
|
-
#
|
8311
|
-
#
|
8312
|
-
#
|
8313
|
-
#
|
8695
|
+
# optional. If `CdcPath` is set, DMS reads CDC files from this path
|
8696
|
+
# and replicates the data changes to the target endpoint. For an S3
|
8697
|
+
# target if you set [ `PreserveTransactions` ][1] to `true`, DMS
|
8698
|
+
# verifies that you have set this parameter to a folder path on your
|
8699
|
+
# S3 target where DMS can save the transaction order for the CDC load.
|
8700
|
+
# DMS creates this CDC folder path in either your S3 target working
|
8701
|
+
# directory or the S3 target location specified by [ `BucketFolder`
|
8702
|
+
# ][2] and [ `BucketName` ][3].
|
8314
8703
|
#
|
8315
8704
|
# For example, if you specify `CdcPath` as `MyChangedData`, and you
|
8316
8705
|
# specify `BucketName` as `MyTargetBucket` but do not specify
|
8317
|
-
# `BucketFolder`,
|
8706
|
+
# `BucketFolder`, DMS creates the CDC folder path following:
|
8318
8707
|
# `MyTargetBucket/MyChangedData`.
|
8319
8708
|
#
|
8320
8709
|
# If you specify the same `CdcPath`, and you specify `BucketName` as
|
8321
|
-
# `MyTargetBucket` and `BucketFolder` as `MyTargetData`,
|
8322
|
-
#
|
8710
|
+
# `MyTargetBucket` and `BucketFolder` as `MyTargetData`, DMS creates
|
8711
|
+
# the CDC folder path following:
|
8323
8712
|
# `MyTargetBucket/MyTargetData/MyChangedData`.
|
8324
8713
|
#
|
8325
8714
|
# For more information on CDC including transaction order on an S3
|
8326
8715
|
# target, see [Capturing data changes (CDC) including transaction
|
8327
8716
|
# order on the S3 target][4].
|
8328
8717
|
#
|
8329
|
-
# <note markdown="1"> This setting is supported in
|
8718
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.2 and later.
|
8330
8719
|
#
|
8331
8720
|
# </note>
|
8332
8721
|
#
|
@@ -8451,31 +8840,32 @@ module Aws::DatabaseMigrationService
|
|
8451
8840
|
# @return [String]
|
8452
8841
|
#
|
8453
8842
|
# @!attribute [rw] service_access_role_arn
|
8454
|
-
# ARN of
|
8843
|
+
# ARN of the service role needed to start the assessment run. The role
|
8844
|
+
# must allow the `iam:PassRole` action.
|
8455
8845
|
# @return [String]
|
8456
8846
|
#
|
8457
8847
|
# @!attribute [rw] result_location_bucket
|
8458
|
-
# Amazon S3 bucket where you want
|
8848
|
+
# Amazon S3 bucket where you want DMS to store the results of this
|
8459
8849
|
# assessment run.
|
8460
8850
|
# @return [String]
|
8461
8851
|
#
|
8462
8852
|
# @!attribute [rw] result_location_folder
|
8463
|
-
# Folder within an Amazon S3 bucket where you want
|
8464
|
-
#
|
8853
|
+
# Folder within an Amazon S3 bucket where you want DMS to store the
|
8854
|
+
# results of this assessment run.
|
8465
8855
|
# @return [String]
|
8466
8856
|
#
|
8467
8857
|
# @!attribute [rw] result_encryption_mode
|
8468
8858
|
# Encryption mode that you can specify to encrypt the results of this
|
8469
|
-
# assessment run. If you don't specify this request parameter,
|
8470
|
-
#
|
8859
|
+
# assessment run. If you don't specify this request parameter, DMS
|
8860
|
+
# stores the assessment run results without encryption. You can
|
8471
8861
|
# specify one of the options following:
|
8472
8862
|
#
|
8473
8863
|
# * `"SSE_S3"` – The server-side encryption provided as a default by
|
8474
8864
|
# Amazon S3.
|
8475
8865
|
#
|
8476
|
-
# * `"SSE_KMS"` –
|
8477
|
-
#
|
8478
|
-
#
|
8866
|
+
# * `"SSE_KMS"` – Key Management Service (KMS) encryption. This
|
8867
|
+
# encryption can use either a custom KMS encryption key that you
|
8868
|
+
# specify or the default KMS encryption key that DMS provides.
|
8479
8869
|
# @return [String]
|
8480
8870
|
#
|
8481
8871
|
# @!attribute [rw] result_kms_key_arn
|
@@ -8490,14 +8880,14 @@ module Aws::DatabaseMigrationService
|
|
8490
8880
|
# @!attribute [rw] include_only
|
8491
8881
|
# Space-separated list of names for specific individual assessments
|
8492
8882
|
# that you want to include. These names come from the default list of
|
8493
|
-
# individual assessments that
|
8883
|
+
# individual assessments that DMS supports for the associated
|
8494
8884
|
# migration task. This task is specified by `ReplicationTaskArn`.
|
8495
8885
|
#
|
8496
8886
|
# <note markdown="1"> You can't set a value for `IncludeOnly` if you also set a value for
|
8497
8887
|
# `Exclude` in the API operation.
|
8498
8888
|
#
|
8499
|
-
# To identify the names of the default individual assessments that
|
8500
|
-
#
|
8889
|
+
# To identify the names of the default individual assessments that DMS
|
8890
|
+
# supports for the associated migration task, run the
|
8501
8891
|
# `DescribeApplicableIndividualAssessments` operation using its own
|
8502
8892
|
# `ReplicationTaskArn` request parameter.
|
8503
8893
|
#
|
@@ -8507,14 +8897,14 @@ module Aws::DatabaseMigrationService
|
|
8507
8897
|
# @!attribute [rw] exclude
|
8508
8898
|
# Space-separated list of names for specific individual assessments
|
8509
8899
|
# that you want to exclude. These names come from the default list of
|
8510
|
-
# individual assessments that
|
8900
|
+
# individual assessments that DMS supports for the associated
|
8511
8901
|
# migration task. This task is specified by `ReplicationTaskArn`.
|
8512
8902
|
#
|
8513
8903
|
# <note markdown="1"> You can't set a value for `Exclude` if you also set a value for
|
8514
8904
|
# `IncludeOnly` in the API operation.
|
8515
8905
|
#
|
8516
|
-
# To identify the names of the default individual assessments that
|
8517
|
-
#
|
8906
|
+
# To identify the names of the default individual assessments that DMS
|
8907
|
+
# supports for the associated migration task, run the
|
8518
8908
|
# `DescribeApplicableIndividualAssessments` operation using its own
|
8519
8909
|
# `ReplicationTaskArn` request parameter.
|
8520
8910
|
#
|
@@ -8598,7 +8988,7 @@ module Aws::DatabaseMigrationService
|
|
8598
8988
|
# with the source endpoint. You can verify this by setting the
|
8599
8989
|
# `slotName` extra connection attribute to the name of this logical
|
8600
8990
|
# replication slot. For more information, see [Extra Connection
|
8601
|
-
# Attributes When Using PostgreSQL as a Source for
|
8991
|
+
# Attributes When Using PostgreSQL as a Source for DMS][1].
|
8602
8992
|
#
|
8603
8993
|
# </note>
|
8604
8994
|
#
|
@@ -8740,7 +9130,7 @@ module Aws::DatabaseMigrationService
|
|
8740
9130
|
# @return [String]
|
8741
9131
|
#
|
8742
9132
|
# @!attribute [rw] supports_cdc
|
8743
|
-
# Indicates if
|
9133
|
+
# Indicates if change data capture (CDC) is supported.
|
8744
9134
|
# @return [Boolean]
|
8745
9135
|
#
|
8746
9136
|
# @!attribute [rw] endpoint_type
|
@@ -8748,9 +9138,9 @@ module Aws::DatabaseMigrationService
|
|
8748
9138
|
# @return [String]
|
8749
9139
|
#
|
8750
9140
|
# @!attribute [rw] replication_instance_engine_minimum_version
|
8751
|
-
# The earliest
|
8752
|
-
#
|
8753
|
-
#
|
9141
|
+
# The earliest DMS engine version that supports this endpoint engine.
|
9142
|
+
# Note that endpoint engines released with DMS versions earlier than
|
9143
|
+
# 3.1.1 do not return a value for this parameter.
|
8754
9144
|
# @return [String]
|
8755
9145
|
#
|
8756
9146
|
# @!attribute [rw] engine_display_name
|
@@ -8808,10 +9198,11 @@ module Aws::DatabaseMigrationService
|
|
8808
9198
|
#
|
8809
9199
|
# @!attribute [rw] secrets_manager_access_role_arn
|
8810
9200
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
8811
|
-
#
|
8812
|
-
# access the value in `SecretsManagerSecret`.
|
8813
|
-
# has the value of the
|
8814
|
-
#
|
9201
|
+
# DMS as the trusted entity and grants the required permissions to
|
9202
|
+
# access the value in `SecretsManagerSecret`. The role must allow the
|
9203
|
+
# `iam:PassRole` action. `SecretsManagerSecret` has the value of the
|
9204
|
+
# Amazon Web Services Secrets Manager secret that allows access to the
|
9205
|
+
# SAP ASE endpoint.
|
8815
9206
|
#
|
8816
9207
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
8817
9208
|
# can specify the values for this setting and
|
@@ -8819,15 +9210,15 @@ module Aws::DatabaseMigrationService
|
|
8819
9210
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
8820
9211
|
# both. For more information on creating this `SecretsManagerSecret`
|
8821
9212
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
8822
|
-
# required to access it, see [Using secrets to access
|
8823
|
-
# Migration Service resources][1] in the *
|
8824
|
-
#
|
9213
|
+
# required to access it, see [Using secrets to access Database
|
9214
|
+
# Migration Service resources][1] in the *Database Migration Service
|
9215
|
+
# User Guide*.
|
8825
9216
|
#
|
8826
9217
|
# </note>
|
8827
9218
|
#
|
8828
9219
|
#
|
8829
9220
|
#
|
8830
|
-
# [1]: https://docs.aws.amazon.com/
|
9221
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
8831
9222
|
# @return [String]
|
8832
9223
|
#
|
8833
9224
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -9025,8 +9416,8 @@ module Aws::DatabaseMigrationService
|
|
9025
9416
|
include Aws::Structure
|
9026
9417
|
end
|
9027
9418
|
|
9028
|
-
# A user-defined key-value pair that describes metadata added to an
|
9029
|
-
#
|
9419
|
+
# A user-defined key-value pair that describes metadata added to an DMS
|
9420
|
+
# resource and that is used by operations such as the following:
|
9030
9421
|
#
|
9031
9422
|
# * `AddTagsToResource`
|
9032
9423
|
#
|