aws-sdk-databasemigrationservice 1.53.0 → 1.54.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-databasemigrationservice.rb +1 -1
- data/lib/aws-sdk-databasemigrationservice/client.rb +332 -234
- data/lib/aws-sdk-databasemigrationservice/client_api.rb +13 -0
- data/lib/aws-sdk-databasemigrationservice/types.rb +704 -537
- metadata +3 -4
@@ -184,6 +184,7 @@ module Aws::DatabaseMigrationService
|
|
184
184
|
PendingMaintenanceAction = Shapes::StructureShape.new(name: 'PendingMaintenanceAction')
|
185
185
|
PendingMaintenanceActionDetails = Shapes::ListShape.new(name: 'PendingMaintenanceActionDetails')
|
186
186
|
PendingMaintenanceActions = Shapes::ListShape.new(name: 'PendingMaintenanceActions')
|
187
|
+
PluginNameValue = Shapes::StringShape.new(name: 'PluginNameValue')
|
187
188
|
PostgreSQLSettings = Shapes::StructureShape.new(name: 'PostgreSQLSettings')
|
188
189
|
RebootReplicationInstanceMessage = Shapes::StructureShape.new(name: 'RebootReplicationInstanceMessage')
|
189
190
|
RebootReplicationInstanceResponse = Shapes::StructureShape.new(name: 'RebootReplicationInstanceResponse')
|
@@ -747,6 +748,7 @@ module Aws::DatabaseMigrationService
|
|
747
748
|
EndpointSetting.add_member(:applicability, Shapes::ShapeRef.new(shape: String, location_name: "Applicability"))
|
748
749
|
EndpointSetting.add_member(:int_value_min, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "IntValueMin"))
|
749
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"))
|
750
752
|
EndpointSetting.struct_class = Types::EndpointSetting
|
751
753
|
|
752
754
|
EndpointSettingEnumValues.member = Shapes::ShapeRef.new(shape: String)
|
@@ -868,6 +870,7 @@ module Aws::DatabaseMigrationService
|
|
868
870
|
KafkaSettings.add_member(:ssl_ca_certificate_arn, Shapes::ShapeRef.new(shape: String, location_name: "SslCaCertificateArn"))
|
869
871
|
KafkaSettings.add_member(:sasl_username, Shapes::ShapeRef.new(shape: String, location_name: "SaslUsername"))
|
870
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"))
|
871
874
|
KafkaSettings.struct_class = Types::KafkaSettings
|
872
875
|
|
873
876
|
KeyList.member = Shapes::ShapeRef.new(shape: String)
|
@@ -881,6 +884,7 @@ module Aws::DatabaseMigrationService
|
|
881
884
|
KinesisSettings.add_member(:include_table_alter_operations, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeTableAlterOperations"))
|
882
885
|
KinesisSettings.add_member(:include_control_details, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeControlDetails"))
|
883
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"))
|
884
888
|
KinesisSettings.struct_class = Types::KinesisSettings
|
885
889
|
|
886
890
|
ListTagsForResourceMessage.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ResourceArn"))
|
@@ -935,6 +939,7 @@ module Aws::DatabaseMigrationService
|
|
935
939
|
ModifyEndpointMessage.add_member(:microsoft_sql_server_settings, Shapes::ShapeRef.new(shape: MicrosoftSQLServerSettings, location_name: "MicrosoftSQLServerSettings"))
|
936
940
|
ModifyEndpointMessage.add_member(:ibm_db_2_settings, Shapes::ShapeRef.new(shape: IBMDb2Settings, location_name: "IBMDb2Settings"))
|
937
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"))
|
938
943
|
ModifyEndpointMessage.struct_class = Types::ModifyEndpointMessage
|
939
944
|
|
940
945
|
ModifyEndpointResponse.add_member(:endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "Endpoint"))
|
@@ -1066,7 +1071,11 @@ module Aws::DatabaseMigrationService
|
|
1066
1071
|
OracleSettings.add_member(:security_db_encryption_name, Shapes::ShapeRef.new(shape: String, location_name: "SecurityDbEncryptionName"))
|
1067
1072
|
OracleSettings.add_member(:server_name, Shapes::ShapeRef.new(shape: String, location_name: "ServerName"))
|
1068
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"))
|
1069
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"))
|
1070
1079
|
OracleSettings.add_member(:secrets_manager_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerAccessRoleArn"))
|
1071
1080
|
OracleSettings.add_member(:secrets_manager_secret_id, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerSecretId"))
|
1072
1081
|
OracleSettings.add_member(:secrets_manager_oracle_asm_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerOracleAsmAccessRoleArn"))
|
@@ -1105,11 +1114,15 @@ module Aws::DatabaseMigrationService
|
|
1105
1114
|
PostgreSQLSettings.add_member(:ddl_artifacts_schema, Shapes::ShapeRef.new(shape: String, location_name: "DdlArtifactsSchema"))
|
1106
1115
|
PostgreSQLSettings.add_member(:execute_timeout, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "ExecuteTimeout"))
|
1107
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"))
|
1108
1120
|
PostgreSQLSettings.add_member(:password, Shapes::ShapeRef.new(shape: SecretString, location_name: "Password"))
|
1109
1121
|
PostgreSQLSettings.add_member(:port, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Port"))
|
1110
1122
|
PostgreSQLSettings.add_member(:server_name, Shapes::ShapeRef.new(shape: String, location_name: "ServerName"))
|
1111
1123
|
PostgreSQLSettings.add_member(:username, Shapes::ShapeRef.new(shape: String, location_name: "Username"))
|
1112
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"))
|
1113
1126
|
PostgreSQLSettings.add_member(:secrets_manager_access_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerAccessRoleArn"))
|
1114
1127
|
PostgreSQLSettings.add_member(:secrets_manager_secret_id, Shapes::ShapeRef.new(shape: String, location_name: "SecretsManagerSecretId"))
|
1115
1128
|
PostgreSQLSettings.struct_class = Types::PostgreSQLSettings
|
@@ -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",
|
@@ -425,6 +426,7 @@ module Aws::DatabaseMigrationService
|
|
425
426
|
# ssl_ca_certificate_arn: "String",
|
426
427
|
# sasl_username: "String",
|
427
428
|
# sasl_password: "SecretString",
|
429
|
+
# no_hex_prefix: false,
|
428
430
|
# },
|
429
431
|
# elasticsearch_settings: {
|
430
432
|
# service_access_role_arn: "String", # required
|
@@ -481,11 +483,15 @@ module Aws::DatabaseMigrationService
|
|
481
483
|
# ddl_artifacts_schema: "String",
|
482
484
|
# execute_timeout: 1,
|
483
485
|
# fail_tasks_on_lob_truncation: false,
|
486
|
+
# heartbeat_enable: false,
|
487
|
+
# heartbeat_schema: "String",
|
488
|
+
# heartbeat_frequency: 1,
|
484
489
|
# password: "SecretString",
|
485
490
|
# port: 1,
|
486
491
|
# server_name: "String",
|
487
492
|
# username: "String",
|
488
493
|
# slot_name: "String",
|
494
|
+
# plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
|
489
495
|
# secrets_manager_access_role_arn: "String",
|
490
496
|
# secrets_manager_secret_id: "String",
|
491
497
|
# },
|
@@ -536,7 +542,11 @@ module Aws::DatabaseMigrationService
|
|
536
542
|
# security_db_encryption_name: "String",
|
537
543
|
# server_name: "String",
|
538
544
|
# spatial_data_option_to_geo_json_function_name: "String",
|
545
|
+
# standby_delay_time: 1,
|
539
546
|
# username: "String",
|
547
|
+
# use_b_file: false,
|
548
|
+
# use_direct_path_full_load: false,
|
549
|
+
# use_logminer_reader: false,
|
540
550
|
# secrets_manager_access_role_arn: "String",
|
541
551
|
# secrets_manager_secret_id: "String",
|
542
552
|
# secrets_manager_oracle_asm_access_role_arn: "String",
|
@@ -631,7 +641,8 @@ module Aws::DatabaseMigrationService
|
|
631
641
|
# @return [Integer]
|
632
642
|
#
|
633
643
|
# @!attribute [rw] database_name
|
634
|
-
# 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.
|
635
646
|
# @return [String]
|
636
647
|
#
|
637
648
|
# @!attribute [rw] extra_connection_attributes
|
@@ -639,9 +650,8 @@ module Aws::DatabaseMigrationService
|
|
639
650
|
# is specified as a name-value pair associated by an equal sign (=).
|
640
651
|
# Multiple attributes are separated by a semicolon (;) with no
|
641
652
|
# additional white space. For information on the attributes available
|
642
|
-
# for connecting your source or target endpoint, see [Working with
|
643
|
-
#
|
644
|
-
# Guide.*
|
653
|
+
# for connecting your source or target endpoint, see [Working with DMS
|
654
|
+
# Endpoints][1] in the *Database Migration Service User Guide.*
|
645
655
|
#
|
646
656
|
#
|
647
657
|
#
|
@@ -649,15 +659,14 @@ module Aws::DatabaseMigrationService
|
|
649
659
|
# @return [String]
|
650
660
|
#
|
651
661
|
# @!attribute [rw] kms_key_id
|
652
|
-
# An
|
662
|
+
# An KMS key identifier that is used to encrypt the connection
|
653
663
|
# parameters for the endpoint.
|
654
664
|
#
|
655
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
656
|
-
#
|
665
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
666
|
+
# uses your default encryption key.
|
657
667
|
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
# Region.
|
668
|
+
# KMS creates the default encryption key for your account. Your
|
669
|
+
# account has a different default encryption key for each Region.
|
661
670
|
# @return [String]
|
662
671
|
#
|
663
672
|
# @!attribute [rw] tags
|
@@ -675,7 +684,8 @@ module Aws::DatabaseMigrationService
|
|
675
684
|
#
|
676
685
|
# @!attribute [rw] service_access_role_arn
|
677
686
|
# The Amazon Resource Name (ARN) for the service access role that you
|
678
|
-
# want to use to create the endpoint.
|
687
|
+
# want to use to create the endpoint. The role must allow the
|
688
|
+
# `iam:PassRole` action.
|
679
689
|
# @return [String]
|
680
690
|
#
|
681
691
|
# @!attribute [rw] external_table_definition
|
@@ -685,19 +695,19 @@ module Aws::DatabaseMigrationService
|
|
685
695
|
# @!attribute [rw] dynamo_db_settings
|
686
696
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
687
697
|
# information about other available settings, see [Using Object
|
688
|
-
# Mapping to Migrate Data to DynamoDB][1] in the *
|
689
|
-
#
|
698
|
+
# Mapping to Migrate Data to DynamoDB][1] in the *Database Migration
|
699
|
+
# Service User Guide.*
|
690
700
|
#
|
691
701
|
#
|
692
702
|
#
|
693
|
-
# [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
|
694
704
|
# @return [Types::DynamoDbSettings]
|
695
705
|
#
|
696
706
|
# @!attribute [rw] s3_settings
|
697
707
|
# Settings in JSON format for the target Amazon S3 endpoint. For more
|
698
708
|
# information about the available settings, see [Extra Connection
|
699
|
-
# Attributes When Using Amazon S3 as a Target for
|
700
|
-
# *
|
709
|
+
# Attributes When Using Amazon S3 as a Target for DMS][1] in the
|
710
|
+
# *Database Migration Service User Guide.*
|
701
711
|
#
|
702
712
|
#
|
703
713
|
#
|
@@ -711,27 +721,24 @@ module Aws::DatabaseMigrationService
|
|
711
721
|
# Possible settings include the following:
|
712
722
|
#
|
713
723
|
# * `ServiceAccessRoleArn` - The IAM role that has permission to
|
714
|
-
# access the Amazon S3 bucket.
|
724
|
+
# access the Amazon S3 bucket. The role must allow the
|
725
|
+
# `iam:PassRole` action.
|
715
726
|
#
|
716
727
|
# * `BucketName` - The name of the S3 bucket to use.
|
717
728
|
#
|
718
|
-
# * `CompressionType` - An optional parameter to use GZIP to compress
|
719
|
-
# the target files. To use GZIP, set this value to `NONE` (the
|
720
|
-
# default). To keep the files uncompressed, don't use this value.
|
721
|
-
#
|
722
729
|
# Shorthand syntax for these settings is as follows:
|
723
|
-
# `ServiceAccessRoleArn=string,BucketName=string
|
730
|
+
# `ServiceAccessRoleArn=string,BucketName=string`
|
724
731
|
#
|
725
732
|
# JSON syntax for these settings is as follows: `\{
|
726
|
-
# "ServiceAccessRoleArn": "string", "BucketName": "string",
|
727
|
-
# "CompressionType": "none"|"gzip" \} `
|
733
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string", \} `
|
728
734
|
# @return [Types::DmsTransferSettings]
|
729
735
|
#
|
730
736
|
# @!attribute [rw] mongo_db_settings
|
731
737
|
# Settings in JSON format for the source MongoDB endpoint. For more
|
732
|
-
# information about the available settings, see [
|
733
|
-
#
|
734
|
-
# 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.*
|
735
742
|
#
|
736
743
|
#
|
737
744
|
#
|
@@ -741,31 +748,30 @@ module Aws::DatabaseMigrationService
|
|
741
748
|
# @!attribute [rw] kinesis_settings
|
742
749
|
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
743
750
|
# Data Streams. For more information about the available settings, see
|
744
|
-
# [Using
|
745
|
-
#
|
746
|
-
# Guide.*
|
751
|
+
# [Using object mapping to migrate data to a Kinesis data stream][1]
|
752
|
+
# in the *Database Migration Service User Guide.*
|
747
753
|
#
|
748
754
|
#
|
749
755
|
#
|
750
|
-
# [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
|
751
757
|
# @return [Types::KinesisSettings]
|
752
758
|
#
|
753
759
|
# @!attribute [rw] kafka_settings
|
754
760
|
# Settings in JSON format for the target Apache Kafka endpoint. For
|
755
|
-
# more information about the available settings, see [Using
|
756
|
-
#
|
757
|
-
#
|
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.*
|
758
764
|
#
|
759
765
|
#
|
760
766
|
#
|
761
|
-
# [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
|
762
768
|
# @return [Types::KafkaSettings]
|
763
769
|
#
|
764
770
|
# @!attribute [rw] elasticsearch_settings
|
765
771
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
766
772
|
# more information about the available settings, see [Extra Connection
|
767
|
-
# Attributes When Using Elasticsearch as a Target for
|
768
|
-
#
|
773
|
+
# Attributes When Using Elasticsearch as a Target for DMS][1] in the
|
774
|
+
# *Database Migration Service User Guide*.
|
769
775
|
#
|
770
776
|
#
|
771
777
|
#
|
@@ -775,8 +781,8 @@ module Aws::DatabaseMigrationService
|
|
775
781
|
# @!attribute [rw] neptune_settings
|
776
782
|
# Settings in JSON format for the target Amazon Neptune endpoint. For
|
777
783
|
# more information about the available settings, see [Specifying
|
778
|
-
#
|
779
|
-
# 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.*
|
780
786
|
#
|
781
787
|
#
|
782
788
|
#
|
@@ -790,80 +796,78 @@ module Aws::DatabaseMigrationService
|
|
790
796
|
# @!attribute [rw] postgre_sql_settings
|
791
797
|
# Settings in JSON format for the source and target PostgreSQL
|
792
798
|
# endpoint. For information about other available settings, see [Extra
|
793
|
-
# connection attributes when using PostgreSQL as a source for
|
794
|
-
#
|
795
|
-
#
|
796
|
-
# 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.*
|
797
802
|
#
|
798
803
|
#
|
799
804
|
#
|
800
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html
|
801
|
-
# [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
|
802
807
|
# @return [Types::PostgreSQLSettings]
|
803
808
|
#
|
804
809
|
# @!attribute [rw] my_sql_settings
|
805
810
|
# Settings in JSON format for the source and target MySQL endpoint.
|
806
811
|
# For information about other available settings, see [Extra
|
807
|
-
# connection attributes when using MySQL as a source for
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
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.*
|
811
816
|
#
|
812
817
|
#
|
813
818
|
#
|
814
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html
|
815
|
-
# [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
|
816
821
|
# @return [Types::MySQLSettings]
|
817
822
|
#
|
818
823
|
# @!attribute [rw] oracle_settings
|
819
824
|
# Settings in JSON format for the source and target Oracle endpoint.
|
820
825
|
# For information about other available settings, see [Extra
|
821
|
-
# connection attributes when using Oracle as a source for
|
822
|
-
#
|
823
|
-
#
|
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.*
|
824
829
|
#
|
825
830
|
#
|
826
831
|
#
|
827
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html
|
828
|
-
# [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
|
829
834
|
# @return [Types::OracleSettings]
|
830
835
|
#
|
831
836
|
# @!attribute [rw] sybase_settings
|
832
837
|
# Settings in JSON format for the source and target SAP ASE endpoint.
|
833
838
|
# For information about other available settings, see [Extra
|
834
|
-
# connection attributes when using SAP ASE as a source for
|
835
|
-
#
|
836
|
-
#
|
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.*
|
837
842
|
#
|
838
843
|
#
|
839
844
|
#
|
840
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html
|
841
|
-
# [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
|
842
847
|
# @return [Types::SybaseSettings]
|
843
848
|
#
|
844
849
|
# @!attribute [rw] microsoft_sql_server_settings
|
845
850
|
# Settings in JSON format for the source and target Microsoft SQL
|
846
851
|
# Server endpoint. For information about other available settings, see
|
847
852
|
# [Extra connection attributes when using SQL Server as a source for
|
848
|
-
#
|
849
|
-
#
|
850
|
-
# 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.*
|
851
855
|
#
|
852
856
|
#
|
853
857
|
#
|
854
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html
|
855
|
-
# [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
|
856
860
|
# @return [Types::MicrosoftSQLServerSettings]
|
857
861
|
#
|
858
862
|
# @!attribute [rw] ibm_db_2_settings
|
859
863
|
# Settings in JSON format for the source IBM Db2 LUW endpoint. For
|
860
864
|
# information about other available settings, see [Extra connection
|
861
|
-
# attributes when using Db2 LUW as a source for
|
862
|
-
# *
|
865
|
+
# attributes when using Db2 LUW as a source for DMS][1] in the
|
866
|
+
# *Database Migration Service User Guide.*
|
863
867
|
#
|
864
868
|
#
|
865
869
|
#
|
866
|
-
# [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
|
867
871
|
# @return [Types::IBMDb2Settings]
|
868
872
|
#
|
869
873
|
# @!attribute [rw] resource_identifier
|
@@ -876,8 +880,8 @@ module Aws::DatabaseMigrationService
|
|
876
880
|
# `Example-App-ARN1`. For example, this value might result in the
|
877
881
|
# `EndpointArn` value
|
878
882
|
# `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you
|
879
|
-
# don't specify a `ResourceIdentifier` value,
|
880
|
-
#
|
883
|
+
# don't specify a `ResourceIdentifier` value, DMS generates a default
|
884
|
+
# identifier value for the end of `EndpointArn`.
|
881
885
|
# @return [String]
|
882
886
|
#
|
883
887
|
# @!attribute [rw] doc_db_settings
|
@@ -954,8 +958,8 @@ module Aws::DatabaseMigrationService
|
|
954
958
|
# }
|
955
959
|
#
|
956
960
|
# @!attribute [rw] subscription_name
|
957
|
-
# The name of the
|
958
|
-
#
|
961
|
+
# The name of the DMS event notification subscription. This name must
|
962
|
+
# be less than 255 characters.
|
959
963
|
# @return [String]
|
960
964
|
#
|
961
965
|
# @!attribute [rw] sns_topic_arn
|
@@ -965,8 +969,8 @@ module Aws::DatabaseMigrationService
|
|
965
969
|
# @return [String]
|
966
970
|
#
|
967
971
|
# @!attribute [rw] source_type
|
968
|
-
# The type of
|
969
|
-
#
|
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
|
970
974
|
# instance, you set this parameter to `replication-instance`. If this
|
971
975
|
# value isn't specified, all events are returned.
|
972
976
|
#
|
@@ -976,8 +980,7 @@ module Aws::DatabaseMigrationService
|
|
976
980
|
# @!attribute [rw] event_categories
|
977
981
|
# A list of event categories for a source type that you want to
|
978
982
|
# subscribe to. For more information, see [Working with Events and
|
979
|
-
# Notifications][1] in the *
|
980
|
-
# Guide.*
|
983
|
+
# Notifications][1] in the *Database Migration Service User Guide.*
|
981
984
|
#
|
982
985
|
#
|
983
986
|
#
|
@@ -985,8 +988,7 @@ module Aws::DatabaseMigrationService
|
|
985
988
|
# @return [Array<String>]
|
986
989
|
#
|
987
990
|
# @!attribute [rw] source_ids
|
988
|
-
# A list of identifiers for which
|
989
|
-
# events.
|
991
|
+
# A list of identifiers for which DMS provides notification events.
|
990
992
|
#
|
991
993
|
# If you don't specify a value, notifications are provided for all
|
992
994
|
# sources.
|
@@ -1085,7 +1087,7 @@ module Aws::DatabaseMigrationService
|
|
1085
1087
|
#
|
1086
1088
|
# For more information on the settings and capacities for the
|
1087
1089
|
# available replication instance classes, see [ Selecting the right
|
1088
|
-
#
|
1090
|
+
# DMS replication instance for your migration][1].
|
1089
1091
|
#
|
1090
1092
|
#
|
1091
1093
|
#
|
@@ -1101,7 +1103,7 @@ module Aws::DatabaseMigrationService
|
|
1101
1103
|
# @!attribute [rw] availability_zone
|
1102
1104
|
# The Availability Zone where the replication instance will be
|
1103
1105
|
# created. The default value is a random, system-chosen Availability
|
1104
|
-
# Zone in the endpoint's
|
1106
|
+
# Zone in the endpoint's Region, for example: `us-east-1d`
|
1105
1107
|
# @return [String]
|
1106
1108
|
#
|
1107
1109
|
# @!attribute [rw] replication_subnet_group_identifier
|
@@ -1115,7 +1117,7 @@ module Aws::DatabaseMigrationService
|
|
1115
1117
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1116
1118
|
#
|
1117
1119
|
# Default: A 30-minute window selected at random from an 8-hour block
|
1118
|
-
# of time per
|
1120
|
+
# of time per Region, occurring on a random day of the week.
|
1119
1121
|
#
|
1120
1122
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1121
1123
|
#
|
@@ -1149,15 +1151,14 @@ module Aws::DatabaseMigrationService
|
|
1149
1151
|
# @return [Array<Types::Tag>]
|
1150
1152
|
#
|
1151
1153
|
# @!attribute [rw] kms_key_id
|
1152
|
-
# An
|
1154
|
+
# An KMS key identifier that is used to encrypt the data on the
|
1153
1155
|
# replication instance.
|
1154
1156
|
#
|
1155
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
1156
|
-
#
|
1157
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
1158
|
+
# uses your default encryption key.
|
1157
1159
|
#
|
1158
|
-
#
|
1159
|
-
#
|
1160
|
-
# Region.
|
1160
|
+
# KMS creates the default encryption key for your account. Your
|
1161
|
+
# account has a different default encryption key for each Region.
|
1161
1162
|
# @return [String]
|
1162
1163
|
#
|
1163
1164
|
# @!attribute [rw] publicly_accessible
|
@@ -1186,8 +1187,8 @@ module Aws::DatabaseMigrationService
|
|
1186
1187
|
# `Example-App-ARN1`. For example, this value might result in the
|
1187
1188
|
# `EndpointArn` value
|
1188
1189
|
# `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you
|
1189
|
-
# don't specify a `ResourceIdentifier` value,
|
1190
|
-
#
|
1190
|
+
# don't specify a `ResourceIdentifier` value, DMS generates a default
|
1191
|
+
# identifier value for the end of `EndpointArn`.
|
1191
1192
|
# @return [String]
|
1192
1193
|
#
|
1193
1194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateReplicationInstanceMessage AWS API Documentation
|
@@ -1342,7 +1343,7 @@ module Aws::DatabaseMigrationService
|
|
1342
1343
|
# @!attribute [rw] table_mappings
|
1343
1344
|
# The table mappings for the task, in JSON format. For more
|
1344
1345
|
# information, see [Using Table Mapping to Specify Task Settings][1]
|
1345
|
-
# in the *
|
1346
|
+
# in the *Database Migration Service User Guide.*
|
1346
1347
|
#
|
1347
1348
|
#
|
1348
1349
|
#
|
@@ -1351,8 +1352,8 @@ module Aws::DatabaseMigrationService
|
|
1351
1352
|
#
|
1352
1353
|
# @!attribute [rw] replication_task_settings
|
1353
1354
|
# Overall settings for the task, in JSON format. For more information,
|
1354
|
-
# see [Specifying Task Settings for
|
1355
|
-
# Tasks][1] in the *
|
1355
|
+
# see [Specifying Task Settings for Database Migration Service
|
1356
|
+
# Tasks][1] in the *Database Migration Service User Guide.*
|
1356
1357
|
#
|
1357
1358
|
#
|
1358
1359
|
#
|
@@ -1388,7 +1389,7 @@ module Aws::DatabaseMigrationService
|
|
1388
1389
|
# with the source endpoint. You can verify this by setting the
|
1389
1390
|
# `slotName` extra connection attribute to the name of this logical
|
1390
1391
|
# replication slot. For more information, see [Extra Connection
|
1391
|
-
# Attributes When Using PostgreSQL as a Source for
|
1392
|
+
# Attributes When Using PostgreSQL as a Source for DMS][1].
|
1392
1393
|
#
|
1393
1394
|
# </note>
|
1394
1395
|
#
|
@@ -1415,8 +1416,8 @@ module Aws::DatabaseMigrationService
|
|
1415
1416
|
# @!attribute [rw] task_data
|
1416
1417
|
# Supplemental information that the task requires to migrate the data
|
1417
1418
|
# for certain source and target endpoints. For more information, see
|
1418
|
-
# [Specifying Supplemental Data for Task Settings][1] in the *
|
1419
|
-
#
|
1419
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *Database
|
1420
|
+
# Migration Service User Guide.*
|
1420
1421
|
#
|
1421
1422
|
#
|
1422
1423
|
#
|
@@ -1433,8 +1434,8 @@ module Aws::DatabaseMigrationService
|
|
1433
1434
|
# `Example-App-ARN1`. For example, this value might result in the
|
1434
1435
|
# `EndpointArn` value
|
1435
1436
|
# `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you
|
1436
|
-
# don't specify a `ResourceIdentifier` value,
|
1437
|
-
#
|
1437
|
+
# don't specify a `ResourceIdentifier` value, DMS generates a default
|
1438
|
+
# identifier value for the end of `EndpointArn`.
|
1438
1439
|
# @return [String]
|
1439
1440
|
#
|
1440
1441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/CreateReplicationTaskMessage AWS API Documentation
|
@@ -1732,16 +1733,16 @@ module Aws::DatabaseMigrationService
|
|
1732
1733
|
# @return [Array<Types::AccountQuota>]
|
1733
1734
|
#
|
1734
1735
|
# @!attribute [rw] unique_account_identifier
|
1735
|
-
# A unique
|
1736
|
-
#
|
1737
|
-
#
|
1738
|
-
#
|
1739
|
-
#
|
1740
|
-
#
|
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:
|
1741
1742
|
# `dms-AccountNumber-UniqueAccountIdentifier.` Here is an example name
|
1742
1743
|
# for this default S3 bucket: `dms-111122223333-c44445555666`.
|
1743
1744
|
#
|
1744
|
-
# <note markdown="1">
|
1745
|
+
# <note markdown="1"> DMS supports the `UniqueAccountIdentifier` parameter in versions
|
1745
1746
|
# 3.1.4 and later.
|
1746
1747
|
#
|
1747
1748
|
# </note>
|
@@ -1827,7 +1828,7 @@ module Aws::DatabaseMigrationService
|
|
1827
1828
|
# request parameters. For more information on the available individual
|
1828
1829
|
# assessments, including compatibility with different migration task
|
1829
1830
|
# configurations, see [Working with premigration assessment runs][1]
|
1830
|
-
# in the *
|
1831
|
+
# in the *Database Migration Service User Guide.*
|
1831
1832
|
#
|
1832
1833
|
#
|
1833
1834
|
#
|
@@ -2181,7 +2182,7 @@ module Aws::DatabaseMigrationService
|
|
2181
2182
|
# }
|
2182
2183
|
#
|
2183
2184
|
# @!attribute [rw] source_type
|
2184
|
-
# The type of
|
2185
|
+
# The type of DMS resource that generates events.
|
2185
2186
|
#
|
2186
2187
|
# Valid values: replication-instance \| replication-task
|
2187
2188
|
# @return [String]
|
@@ -2227,7 +2228,7 @@ module Aws::DatabaseMigrationService
|
|
2227
2228
|
# }
|
2228
2229
|
#
|
2229
2230
|
# @!attribute [rw] subscription_name
|
2230
|
-
# The name of the
|
2231
|
+
# The name of the DMS event subscription to be described.
|
2231
2232
|
# @return [String]
|
2232
2233
|
#
|
2233
2234
|
# @!attribute [rw] filters
|
@@ -2306,7 +2307,7 @@ module Aws::DatabaseMigrationService
|
|
2306
2307
|
# @return [String]
|
2307
2308
|
#
|
2308
2309
|
# @!attribute [rw] source_type
|
2309
|
-
# The type of
|
2310
|
+
# The type of DMS resource that generates events.
|
2310
2311
|
#
|
2311
2312
|
# Valid values: replication-instance \| replication-task
|
2312
2313
|
# @return [String]
|
@@ -3162,6 +3163,9 @@ module Aws::DatabaseMigrationService
|
|
3162
3163
|
#
|
3163
3164
|
# @!attribute [rw] service_access_role_arn
|
3164
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.
|
3165
3169
|
# @return [String]
|
3166
3170
|
#
|
3167
3171
|
# @!attribute [rw] bucket_name
|
@@ -3240,20 +3244,20 @@ module Aws::DatabaseMigrationService
|
|
3240
3244
|
# @return [Integer]
|
3241
3245
|
#
|
3242
3246
|
# @!attribute [rw] kms_key_id
|
3243
|
-
# The
|
3244
|
-
#
|
3245
|
-
# `KmsKeyId` parameter, then
|
3246
|
-
#
|
3247
|
-
#
|
3248
|
-
# 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.
|
3249
3252
|
# @return [String]
|
3250
3253
|
#
|
3251
3254
|
# @!attribute [rw] secrets_manager_access_role_arn
|
3252
3255
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
3253
|
-
#
|
3254
|
-
# access the value in `SecretsManagerSecret`.
|
3255
|
-
# has the value of the
|
3256
|
-
# 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.
|
3257
3261
|
#
|
3258
3262
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
3259
3263
|
# can specify the values for this setting and
|
@@ -3261,15 +3265,15 @@ module Aws::DatabaseMigrationService
|
|
3261
3265
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
3262
3266
|
# both. For more information on creating this `SecretsManagerSecret`
|
3263
3267
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
3264
|
-
# required to access it, see [Using secrets to access
|
3265
|
-
# Migration Service resources][1] in the *
|
3266
|
-
#
|
3268
|
+
# required to access it, see [Using secrets to access Database
|
3269
|
+
# Migration Service resources][1] in the *Database Migration Service
|
3270
|
+
# User Guide*.
|
3267
3271
|
#
|
3268
3272
|
# </note>
|
3269
3273
|
#
|
3270
3274
|
#
|
3271
3275
|
#
|
3272
|
-
# [1]: https://docs.aws.amazon.com/
|
3276
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
3273
3277
|
# @return [String]
|
3274
3278
|
#
|
3275
3279
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -3296,7 +3300,7 @@ module Aws::DatabaseMigrationService
|
|
3296
3300
|
include Aws::Structure
|
3297
3301
|
end
|
3298
3302
|
|
3299
|
-
# Provides the Amazon Resource Name (ARN) of the
|
3303
|
+
# Provides the Amazon Resource Name (ARN) of the Identity and Access
|
3300
3304
|
# Management (IAM) role used to define an Amazon DynamoDB target
|
3301
3305
|
# endpoint.
|
3302
3306
|
#
|
@@ -3308,7 +3312,8 @@ module Aws::DatabaseMigrationService
|
|
3308
3312
|
# }
|
3309
3313
|
#
|
3310
3314
|
# @!attribute [rw] service_access_role_arn
|
3311
|
-
# 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.
|
3312
3317
|
# @return [String]
|
3313
3318
|
#
|
3314
3319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DynamoDbSettings AWS API Documentation
|
@@ -3332,12 +3337,12 @@ module Aws::DatabaseMigrationService
|
|
3332
3337
|
# }
|
3333
3338
|
#
|
3334
3339
|
# @!attribute [rw] service_access_role_arn
|
3335
|
-
# The Amazon Resource Name (ARN) used by service to access the IAM
|
3336
|
-
# 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.
|
3337
3342
|
# @return [String]
|
3338
3343
|
#
|
3339
3344
|
# @!attribute [rw] endpoint_uri
|
3340
|
-
# The endpoint for the Elasticsearch cluster.
|
3345
|
+
# The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a
|
3341
3346
|
# transport protocol (http/https) is not specified.
|
3342
3347
|
# @return [String]
|
3343
3348
|
#
|
@@ -3375,8 +3380,6 @@ module Aws::DatabaseMigrationService
|
|
3375
3380
|
#
|
3376
3381
|
# * `DescribeEndpoint`
|
3377
3382
|
#
|
3378
|
-
# * `DescribeEndpointTypes`
|
3379
|
-
#
|
3380
3383
|
# * `ModifyEndpoint`
|
3381
3384
|
#
|
3382
3385
|
# @!attribute [rw] endpoint_identifier
|
@@ -3429,15 +3432,14 @@ module Aws::DatabaseMigrationService
|
|
3429
3432
|
# @return [String]
|
3430
3433
|
#
|
3431
3434
|
# @!attribute [rw] kms_key_id
|
3432
|
-
# An
|
3435
|
+
# An KMS key identifier that is used to encrypt the connection
|
3433
3436
|
# parameters for the endpoint.
|
3434
3437
|
#
|
3435
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
3436
|
-
#
|
3438
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
3439
|
+
# uses your default encryption key.
|
3437
3440
|
#
|
3438
|
-
#
|
3439
|
-
#
|
3440
|
-
# Region.
|
3441
|
+
# KMS creates the default encryption key for your account. Your
|
3442
|
+
# account has a different default encryption key for each Region.
|
3441
3443
|
# @return [String]
|
3442
3444
|
#
|
3443
3445
|
# @!attribute [rw] endpoint_arn
|
@@ -3456,7 +3458,8 @@ module Aws::DatabaseMigrationService
|
|
3456
3458
|
# @return [String]
|
3457
3459
|
#
|
3458
3460
|
# @!attribute [rw] service_access_role_arn
|
3459
|
-
# 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.
|
3460
3463
|
# @return [String]
|
3461
3464
|
#
|
3462
3465
|
# @!attribute [rw] external_table_definition
|
@@ -3486,20 +3489,16 @@ module Aws::DatabaseMigrationService
|
|
3486
3489
|
# Possible settings include the following:
|
3487
3490
|
#
|
3488
3491
|
# * `ServiceAccessRoleArn` - The IAM role that has permission to
|
3489
|
-
# access the Amazon S3 bucket.
|
3492
|
+
# access the Amazon S3 bucket. The role must allow the
|
3493
|
+
# `iam:PassRole` action.
|
3490
3494
|
#
|
3491
3495
|
# * `BucketName` - The name of the S3 bucket to use.
|
3492
3496
|
#
|
3493
|
-
# * `CompressionType` - An optional parameter to use GZIP to compress
|
3494
|
-
# the target files. To use GZIP, set this value to `NONE` (the
|
3495
|
-
# default). To keep the files uncompressed, don't use this value.
|
3496
|
-
#
|
3497
3497
|
# Shorthand syntax for these settings is as follows:
|
3498
|
-
# `ServiceAccessRoleArn=string,BucketName=string
|
3498
|
+
# `ServiceAccessRoleArn=string,BucketName=string,`
|
3499
3499
|
#
|
3500
3500
|
# JSON syntax for these settings is as follows: `\{
|
3501
|
-
# "ServiceAccessRoleArn": "string", "BucketName": "string"
|
3502
|
-
# "CompressionType": "none"|"gzip" \} `
|
3501
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string"\} `
|
3503
3502
|
# @return [Types::DmsTransferSettings]
|
3504
3503
|
#
|
3505
3504
|
# @!attribute [rw] mongo_db_settings
|
@@ -3641,6 +3640,11 @@ module Aws::DatabaseMigrationService
|
|
3641
3640
|
# The maximum value of an endpoint setting that is of type `int`.
|
3642
3641
|
# @return [Integer]
|
3643
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
|
+
#
|
3644
3648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/EndpointSetting AWS API Documentation
|
3645
3649
|
#
|
3646
3650
|
class EndpointSetting < Struct.new(
|
@@ -3651,7 +3655,8 @@ module Aws::DatabaseMigrationService
|
|
3651
3655
|
:units,
|
3652
3656
|
:applicability,
|
3653
3657
|
:int_value_min,
|
3654
|
-
:int_value_max
|
3658
|
+
:int_value_max,
|
3659
|
+
:default_value)
|
3655
3660
|
SENSITIVE = []
|
3656
3661
|
include Aws::Structure
|
3657
3662
|
end
|
@@ -3659,14 +3664,14 @@ module Aws::DatabaseMigrationService
|
|
3659
3664
|
# Describes an identifiable significant activity that affects a
|
3660
3665
|
# replication instance or task. This object can provide the message, the
|
3661
3666
|
# available event categories, the date and source of the event, and the
|
3662
|
-
#
|
3667
|
+
# DMS resource type.
|
3663
3668
|
#
|
3664
3669
|
# @!attribute [rw] source_identifier
|
3665
3670
|
# The identifier of an event source.
|
3666
3671
|
# @return [String]
|
3667
3672
|
#
|
3668
3673
|
# @!attribute [rw] source_type
|
3669
|
-
# The type of
|
3674
|
+
# The type of DMS resource that generates events.
|
3670
3675
|
#
|
3671
3676
|
# Valid values: replication-instance \| endpoint \| replication-task
|
3672
3677
|
# @return [String]
|
@@ -3696,15 +3701,15 @@ module Aws::DatabaseMigrationService
|
|
3696
3701
|
end
|
3697
3702
|
|
3698
3703
|
# Lists categories of events subscribed to, and generated by, the
|
3699
|
-
# applicable
|
3700
|
-
#
|
3704
|
+
# applicable DMS resource type. This data type appears in response to
|
3705
|
+
# the [ `DescribeEventCategories` ][1] action.
|
3701
3706
|
#
|
3702
3707
|
#
|
3703
3708
|
#
|
3704
3709
|
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html
|
3705
3710
|
#
|
3706
3711
|
# @!attribute [rw] source_type
|
3707
|
-
# The type of
|
3712
|
+
# The type of DMS resource that generates events.
|
3708
3713
|
#
|
3709
3714
|
# Valid values: replication-instance \| replication-server \|
|
3710
3715
|
# security-group \| replication-task
|
@@ -3727,38 +3732,38 @@ module Aws::DatabaseMigrationService
|
|
3727
3732
|
# `CreateEventSubscription` operation.
|
3728
3733
|
#
|
3729
3734
|
# @!attribute [rw] customer_aws_id
|
3730
|
-
# The
|
3731
|
-
# notification subscription.
|
3735
|
+
# The Amazon Web Services customer account associated with the DMS
|
3736
|
+
# event notification subscription.
|
3732
3737
|
# @return [String]
|
3733
3738
|
#
|
3734
3739
|
# @!attribute [rw] cust_subscription_id
|
3735
|
-
# The
|
3740
|
+
# The DMS event notification subscription Id.
|
3736
3741
|
# @return [String]
|
3737
3742
|
#
|
3738
3743
|
# @!attribute [rw] sns_topic_arn
|
3739
|
-
# The topic ARN of the
|
3744
|
+
# The topic ARN of the DMS event notification subscription.
|
3740
3745
|
# @return [String]
|
3741
3746
|
#
|
3742
3747
|
# @!attribute [rw] status
|
3743
|
-
# The status of the
|
3748
|
+
# The status of the DMS event notification subscription.
|
3744
3749
|
#
|
3745
3750
|
# Constraints:
|
3746
3751
|
#
|
3747
3752
|
# Can be one of the following: creating \| modifying \| deleting \|
|
3748
3753
|
# active \| no-permission \| topic-not-exist
|
3749
3754
|
#
|
3750
|
-
# The status "no-permission" indicates that
|
3755
|
+
# The status "no-permission" indicates that DMS no longer has
|
3751
3756
|
# permission to post to the SNS topic. The status "topic-not-exist"
|
3752
3757
|
# indicates that the topic was deleted after the subscription was
|
3753
3758
|
# created.
|
3754
3759
|
# @return [String]
|
3755
3760
|
#
|
3756
3761
|
# @!attribute [rw] subscription_creation_time
|
3757
|
-
# The time the
|
3762
|
+
# The time the DMS event notification subscription was created.
|
3758
3763
|
# @return [String]
|
3759
3764
|
#
|
3760
3765
|
# @!attribute [rw] source_type
|
3761
|
-
# The type of
|
3766
|
+
# The type of DMS resource that generates events.
|
3762
3767
|
#
|
3763
3768
|
# Valid values: replication-instance \| replication-server \|
|
3764
3769
|
# security-group \| replication-task
|
@@ -3793,9 +3798,9 @@ module Aws::DatabaseMigrationService
|
|
3793
3798
|
end
|
3794
3799
|
|
3795
3800
|
# Identifies the name and value of a filter object. This filter is used
|
3796
|
-
# to limit the number and type of
|
3797
|
-
#
|
3798
|
-
#
|
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.
|
3799
3804
|
#
|
3800
3805
|
# @note When making an API call, you may pass Filter
|
3801
3806
|
# data as a hash:
|
@@ -3851,7 +3856,7 @@ module Aws::DatabaseMigrationService
|
|
3851
3856
|
# @return [String]
|
3852
3857
|
#
|
3853
3858
|
# @!attribute [rw] port
|
3854
|
-
# Endpoint TCP port.
|
3859
|
+
# Endpoint TCP port. The default value is 50000.
|
3855
3860
|
# @return [Integer]
|
3856
3861
|
#
|
3857
3862
|
# @!attribute [rw] server_name
|
@@ -3879,10 +3884,11 @@ module Aws::DatabaseMigrationService
|
|
3879
3884
|
#
|
3880
3885
|
# @!attribute [rw] secrets_manager_access_role_arn
|
3881
3886
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
3882
|
-
#
|
3883
|
-
# access the value in `SecretsManagerSecret`.
|
3884
|
-
# has the value of the
|
3885
|
-
#
|
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.
|
3886
3892
|
#
|
3887
3893
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
3888
3894
|
# can specify the values for this setting and
|
@@ -3890,15 +3896,15 @@ module Aws::DatabaseMigrationService
|
|
3890
3896
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
3891
3897
|
# both. For more information on creating this `SecretsManagerSecret`
|
3892
3898
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
3893
|
-
# required to access it, see [Using secrets to access
|
3894
|
-
# Migration Service resources][1] in the *
|
3895
|
-
#
|
3899
|
+
# required to access it, see [Using secrets to access Database
|
3900
|
+
# Migration Service resources][1] in the *Database Migration Service
|
3901
|
+
# User Guide*.
|
3896
3902
|
#
|
3897
3903
|
# </note>
|
3898
3904
|
#
|
3899
3905
|
#
|
3900
3906
|
#
|
3901
|
-
# [1]: https://docs.aws.amazon.com/
|
3907
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
3902
3908
|
# @return [String]
|
3903
3909
|
#
|
3904
3910
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -3952,7 +3958,8 @@ module Aws::DatabaseMigrationService
|
|
3952
3958
|
#
|
3953
3959
|
# @!attribute [rw] certificate_wallet
|
3954
3960
|
# The location of an imported Oracle Wallet certificate for use with
|
3955
|
-
# SSL.
|
3961
|
+
# SSL. Provide the name of a `.sso` file using the `fileb://` prefix.
|
3962
|
+
# You can't provide the certificate inline.
|
3956
3963
|
# @return [String]
|
3957
3964
|
#
|
3958
3965
|
# @!attribute [rw] tags
|
@@ -4062,8 +4069,7 @@ module Aws::DatabaseMigrationService
|
|
4062
4069
|
include Aws::Structure
|
4063
4070
|
end
|
4064
4071
|
|
4065
|
-
# An
|
4066
|
-
# AWS KMS.
|
4072
|
+
# An Key Management Service (KMS) error is preventing access to KMS.
|
4067
4073
|
#
|
4068
4074
|
# @!attribute [rw] message
|
4069
4075
|
# @return [String]
|
@@ -4076,8 +4082,7 @@ module Aws::DatabaseMigrationService
|
|
4076
4082
|
include Aws::Structure
|
4077
4083
|
end
|
4078
4084
|
|
4079
|
-
# The state of the specified
|
4080
|
-
# request.
|
4085
|
+
# The state of the specified KMS resource isn't valid for this request.
|
4081
4086
|
#
|
4082
4087
|
# @!attribute [rw] message
|
4083
4088
|
# @return [String]
|
@@ -4090,7 +4095,7 @@ module Aws::DatabaseMigrationService
|
|
4090
4095
|
include Aws::Structure
|
4091
4096
|
end
|
4092
4097
|
|
4093
|
-
#
|
4098
|
+
# DMS cannot access the KMS key.
|
4094
4099
|
#
|
4095
4100
|
# @!attribute [rw] message
|
4096
4101
|
# @return [String]
|
@@ -4103,7 +4108,7 @@ module Aws::DatabaseMigrationService
|
|
4103
4108
|
include Aws::Structure
|
4104
4109
|
end
|
4105
4110
|
|
4106
|
-
# The specified
|
4111
|
+
# The specified KMS entity or resource can't be found.
|
4107
4112
|
#
|
4108
4113
|
# @!attribute [rw] message
|
4109
4114
|
# @return [String]
|
@@ -4116,7 +4121,7 @@ module Aws::DatabaseMigrationService
|
|
4116
4121
|
include Aws::Structure
|
4117
4122
|
end
|
4118
4123
|
|
4119
|
-
# This request triggered
|
4124
|
+
# This request triggered KMS request throttling.
|
4120
4125
|
#
|
4121
4126
|
# @!attribute [rw] message
|
4122
4127
|
# @return [String]
|
@@ -4155,6 +4160,7 @@ module Aws::DatabaseMigrationService
|
|
4155
4160
|
# ssl_ca_certificate_arn: "String",
|
4156
4161
|
# sasl_username: "String",
|
4157
4162
|
# sasl_password: "SecretString",
|
4163
|
+
# no_hex_prefix: false,
|
4158
4164
|
# }
|
4159
4165
|
#
|
4160
4166
|
# @!attribute [rw] broker
|
@@ -4163,8 +4169,8 @@ module Aws::DatabaseMigrationService
|
|
4163
4169
|
# in the form ` broker-hostname-or-ip:port `. For example,
|
4164
4170
|
# `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"`. For more
|
4165
4171
|
# information and examples of specifying a list of broker locations,
|
4166
|
-
# see [Using Apache Kafka as a target for
|
4167
|
-
# Service][1] in the *
|
4172
|
+
# see [Using Apache Kafka as a target for Database Migration
|
4173
|
+
# Service][1] in the *Database Migration Service User Guide*.
|
4168
4174
|
#
|
4169
4175
|
#
|
4170
4176
|
#
|
@@ -4173,8 +4179,7 @@ module Aws::DatabaseMigrationService
|
|
4173
4179
|
#
|
4174
4180
|
# @!attribute [rw] topic
|
4175
4181
|
# The topic to which you migrate the data. If you don't specify a
|
4176
|
-
# topic,
|
4177
|
-
# topic.
|
4182
|
+
# topic, DMS specifies `"kafka-default-topic"` as the migration topic.
|
4178
4183
|
# @return [String]
|
4179
4184
|
#
|
4180
4185
|
# @!attribute [rw] message_format
|
@@ -4192,8 +4197,8 @@ module Aws::DatabaseMigrationService
|
|
4192
4197
|
# @return [Boolean]
|
4193
4198
|
#
|
4194
4199
|
# @!attribute [rw] include_partition_value
|
4195
|
-
# Shows the partition value within the Kafka message output
|
4196
|
-
#
|
4200
|
+
# Shows the partition value within the Kafka message output unless the
|
4201
|
+
# partition type is `schema-table-type`. The default is `false`.
|
4197
4202
|
# @return [Boolean]
|
4198
4203
|
#
|
4199
4204
|
# @!attribute [rw] partition_include_schema_table
|
@@ -4253,12 +4258,12 @@ module Aws::DatabaseMigrationService
|
|
4253
4258
|
#
|
4254
4259
|
# @!attribute [rw] ssl_ca_certificate_arn
|
4255
4260
|
# The Amazon Resource Name (ARN) for the private Certification
|
4256
|
-
# Authority (CA) cert that
|
4257
|
-
#
|
4261
|
+
# Authority (CA) cert that DMS uses to securely connect to your Kafka
|
4262
|
+
# target endpoint.
|
4258
4263
|
# @return [String]
|
4259
4264
|
#
|
4260
4265
|
# @!attribute [rw] sasl_username
|
4261
|
-
# The secure
|
4266
|
+
# The secure user name you created when you first set up your MSK
|
4262
4267
|
# cluster to validate a client identity and make an encrypted
|
4263
4268
|
# connection between server and client using SASL-SSL authentication.
|
4264
4269
|
# @return [String]
|
@@ -4269,6 +4274,13 @@ module Aws::DatabaseMigrationService
|
|
4269
4274
|
# connection between server and client using SASL-SSL authentication.
|
4270
4275
|
# @return [String]
|
4271
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
|
+
#
|
4272
4284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KafkaSettings AWS API Documentation
|
4273
4285
|
#
|
4274
4286
|
class KafkaSettings < Struct.new(
|
@@ -4288,7 +4300,8 @@ module Aws::DatabaseMigrationService
|
|
4288
4300
|
:ssl_client_key_password,
|
4289
4301
|
:ssl_ca_certificate_arn,
|
4290
4302
|
:sasl_username,
|
4291
|
-
:sasl_password
|
4303
|
+
:sasl_password,
|
4304
|
+
:no_hex_prefix)
|
4292
4305
|
SENSITIVE = [:ssl_client_key_password, :sasl_password]
|
4293
4306
|
include Aws::Structure
|
4294
4307
|
end
|
@@ -4311,6 +4324,7 @@ module Aws::DatabaseMigrationService
|
|
4311
4324
|
# include_table_alter_operations: false,
|
4312
4325
|
# include_control_details: false,
|
4313
4326
|
# include_null_and_empty: false,
|
4327
|
+
# no_hex_prefix: false,
|
4314
4328
|
# }
|
4315
4329
|
#
|
4316
4330
|
# @!attribute [rw] stream_arn
|
@@ -4325,9 +4339,9 @@ module Aws::DatabaseMigrationService
|
|
4325
4339
|
# @return [String]
|
4326
4340
|
#
|
4327
4341
|
# @!attribute [rw] service_access_role_arn
|
4328
|
-
# The Amazon Resource Name (ARN) for the
|
4329
|
-
#
|
4330
|
-
#
|
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.
|
4331
4345
|
# @return [String]
|
4332
4346
|
#
|
4333
4347
|
# @!attribute [rw] include_transaction_details
|
@@ -4371,6 +4385,13 @@ module Aws::DatabaseMigrationService
|
|
4371
4385
|
# The default is `false`.
|
4372
4386
|
# @return [Boolean]
|
4373
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
|
+
#
|
4374
4395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KinesisSettings AWS API Documentation
|
4375
4396
|
#
|
4376
4397
|
class KinesisSettings < Struct.new(
|
@@ -4382,7 +4403,8 @@ module Aws::DatabaseMigrationService
|
|
4382
4403
|
:partition_include_schema_table,
|
4383
4404
|
:include_table_alter_operations,
|
4384
4405
|
:include_control_details,
|
4385
|
-
:include_null_and_empty
|
4406
|
+
:include_null_and_empty,
|
4407
|
+
:no_hex_prefix)
|
4386
4408
|
SENSITIVE = []
|
4387
4409
|
include Aws::Structure
|
4388
4410
|
end
|
@@ -4396,7 +4418,7 @@ module Aws::DatabaseMigrationService
|
|
4396
4418
|
#
|
4397
4419
|
# @!attribute [rw] resource_arn
|
4398
4420
|
# The Amazon Resource Name (ARN) string that uniquely identifies the
|
4399
|
-
#
|
4421
|
+
# DMS resource.
|
4400
4422
|
# @return [String]
|
4401
4423
|
#
|
4402
4424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ListTagsForResourceMessage AWS API Documentation
|
@@ -4455,8 +4477,8 @@ module Aws::DatabaseMigrationService
|
|
4455
4477
|
# @return [String]
|
4456
4478
|
#
|
4457
4479
|
# @!attribute [rw] control_tables_file_group
|
4458
|
-
# Specifies a file group for the
|
4459
|
-
# 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
|
4460
4482
|
# (awsdms\_ apply\_exception, awsdms\_apply, awsdms\_changes) are
|
4461
4483
|
# created for the specified file group.
|
4462
4484
|
# @return [String]
|
@@ -4473,7 +4495,7 @@ module Aws::DatabaseMigrationService
|
|
4473
4495
|
# @return [Boolean]
|
4474
4496
|
#
|
4475
4497
|
# @!attribute [rw] read_backup_only
|
4476
|
-
# When this attribute is set to `Y`,
|
4498
|
+
# When this attribute is set to `Y`, DMS only reads changes from
|
4477
4499
|
# transaction log backups and doesn't read from the active
|
4478
4500
|
# transaction log file during ongoing replication. Setting this
|
4479
4501
|
# parameter to `Y` enables you to control active transaction log file
|
@@ -4483,24 +4505,24 @@ module Aws::DatabaseMigrationService
|
|
4483
4505
|
#
|
4484
4506
|
# @!attribute [rw] safeguard_policy
|
4485
4507
|
# Use this attribute to minimize the need to access the backup log and
|
4486
|
-
# enable
|
4508
|
+
# enable DMS to prevent truncation using one of the following two
|
4487
4509
|
# methods.
|
4488
4510
|
#
|
4489
4511
|
# *Start transactions in the database:* This is the default method.
|
4490
|
-
# When this method is used,
|
4491
|
-
#
|
4492
|
-
#
|
4493
|
-
#
|
4494
|
-
#
|
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.
|
4495
4517
|
#
|
4496
4518
|
# *Exclusively use sp\_repldone within a single task*\: When this
|
4497
|
-
# method is used,
|
4498
|
-
#
|
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
|
4499
4521
|
# method doesn't involve any transactional activities, it can only be
|
4500
4522
|
# used when Microsoft Replication isn't running. Also, when using
|
4501
|
-
# this method, only one
|
4502
|
-
#
|
4503
|
-
#
|
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.
|
4504
4526
|
# @return [String]
|
4505
4527
|
#
|
4506
4528
|
# @!attribute [rw] server_name
|
@@ -4525,10 +4547,11 @@ module Aws::DatabaseMigrationService
|
|
4525
4547
|
#
|
4526
4548
|
# @!attribute [rw] secrets_manager_access_role_arn
|
4527
4549
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
4528
|
-
#
|
4529
|
-
# access the value in `SecretsManagerSecret`.
|
4530
|
-
# has the value of the
|
4531
|
-
#
|
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.
|
4532
4555
|
#
|
4533
4556
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
4534
4557
|
# can specify the values for this setting and
|
@@ -4536,15 +4559,15 @@ module Aws::DatabaseMigrationService
|
|
4536
4559
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
4537
4560
|
# both. For more information on creating this `SecretsManagerSecret`
|
4538
4561
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
4539
|
-
# required to access it, see [Using secrets to access
|
4540
|
-
# Migration Service resources][1] in the *
|
4541
|
-
#
|
4562
|
+
# required to access it, see [Using secrets to access Database
|
4563
|
+
# Migration Service resources][1] in the *Database Migration Service
|
4564
|
+
# User Guide*.
|
4542
4565
|
#
|
4543
4566
|
# </note>
|
4544
4567
|
#
|
4545
4568
|
#
|
4546
4569
|
#
|
4547
|
-
# [1]: https://docs.aws.amazon.com/
|
4570
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
4548
4571
|
# @return [String]
|
4549
4572
|
#
|
4550
4573
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -4655,6 +4678,7 @@ module Aws::DatabaseMigrationService
|
|
4655
4678
|
# include_table_alter_operations: false,
|
4656
4679
|
# include_control_details: false,
|
4657
4680
|
# include_null_and_empty: false,
|
4681
|
+
# no_hex_prefix: false,
|
4658
4682
|
# },
|
4659
4683
|
# kafka_settings: {
|
4660
4684
|
# broker: "String",
|
@@ -4674,6 +4698,7 @@ module Aws::DatabaseMigrationService
|
|
4674
4698
|
# ssl_ca_certificate_arn: "String",
|
4675
4699
|
# sasl_username: "String",
|
4676
4700
|
# sasl_password: "SecretString",
|
4701
|
+
# no_hex_prefix: false,
|
4677
4702
|
# },
|
4678
4703
|
# elasticsearch_settings: {
|
4679
4704
|
# service_access_role_arn: "String", # required
|
@@ -4730,11 +4755,15 @@ module Aws::DatabaseMigrationService
|
|
4730
4755
|
# ddl_artifacts_schema: "String",
|
4731
4756
|
# execute_timeout: 1,
|
4732
4757
|
# fail_tasks_on_lob_truncation: false,
|
4758
|
+
# heartbeat_enable: false,
|
4759
|
+
# heartbeat_schema: "String",
|
4760
|
+
# heartbeat_frequency: 1,
|
4733
4761
|
# password: "SecretString",
|
4734
4762
|
# port: 1,
|
4735
4763
|
# server_name: "String",
|
4736
4764
|
# username: "String",
|
4737
4765
|
# slot_name: "String",
|
4766
|
+
# plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
|
4738
4767
|
# secrets_manager_access_role_arn: "String",
|
4739
4768
|
# secrets_manager_secret_id: "String",
|
4740
4769
|
# },
|
@@ -4785,7 +4814,11 @@ module Aws::DatabaseMigrationService
|
|
4785
4814
|
# security_db_encryption_name: "String",
|
4786
4815
|
# server_name: "String",
|
4787
4816
|
# spatial_data_option_to_geo_json_function_name: "String",
|
4817
|
+
# standby_delay_time: 1,
|
4788
4818
|
# username: "String",
|
4819
|
+
# use_b_file: false,
|
4820
|
+
# use_direct_path_full_load: false,
|
4821
|
+
# use_logminer_reader: false,
|
4789
4822
|
# secrets_manager_access_role_arn: "String",
|
4790
4823
|
# secrets_manager_secret_id: "String",
|
4791
4824
|
# secrets_manager_oracle_asm_access_role_arn: "String",
|
@@ -4841,6 +4874,7 @@ module Aws::DatabaseMigrationService
|
|
4841
4874
|
# secrets_manager_access_role_arn: "String",
|
4842
4875
|
# secrets_manager_secret_id: "String",
|
4843
4876
|
# },
|
4877
|
+
# exact_settings: false,
|
4844
4878
|
# }
|
4845
4879
|
#
|
4846
4880
|
# @!attribute [rw] endpoint_arn
|
@@ -4884,7 +4918,8 @@ module Aws::DatabaseMigrationService
|
|
4884
4918
|
# @return [Integer]
|
4885
4919
|
#
|
4886
4920
|
# @!attribute [rw] database_name
|
4887
|
-
# 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.
|
4888
4923
|
# @return [String]
|
4889
4924
|
#
|
4890
4925
|
# @!attribute [rw] extra_connection_attributes
|
@@ -4903,8 +4938,8 @@ module Aws::DatabaseMigrationService
|
|
4903
4938
|
# @return [String]
|
4904
4939
|
#
|
4905
4940
|
# @!attribute [rw] service_access_role_arn
|
4906
|
-
# The Amazon Resource Name (ARN) for the
|
4907
|
-
#
|
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.
|
4908
4943
|
# @return [String]
|
4909
4944
|
#
|
4910
4945
|
# @!attribute [rw] external_table_definition
|
@@ -4914,19 +4949,19 @@ module Aws::DatabaseMigrationService
|
|
4914
4949
|
# @!attribute [rw] dynamo_db_settings
|
4915
4950
|
# Settings in JSON format for the target Amazon DynamoDB endpoint. For
|
4916
4951
|
# information about other available settings, see [Using Object
|
4917
|
-
# Mapping to Migrate Data to DynamoDB][1] in the *
|
4918
|
-
#
|
4952
|
+
# Mapping to Migrate Data to DynamoDB][1] in the *Database Migration
|
4953
|
+
# Service User Guide.*
|
4919
4954
|
#
|
4920
4955
|
#
|
4921
4956
|
#
|
4922
|
-
# [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
|
4923
4958
|
# @return [Types::DynamoDbSettings]
|
4924
4959
|
#
|
4925
4960
|
# @!attribute [rw] s3_settings
|
4926
4961
|
# Settings in JSON format for the target Amazon S3 endpoint. For more
|
4927
4962
|
# information about the available settings, see [Extra Connection
|
4928
|
-
# Attributes When Using Amazon S3 as a Target for
|
4929
|
-
# *
|
4963
|
+
# Attributes When Using Amazon S3 as a Target for DMS][1] in the
|
4964
|
+
# *Database Migration Service User Guide.*
|
4930
4965
|
#
|
4931
4966
|
#
|
4932
4967
|
#
|
@@ -4939,64 +4974,58 @@ module Aws::DatabaseMigrationService
|
|
4939
4974
|
#
|
4940
4975
|
# Attributes include the following:
|
4941
4976
|
#
|
4942
|
-
# * serviceAccessRoleArn - The
|
4943
|
-
#
|
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.
|
4944
4980
|
#
|
4945
4981
|
# * BucketName - The name of the S3 bucket to use.
|
4946
4982
|
#
|
4947
|
-
# * compressionType - An optional parameter to use GZIP to compress
|
4948
|
-
# the target files. Either set this parameter to NONE (the default)
|
4949
|
-
# or don't use it to leave the files uncompressed.
|
4950
|
-
#
|
4951
4983
|
# Shorthand syntax for these settings is as follows:
|
4952
|
-
# `ServiceAccessRoleArn=string
|
4953
|
-
# ,BucketName=string,CompressionType=string`
|
4984
|
+
# `ServiceAccessRoleArn=string ,BucketName=string`
|
4954
4985
|
#
|
4955
4986
|
# JSON syntax for these settings is as follows: `\{
|
4956
|
-
# "ServiceAccessRoleArn": "string", "BucketName": "string"
|
4957
|
-
# "CompressionType": "none"|"gzip" \} `
|
4987
|
+
# "ServiceAccessRoleArn": "string", "BucketName": "string"\} `
|
4958
4988
|
# @return [Types::DmsTransferSettings]
|
4959
4989
|
#
|
4960
4990
|
# @!attribute [rw] mongo_db_settings
|
4961
4991
|
# Settings in JSON format for the source MongoDB endpoint. For more
|
4962
4992
|
# information about the available settings, see the configuration
|
4963
|
-
# properties section in [
|
4964
|
-
# Migration Service][1] in the
|
4965
|
-
# 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.*
|
4966
4996
|
#
|
4967
4997
|
#
|
4968
4998
|
#
|
4969
|
-
# [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
|
4970
5000
|
# @return [Types::MongoDbSettings]
|
4971
5001
|
#
|
4972
5002
|
# @!attribute [rw] kinesis_settings
|
4973
5003
|
# Settings in JSON format for the target endpoint for Amazon Kinesis
|
4974
5004
|
# Data Streams. For more information about the available settings, see
|
4975
|
-
# [Using
|
4976
|
-
#
|
4977
|
-
# Guide.*
|
5005
|
+
# [Using object mapping to migrate data to a Kinesis data stream][1]
|
5006
|
+
# in the *Database Migration Service User Guide.*
|
4978
5007
|
#
|
4979
5008
|
#
|
4980
5009
|
#
|
4981
|
-
# [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
|
4982
5011
|
# @return [Types::KinesisSettings]
|
4983
5012
|
#
|
4984
5013
|
# @!attribute [rw] kafka_settings
|
4985
5014
|
# Settings in JSON format for the target Apache Kafka endpoint. For
|
4986
|
-
# more information about the available settings, see [Using
|
4987
|
-
#
|
4988
|
-
#
|
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.*
|
4989
5018
|
#
|
4990
5019
|
#
|
4991
5020
|
#
|
4992
|
-
# [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
|
4993
5022
|
# @return [Types::KafkaSettings]
|
4994
5023
|
#
|
4995
5024
|
# @!attribute [rw] elasticsearch_settings
|
4996
5025
|
# Settings in JSON format for the target Elasticsearch endpoint. For
|
4997
5026
|
# more information about the available settings, see [Extra Connection
|
4998
|
-
# Attributes When Using Elasticsearch as a Target for
|
4999
|
-
#
|
5027
|
+
# Attributes When Using Elasticsearch as a Target for DMS][1] in the
|
5028
|
+
# *Database Migration Service User Guide.*
|
5000
5029
|
#
|
5001
5030
|
#
|
5002
5031
|
#
|
@@ -5006,8 +5035,8 @@ module Aws::DatabaseMigrationService
|
|
5006
5035
|
# @!attribute [rw] neptune_settings
|
5007
5036
|
# Settings in JSON format for the target Amazon Neptune endpoint. For
|
5008
5037
|
# more information about the available settings, see [Specifying
|
5009
|
-
#
|
5010
|
-
# 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.*
|
5011
5040
|
#
|
5012
5041
|
#
|
5013
5042
|
#
|
@@ -5021,94 +5050,117 @@ module Aws::DatabaseMigrationService
|
|
5021
5050
|
# @!attribute [rw] postgre_sql_settings
|
5022
5051
|
# Settings in JSON format for the source and target PostgreSQL
|
5023
5052
|
# endpoint. For information about other available settings, see [Extra
|
5024
|
-
# connection attributes when using PostgreSQL as a source for
|
5025
|
-
#
|
5026
|
-
#
|
5027
|
-
# 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.*
|
5028
5056
|
#
|
5029
5057
|
#
|
5030
5058
|
#
|
5031
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.ConnectionAttrib
|
5032
|
-
# [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
|
5033
5061
|
# @return [Types::PostgreSQLSettings]
|
5034
5062
|
#
|
5035
5063
|
# @!attribute [rw] my_sql_settings
|
5036
5064
|
# Settings in JSON format for the source and target MySQL endpoint.
|
5037
5065
|
# For information about other available settings, see [Extra
|
5038
|
-
# connection attributes when using MySQL as a source for
|
5039
|
-
#
|
5040
|
-
#
|
5041
|
-
#
|
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.*
|
5042
5070
|
#
|
5043
5071
|
#
|
5044
5072
|
#
|
5045
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.ConnectionAttrib
|
5046
|
-
# [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
|
5047
5075
|
# @return [Types::MySQLSettings]
|
5048
5076
|
#
|
5049
5077
|
# @!attribute [rw] oracle_settings
|
5050
5078
|
# Settings in JSON format for the source and target Oracle endpoint.
|
5051
5079
|
# For information about other available settings, see [Extra
|
5052
|
-
# connection attributes when using Oracle as a source for
|
5053
|
-
#
|
5054
|
-
#
|
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.*
|
5055
5083
|
#
|
5056
5084
|
#
|
5057
5085
|
#
|
5058
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.ConnectionAttrib
|
5059
|
-
# [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
|
5060
5088
|
# @return [Types::OracleSettings]
|
5061
5089
|
#
|
5062
5090
|
# @!attribute [rw] sybase_settings
|
5063
5091
|
# Settings in JSON format for the source and target SAP ASE endpoint.
|
5064
5092
|
# For information about other available settings, see [Extra
|
5065
|
-
# connection attributes when using SAP ASE as a source for
|
5066
|
-
#
|
5067
|
-
#
|
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.*
|
5068
5096
|
#
|
5069
5097
|
#
|
5070
5098
|
#
|
5071
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.ConnectionAttrib
|
5072
|
-
# [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
|
5073
5101
|
# @return [Types::SybaseSettings]
|
5074
5102
|
#
|
5075
5103
|
# @!attribute [rw] microsoft_sql_server_settings
|
5076
5104
|
# Settings in JSON format for the source and target Microsoft SQL
|
5077
5105
|
# Server endpoint. For information about other available settings, see
|
5078
5106
|
# [Extra connection attributes when using SQL Server as a source for
|
5079
|
-
#
|
5080
|
-
#
|
5081
|
-
# 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.*
|
5082
5109
|
#
|
5083
5110
|
#
|
5084
5111
|
#
|
5085
|
-
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.ConnectionAttrib
|
5086
|
-
# [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
|
5087
5114
|
# @return [Types::MicrosoftSQLServerSettings]
|
5088
5115
|
#
|
5089
5116
|
# @!attribute [rw] ibm_db_2_settings
|
5090
5117
|
# Settings in JSON format for the source IBM Db2 LUW endpoint. For
|
5091
5118
|
# information about other available settings, see [Extra connection
|
5092
|
-
# attributes when using Db2 LUW as a source for
|
5093
|
-
# *
|
5119
|
+
# attributes when using Db2 LUW as a source for DMS][1] in the
|
5120
|
+
# *Database Migration Service User Guide.*
|
5094
5121
|
#
|
5095
5122
|
#
|
5096
5123
|
#
|
5097
|
-
# [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
|
5098
5125
|
# @return [Types::IBMDb2Settings]
|
5099
5126
|
#
|
5100
5127
|
# @!attribute [rw] doc_db_settings
|
5101
5128
|
# Settings in JSON format for the source DocumentDB endpoint. For more
|
5102
5129
|
# information about the available settings, see the configuration
|
5103
|
-
# properties section in [ Using DocumentDB as a Target for
|
5104
|
-
#
|
5105
|
-
#
|
5130
|
+
# properties section in [ Using DocumentDB as a Target for Database
|
5131
|
+
# Migration Service ][1] in the *Database Migration Service User
|
5132
|
+
# Guide.*
|
5106
5133
|
#
|
5107
5134
|
#
|
5108
5135
|
#
|
5109
5136
|
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html
|
5110
5137
|
# @return [Types::DocDbSettings]
|
5111
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
|
+
#
|
5112
5164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ModifyEndpointMessage AWS API Documentation
|
5113
5165
|
#
|
5114
5166
|
class ModifyEndpointMessage < Struct.new(
|
@@ -5141,7 +5193,8 @@ module Aws::DatabaseMigrationService
|
|
5141
5193
|
:sybase_settings,
|
5142
5194
|
:microsoft_sql_server_settings,
|
5143
5195
|
:ibm_db_2_settings,
|
5144
|
-
:doc_db_settings
|
5196
|
+
:doc_db_settings,
|
5197
|
+
:exact_settings)
|
5145
5198
|
SENSITIVE = [:password]
|
5146
5199
|
include Aws::Structure
|
5147
5200
|
end
|
@@ -5170,8 +5223,7 @@ module Aws::DatabaseMigrationService
|
|
5170
5223
|
# }
|
5171
5224
|
#
|
5172
5225
|
# @!attribute [rw] subscription_name
|
5173
|
-
# The name of the
|
5174
|
-
# modified.
|
5226
|
+
# The name of the DMS event notification subscription to be modified.
|
5175
5227
|
# @return [String]
|
5176
5228
|
#
|
5177
5229
|
# @!attribute [rw] sns_topic_arn
|
@@ -5181,7 +5233,7 @@ module Aws::DatabaseMigrationService
|
|
5181
5233
|
# @return [String]
|
5182
5234
|
#
|
5183
5235
|
# @!attribute [rw] source_type
|
5184
|
-
# The type of
|
5236
|
+
# The type of DMS resource that generates the events you want to
|
5185
5237
|
# subscribe to.
|
5186
5238
|
#
|
5187
5239
|
# Valid values: replication-instance \| replication-task
|
@@ -5260,7 +5312,7 @@ module Aws::DatabaseMigrationService
|
|
5260
5312
|
#
|
5261
5313
|
# For more information on the settings and capacities for the
|
5262
5314
|
# available replication instance classes, see [ Selecting the right
|
5263
|
-
#
|
5315
|
+
# DMS replication instance for your migration][1].
|
5264
5316
|
#
|
5265
5317
|
#
|
5266
5318
|
#
|
@@ -5327,8 +5379,7 @@ module Aws::DatabaseMigrationService
|
|
5327
5379
|
#
|
5328
5380
|
# * A newer minor version is available.
|
5329
5381
|
#
|
5330
|
-
# *
|
5331
|
-
# version.
|
5382
|
+
# * DMS has enabled automatic patching for the given engine version.
|
5332
5383
|
# @return [Boolean]
|
5333
5384
|
#
|
5334
5385
|
# @!attribute [rw] replication_instance_identifier
|
@@ -5446,10 +5497,10 @@ module Aws::DatabaseMigrationService
|
|
5446
5497
|
# @return [String]
|
5447
5498
|
#
|
5448
5499
|
# @!attribute [rw] table_mappings
|
5449
|
-
# When using the
|
5450
|
-
#
|
5451
|
-
#
|
5452
|
-
#
|
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.
|
5453
5504
|
# @return [String]
|
5454
5505
|
#
|
5455
5506
|
# @!attribute [rw] replication_task_settings
|
@@ -5486,7 +5537,7 @@ module Aws::DatabaseMigrationService
|
|
5486
5537
|
# with the source endpoint. You can verify this by setting the
|
5487
5538
|
# `slotName` extra connection attribute to the name of this logical
|
5488
5539
|
# replication slot. For more information, see [Extra Connection
|
5489
|
-
# Attributes When Using PostgreSQL as a Source for
|
5540
|
+
# Attributes When Using PostgreSQL as a Source for DMS][1].
|
5490
5541
|
#
|
5491
5542
|
# </note>
|
5492
5543
|
#
|
@@ -5509,8 +5560,8 @@ module Aws::DatabaseMigrationService
|
|
5509
5560
|
# @!attribute [rw] task_data
|
5510
5561
|
# Supplemental information that the task requires to migrate the data
|
5511
5562
|
# for certain source and target endpoints. For more information, see
|
5512
|
-
# [Specifying Supplemental Data for Task Settings][1] in the *
|
5513
|
-
#
|
5563
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *Database
|
5564
|
+
# Migration Service User Guide.*
|
5514
5565
|
#
|
5515
5566
|
#
|
5516
5567
|
#
|
@@ -5636,20 +5687,20 @@ module Aws::DatabaseMigrationService
|
|
5636
5687
|
# @return [String]
|
5637
5688
|
#
|
5638
5689
|
# @!attribute [rw] kms_key_id
|
5639
|
-
# The
|
5640
|
-
#
|
5641
|
-
# `KmsKeyId` parameter, then
|
5642
|
-
#
|
5643
|
-
#
|
5644
|
-
# 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.
|
5645
5695
|
# @return [String]
|
5646
5696
|
#
|
5647
5697
|
# @!attribute [rw] secrets_manager_access_role_arn
|
5648
5698
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
5649
|
-
#
|
5650
|
-
# access the value in `SecretsManagerSecret`.
|
5651
|
-
# has the value of the
|
5652
|
-
# 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.
|
5653
5704
|
#
|
5654
5705
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
5655
5706
|
# can specify the values for this setting and
|
@@ -5657,15 +5708,15 @@ module Aws::DatabaseMigrationService
|
|
5657
5708
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
5658
5709
|
# both. For more information on creating this `SecretsManagerSecret`
|
5659
5710
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
5660
|
-
# required to access it, see [Using secrets to access
|
5661
|
-
# Migration Service resources][1] in the *
|
5662
|
-
#
|
5711
|
+
# required to access it, see [Using secrets to access Database
|
5712
|
+
# Migration Service resources][1] in the *Database Migration Service
|
5713
|
+
# User Guide*.
|
5663
5714
|
#
|
5664
5715
|
# </note>
|
5665
5716
|
#
|
5666
5717
|
#
|
5667
5718
|
#
|
5668
|
-
# [1]: https://docs.aws.amazon.com/
|
5719
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
5669
5720
|
# @return [String]
|
5670
5721
|
#
|
5671
5722
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -5756,9 +5807,12 @@ module Aws::DatabaseMigrationService
|
|
5756
5807
|
# }
|
5757
5808
|
#
|
5758
5809
|
# @!attribute [rw] after_connect_script
|
5759
|
-
# Specifies a script to run immediately after
|
5810
|
+
# Specifies a script to run immediately after DMS connects to the
|
5760
5811
|
# endpoint. The migration task continues running regardless if the SQL
|
5761
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.
|
5762
5816
|
# @return [String]
|
5763
5817
|
#
|
5764
5818
|
# @!attribute [rw] clean_source_metadata_on_mismatch
|
@@ -5769,7 +5823,14 @@ module Aws::DatabaseMigrationService
|
|
5769
5823
|
# @return [Boolean]
|
5770
5824
|
#
|
5771
5825
|
# @!attribute [rw] database_name
|
5772
|
-
# 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.
|
5773
5834
|
# @return [String]
|
5774
5835
|
#
|
5775
5836
|
# @!attribute [rw] events_poll_interval
|
@@ -5778,8 +5839,8 @@ module Aws::DatabaseMigrationService
|
|
5778
5839
|
#
|
5779
5840
|
# Example: `eventsPollInterval=5;`
|
5780
5841
|
#
|
5781
|
-
# In the example,
|
5782
|
-
#
|
5842
|
+
# In the example, DMS checks for changes in the binary logs every five
|
5843
|
+
# seconds.
|
5783
5844
|
# @return [Integer]
|
5784
5845
|
#
|
5785
5846
|
# @!attribute [rw] target_db_type
|
@@ -5832,10 +5893,11 @@ module Aws::DatabaseMigrationService
|
|
5832
5893
|
#
|
5833
5894
|
# @!attribute [rw] secrets_manager_access_role_arn
|
5834
5895
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
5835
|
-
#
|
5836
|
-
# access the value in `SecretsManagerSecret`.
|
5837
|
-
# has the value of the
|
5838
|
-
# 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.
|
5839
5901
|
#
|
5840
5902
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
5841
5903
|
# can specify the values for this setting and
|
@@ -5843,15 +5905,15 @@ module Aws::DatabaseMigrationService
|
|
5843
5905
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
5844
5906
|
# both. For more information on creating this `SecretsManagerSecret`
|
5845
5907
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
5846
|
-
# required to access it, see [Using secrets to access
|
5847
|
-
# Migration Service resources][1] in the *
|
5848
|
-
#
|
5908
|
+
# required to access it, see [Using secrets to access Database
|
5909
|
+
# Migration Service resources][1] in the *Database Migration Service
|
5910
|
+
# User Guide*.
|
5849
5911
|
#
|
5850
5912
|
# </note>
|
5851
5913
|
#
|
5852
5914
|
#
|
5853
5915
|
#
|
5854
|
-
# [1]: https://docs.aws.amazon.com/
|
5916
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
5855
5917
|
# @return [String]
|
5856
5918
|
#
|
5857
5919
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -5898,9 +5960,10 @@ module Aws::DatabaseMigrationService
|
|
5898
5960
|
#
|
5899
5961
|
# @!attribute [rw] service_access_role_arn
|
5900
5962
|
# The Amazon Resource Name (ARN) of the service role that you created
|
5901
|
-
# for the Neptune target endpoint.
|
5902
|
-
#
|
5903
|
-
#
|
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>
|
5904
5967
|
#
|
5905
5968
|
#
|
5906
5969
|
#
|
@@ -5908,39 +5971,39 @@ module Aws::DatabaseMigrationService
|
|
5908
5971
|
# @return [String]
|
5909
5972
|
#
|
5910
5973
|
# @!attribute [rw] s3_bucket_name
|
5911
|
-
# The name of the Amazon S3 bucket where
|
5974
|
+
# The name of the Amazon S3 bucket where DMS can temporarily store
|
5912
5975
|
# migrated graph data in .csv files before bulk-loading it to the
|
5913
|
-
# Neptune target database.
|
5914
|
-
#
|
5976
|
+
# Neptune target database. DMS maps the SQL source data to graph data
|
5977
|
+
# before storing it in these .csv files.
|
5915
5978
|
# @return [String]
|
5916
5979
|
#
|
5917
5980
|
# @!attribute [rw] s3_bucket_folder
|
5918
|
-
# A folder path where you want
|
5919
|
-
#
|
5981
|
+
# A folder path where you want DMS to store migrated graph data in the
|
5982
|
+
# S3 bucket specified by `S3BucketName`
|
5920
5983
|
# @return [String]
|
5921
5984
|
#
|
5922
5985
|
# @!attribute [rw] error_retry_duration
|
5923
|
-
# The number of milliseconds for
|
5924
|
-
#
|
5925
|
-
#
|
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.
|
5926
5989
|
# @return [Integer]
|
5927
5990
|
#
|
5928
5991
|
# @!attribute [rw] max_file_size
|
5929
5992
|
# The maximum size in kilobytes of migrated graph data stored in a
|
5930
|
-
# .csv file before
|
5993
|
+
# .csv file before DMS bulk-loads the data to the Neptune target
|
5931
5994
|
# database. The default is 1,048,576 KB. If the bulk load is
|
5932
|
-
# successful,
|
5933
|
-
#
|
5995
|
+
# successful, DMS clears the bucket, ready to store the next batch of
|
5996
|
+
# migrated graph data.
|
5934
5997
|
# @return [Integer]
|
5935
5998
|
#
|
5936
5999
|
# @!attribute [rw] max_retry_count
|
5937
|
-
# The number of times for
|
5938
|
-
#
|
5939
|
-
#
|
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.
|
5940
6003
|
# @return [Integer]
|
5941
6004
|
#
|
5942
6005
|
# @!attribute [rw] iam_auth_enabled
|
5943
|
-
# If you want
|
6006
|
+
# If you want Identity and Access Management (IAM) authorization
|
5944
6007
|
# enabled for this endpoint, set this parameter to `true`. Then attach
|
5945
6008
|
# the appropriate IAM policy document to your service role specified
|
5946
6009
|
# by `ServiceAccessRoleArn`. The default is `false`.
|
@@ -5996,7 +6059,11 @@ module Aws::DatabaseMigrationService
|
|
5996
6059
|
# security_db_encryption_name: "String",
|
5997
6060
|
# server_name: "String",
|
5998
6061
|
# spatial_data_option_to_geo_json_function_name: "String",
|
6062
|
+
# standby_delay_time: 1,
|
5999
6063
|
# username: "String",
|
6064
|
+
# use_b_file: false,
|
6065
|
+
# use_direct_path_full_load: false,
|
6066
|
+
# use_logminer_reader: false,
|
6000
6067
|
# secrets_manager_access_role_arn: "String",
|
6001
6068
|
# secrets_manager_secret_id: "String",
|
6002
6069
|
# secrets_manager_oracle_asm_access_role_arn: "String",
|
@@ -6013,20 +6080,30 @@ module Aws::DatabaseMigrationService
|
|
6013
6080
|
# @return [Boolean]
|
6014
6081
|
#
|
6015
6082
|
# @!attribute [rw] archived_log_dest_id
|
6016
|
-
# Specifies the
|
6017
|
-
# should be the same as
|
6018
|
-
#
|
6019
|
-
#
|
6020
|
-
#
|
6021
|
-
# 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.
|
6022
6089
|
# @return [Integer]
|
6023
6090
|
#
|
6024
6091
|
# @!attribute [rw] additional_archived_log_dest_id
|
6025
|
-
# Set this attribute with `
|
6092
|
+
# Set this attribute with `ArchivedLogDestId` in a primary/ standby
|
6026
6093
|
# setup. This attribute is useful in the case of a switchover. In this
|
6027
|
-
# case,
|
6028
|
-
#
|
6029
|
-
#
|
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
|
6030
6107
|
# @return [Integer]
|
6031
6108
|
#
|
6032
6109
|
# @!attribute [rw] allow_select_nested_tables
|
@@ -6036,7 +6113,7 @@ module Aws::DatabaseMigrationService
|
|
6036
6113
|
#
|
6037
6114
|
# @!attribute [rw] parallel_asm_read_threads
|
6038
6115
|
# Set this attribute to change the number of threads that DMS
|
6039
|
-
# configures to perform a
|
6116
|
+
# configures to perform a change data capture (CDC) load using Oracle
|
6040
6117
|
# Automatic Storage Management (ASM). You can specify an integer value
|
6041
6118
|
# between 2 (the default) and 8 (the maximum). Use this attribute
|
6042
6119
|
# together with the `readAheadBlocks` attribute.
|
@@ -6044,7 +6121,7 @@ module Aws::DatabaseMigrationService
|
|
6044
6121
|
#
|
6045
6122
|
# @!attribute [rw] read_ahead_blocks
|
6046
6123
|
# Set this attribute to change the number of read-ahead blocks that
|
6047
|
-
# DMS configures to perform a
|
6124
|
+
# DMS configures to perform a change data capture (CDC) load using
|
6048
6125
|
# Oracle Automatic Storage Management (ASM). You can specify an
|
6049
6126
|
# integer value between 1000 (the default) and 200,000 (the maximum).
|
6050
6127
|
# @return [Integer]
|
@@ -6097,9 +6174,9 @@ module Aws::DatabaseMigrationService
|
|
6097
6174
|
# @return [Boolean]
|
6098
6175
|
#
|
6099
6176
|
# @!attribute [rw] archived_logs_only
|
6100
|
-
# When this field is set to `Y`,
|
6101
|
-
#
|
6102
|
-
#
|
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.
|
6103
6180
|
# @return [Boolean]
|
6104
6181
|
#
|
6105
6182
|
# @!attribute [rw] asm_password
|
@@ -6158,8 +6235,8 @@ module Aws::DatabaseMigrationService
|
|
6158
6235
|
# @!attribute [rw] direct_path_parallel_load
|
6159
6236
|
# When set to `true`, this attribute specifies a parallel load when
|
6160
6237
|
# `useDirectPathFullLoad` is set to `Y`. This attribute also only
|
6161
|
-
# applies when you use the
|
6162
|
-
#
|
6238
|
+
# applies when you use the DMS parallel load feature. Note that the
|
6239
|
+
# target table cannot have any constraints or indexes.
|
6163
6240
|
# @return [Boolean]
|
6164
6241
|
#
|
6165
6242
|
# @!attribute [rw] fail_tasks_on_lob_truncation
|
@@ -6206,7 +6283,7 @@ module Aws::DatabaseMigrationService
|
|
6206
6283
|
# when you create the endpoint. The `SecurityDbEncryptian` setting is
|
6207
6284
|
# related to this `SecurityDbEncryptionName` setting. For more
|
6208
6285
|
# information, see [ Supported encryption methods for using Oracle as
|
6209
|
-
# a source for
|
6286
|
+
# a source for DMS ][1] in the *Database Migration Service User
|
6210
6287
|
# Guide*.
|
6211
6288
|
#
|
6212
6289
|
#
|
@@ -6222,8 +6299,8 @@ module Aws::DatabaseMigrationService
|
|
6222
6299
|
# information on setting the key name value of
|
6223
6300
|
# `SecurityDbEncryptionName`, see the information and example for
|
6224
6301
|
# setting the `securityDbEncryptionName` extra connection attribute in
|
6225
|
-
# [ Supported encryption methods for using Oracle as a source for
|
6226
|
-
#
|
6302
|
+
# [ Supported encryption methods for using Oracle as a source for DMS
|
6303
|
+
# ][1] in the *Database Migration Service User Guide*.
|
6227
6304
|
#
|
6228
6305
|
#
|
6229
6306
|
#
|
@@ -6242,16 +6319,62 @@ module Aws::DatabaseMigrationService
|
|
6242
6319
|
# `SpatialDataOptionToGeoJsonFunctionName` to call it instead.
|
6243
6320
|
# @return [String]
|
6244
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
|
+
#
|
6245
6334
|
# @!attribute [rw] username
|
6246
6335
|
# Endpoint connection user name.
|
6247
6336
|
# @return [String]
|
6248
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
|
+
#
|
6249
6371
|
# @!attribute [rw] secrets_manager_access_role_arn
|
6250
6372
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
6251
|
-
#
|
6252
|
-
# access the value in `SecretsManagerSecret`.
|
6253
|
-
# has the value of the
|
6254
|
-
# 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.
|
6255
6378
|
#
|
6256
6379
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
6257
6380
|
# can specify the values for this setting and
|
@@ -6259,15 +6382,15 @@ module Aws::DatabaseMigrationService
|
|
6259
6382
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
6260
6383
|
# both. For more information on creating this `SecretsManagerSecret`
|
6261
6384
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
6262
|
-
# required to access it, see [Using secrets to access
|
6263
|
-
# Migration Service resources][1] in the *
|
6264
|
-
#
|
6385
|
+
# required to access it, see [Using secrets to access Database
|
6386
|
+
# Migration Service resources][1] in the *Database Migration Service
|
6387
|
+
# User Guide*.
|
6265
6388
|
#
|
6266
6389
|
# </note>
|
6267
6390
|
#
|
6268
6391
|
#
|
6269
6392
|
#
|
6270
|
-
# [1]: https://docs.aws.amazon.com/
|
6393
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6271
6394
|
# @return [String]
|
6272
6395
|
#
|
6273
6396
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -6278,7 +6401,7 @@ module Aws::DatabaseMigrationService
|
|
6278
6401
|
#
|
6279
6402
|
# @!attribute [rw] secrets_manager_oracle_asm_access_role_arn
|
6280
6403
|
# Required only if your Oracle endpoint uses Advanced Storage Manager
|
6281
|
-
# (ASM). The full ARN of the IAM role that specifies
|
6404
|
+
# (ASM). The full ARN of the IAM role that specifies DMS as the
|
6282
6405
|
# trusted entity and grants the required permissions to access the
|
6283
6406
|
# `SecretsManagerOracleAsmSecret`. This
|
6284
6407
|
# `SecretsManagerOracleAsmSecret` has the secret value that allows
|
@@ -6292,14 +6415,14 @@ module Aws::DatabaseMigrationService
|
|
6292
6415
|
# `SecretsManagerOracleAsmSecret` and the
|
6293
6416
|
# `SecretsManagerOracleAsmAccessRoleArn` and
|
6294
6417
|
# `SecretsManagerOracleAsmSecretId` required to access it, see [Using
|
6295
|
-
# secrets to access
|
6296
|
-
#
|
6418
|
+
# secrets to access Database Migration Service resources][1] in the
|
6419
|
+
# *Database Migration Service User Guide*.
|
6297
6420
|
#
|
6298
6421
|
# </note>
|
6299
6422
|
#
|
6300
6423
|
#
|
6301
6424
|
#
|
6302
|
-
# [1]: https://docs.aws.amazon.com/
|
6425
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6303
6426
|
# @return [String]
|
6304
6427
|
#
|
6305
6428
|
# @!attribute [rw] secrets_manager_oracle_asm_secret_id
|
@@ -6342,7 +6465,11 @@ module Aws::DatabaseMigrationService
|
|
6342
6465
|
:security_db_encryption_name,
|
6343
6466
|
:server_name,
|
6344
6467
|
:spatial_data_option_to_geo_json_function_name,
|
6468
|
+
:standby_delay_time,
|
6345
6469
|
:username,
|
6470
|
+
:use_b_file,
|
6471
|
+
:use_direct_path_full_load,
|
6472
|
+
:use_logminer_reader,
|
6346
6473
|
:secrets_manager_access_role_arn,
|
6347
6474
|
:secrets_manager_secret_id,
|
6348
6475
|
:secrets_manager_oracle_asm_access_role_arn,
|
@@ -6368,7 +6495,7 @@ module Aws::DatabaseMigrationService
|
|
6368
6495
|
#
|
6369
6496
|
# For more information on the settings and capacities for the
|
6370
6497
|
# available replication instance classes, see [ Selecting the right
|
6371
|
-
#
|
6498
|
+
# DMS replication instance for your migration][1].
|
6372
6499
|
#
|
6373
6500
|
#
|
6374
6501
|
#
|
@@ -6408,7 +6535,7 @@ module Aws::DatabaseMigrationService
|
|
6408
6535
|
# replication instance is in Beta or test mode. This indicates some
|
6409
6536
|
# features might not work as expected.
|
6410
6537
|
#
|
6411
|
-
# <note markdown="1">
|
6538
|
+
# <note markdown="1"> DMS supports the `ReleaseStatus` parameter in versions 3.1.4 and
|
6412
6539
|
# later.
|
6413
6540
|
#
|
6414
6541
|
# </note>
|
@@ -6430,9 +6557,9 @@ module Aws::DatabaseMigrationService
|
|
6430
6557
|
include Aws::Structure
|
6431
6558
|
end
|
6432
6559
|
|
6433
|
-
# Describes a maintenance action pending for an
|
6434
|
-
#
|
6435
|
-
#
|
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.
|
6436
6563
|
#
|
6437
6564
|
# @!attribute [rw] action
|
6438
6565
|
# The type of pending maintenance action that is available for the
|
@@ -6497,25 +6624,29 @@ module Aws::DatabaseMigrationService
|
|
6497
6624
|
# ddl_artifacts_schema: "String",
|
6498
6625
|
# execute_timeout: 1,
|
6499
6626
|
# fail_tasks_on_lob_truncation: false,
|
6627
|
+
# heartbeat_enable: false,
|
6628
|
+
# heartbeat_schema: "String",
|
6629
|
+
# heartbeat_frequency: 1,
|
6500
6630
|
# password: "SecretString",
|
6501
6631
|
# port: 1,
|
6502
6632
|
# server_name: "String",
|
6503
6633
|
# username: "String",
|
6504
6634
|
# slot_name: "String",
|
6635
|
+
# plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical
|
6505
6636
|
# secrets_manager_access_role_arn: "String",
|
6506
6637
|
# secrets_manager_secret_id: "String",
|
6507
6638
|
# }
|
6508
6639
|
#
|
6509
6640
|
# @!attribute [rw] after_connect_script
|
6510
|
-
# For use with change data capture (CDC) only, this attribute has
|
6511
|
-
#
|
6512
|
-
#
|
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.
|
6513
6644
|
#
|
6514
6645
|
# Example: `afterConnectScript=SET session_replication_role='replica'`
|
6515
6646
|
# @return [String]
|
6516
6647
|
#
|
6517
6648
|
# @!attribute [rw] capture_ddls
|
6518
|
-
# To capture DDL events,
|
6649
|
+
# To capture DDL events, DMS creates various artifacts in the
|
6519
6650
|
# PostgreSQL database when the task starts. You can later remove these
|
6520
6651
|
# artifacts.
|
6521
6652
|
#
|
@@ -6556,6 +6687,22 @@ module Aws::DatabaseMigrationService
|
|
6556
6687
|
# the task fails instead of truncating the LOB data.
|
6557
6688
|
# @return [Boolean]
|
6558
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
|
+
#
|
6559
6706
|
# @!attribute [rw] password
|
6560
6707
|
# Endpoint connection password.
|
6561
6708
|
# @return [String]
|
@@ -6576,16 +6723,21 @@ module Aws::DatabaseMigrationService
|
|
6576
6723
|
# Sets the name of a previously created logical replication slot for a
|
6577
6724
|
# CDC load of the PostgreSQL source instance.
|
6578
6725
|
#
|
6579
|
-
# When used with the
|
6726
|
+
# When used with the DMS API `CdcStartPosition` request parameter,
|
6580
6727
|
# this attribute also enables using native CDC start points.
|
6581
6728
|
# @return [String]
|
6582
6729
|
#
|
6730
|
+
# @!attribute [rw] plugin_name
|
6731
|
+
# Specifies the plugin to use to create a replication slot.
|
6732
|
+
# @return [String]
|
6733
|
+
#
|
6583
6734
|
# @!attribute [rw] secrets_manager_access_role_arn
|
6584
6735
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
6585
|
-
#
|
6586
|
-
# access the value in `SecretsManagerSecret`.
|
6587
|
-
# has the value of the
|
6588
|
-
# 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.
|
6589
6741
|
#
|
6590
6742
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
6591
6743
|
# can specify the values for this setting and
|
@@ -6593,15 +6745,15 @@ module Aws::DatabaseMigrationService
|
|
6593
6745
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
6594
6746
|
# both. For more information on creating this `SecretsManagerSecret`
|
6595
6747
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
6596
|
-
# required to access it, see [Using secrets to access
|
6597
|
-
# Migration Service resources][1] in the *
|
6598
|
-
#
|
6748
|
+
# required to access it, see [Using secrets to access Database
|
6749
|
+
# Migration Service resources][1] in the *Database Migration Service
|
6750
|
+
# User Guide*.
|
6599
6751
|
#
|
6600
6752
|
# </note>
|
6601
6753
|
#
|
6602
6754
|
#
|
6603
6755
|
#
|
6604
|
-
# [1]: https://docs.aws.amazon.com/
|
6756
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6605
6757
|
# @return [String]
|
6606
6758
|
#
|
6607
6759
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -6620,11 +6772,15 @@ module Aws::DatabaseMigrationService
|
|
6620
6772
|
:ddl_artifacts_schema,
|
6621
6773
|
:execute_timeout,
|
6622
6774
|
:fail_tasks_on_lob_truncation,
|
6775
|
+
:heartbeat_enable,
|
6776
|
+
:heartbeat_schema,
|
6777
|
+
:heartbeat_frequency,
|
6623
6778
|
:password,
|
6624
6779
|
:port,
|
6625
6780
|
:server_name,
|
6626
6781
|
:username,
|
6627
6782
|
:slot_name,
|
6783
|
+
:plugin_name,
|
6628
6784
|
:secrets_manager_access_role_arn,
|
6629
6785
|
:secrets_manager_secret_id)
|
6630
6786
|
SENSITIVE = [:password]
|
@@ -6728,14 +6884,14 @@ module Aws::DatabaseMigrationService
|
|
6728
6884
|
# An S3 folder where the comma-separated-value (.csv) files are stored
|
6729
6885
|
# before being uploaded to the target Redshift cluster.
|
6730
6886
|
#
|
6731
|
-
# For full load mode,
|
6732
|
-
#
|
6733
|
-
#
|
6734
|
-
#
|
6735
|
-
#
|
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
|
6736
6892
|
# Developer Guide*.
|
6737
6893
|
#
|
6738
|
-
# For change-data-capture (CDC) mode,
|
6894
|
+
# For change-data-capture (CDC) mode, DMS creates a *NetChanges*
|
6739
6895
|
# table, and loads the .csv files to this
|
6740
6896
|
# *BucketFolder/NetChangesTableID* path.
|
6741
6897
|
#
|
@@ -6785,7 +6941,7 @@ module Aws::DatabaseMigrationService
|
|
6785
6941
|
# @return [String]
|
6786
6942
|
#
|
6787
6943
|
# @!attribute [rw] empty_as_null
|
6788
|
-
# A value that specifies whether
|
6944
|
+
# A value that specifies whether DMS should migrate empty CHAR and
|
6789
6945
|
# VARCHAR fields as NULL. A value of `true` sets empty CHAR and
|
6790
6946
|
# VARCHAR fields to null. The default is `false`.
|
6791
6947
|
# @return [Boolean]
|
@@ -6802,9 +6958,9 @@ module Aws::DatabaseMigrationService
|
|
6802
6958
|
#
|
6803
6959
|
# </note>
|
6804
6960
|
#
|
6805
|
-
# To use `SSE_S3`, create an
|
6806
|
-
#
|
6807
|
-
#
|
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"`
|
6808
6964
|
# @return [String]
|
6809
6965
|
#
|
6810
6966
|
# @!attribute [rw] explicit_ids
|
@@ -6833,8 +6989,8 @@ module Aws::DatabaseMigrationService
|
|
6833
6989
|
#
|
6834
6990
|
# @!attribute [rw] load_timeout
|
6835
6991
|
# The amount of time to wait (in milliseconds) before timing out of
|
6836
|
-
# operations performed by
|
6837
|
-
#
|
6992
|
+
# operations performed by DMS on a Redshift cluster, such as Redshift
|
6993
|
+
# COPY, INSERT, DELETE, and UPDATE.
|
6838
6994
|
# @return [Integer]
|
6839
6995
|
#
|
6840
6996
|
# @!attribute [rw] max_file_size
|
@@ -6875,14 +7031,14 @@ module Aws::DatabaseMigrationService
|
|
6875
7031
|
#
|
6876
7032
|
# @!attribute [rw] service_access_role_arn
|
6877
7033
|
# The Amazon Resource Name (ARN) of the IAM role that has access to
|
6878
|
-
# the Amazon Redshift service.
|
7034
|
+
# the Amazon Redshift service. The role must allow the `iam:PassRole`
|
7035
|
+
# action.
|
6879
7036
|
# @return [String]
|
6880
7037
|
#
|
6881
7038
|
# @!attribute [rw] server_side_encryption_kms_key_id
|
6882
|
-
# The
|
6883
|
-
#
|
6884
|
-
#
|
6885
|
-
# 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.
|
6886
7042
|
# @return [String]
|
6887
7043
|
#
|
6888
7044
|
# @!attribute [rw] time_format
|
@@ -6923,10 +7079,11 @@ module Aws::DatabaseMigrationService
|
|
6923
7079
|
#
|
6924
7080
|
# @!attribute [rw] secrets_manager_access_role_arn
|
6925
7081
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
6926
|
-
#
|
6927
|
-
# access the value in `SecretsManagerSecret`.
|
6928
|
-
# has the value of the
|
6929
|
-
#
|
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.
|
6930
7087
|
#
|
6931
7088
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
6932
7089
|
# can specify the values for this setting and
|
@@ -6934,15 +7091,15 @@ module Aws::DatabaseMigrationService
|
|
6934
7091
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
6935
7092
|
# both. For more information on creating this `SecretsManagerSecret`
|
6936
7093
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
6937
|
-
# required to access it, see [Using secrets to access
|
6938
|
-
# Migration Service resources][1] in the *
|
6939
|
-
#
|
7094
|
+
# required to access it, see [Using secrets to access Database
|
7095
|
+
# Migration Service resources][1] in the *Database Migration Service
|
7096
|
+
# User Guide*.
|
6940
7097
|
#
|
6941
7098
|
# </note>
|
6942
7099
|
#
|
6943
7100
|
#
|
6944
7101
|
#
|
6945
|
-
# [1]: https://docs.aws.amazon.com/
|
7102
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
6946
7103
|
# @return [String]
|
6947
7104
|
#
|
6948
7105
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -7117,7 +7274,7 @@ module Aws::DatabaseMigrationService
|
|
7117
7274
|
include Aws::Structure
|
7118
7275
|
end
|
7119
7276
|
|
7120
|
-
# Removes one or more tags from an
|
7277
|
+
# Removes one or more tags from an DMS resource.
|
7121
7278
|
#
|
7122
7279
|
# @note When making an API call, you may pass RemoveTagsFromResourceMessage
|
7123
7280
|
# data as a hash:
|
@@ -7128,8 +7285,8 @@ module Aws::DatabaseMigrationService
|
|
7128
7285
|
# }
|
7129
7286
|
#
|
7130
7287
|
# @!attribute [rw] resource_arn
|
7131
|
-
# An
|
7132
|
-
#
|
7288
|
+
# An DMS resource from which you want to remove tag(s). The value for
|
7289
|
+
# this parameter is an Amazon Resource Name (ARN).
|
7133
7290
|
# @return [String]
|
7134
7291
|
#
|
7135
7292
|
# @!attribute [rw] tag_keys
|
@@ -7169,12 +7326,12 @@ module Aws::DatabaseMigrationService
|
|
7169
7326
|
# @!attribute [rw] replication_instance_class
|
7170
7327
|
# The compute and memory capacity of the replication instance as
|
7171
7328
|
# defined for the specified replication instance class. It is a
|
7172
|
-
# required parameter, although a
|
7329
|
+
# required parameter, although a default value is pre-selected in the
|
7173
7330
|
# DMS console.
|
7174
7331
|
#
|
7175
7332
|
# For more information on the settings and capacities for the
|
7176
7333
|
# available replication instance classes, see [ Selecting the right
|
7177
|
-
#
|
7334
|
+
# DMS replication instance for your migration][1].
|
7178
7335
|
#
|
7179
7336
|
#
|
7180
7337
|
#
|
@@ -7266,15 +7423,14 @@ module Aws::DatabaseMigrationService
|
|
7266
7423
|
# @return [Boolean]
|
7267
7424
|
#
|
7268
7425
|
# @!attribute [rw] kms_key_id
|
7269
|
-
# An
|
7426
|
+
# An KMS key identifier that is used to encrypt the data on the
|
7270
7427
|
# replication instance.
|
7271
7428
|
#
|
7272
|
-
# If you don't specify a value for the `KmsKeyId` parameter, then
|
7273
|
-
#
|
7429
|
+
# If you don't specify a value for the `KmsKeyId` parameter, then DMS
|
7430
|
+
# uses your default encryption key.
|
7274
7431
|
#
|
7275
|
-
#
|
7276
|
-
#
|
7277
|
-
# Region.
|
7432
|
+
# KMS creates the default encryption key for your account. Your
|
7433
|
+
# account has a different default encryption key for each Region.
|
7278
7434
|
# @return [String]
|
7279
7435
|
#
|
7280
7436
|
# @!attribute [rw] replication_instance_arn
|
@@ -7387,7 +7543,7 @@ module Aws::DatabaseMigrationService
|
|
7387
7543
|
#
|
7388
7544
|
# For more information on the settings and capacities for the
|
7389
7545
|
# available replication instance classes, see [ Selecting the right
|
7390
|
-
#
|
7546
|
+
# DMS replication instance for your migration][1].
|
7391
7547
|
#
|
7392
7548
|
#
|
7393
7549
|
#
|
@@ -7655,8 +7811,8 @@ module Aws::DatabaseMigrationService
|
|
7655
7811
|
# @!attribute [rw] task_data
|
7656
7812
|
# Supplemental information that the task requires to migrate the data
|
7657
7813
|
# for certain source and target endpoints. For more information, see
|
7658
|
-
# [Specifying Supplemental Data for Task Settings][1] in the *
|
7659
|
-
#
|
7814
|
+
# [Specifying Supplemental Data for Task Settings][1] in the *Database
|
7815
|
+
# Migration Service User Guide.*
|
7660
7816
|
#
|
7661
7817
|
#
|
7662
7818
|
#
|
@@ -7725,10 +7881,18 @@ module Aws::DatabaseMigrationService
|
|
7725
7881
|
#
|
7726
7882
|
# @!attribute [rw] assessment_results
|
7727
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.
|
7728
7888
|
# @return [String]
|
7729
7889
|
#
|
7730
7890
|
# @!attribute [rw] s3_object_url
|
7731
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.
|
7732
7896
|
# @return [String]
|
7733
7897
|
#
|
7734
7898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ReplicationTaskAssessmentResult AWS API Documentation
|
@@ -7811,17 +7975,18 @@ module Aws::DatabaseMigrationService
|
|
7811
7975
|
#
|
7812
7976
|
# @!attribute [rw] service_access_role_arn
|
7813
7977
|
# ARN of the service role used to start the assessment run using the
|
7814
|
-
# `StartReplicationTaskAssessmentRun` operation.
|
7978
|
+
# `StartReplicationTaskAssessmentRun` operation. The role must allow
|
7979
|
+
# the `iam:PassRole` action.
|
7815
7980
|
# @return [String]
|
7816
7981
|
#
|
7817
7982
|
# @!attribute [rw] result_location_bucket
|
7818
|
-
# Amazon S3 bucket where
|
7983
|
+
# Amazon S3 bucket where DMS stores the results of this assessment
|
7819
7984
|
# run.
|
7820
7985
|
# @return [String]
|
7821
7986
|
#
|
7822
7987
|
# @!attribute [rw] result_location_folder
|
7823
|
-
# Folder in an Amazon S3 bucket where
|
7824
|
-
#
|
7988
|
+
# Folder in an Amazon S3 bucket where DMS stores the results of this
|
7989
|
+
# assessment run.
|
7825
7990
|
# @return [String]
|
7826
7991
|
#
|
7827
7992
|
# @!attribute [rw] result_encryption_mode
|
@@ -7829,7 +7994,7 @@ module Aws::DatabaseMigrationService
|
|
7829
7994
|
# @return [String]
|
7830
7995
|
#
|
7831
7996
|
# @!attribute [rw] result_kms_key_arn
|
7832
|
-
# ARN of the
|
7997
|
+
# ARN of the KMS encryption key used to encrypt the assessment run
|
7833
7998
|
# results.
|
7834
7999
|
# @return [String]
|
7835
8000
|
#
|
@@ -8031,13 +8196,13 @@ module Aws::DatabaseMigrationService
|
|
8031
8196
|
include Aws::Structure
|
8032
8197
|
end
|
8033
8198
|
|
8034
|
-
# Identifies an
|
8199
|
+
# Identifies an DMS resource and any pending actions for it.
|
8035
8200
|
#
|
8036
8201
|
# @!attribute [rw] resource_identifier
|
8037
8202
|
# The Amazon Resource Name (ARN) of the DMS resource that the pending
|
8038
8203
|
# maintenance action applies to. For information about creating an
|
8039
|
-
# ARN, see [ Constructing an Amazon Resource Name (ARN) for
|
8040
|
-
#
|
8204
|
+
# ARN, see [ Constructing an Amazon Resource Name (ARN) for DMS][1] in
|
8205
|
+
# the DMS documentation.
|
8041
8206
|
#
|
8042
8207
|
#
|
8043
8208
|
#
|
@@ -8134,9 +8299,10 @@ module Aws::DatabaseMigrationService
|
|
8134
8299
|
# }
|
8135
8300
|
#
|
8136
8301
|
# @!attribute [rw] service_access_role_arn
|
8137
|
-
# The Amazon Resource Name (ARN) used by the service access IAM
|
8138
|
-
#
|
8139
|
-
#
|
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.
|
8140
8306
|
# @return [String]
|
8141
8307
|
#
|
8142
8308
|
# @!attribute [rw] external_table_definition
|
@@ -8183,9 +8349,9 @@ module Aws::DatabaseMigrationService
|
|
8183
8349
|
#
|
8184
8350
|
# </note>
|
8185
8351
|
#
|
8186
|
-
# To use `SSE_S3`, you need an
|
8187
|
-
#
|
8188
|
-
#
|
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:
|
8189
8355
|
#
|
8190
8356
|
# * `s3:CreateBucket`
|
8191
8357
|
#
|
@@ -8211,10 +8377,10 @@ module Aws::DatabaseMigrationService
|
|
8211
8377
|
# @return [String]
|
8212
8378
|
#
|
8213
8379
|
# @!attribute [rw] server_side_encryption_kms_key_id
|
8214
|
-
# If you are using `SSE_KMS` for the `EncryptionMode`, provide the
|
8215
|
-
#
|
8216
|
-
#
|
8217
|
-
#
|
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.
|
8218
8384
|
#
|
8219
8385
|
# Here is a CLI example: `aws dms create-endpoint
|
8220
8386
|
# --endpoint-identifier value --endpoint-type target --engine-name s3
|
@@ -8293,8 +8459,8 @@ module Aws::DatabaseMigrationService
|
|
8293
8459
|
# comma-separated value (.csv) output files only to indicate how the
|
8294
8460
|
# rows were added to the source database.
|
8295
8461
|
#
|
8296
|
-
# <note markdown="1">
|
8297
|
-
#
|
8462
|
+
# <note markdown="1"> DMS supports the `IncludeOpForFullLoad` parameter in versions 3.1.4
|
8463
|
+
# and later.
|
8298
8464
|
#
|
8299
8465
|
# </note>
|
8300
8466
|
#
|
@@ -8309,8 +8475,8 @@ module Aws::DatabaseMigrationService
|
|
8309
8475
|
# <note markdown="1"> This setting works together with the `CdcInsertsOnly` and the
|
8310
8476
|
# `CdcInsertsAndUpdates` parameters for output to .csv files only. For
|
8311
8477
|
# more information about how these settings work together, see
|
8312
|
-
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8313
|
-
# Database Migration Service User Guide.*.
|
8478
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8479
|
+
# *Database Migration Service User Guide.*.
|
8314
8480
|
#
|
8315
8481
|
# </note>
|
8316
8482
|
#
|
@@ -8337,10 +8503,10 @@ module Aws::DatabaseMigrationService
|
|
8337
8503
|
# `false`, every CDC record is written without a first field to
|
8338
8504
|
# indicate the INSERT operation at the source. For more information
|
8339
8505
|
# about how these settings work together, see [Indicating Source DB
|
8340
|
-
# Operations in Migrated S3 Data][1] in the *
|
8506
|
+
# Operations in Migrated S3 Data][1] in the *Database Migration
|
8341
8507
|
# Service User Guide.*.
|
8342
8508
|
#
|
8343
|
-
# <note markdown="1">
|
8509
|
+
# <note markdown="1"> DMS supports the interaction described preceding between the
|
8344
8510
|
# `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions
|
8345
8511
|
# 3.1.4 and later.
|
8346
8512
|
#
|
@@ -8357,11 +8523,11 @@ module Aws::DatabaseMigrationService
|
|
8357
8523
|
# @return [Boolean]
|
8358
8524
|
#
|
8359
8525
|
# @!attribute [rw] timestamp_column_name
|
8360
|
-
# A value that when nonblank causes
|
8361
|
-
#
|
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.
|
8362
8528
|
#
|
8363
|
-
# <note markdown="1">
|
8364
|
-
#
|
8529
|
+
# <note markdown="1"> DMS supports the `TimestampColumnName` parameter in versions 3.1.4
|
8530
|
+
# and later.
|
8365
8531
|
#
|
8366
8532
|
# </note>
|
8367
8533
|
#
|
@@ -8392,23 +8558,23 @@ module Aws::DatabaseMigrationService
|
|
8392
8558
|
# values that are written to an Amazon S3 object file in .parquet
|
8393
8559
|
# format.
|
8394
8560
|
#
|
8395
|
-
# <note markdown="1">
|
8561
|
+
# <note markdown="1"> DMS supports the `ParquetTimestampInMillisecond` parameter in
|
8396
8562
|
# versions 3.1.4 and later.
|
8397
8563
|
#
|
8398
8564
|
# </note>
|
8399
8565
|
#
|
8400
|
-
# When `ParquetTimestampInMillisecond` is set to `true` or `y`,
|
8401
|
-
#
|
8566
|
+
# When `ParquetTimestampInMillisecond` is set to `true` or `y`, DMS
|
8567
|
+
# writes all `TIMESTAMP` columns in a .parquet formatted file with
|
8402
8568
|
# millisecond precision. Otherwise, DMS writes them with microsecond
|
8403
8569
|
# precision.
|
8404
8570
|
#
|
8405
|
-
# Currently, Amazon Athena and
|
8571
|
+
# Currently, Amazon Athena and Glue can handle only millisecond
|
8406
8572
|
# precision for `TIMESTAMP` values. Set this parameter to `true` for
|
8407
8573
|
# S3 endpoint object files that are .parquet formatted only if you
|
8408
|
-
# plan to query or process the data with Athena or
|
8574
|
+
# plan to query or process the data with Athena or Glue.
|
8409
8575
|
#
|
8410
|
-
# <note markdown="1">
|
8411
|
-
#
|
8576
|
+
# <note markdown="1"> DMS writes any `TIMESTAMP` column values written to an S3 file in
|
8577
|
+
# .csv format with microsecond precision.
|
8412
8578
|
#
|
8413
8579
|
# Setting `ParquetTimestampInMillisecond` has no effect on the string
|
8414
8580
|
# format of the timestamp column value that is inserted by setting the
|
@@ -8433,10 +8599,10 @@ module Aws::DatabaseMigrationService
|
|
8433
8599
|
# `IncludeOpForFullLoad` is set to `false`, CDC records are written
|
8434
8600
|
# without an indication of INSERT or UPDATE operations at the source.
|
8435
8601
|
# For more information about how these settings work together, see
|
8436
|
-
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8437
|
-
# Database Migration Service User Guide.*.
|
8602
|
+
# [Indicating Source DB Operations in Migrated S3 Data][1] in the
|
8603
|
+
# *Database Migration Service User Guide.*.
|
8438
8604
|
#
|
8439
|
-
# <note markdown="1">
|
8605
|
+
# <note markdown="1"> DMS supports the use of the `CdcInsertsAndUpdates` parameter in
|
8440
8606
|
# versions 3.3.1 and later.
|
8441
8607
|
#
|
8442
8608
|
# `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to
|
@@ -8454,7 +8620,7 @@ module Aws::DatabaseMigrationService
|
|
8454
8620
|
# @!attribute [rw] date_partition_enabled
|
8455
8621
|
# When set to `true`, this parameter partitions S3 bucket folders
|
8456
8622
|
# based on transaction commit dates. The default value is `false`. For
|
8457
|
-
# more information about date-based folder
|
8623
|
+
# more information about date-based folder partitioning, see [Using
|
8458
8624
|
# date-based folder partitioning][1].
|
8459
8625
|
#
|
8460
8626
|
#
|
@@ -8477,11 +8643,11 @@ module Aws::DatabaseMigrationService
|
|
8477
8643
|
# @!attribute [rw] use_csv_no_sup_value
|
8478
8644
|
# This setting applies if the S3 output files during a change data
|
8479
8645
|
# capture (CDC) load are written in .csv format. If set to `true` for
|
8480
|
-
# columns not included in the supplemental log,
|
8646
|
+
# columns not included in the supplemental log, DMS uses the value
|
8481
8647
|
# specified by [ `CsvNoSupValue` ][1]. If not set or set to `false`,
|
8482
|
-
#
|
8648
|
+
# DMS uses the null value for these columns.
|
8483
8649
|
#
|
8484
|
-
# <note markdown="1"> This setting is supported in
|
8650
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.1 and later.
|
8485
8651
|
#
|
8486
8652
|
# </note>
|
8487
8653
|
#
|
@@ -8494,12 +8660,11 @@ module Aws::DatabaseMigrationService
|
|
8494
8660
|
# This setting only applies if your Amazon S3 output files during a
|
8495
8661
|
# change data capture (CDC) load are written in .csv format. If [
|
8496
8662
|
# `UseCsvNoSupValue` ][1] is set to true, specify a string value that
|
8497
|
-
# you want
|
8498
|
-
#
|
8499
|
-
#
|
8500
|
-
# `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.
|
8501
8666
|
#
|
8502
|
-
# <note markdown="1"> This setting is supported in
|
8667
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.1 and later.
|
8503
8668
|
#
|
8504
8669
|
# </note>
|
8505
8670
|
#
|
@@ -8509,12 +8674,12 @@ module Aws::DatabaseMigrationService
|
|
8509
8674
|
# @return [String]
|
8510
8675
|
#
|
8511
8676
|
# @!attribute [rw] preserve_transactions
|
8512
|
-
# If set to `true`,
|
8513
|
-
#
|
8514
|
-
#
|
8515
|
-
#
|
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].
|
8516
8681
|
#
|
8517
|
-
# <note markdown="1"> This setting is supported in
|
8682
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.2 and later.
|
8518
8683
|
#
|
8519
8684
|
# </note>
|
8520
8685
|
#
|
@@ -8527,30 +8692,30 @@ module Aws::DatabaseMigrationService
|
|
8527
8692
|
# @!attribute [rw] cdc_path
|
8528
8693
|
# Specifies the folder path of CDC files. For an S3 source, this
|
8529
8694
|
# setting is required if a task captures change data; otherwise, it's
|
8530
|
-
# optional. If `CdcPath` is set,
|
8531
|
-
#
|
8532
|
-
#
|
8533
|
-
#
|
8534
|
-
#
|
8535
|
-
#
|
8536
|
-
#
|
8537
|
-
#
|
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].
|
8538
8703
|
#
|
8539
8704
|
# For example, if you specify `CdcPath` as `MyChangedData`, and you
|
8540
8705
|
# specify `BucketName` as `MyTargetBucket` but do not specify
|
8541
|
-
# `BucketFolder`,
|
8706
|
+
# `BucketFolder`, DMS creates the CDC folder path following:
|
8542
8707
|
# `MyTargetBucket/MyChangedData`.
|
8543
8708
|
#
|
8544
8709
|
# If you specify the same `CdcPath`, and you specify `BucketName` as
|
8545
|
-
# `MyTargetBucket` and `BucketFolder` as `MyTargetData`,
|
8546
|
-
#
|
8710
|
+
# `MyTargetBucket` and `BucketFolder` as `MyTargetData`, DMS creates
|
8711
|
+
# the CDC folder path following:
|
8547
8712
|
# `MyTargetBucket/MyTargetData/MyChangedData`.
|
8548
8713
|
#
|
8549
8714
|
# For more information on CDC including transaction order on an S3
|
8550
8715
|
# target, see [Capturing data changes (CDC) including transaction
|
8551
8716
|
# order on the S3 target][4].
|
8552
8717
|
#
|
8553
|
-
# <note markdown="1"> This setting is supported in
|
8718
|
+
# <note markdown="1"> This setting is supported in DMS versions 3.4.2 and later.
|
8554
8719
|
#
|
8555
8720
|
# </note>
|
8556
8721
|
#
|
@@ -8675,31 +8840,32 @@ module Aws::DatabaseMigrationService
|
|
8675
8840
|
# @return [String]
|
8676
8841
|
#
|
8677
8842
|
# @!attribute [rw] service_access_role_arn
|
8678
|
-
# ARN of
|
8843
|
+
# ARN of the service role needed to start the assessment run. The role
|
8844
|
+
# must allow the `iam:PassRole` action.
|
8679
8845
|
# @return [String]
|
8680
8846
|
#
|
8681
8847
|
# @!attribute [rw] result_location_bucket
|
8682
|
-
# Amazon S3 bucket where you want
|
8848
|
+
# Amazon S3 bucket where you want DMS to store the results of this
|
8683
8849
|
# assessment run.
|
8684
8850
|
# @return [String]
|
8685
8851
|
#
|
8686
8852
|
# @!attribute [rw] result_location_folder
|
8687
|
-
# Folder within an Amazon S3 bucket where you want
|
8688
|
-
#
|
8853
|
+
# Folder within an Amazon S3 bucket where you want DMS to store the
|
8854
|
+
# results of this assessment run.
|
8689
8855
|
# @return [String]
|
8690
8856
|
#
|
8691
8857
|
# @!attribute [rw] result_encryption_mode
|
8692
8858
|
# Encryption mode that you can specify to encrypt the results of this
|
8693
|
-
# assessment run. If you don't specify this request parameter,
|
8694
|
-
#
|
8859
|
+
# assessment run. If you don't specify this request parameter, DMS
|
8860
|
+
# stores the assessment run results without encryption. You can
|
8695
8861
|
# specify one of the options following:
|
8696
8862
|
#
|
8697
8863
|
# * `"SSE_S3"` – The server-side encryption provided as a default by
|
8698
8864
|
# Amazon S3.
|
8699
8865
|
#
|
8700
|
-
# * `"SSE_KMS"` –
|
8701
|
-
#
|
8702
|
-
#
|
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.
|
8703
8869
|
# @return [String]
|
8704
8870
|
#
|
8705
8871
|
# @!attribute [rw] result_kms_key_arn
|
@@ -8714,14 +8880,14 @@ module Aws::DatabaseMigrationService
|
|
8714
8880
|
# @!attribute [rw] include_only
|
8715
8881
|
# Space-separated list of names for specific individual assessments
|
8716
8882
|
# that you want to include. These names come from the default list of
|
8717
|
-
# individual assessments that
|
8883
|
+
# individual assessments that DMS supports for the associated
|
8718
8884
|
# migration task. This task is specified by `ReplicationTaskArn`.
|
8719
8885
|
#
|
8720
8886
|
# <note markdown="1"> You can't set a value for `IncludeOnly` if you also set a value for
|
8721
8887
|
# `Exclude` in the API operation.
|
8722
8888
|
#
|
8723
|
-
# To identify the names of the default individual assessments that
|
8724
|
-
#
|
8889
|
+
# To identify the names of the default individual assessments that DMS
|
8890
|
+
# supports for the associated migration task, run the
|
8725
8891
|
# `DescribeApplicableIndividualAssessments` operation using its own
|
8726
8892
|
# `ReplicationTaskArn` request parameter.
|
8727
8893
|
#
|
@@ -8731,14 +8897,14 @@ module Aws::DatabaseMigrationService
|
|
8731
8897
|
# @!attribute [rw] exclude
|
8732
8898
|
# Space-separated list of names for specific individual assessments
|
8733
8899
|
# that you want to exclude. These names come from the default list of
|
8734
|
-
# individual assessments that
|
8900
|
+
# individual assessments that DMS supports for the associated
|
8735
8901
|
# migration task. This task is specified by `ReplicationTaskArn`.
|
8736
8902
|
#
|
8737
8903
|
# <note markdown="1"> You can't set a value for `Exclude` if you also set a value for
|
8738
8904
|
# `IncludeOnly` in the API operation.
|
8739
8905
|
#
|
8740
|
-
# To identify the names of the default individual assessments that
|
8741
|
-
#
|
8906
|
+
# To identify the names of the default individual assessments that DMS
|
8907
|
+
# supports for the associated migration task, run the
|
8742
8908
|
# `DescribeApplicableIndividualAssessments` operation using its own
|
8743
8909
|
# `ReplicationTaskArn` request parameter.
|
8744
8910
|
#
|
@@ -8822,7 +8988,7 @@ module Aws::DatabaseMigrationService
|
|
8822
8988
|
# with the source endpoint. You can verify this by setting the
|
8823
8989
|
# `slotName` extra connection attribute to the name of this logical
|
8824
8990
|
# replication slot. For more information, see [Extra Connection
|
8825
|
-
# Attributes When Using PostgreSQL as a Source for
|
8991
|
+
# Attributes When Using PostgreSQL as a Source for DMS][1].
|
8826
8992
|
#
|
8827
8993
|
# </note>
|
8828
8994
|
#
|
@@ -8964,7 +9130,7 @@ module Aws::DatabaseMigrationService
|
|
8964
9130
|
# @return [String]
|
8965
9131
|
#
|
8966
9132
|
# @!attribute [rw] supports_cdc
|
8967
|
-
# Indicates if
|
9133
|
+
# Indicates if change data capture (CDC) is supported.
|
8968
9134
|
# @return [Boolean]
|
8969
9135
|
#
|
8970
9136
|
# @!attribute [rw] endpoint_type
|
@@ -8972,9 +9138,9 @@ module Aws::DatabaseMigrationService
|
|
8972
9138
|
# @return [String]
|
8973
9139
|
#
|
8974
9140
|
# @!attribute [rw] replication_instance_engine_minimum_version
|
8975
|
-
# The earliest
|
8976
|
-
#
|
8977
|
-
#
|
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.
|
8978
9144
|
# @return [String]
|
8979
9145
|
#
|
8980
9146
|
# @!attribute [rw] engine_display_name
|
@@ -9032,10 +9198,11 @@ module Aws::DatabaseMigrationService
|
|
9032
9198
|
#
|
9033
9199
|
# @!attribute [rw] secrets_manager_access_role_arn
|
9034
9200
|
# The full Amazon Resource Name (ARN) of the IAM role that specifies
|
9035
|
-
#
|
9036
|
-
# access the value in `SecretsManagerSecret`.
|
9037
|
-
# has the value of the
|
9038
|
-
#
|
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.
|
9039
9206
|
#
|
9040
9207
|
# <note markdown="1"> You can specify one of two sets of values for these permissions. You
|
9041
9208
|
# can specify the values for this setting and
|
@@ -9043,15 +9210,15 @@ module Aws::DatabaseMigrationService
|
|
9043
9210
|
# `UserName`, `Password`, `ServerName`, and `Port`. You can't specify
|
9044
9211
|
# both. For more information on creating this `SecretsManagerSecret`
|
9045
9212
|
# and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId`
|
9046
|
-
# required to access it, see [Using secrets to access
|
9047
|
-
# Migration Service resources][1] in the *
|
9048
|
-
#
|
9213
|
+
# required to access it, see [Using secrets to access Database
|
9214
|
+
# Migration Service resources][1] in the *Database Migration Service
|
9215
|
+
# User Guide*.
|
9049
9216
|
#
|
9050
9217
|
# </note>
|
9051
9218
|
#
|
9052
9219
|
#
|
9053
9220
|
#
|
9054
|
-
# [1]: https://docs.aws.amazon.com/
|
9221
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager
|
9055
9222
|
# @return [String]
|
9056
9223
|
#
|
9057
9224
|
# @!attribute [rw] secrets_manager_secret_id
|
@@ -9249,8 +9416,8 @@ module Aws::DatabaseMigrationService
|
|
9249
9416
|
include Aws::Structure
|
9250
9417
|
end
|
9251
9418
|
|
9252
|
-
# A user-defined key-value pair that describes metadata added to an
|
9253
|
-
#
|
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:
|
9254
9421
|
#
|
9255
9422
|
# * `AddTagsToResource`
|
9256
9423
|
#
|