@aws-sdk/client-database-migration-service 3.744.0 → 3.749.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +27 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +25 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +2 -1
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataProviderCommand.d.ts +30 -2
- package/dist-types/commands/CreateEndpointCommand.d.ts +5 -4
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +1 -2
- package/dist-types/commands/CreateReplicationConfigCommand.d.ts +3 -3
- package/dist-types/commands/CreateReplicationInstanceCommand.d.ts +7 -8
- package/dist-types/commands/CreateReplicationSubnetGroupCommand.d.ts +8 -6
- package/dist-types/commands/DeleteDataProviderCommand.d.ts +14 -0
- package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReplicationConfigCommand.d.ts +4 -3
- package/dist-types/commands/DescribeApplicableIndividualAssessmentsCommand.d.ts +14 -13
- package/dist-types/commands/DescribeDataProvidersCommand.d.ts +16 -1
- package/dist-types/commands/DescribeEndpointSettingsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +1 -2
- package/dist-types/commands/DescribeEventsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeExtensionPackAssociationsCommand.d.ts +3 -4
- package/dist-types/commands/DescribeInstanceProfilesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeMetadataModelAssessmentsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeMigrationProjectsCommand.d.ts +2 -1
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplicationConfigsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplicationTaskAssessmentResultsCommand.d.ts +3 -5
- package/dist-types/commands/DescribeReplicationTaskIndividualAssessmentsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReplicationsCommand.d.ts +24 -0
- package/dist-types/commands/ExportMetadataModelAssessmentCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
- package/dist-types/commands/ModifyDataProviderCommand.d.ts +30 -1
- package/dist-types/commands/ModifyEndpointCommand.d.ts +5 -4
- package/dist-types/commands/ModifyInstanceProfileCommand.d.ts +2 -2
- package/dist-types/commands/ModifyReplicationConfigCommand.d.ts +8 -8
- package/dist-types/commands/MoveReplicationTaskCommand.d.ts +1 -2
- package/dist-types/commands/ReloadTablesCommand.d.ts +2 -2
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -5
- package/dist-types/commands/StartExtensionPackAssociationCommand.d.ts +1 -2
- package/dist-types/commands/StartMetadataModelAssessmentCommand.d.ts +2 -2
- package/dist-types/commands/StartMetadataModelExportAsScriptCommand.d.ts +2 -1
- package/dist-types/commands/StartMetadataModelImportCommand.d.ts +2 -1
- package/dist-types/commands/StartReplicationCommand.d.ts +30 -4
- package/dist-types/commands/StartReplicationTaskAssessmentCommand.d.ts +4 -4
- package/dist-types/commands/StartReplicationTaskAssessmentRunCommand.d.ts +2 -2
- package/dist-types/commands/StopReplicationCommand.d.ts +27 -2
- package/dist-types/commands/UpdateSubscriptionsToEventBridgeCommand.d.ts +11 -9
- package/dist-types/models/models_0.d.ts +1407 -1211
- package/dist-types/models/models_1.d.ts +311 -138
- package/dist-types/ts3.4/commands/DescribeReplicationTaskIndividualAssessmentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +76 -18
- package/dist-types/ts3.4/models/models_1.d.ts +19 -0
- package/package.json +11 -11
|
@@ -1,6 +1,121 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { DatabaseMigrationServiceServiceException as __BaseException } from "./DatabaseMigrationServiceServiceException";
|
|
3
3
|
import { Certificate, ComputeConfig, Connection, DataMigration, DataProvider, DataProviderDescriptorDefinition, DataProviderSettings, DmsSslModeValue, DmsTransferSettings, DocDbSettings, DynamoDbSettings, ElasticsearchSettings, Endpoint, EventSubscription, Filter, GcpMySQLSettings, IBMDb2Settings, InstanceProfile, KafkaSettings, KerberosAuthenticationSettings, KinesisSettings, MicrosoftSQLServerSettings, MigrationProject, MigrationTypeValue, MongoDbSettings, MySQLSettings, NeptuneSettings, OracleSettings, PostgreSQLSettings, RecommendationSettings, RedisSettings, RedshiftSettings, RefreshSchemasStatus, Replication, ReplicationConfig, ReplicationEndpointTypeValue, ReplicationInstance, ReplicationSubnetGroup, ReplicationTask, ReplicationTaskAssessmentRun, S3Settings, SCApplicationAttributes, SourceDataSetting, SybaseSettings, TableStatistics, Tag, TargetDataSetting, TimestreamSettings } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* <p></p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface DescribeReplicationTaskIndividualAssessmentsMessage {
|
|
9
|
+
/**
|
|
10
|
+
* <p>Filters applied to the individual assessments described in the form of key-value
|
|
11
|
+
* pairs.</p>
|
|
12
|
+
* <p>Valid filter names: <code>replication-task-assessment-run-arn</code>,
|
|
13
|
+
* <code>replication-task-arn</code>, <code>status</code>
|
|
14
|
+
* </p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
Filters?: Filter[] | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* <p>The maximum number of records to include in the response. If more records exist than the
|
|
20
|
+
* specified <code>MaxRecords</code> value, a pagination token called a marker is included in
|
|
21
|
+
* the response so that the remaining results can be retrieved.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
MaxRecords?: number | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>An optional pagination token provided by a previous request. If this parameter is
|
|
27
|
+
* specified, the response includes only records beyond the marker, up to the value specified
|
|
28
|
+
* by <code>MaxRecords</code>.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
Marker?: string | undefined;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* <p>Provides information that describes an individual assessment from a premigration
|
|
35
|
+
* assessment run.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
export interface ReplicationTaskIndividualAssessment {
|
|
39
|
+
/**
|
|
40
|
+
* <p>Amazon Resource Name (ARN) of this individual assessment.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
ReplicationTaskIndividualAssessmentArn?: string | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>ARN of the premigration assessment run that is created to run this individual
|
|
46
|
+
* assessment.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
ReplicationTaskAssessmentRunArn?: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>Name of this individual assessment.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
IndividualAssessmentName?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>Individual assessment status.</p>
|
|
57
|
+
* <p>This status can have one of the following values:</p>
|
|
58
|
+
* <ul>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>
|
|
61
|
+
* <code>"cancelled"</code>
|
|
62
|
+
* </p>
|
|
63
|
+
* </li>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>
|
|
66
|
+
* <code>"error"</code>
|
|
67
|
+
* </p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>
|
|
71
|
+
* <code>"failed"</code>
|
|
72
|
+
* </p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>
|
|
76
|
+
* <code>"passed"</code>
|
|
77
|
+
* </p>
|
|
78
|
+
* </li>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>
|
|
81
|
+
* <code>"pending"</code>
|
|
82
|
+
* </p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>
|
|
86
|
+
* <code>"running"</code>
|
|
87
|
+
* </p>
|
|
88
|
+
* </li>
|
|
89
|
+
* </ul>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
Status?: string | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>Date when this individual assessment was started as part of running the
|
|
95
|
+
* <code>StartReplicationTaskAssessmentRun</code> operation.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
ReplicationTaskIndividualAssessmentStartDate?: Date | undefined;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* <p></p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export interface DescribeReplicationTaskIndividualAssessmentsResponse {
|
|
105
|
+
/**
|
|
106
|
+
* <p>A pagination token returned for you to pass to a subsequent request. If you pass this
|
|
107
|
+
* token as the <code>Marker</code> value in a subsequent request, the response includes only
|
|
108
|
+
* records beyond the marker, up to the value specified in the request by
|
|
109
|
+
* <code>MaxRecords</code>.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
Marker?: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>One or more individual assessments as specified by <code>Filters</code>.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
ReplicationTaskIndividualAssessments?: ReplicationTaskIndividualAssessment[] | undefined;
|
|
118
|
+
}
|
|
4
119
|
/**
|
|
5
120
|
* <p></p>
|
|
6
121
|
* @public
|
|
@@ -243,8 +358,9 @@ export interface ImportCertificateMessage {
|
|
|
243
358
|
*/
|
|
244
359
|
CertificatePem?: string | undefined;
|
|
245
360
|
/**
|
|
246
|
-
* <p>The location of an imported Oracle Wallet certificate for use with SSL. Provide the name
|
|
247
|
-
*
|
|
361
|
+
* <p>The location of an imported Oracle Wallet certificate for use with SSL. Provide the name
|
|
362
|
+
* of a <code>.sso</code> file using the <code>fileb://</code> prefix. You can't provide the
|
|
363
|
+
* certificate inline.</p>
|
|
248
364
|
* <p>Example: <code>filebase64("$\{path.root\}/rds-ca-2019-root.sso")</code>
|
|
249
365
|
* </p>
|
|
250
366
|
* @public
|
|
@@ -375,12 +491,14 @@ export interface ModifyDataMigrationMessage {
|
|
|
375
491
|
*/
|
|
376
492
|
TargetDataSettings?: TargetDataSetting[] | undefined;
|
|
377
493
|
/**
|
|
378
|
-
* <p>The number of parallel jobs that trigger parallel threads to unload the tables from the
|
|
494
|
+
* <p>The number of parallel jobs that trigger parallel threads to unload the tables from the
|
|
495
|
+
* source, and then load them to the target.</p>
|
|
379
496
|
* @public
|
|
380
497
|
*/
|
|
381
498
|
NumberOfJobs?: number | undefined;
|
|
382
499
|
/**
|
|
383
|
-
* <p>A JSON-formatted string that defines what objects to include and exclude from the
|
|
500
|
+
* <p>A JSON-formatted string that defines what objects to include and exclude from the
|
|
501
|
+
* migration.</p>
|
|
384
502
|
* @public
|
|
385
503
|
*/
|
|
386
504
|
SelectionRules?: string | undefined;
|
|
@@ -419,7 +537,7 @@ export interface ModifyDataProviderMessage {
|
|
|
419
537
|
/**
|
|
420
538
|
* <p>The type of database engine for the data provider. Valid values include <code>"aurora"</code>,
|
|
421
539
|
* <code>"aurora-postgresql"</code>, <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>,
|
|
422
|
-
* <code>"sqlserver"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, and <code>docdb</code>. A value of <code>"aurora"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>
|
|
540
|
+
* <code>"sqlserver"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, <code>db2</code>, <code>db2-zos</code> and <code>docdb</code>. A value of <code>"aurora"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>
|
|
423
541
|
* @public
|
|
424
542
|
*/
|
|
425
543
|
Engine?: string | undefined;
|
|
@@ -474,19 +592,20 @@ export interface ModifyEndpointMessage {
|
|
|
474
592
|
*/
|
|
475
593
|
EndpointIdentifier?: string | undefined;
|
|
476
594
|
/**
|
|
477
|
-
* <p>The type of endpoint.
|
|
595
|
+
* <p>The type of endpoint. Valid values are <code>source</code> and
|
|
596
|
+
* <code>target</code>.</p>
|
|
478
597
|
* @public
|
|
479
598
|
*/
|
|
480
599
|
EndpointType?: ReplicationEndpointTypeValue | undefined;
|
|
481
600
|
/**
|
|
482
601
|
* <p>The database engine name. Valid values, depending on the EndpointType, include
|
|
483
|
-
*
|
|
484
|
-
*
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
*
|
|
489
|
-
*
|
|
602
|
+
* <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>,
|
|
603
|
+
* <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>,
|
|
604
|
+
* <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"db2-zos"</code>,
|
|
605
|
+
* <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>,
|
|
606
|
+
* <code>"mongodb"</code>, <code>"kinesis"</code>, <code>"kafka"</code>,
|
|
607
|
+
* <code>"elasticsearch"</code>, <code>"documentdb"</code>, <code>"sqlserver"</code>,
|
|
608
|
+
* <code>"neptune"</code>, and <code>"babelfish"</code>.</p>
|
|
490
609
|
* @public
|
|
491
610
|
*/
|
|
492
611
|
EngineName?: string | undefined;
|
|
@@ -511,7 +630,8 @@ export interface ModifyEndpointMessage {
|
|
|
511
630
|
*/
|
|
512
631
|
Port?: number | undefined;
|
|
513
632
|
/**
|
|
514
|
-
* <p>The name of the endpoint database. For a MySQL source or target endpoint, do not specify
|
|
633
|
+
* <p>The name of the endpoint database. For a MySQL source or target endpoint, do not specify
|
|
634
|
+
* DatabaseName.</p>
|
|
515
635
|
* @public
|
|
516
636
|
*/
|
|
517
637
|
DatabaseName?: string | undefined;
|
|
@@ -527,13 +647,14 @@ export interface ModifyEndpointMessage {
|
|
|
527
647
|
*/
|
|
528
648
|
CertificateArn?: string | undefined;
|
|
529
649
|
/**
|
|
530
|
-
* <p>The SSL mode used to connect to the endpoint.
|
|
650
|
+
* <p>The SSL mode used to connect to the endpoint. The default value is
|
|
651
|
+
* <code>none</code>.</p>
|
|
531
652
|
* @public
|
|
532
653
|
*/
|
|
533
654
|
SslMode?: DmsSslModeValue | undefined;
|
|
534
655
|
/**
|
|
535
|
-
* <p> The Amazon Resource Name (ARN) for the IAM role you want to use to modify
|
|
536
|
-
*
|
|
656
|
+
* <p> The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint.
|
|
657
|
+
* The role must allow the <code>iam:PassRole</code> action.</p>
|
|
537
658
|
* @public
|
|
538
659
|
*/
|
|
539
660
|
ServiceAccessRoleArn?: string | undefined;
|
|
@@ -543,17 +664,16 @@ export interface ModifyEndpointMessage {
|
|
|
543
664
|
*/
|
|
544
665
|
ExternalTableDefinition?: string | undefined;
|
|
545
666
|
/**
|
|
546
|
-
* <p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
* Guide.</i>
|
|
667
|
+
* <p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about
|
|
668
|
+
* other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>Database Migration Service
|
|
669
|
+
* User Guide.</i>
|
|
550
670
|
* </p>
|
|
551
671
|
* @public
|
|
552
672
|
*/
|
|
553
673
|
DynamoDbSettings?: DynamoDbSettings | undefined;
|
|
554
674
|
/**
|
|
555
675
|
* <p>Settings in JSON format for the target Amazon S3 endpoint. For more information about
|
|
556
|
-
*
|
|
676
|
+
* the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring">Extra
|
|
557
677
|
* Connection Attributes When Using Amazon S3 as a Target for DMS</a> in the
|
|
558
678
|
* <i>Database Migration Service User Guide.</i>
|
|
559
679
|
* </p>
|
|
@@ -565,7 +685,8 @@ export interface ModifyEndpointMessage {
|
|
|
565
685
|
* <p>Attributes include the following:</p>
|
|
566
686
|
* <ul>
|
|
567
687
|
* <li>
|
|
568
|
-
* <p>serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access
|
|
688
|
+
* <p>serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access
|
|
689
|
+
* IAM role. The role must allow the <code>iam:PassRole</code> action.</p>
|
|
569
690
|
* </li>
|
|
570
691
|
* <li>
|
|
571
692
|
* <p>BucketName - The name of the S3 bucket to use.</p>
|
|
@@ -582,41 +703,41 @@ export interface ModifyEndpointMessage {
|
|
|
582
703
|
DmsTransferSettings?: DmsTransferSettings | undefined;
|
|
583
704
|
/**
|
|
584
705
|
* <p>Settings in JSON format for the source MongoDB endpoint. For more information about the
|
|
585
|
-
* available settings, see the configuration properties section in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration">Endpoint configuration settings
|
|
586
|
-
*
|
|
587
|
-
* <i>Database Migration Service User Guide.</i>
|
|
706
|
+
* available settings, see the configuration properties section in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration">Endpoint configuration settings when using MongoDB as a source for Database Migration Service</a> in
|
|
707
|
+
* the <i>Database Migration Service User Guide.</i>
|
|
588
708
|
* </p>
|
|
589
709
|
* @public
|
|
590
710
|
*/
|
|
591
711
|
MongoDbSettings?: MongoDbSettings | undefined;
|
|
592
712
|
/**
|
|
593
713
|
* <p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For
|
|
594
|
-
* more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping">Using object mapping to
|
|
595
|
-
*
|
|
714
|
+
* more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping">Using object mapping to migrate data to a Kinesis data stream</a> in the
|
|
715
|
+
* <i>Database Migration Service User Guide.</i>
|
|
596
716
|
* </p>
|
|
597
717
|
* @public
|
|
598
718
|
*/
|
|
599
719
|
KinesisSettings?: KinesisSettings | undefined;
|
|
600
720
|
/**
|
|
601
721
|
* <p>Settings in JSON format for the target Apache Kafka endpoint. For more information about
|
|
602
|
-
* the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping">Using
|
|
603
|
-
* to migrate data to a Kafka topic</a> in the <i>Database Migration Service User
|
|
722
|
+
* the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping">Using
|
|
723
|
+
* object mapping to migrate data to a Kafka topic</a> in the <i>Database Migration Service User
|
|
724
|
+
* Guide.</i>
|
|
604
725
|
* </p>
|
|
605
726
|
* @public
|
|
606
727
|
*/
|
|
607
728
|
KafkaSettings?: KafkaSettings | undefined;
|
|
608
729
|
/**
|
|
609
|
-
* <p>Settings in JSON format for the target OpenSearch endpoint. For more
|
|
610
|
-
* about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration">Extra Connection Attributes When Using OpenSearch as a Target for
|
|
611
|
-
*
|
|
730
|
+
* <p>Settings in JSON format for the target OpenSearch endpoint. For more
|
|
731
|
+
* information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration">Extra Connection Attributes When Using OpenSearch as a Target for
|
|
732
|
+
* DMS</a> in the <i>Database Migration Service User Guide.</i>
|
|
612
733
|
* </p>
|
|
613
734
|
* @public
|
|
614
735
|
*/
|
|
615
736
|
ElasticsearchSettings?: ElasticsearchSettings | undefined;
|
|
616
737
|
/**
|
|
617
738
|
* <p>Settings in JSON format for the target Amazon Neptune endpoint. For more information
|
|
618
|
-
* about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings">Specifying graph-mapping rules using Gremlin and R2RML for Amazon
|
|
619
|
-
*
|
|
739
|
+
* about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings">Specifying graph-mapping rules using Gremlin and R2RML for Amazon
|
|
740
|
+
* Neptune as a target</a> in the <i>Database Migration Service User Guide.</i>
|
|
620
741
|
* </p>
|
|
621
742
|
* @public
|
|
622
743
|
*/
|
|
@@ -628,9 +749,8 @@ export interface ModifyEndpointMessage {
|
|
|
628
749
|
RedshiftSettings?: RedshiftSettings | undefined;
|
|
629
750
|
/**
|
|
630
751
|
* <p>Settings in JSON format for the source and target PostgreSQL endpoint. For information
|
|
631
|
-
* about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra connection
|
|
632
|
-
*
|
|
633
|
-
* Extra connection attributes when using PostgreSQL as a target for DMS</a> in the
|
|
752
|
+
* about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra connection attributes when using PostgreSQL as a source for DMS</a> and
|
|
753
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib"> Extra connection attributes when using PostgreSQL as a target for DMS</a> in the
|
|
634
754
|
* <i>Database Migration Service User Guide.</i>
|
|
635
755
|
* </p>
|
|
636
756
|
* @public
|
|
@@ -638,18 +758,15 @@ export interface ModifyEndpointMessage {
|
|
|
638
758
|
PostgreSQLSettings?: PostgreSQLSettings | undefined;
|
|
639
759
|
/**
|
|
640
760
|
* <p>Settings in JSON format for the source and target MySQL endpoint. For information about
|
|
641
|
-
* other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib">Extra connection
|
|
642
|
-
*
|
|
643
|
-
* connection attributes when using a MySQL-compatible database as a target for DMS</a> in the <i>Database Migration Service User
|
|
644
|
-
* Guide.</i>
|
|
761
|
+
* other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib">Extra connection attributes when using MySQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib">Extra connection attributes when using a MySQL-compatible database as a target for
|
|
762
|
+
* DMS</a> in the <i>Database Migration Service User Guide.</i>
|
|
645
763
|
* </p>
|
|
646
764
|
* @public
|
|
647
765
|
*/
|
|
648
766
|
MySQLSettings?: MySQLSettings | undefined;
|
|
649
767
|
/**
|
|
650
768
|
* <p>Settings in JSON format for the source and target Oracle endpoint. For information about
|
|
651
|
-
* other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib">Extra connection
|
|
652
|
-
* attributes when using Oracle as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib">
|
|
769
|
+
* other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib">Extra connection attributes when using Oracle as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib">
|
|
653
770
|
* Extra connection attributes when using Oracle as a target for DMS</a> in the
|
|
654
771
|
* <i>Database Migration Service User Guide.</i>
|
|
655
772
|
* </p>
|
|
@@ -658,19 +775,18 @@ export interface ModifyEndpointMessage {
|
|
|
658
775
|
OracleSettings?: OracleSettings | undefined;
|
|
659
776
|
/**
|
|
660
777
|
* <p>Settings in JSON format for the source and target SAP ASE endpoint. For information
|
|
661
|
-
* about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib">Extra
|
|
662
|
-
* when using SAP ASE as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib">Extra
|
|
663
|
-
* when using SAP ASE as a target for DMS</a> in the
|
|
664
|
-
*
|
|
778
|
+
* about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib">Extra
|
|
779
|
+
* connection attributes when using SAP ASE as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib">Extra
|
|
780
|
+
* connection attributes when using SAP ASE as a target for DMS</a> in the
|
|
781
|
+
* <i>Database Migration Service User Guide.</i>
|
|
665
782
|
* </p>
|
|
666
783
|
* @public
|
|
667
784
|
*/
|
|
668
785
|
SybaseSettings?: SybaseSettings | undefined;
|
|
669
786
|
/**
|
|
670
787
|
* <p>Settings in JSON format for the source and target Microsoft SQL Server endpoint. For
|
|
671
|
-
* information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib">Extra connection
|
|
672
|
-
*
|
|
673
|
-
* Extra connection attributes when using SQL Server as a target for DMS</a> in the
|
|
788
|
+
* information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib">Extra connection attributes when using SQL Server as a source for DMS</a> and
|
|
789
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib"> Extra connection attributes when using SQL Server as a target for DMS</a> in the
|
|
674
790
|
* <i>Database Migration Service User Guide.</i>
|
|
675
791
|
* </p>
|
|
676
792
|
* @public
|
|
@@ -678,18 +794,18 @@ export interface ModifyEndpointMessage {
|
|
|
678
794
|
MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings | undefined;
|
|
679
795
|
/**
|
|
680
796
|
* <p>Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other
|
|
681
|
-
* available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib">Extra
|
|
682
|
-
* when using Db2 LUW as a source for DMS</a> in the
|
|
683
|
-
*
|
|
797
|
+
* available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib">Extra
|
|
798
|
+
* connection attributes when using Db2 LUW as a source for DMS</a> in the
|
|
799
|
+
* <i>Database Migration Service User Guide.</i>
|
|
684
800
|
* </p>
|
|
685
801
|
* @public
|
|
686
802
|
*/
|
|
687
803
|
IBMDb2Settings?: IBMDb2Settings | undefined;
|
|
688
804
|
/**
|
|
689
|
-
* <p>Settings in JSON format for the source DocumentDB endpoint. For more information about
|
|
690
|
-
* available settings, see the configuration properties section in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html"> Using
|
|
691
|
-
*
|
|
692
|
-
*
|
|
805
|
+
* <p>Settings in JSON format for the source DocumentDB endpoint. For more information about
|
|
806
|
+
* the available settings, see the configuration properties section in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html"> Using
|
|
807
|
+
* DocumentDB as a Target for Database Migration Service </a> in the <i>Database Migration Service User
|
|
808
|
+
* Guide.</i>
|
|
693
809
|
* </p>
|
|
694
810
|
* @public
|
|
695
811
|
*/
|
|
@@ -705,12 +821,12 @@ export interface ModifyEndpointMessage {
|
|
|
705
821
|
* attribute is N, the current call to <code>ModifyEndpoint</code> does two things: </p>
|
|
706
822
|
* <ul>
|
|
707
823
|
* <li>
|
|
708
|
-
* <p>It replaces any endpoint settings that already exist with new values, for settings
|
|
709
|
-
* same names.</p>
|
|
824
|
+
* <p>It replaces any endpoint settings that already exist with new values, for settings
|
|
825
|
+
* with the same names.</p>
|
|
710
826
|
* </li>
|
|
711
827
|
* <li>
|
|
712
|
-
* <p>It creates new endpoint settings that you specify in the call, for settings with
|
|
713
|
-
* names. </p>
|
|
828
|
+
* <p>It creates new endpoint settings that you specify in the call, for settings with
|
|
829
|
+
* different names. </p>
|
|
714
830
|
* </li>
|
|
715
831
|
* </ul>
|
|
716
832
|
* <p>For example, if you call <code>create-endpoint ... --endpoint-settings '\{"a":1\}'
|
|
@@ -967,14 +1083,14 @@ export interface ModifyReplicationConfigMessage {
|
|
|
967
1083
|
*/
|
|
968
1084
|
ComputeConfig?: ComputeConfig | undefined;
|
|
969
1085
|
/**
|
|
970
|
-
* <p>The Amazon Resource Name (ARN) of the source endpoint for
|
|
971
|
-
*
|
|
1086
|
+
* <p>The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless
|
|
1087
|
+
* replication configuration.</p>
|
|
972
1088
|
* @public
|
|
973
1089
|
*/
|
|
974
1090
|
SourceEndpointArn?: string | undefined;
|
|
975
1091
|
/**
|
|
976
|
-
* <p>The Amazon Resource Name (ARN) of the target endpoint for
|
|
977
|
-
*
|
|
1092
|
+
* <p>The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless
|
|
1093
|
+
* replication configuration.</p>
|
|
978
1094
|
* @public
|
|
979
1095
|
*/
|
|
980
1096
|
TargetEndpointArn?: string | undefined;
|
|
@@ -1013,11 +1129,11 @@ export interface ModifyReplicationInstanceMessage {
|
|
|
1013
1129
|
ApplyImmediately?: boolean | undefined;
|
|
1014
1130
|
/**
|
|
1015
1131
|
* <p>The compute and memory capacity of the replication instance as defined for the specified
|
|
1016
|
-
* replication instance class. For example to specify the instance class dms.c4.large, set
|
|
1017
|
-
* <p>
|
|
1018
|
-
* <
|
|
1019
|
-
*
|
|
1020
|
-
*
|
|
1132
|
+
* replication instance class. For example to specify the instance class dms.c4.large, set
|
|
1133
|
+
* this parameter to <code>"dms.c4.large"</code>.</p>
|
|
1134
|
+
* <p>For more information on the settings and capacities for the available replication
|
|
1135
|
+
* instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your
|
|
1136
|
+
* migration</a>. </p>
|
|
1021
1137
|
* @public
|
|
1022
1138
|
*/
|
|
1023
1139
|
ReplicationInstanceClass?: string | undefined;
|
|
@@ -1041,8 +1157,8 @@ export interface ModifyReplicationInstanceMessage {
|
|
|
1041
1157
|
*/
|
|
1042
1158
|
PreferredMaintenanceWindow?: string | undefined;
|
|
1043
1159
|
/**
|
|
1044
|
-
* <p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set
|
|
1045
|
-
*
|
|
1160
|
+
* <p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set
|
|
1161
|
+
* the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to
|
|
1046
1162
|
* <code>true</code>. </p>
|
|
1047
1163
|
* @public
|
|
1048
1164
|
*/
|
|
@@ -1050,7 +1166,7 @@ export interface ModifyReplicationInstanceMessage {
|
|
|
1050
1166
|
/**
|
|
1051
1167
|
* <p>The engine version number of the replication instance.</p>
|
|
1052
1168
|
* <p>When modifying a major engine version of an instance, also set
|
|
1053
|
-
*
|
|
1169
|
+
* <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>
|
|
1054
1170
|
* @public
|
|
1055
1171
|
*/
|
|
1056
1172
|
EngineVersion?: string | undefined;
|
|
@@ -1090,14 +1206,15 @@ export interface ModifyReplicationInstanceMessage {
|
|
|
1090
1206
|
*/
|
|
1091
1207
|
ReplicationInstanceIdentifier?: string | undefined;
|
|
1092
1208
|
/**
|
|
1093
|
-
* <p>The type of IP address protocol used by a replication instance,
|
|
1094
|
-
*
|
|
1095
|
-
*
|
|
1209
|
+
* <p>The type of IP address protocol used by a replication instance, such as IPv4 only or
|
|
1210
|
+
* Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet
|
|
1211
|
+
* supported.</p>
|
|
1096
1212
|
* @public
|
|
1097
1213
|
*/
|
|
1098
1214
|
NetworkType?: string | undefined;
|
|
1099
1215
|
/**
|
|
1100
|
-
* <p>Specifies the
|
|
1216
|
+
* <p>Specifies the settings required for kerberos authentication when modifying a replication
|
|
1217
|
+
* instance.</p>
|
|
1101
1218
|
* @public
|
|
1102
1219
|
*/
|
|
1103
1220
|
KerberosAuthenticationSettings?: KerberosAuthenticationSettings | undefined;
|
|
@@ -1197,17 +1314,17 @@ export interface ModifyReplicationTaskMessage {
|
|
|
1197
1314
|
*/
|
|
1198
1315
|
ReplicationTaskIdentifier?: string | undefined;
|
|
1199
1316
|
/**
|
|
1200
|
-
* <p>The migration type. Valid values: <code>full-load</code> | <code>cdc</code> |
|
|
1317
|
+
* <p>The migration type. Valid values: <code>full-load</code> | <code>cdc</code> |
|
|
1318
|
+
* <code>full-load-and-cdc</code>
|
|
1201
1319
|
* </p>
|
|
1202
1320
|
* @public
|
|
1203
1321
|
*/
|
|
1204
1322
|
MigrationType?: MigrationTypeValue | undefined;
|
|
1205
1323
|
/**
|
|
1206
|
-
* <p>When using the CLI or boto3, provide the path of the JSON file that contains the
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1210
|
-
* </p>
|
|
1324
|
+
* <p>When using the CLI or boto3, provide the path of the JSON file that contains the table
|
|
1325
|
+
* mappings. Precede the path with <code>file://</code>. For example, <code>--table-mappings
|
|
1326
|
+
* file://mappingfile.json</code>. When working with the DMS API, provide the JSON as the
|
|
1327
|
+
* parameter value. </p>
|
|
1211
1328
|
* @public
|
|
1212
1329
|
*/
|
|
1213
1330
|
TableMappings?: string | undefined;
|
|
@@ -1252,9 +1369,9 @@ export interface ModifyReplicationTaskMessage {
|
|
|
1252
1369
|
*/
|
|
1253
1370
|
CdcStopPosition?: string | undefined;
|
|
1254
1371
|
/**
|
|
1255
|
-
* <p>Supplemental information that the task requires to migrate the data for certain source
|
|
1256
|
-
*
|
|
1257
|
-
*
|
|
1372
|
+
* <p>Supplemental information that the task requires to migrate the data for certain source
|
|
1373
|
+
* and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for
|
|
1374
|
+
* Task Settings</a> in the <i>Database Migration Service User Guide.</i>
|
|
1258
1375
|
* </p>
|
|
1259
1376
|
* @public
|
|
1260
1377
|
*/
|
|
@@ -1310,15 +1427,17 @@ export interface RebootReplicationInstanceMessage {
|
|
|
1310
1427
|
/**
|
|
1311
1428
|
* <p>If this parameter is <code>true</code>, the reboot is conducted through a Multi-AZ
|
|
1312
1429
|
* failover. If the instance isn't configured for Multi-AZ, then you can't specify
|
|
1313
|
-
*
|
|
1430
|
+
* <code>true</code>. ( <code>--force-planned-failover</code> and
|
|
1431
|
+
* <code>--force-failover</code> can't both be set to <code>true</code>.)</p>
|
|
1314
1432
|
* @public
|
|
1315
1433
|
*/
|
|
1316
1434
|
ForceFailover?: boolean | undefined;
|
|
1317
1435
|
/**
|
|
1318
|
-
* <p>If this parameter is <code>true</code>, the reboot is conducted through a planned
|
|
1319
|
-
* where resources are released and cleaned up prior to conducting the
|
|
1320
|
-
* If the instance isn''t configured for Multi-AZ, then you can't specify
|
|
1321
|
-
*
|
|
1436
|
+
* <p>If this parameter is <code>true</code>, the reboot is conducted through a planned
|
|
1437
|
+
* Multi-AZ failover where resources are released and cleaned up prior to conducting the
|
|
1438
|
+
* failover. If the instance isn''t configured for Multi-AZ, then you can't specify
|
|
1439
|
+
* <code>true</code>. ( <code>--force-planned-failover</code> and
|
|
1440
|
+
* <code>--force-failover</code> can't both be set to <code>true</code>.)</p>
|
|
1322
1441
|
* @public
|
|
1323
1442
|
*/
|
|
1324
1443
|
ForcePlannedFailover?: boolean | undefined;
|
|
@@ -1462,7 +1581,8 @@ export interface ReloadTablesResponse {
|
|
|
1462
1581
|
*/
|
|
1463
1582
|
export interface RemoveTagsFromResourceMessage {
|
|
1464
1583
|
/**
|
|
1465
|
-
* <p>An DMS resource from which you want to remove tag(s). The value for this parameter is
|
|
1584
|
+
* <p>An DMS resource from which you want to remove tag(s). The value for this parameter is
|
|
1585
|
+
* an Amazon Resource Name (ARN).</p>
|
|
1466
1586
|
* @public
|
|
1467
1587
|
*/
|
|
1468
1588
|
ResourceArn: string | undefined;
|
|
@@ -1517,7 +1637,8 @@ export interface StartDataMigrationMessage {
|
|
|
1517
1637
|
DataMigrationIdentifier: string | undefined;
|
|
1518
1638
|
/**
|
|
1519
1639
|
* <p>Specifies the start type for the data migration. Valid values include
|
|
1520
|
-
*
|
|
1640
|
+
* <code>start-replication</code>, <code>reload-target</code>, and
|
|
1641
|
+
* <code>resume-processing</code>.</p>
|
|
1521
1642
|
* @public
|
|
1522
1643
|
*/
|
|
1523
1644
|
StartType: StartReplicationMigrationTypeValue | undefined;
|
|
@@ -1749,28 +1870,76 @@ export interface StartReplicationMessage {
|
|
|
1749
1870
|
ReplicationConfigArn: string | undefined;
|
|
1750
1871
|
/**
|
|
1751
1872
|
* <p>The replication type.</p>
|
|
1752
|
-
* <p>When the replication type is <code>full-load</code> or <code>full-load-and-cdc</code>,
|
|
1753
|
-
* for the first run of the replication is
|
|
1754
|
-
* <
|
|
1755
|
-
*
|
|
1873
|
+
* <p>When the replication type is <code>full-load</code> or <code>full-load-and-cdc</code>,
|
|
1874
|
+
* the only valid value for the first run of the replication is
|
|
1875
|
+
* <code>start-replication</code>. This option will start the replication.</p>
|
|
1876
|
+
* <p>You can also use <a>ReloadTables</a> to reload specific tables that failed
|
|
1877
|
+
* during replication instead of restarting the replication.</p>
|
|
1756
1878
|
* <p>The <code>resume-processing</code> option isn't applicable for a full-load replication,
|
|
1757
1879
|
* because you can't resume partially loaded tables during the full load phase.</p>
|
|
1758
|
-
* <p>For a <code>full-load-and-cdc</code> replication, DMS migrates table data, and then
|
|
1759
|
-
* that occur on the source. To load all the tables again, and start
|
|
1760
|
-
* use <code>reload-target</code>. Otherwise use
|
|
1761
|
-
*
|
|
1880
|
+
* <p>For a <code>full-load-and-cdc</code> replication, DMS migrates table data, and then
|
|
1881
|
+
* applies data changes that occur on the source. To load all the tables again, and start
|
|
1882
|
+
* capturing source changes, use <code>reload-target</code>. Otherwise use
|
|
1883
|
+
* <code>resume-processing</code>, to replicate the changes from the last stop
|
|
1884
|
+
* position.</p>
|
|
1762
1885
|
* @public
|
|
1763
1886
|
*/
|
|
1764
1887
|
StartReplicationType: string | undefined;
|
|
1765
1888
|
/**
|
|
1766
|
-
* <p>
|
|
1767
|
-
*
|
|
1889
|
+
* <p>User-defined settings for the premigration assessment. The possible values are:</p>
|
|
1890
|
+
* <ul>
|
|
1891
|
+
* <li>
|
|
1892
|
+
* <p>
|
|
1893
|
+
* <code>ResultLocationFinder</code>: The folder within an Amazon Amazon S3 bucket where
|
|
1894
|
+
* you want DMS to store the results of this assessment run.</p>
|
|
1895
|
+
* </li>
|
|
1896
|
+
* <li>
|
|
1897
|
+
* <p>
|
|
1898
|
+
* <code>ResultEncryptionMode</code>: The supported values are <code>SSE_KMS</code>
|
|
1899
|
+
* and <code>SSE_S3</code>. If these values are not provided, then the files are not
|
|
1900
|
+
* encrypted at rest. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.KMSKeys">Creating
|
|
1901
|
+
* Amazon Web Services KMS keys to encrypt Amazon Amazon S3 target objects</a>.</p>
|
|
1902
|
+
* </li>
|
|
1903
|
+
* <li>
|
|
1904
|
+
* <p>
|
|
1905
|
+
* <code>ResultKmsKeyArn</code>: The ARN of a customer KMS encryption key that you
|
|
1906
|
+
* specify when you set <code>ResultEncryptionMode</code> to
|
|
1907
|
+
* <code>SSE_KMS</code>.</p>
|
|
1908
|
+
* </li>
|
|
1909
|
+
* <li>
|
|
1910
|
+
* <p>
|
|
1911
|
+
* <code>IncludeOnly</code>: A space-separated list of names for specific individual
|
|
1912
|
+
* assessments that you want to include. These names come from the default list of
|
|
1913
|
+
* individual assessments that Database Migration Service supports for the associated migration.</p>
|
|
1914
|
+
* </li>
|
|
1915
|
+
* <li>
|
|
1916
|
+
* <p>
|
|
1917
|
+
* <code>Exclude</code>: A space-separated list of names for specific individual
|
|
1918
|
+
* assessments that you want to exclude. These names come from the default list of
|
|
1919
|
+
* individual assessments that Database Migration Service supports for the associated migration.</p>
|
|
1920
|
+
* </li>
|
|
1921
|
+
* <li>
|
|
1922
|
+
* <p>
|
|
1923
|
+
* <code>FailOnAssessmentFailure</code>: A configurable setting you can set to
|
|
1924
|
+
* <code>true</code> (the default setting) or <code>false</code>. Use this setting to
|
|
1925
|
+
* to stop the replication from starting automatically if the assessment fails. This can
|
|
1926
|
+
* help you evaluate the issue that is preventing the replication from running
|
|
1927
|
+
* successfully.</p>
|
|
1928
|
+
* </li>
|
|
1929
|
+
* </ul>
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
PremigrationAssessmentSettings?: string | undefined;
|
|
1933
|
+
/**
|
|
1934
|
+
* <p>Indicates the start time for a change data capture (CDC) operation. Use either
|
|
1935
|
+
* <code>CdcStartTime</code> or <code>CdcStartPosition</code> to specify when you want a
|
|
1936
|
+
* CDC operation to start. Specifying both values results in an error.</p>
|
|
1768
1937
|
* @public
|
|
1769
1938
|
*/
|
|
1770
1939
|
CdcStartTime?: Date | undefined;
|
|
1771
1940
|
/**
|
|
1772
1941
|
* <p>Indicates when you want a change data capture (CDC) operation to start. Use either
|
|
1773
|
-
*
|
|
1942
|
+
* <code>CdcStartPosition</code> or <code>CdcStartTime</code> to specify when you want a
|
|
1774
1943
|
* CDC operation to start. Specifying both values results in an error.</p>
|
|
1775
1944
|
* <p>The value can be in date, checkpoint, or LSN/SCN format.</p>
|
|
1776
1945
|
* @public
|
|
@@ -1819,16 +1988,18 @@ export interface StartReplicationTaskMessage {
|
|
|
1819
1988
|
ReplicationTaskArn: string | undefined;
|
|
1820
1989
|
/**
|
|
1821
1990
|
* <p>The type of replication task to start.</p>
|
|
1822
|
-
* <p>When the migration type is <code>full-load</code> or <code>full-load-and-cdc</code>, the
|
|
1823
|
-
*
|
|
1824
|
-
*
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1827
|
-
*
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
1830
|
-
*
|
|
1831
|
-
* changes
|
|
1991
|
+
* <p>When the migration type is <code>full-load</code> or <code>full-load-and-cdc</code>, the
|
|
1992
|
+
* only valid value for the first run of the task is <code>start-replication</code>. This
|
|
1993
|
+
* option will start the migration.</p>
|
|
1994
|
+
* <p>You can also use <a>ReloadTables</a> to reload specific tables that failed
|
|
1995
|
+
* during migration instead of restarting the task.</p>
|
|
1996
|
+
* <p>The <code>resume-processing</code> option isn't applicable for a full-load task, because
|
|
1997
|
+
* you can't resume partially loaded tables during the full load phase.</p>
|
|
1998
|
+
* <p>For a <code>full-load-and-cdc</code> task, DMS migrates table data, and then applies
|
|
1999
|
+
* data changes that occur on the source. To load all the tables again, and start capturing
|
|
2000
|
+
* source changes, use <code>reload-target</code>. Otherwise use
|
|
2001
|
+
* <code>resume-processing</code>, to replicate the changes from the last stop
|
|
2002
|
+
* position.</p>
|
|
1832
2003
|
* @public
|
|
1833
2004
|
*/
|
|
1834
2005
|
StartReplicationTaskType: StartReplicationTaskTypeValue | undefined;
|
|
@@ -1925,7 +2096,8 @@ export interface StartReplicationTaskAssessmentRunMessage {
|
|
|
1925
2096
|
*/
|
|
1926
2097
|
ReplicationTaskArn: string | undefined;
|
|
1927
2098
|
/**
|
|
1928
|
-
* <p>ARN of the service role needed to start the assessment run. The role must allow the
|
|
2099
|
+
* <p>ARN of the service role needed to start the assessment run. The role must allow the
|
|
2100
|
+
* <code>iam:PassRole</code> action.</p>
|
|
1929
2101
|
* @public
|
|
1930
2102
|
*/
|
|
1931
2103
|
ServiceAccessRoleArn: string | undefined;
|
|
@@ -1936,8 +2108,8 @@ export interface StartReplicationTaskAssessmentRunMessage {
|
|
|
1936
2108
|
*/
|
|
1937
2109
|
ResultLocationBucket: string | undefined;
|
|
1938
2110
|
/**
|
|
1939
|
-
* <p>Folder within an Amazon S3 bucket where you want DMS to store the results of this
|
|
1940
|
-
* run.</p>
|
|
2111
|
+
* <p>Folder within an Amazon S3 bucket where you want DMS to store the results of this
|
|
2112
|
+
* assessment run.</p>
|
|
1941
2113
|
* @public
|
|
1942
2114
|
*/
|
|
1943
2115
|
ResultLocationFolder?: string | undefined;
|
|
@@ -1953,9 +2125,9 @@ export interface StartReplicationTaskAssessmentRunMessage {
|
|
|
1953
2125
|
* </li>
|
|
1954
2126
|
* <li>
|
|
1955
2127
|
* <p>
|
|
1956
|
-
* <code>"SSE_KMS"</code> – Key Management Service (KMS) encryption.
|
|
1957
|
-
*
|
|
1958
|
-
*
|
|
2128
|
+
* <code>"SSE_KMS"</code> – Key Management Service (KMS) encryption. This encryption can
|
|
2129
|
+
* use either a custom KMS encryption key that you specify or the default KMS encryption
|
|
2130
|
+
* key that DMS provides.</p>
|
|
1959
2131
|
* </li>
|
|
1960
2132
|
* </ul>
|
|
1961
2133
|
* @public
|
|
@@ -1979,11 +2151,12 @@ export interface StartReplicationTaskAssessmentRunMessage {
|
|
|
1979
2151
|
* <code>ReplicationTaskArn</code>.</p>
|
|
1980
2152
|
* <note>
|
|
1981
2153
|
* <p>You can't set a value for <code>IncludeOnly</code> if you also set a value for
|
|
1982
|
-
*
|
|
1983
|
-
*
|
|
1984
|
-
*
|
|
1985
|
-
*
|
|
1986
|
-
*
|
|
2154
|
+
* <code>Exclude</code> in the API operation.
|
|
2155
|
+
* </p>
|
|
2156
|
+
* <p>To identify the names of the default individual assessments that DMS supports for
|
|
2157
|
+
* the associated migration task, run the
|
|
2158
|
+
* <code>DescribeApplicableIndividualAssessments</code> operation using its own
|
|
2159
|
+
* <code>ReplicationTaskArn</code> request parameter.</p>
|
|
1987
2160
|
* </note>
|
|
1988
2161
|
* @public
|
|
1989
2162
|
*/
|
|
@@ -1995,17 +2168,18 @@ export interface StartReplicationTaskAssessmentRunMessage {
|
|
|
1995
2168
|
* <code>ReplicationTaskArn</code>.</p>
|
|
1996
2169
|
* <note>
|
|
1997
2170
|
* <p>You can't set a value for <code>Exclude</code> if you also set a value for
|
|
1998
|
-
*
|
|
1999
|
-
* <p>To identify the names of the default individual assessments that DMS
|
|
2000
|
-
*
|
|
2001
|
-
*
|
|
2002
|
-
*
|
|
2171
|
+
* <code>IncludeOnly</code> in the API operation.</p>
|
|
2172
|
+
* <p>To identify the names of the default individual assessments that DMS supports for
|
|
2173
|
+
* the associated migration task, run the
|
|
2174
|
+
* <code>DescribeApplicableIndividualAssessments</code> operation using its own
|
|
2175
|
+
* <code>ReplicationTaskArn</code> request parameter.</p>
|
|
2003
2176
|
* </note>
|
|
2004
2177
|
* @public
|
|
2005
2178
|
*/
|
|
2006
2179
|
Exclude?: string[] | undefined;
|
|
2007
2180
|
/**
|
|
2008
|
-
* <p>One or more tags to be assigned to the premigration assessment run that you want to
|
|
2181
|
+
* <p>One or more tags to be assigned to the premigration assessment run that you want to
|
|
2182
|
+
* start.</p>
|
|
2009
2183
|
* @public
|
|
2010
2184
|
*/
|
|
2011
2185
|
Tags?: Tag[] | undefined;
|
|
@@ -2117,11 +2291,9 @@ export interface TestConnectionResponse {
|
|
|
2117
2291
|
*/
|
|
2118
2292
|
export interface UpdateSubscriptionsToEventBridgeMessage {
|
|
2119
2293
|
/**
|
|
2120
|
-
* <p>When set to true, this operation migrates DMS subscriptions for Amazon
|
|
2121
|
-
* notifications no matter what your replication instance version is. If not set or set to
|
|
2122
|
-
* false, this operation runs only when all your replication instances are from DMS
|
|
2123
|
-
* version 3.4.5 or higher.
|
|
2124
|
-
* </p>
|
|
2294
|
+
* <p>When set to true, this operation migrates DMS subscriptions for Amazon
|
|
2295
|
+
* SNS notifications no matter what your replication instance version is. If not set or set to
|
|
2296
|
+
* false, this operation runs only when all your replication instances are from DMS version 3.4.5 or higher. </p>
|
|
2125
2297
|
* @public
|
|
2126
2298
|
*/
|
|
2127
2299
|
ForceMove?: boolean | undefined;
|
|
@@ -2132,7 +2304,8 @@ export interface UpdateSubscriptionsToEventBridgeMessage {
|
|
|
2132
2304
|
*/
|
|
2133
2305
|
export interface UpdateSubscriptionsToEventBridgeResponse {
|
|
2134
2306
|
/**
|
|
2135
|
-
* <p>A string that indicates how many event subscriptions were migrated and how many remain
|
|
2307
|
+
* <p>A string that indicates how many event subscriptions were migrated and how many remain
|
|
2308
|
+
* to be migrated.</p>
|
|
2136
2309
|
* @public
|
|
2137
2310
|
*/
|
|
2138
2311
|
Result?: string | undefined;
|