@aws-sdk/client-database-migration-service 3.41.0 → 3.46.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/CHANGELOG.md +55 -0
- package/dist-cjs/endpoints.js +9 -0
- package/dist-cjs/models/models_0.js +20 -10
- package/dist-cjs/protocols/Aws_json1_1.js +64 -0
- package/dist-cjs/runtimeConfig.js +0 -2
- package/dist-es/endpoints.js +9 -0
- package/dist-es/models/models_0.js +15 -11
- package/dist-es/protocols/Aws_json1_1.js +52 -7
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/DatabaseMigrationService.d.ts +14 -2
- package/dist-types/commands/DescribeReplicationTaskAssessmentResultsCommand.d.ts +1 -2
- package/dist-types/commands/StartReplicationTaskAssessmentCommand.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +186 -48
- package/dist-types/ts3.4/models/models_0.d.ts +49 -4
- package/package.json +37 -44
|
@@ -12,8 +12,7 @@ export interface DescribeReplicationTaskAssessmentResultsCommandOutput extends D
|
|
|
12
12
|
* latest results.</p>
|
|
13
13
|
* <p>For more information about DMS task assessments, see
|
|
14
14
|
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment report</a>
|
|
15
|
-
* in the <
|
|
16
|
-
* Database Migration Service User Guide</a>.</p>
|
|
15
|
+
* in the <i>Database Migration Service User Guide</i>.</p>
|
|
17
16
|
* @example
|
|
18
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
18
|
* ```javascript
|
|
@@ -9,6 +9,19 @@ export interface StartReplicationTaskAssessmentCommandOutput extends StartReplic
|
|
|
9
9
|
/**
|
|
10
10
|
* <p> Starts the replication task assessment for unsupported data types in the source
|
|
11
11
|
* database. </p>
|
|
12
|
+
* <p>You can only use this operation for a task if the following conditions are true:</p>
|
|
13
|
+
* <ul>
|
|
14
|
+
* <li>
|
|
15
|
+
* <p>The task must be in the <code>stopped</code> state.</p>
|
|
16
|
+
* </li>
|
|
17
|
+
* <li>
|
|
18
|
+
* <p>The task must have successful connections to the source and target.</p>
|
|
19
|
+
* </li>
|
|
20
|
+
* </ul>
|
|
21
|
+
* <p>If either of these conditions are not met, an <code>InvalidResourceStateFault</code> error will result. </p>
|
|
22
|
+
* <p>For information about DMS task assessments, see
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment report</a>
|
|
24
|
+
* in the <i>Database Migration Service User Guide</i>.</p>
|
|
12
25
|
* @example
|
|
13
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
27
|
* ```javascript
|
|
@@ -571,7 +571,7 @@ export declare namespace DynamoDbSettings {
|
|
|
571
571
|
const filterSensitiveLog: (obj: DynamoDbSettings) => any;
|
|
572
572
|
}
|
|
573
573
|
/**
|
|
574
|
-
* <p>Provides information that defines an
|
|
574
|
+
* <p>Provides information that defines an OpenSearch endpoint.</p>
|
|
575
575
|
*/
|
|
576
576
|
export interface ElasticsearchSettings {
|
|
577
577
|
/**
|
|
@@ -580,7 +580,7 @@ export interface ElasticsearchSettings {
|
|
|
580
580
|
*/
|
|
581
581
|
ServiceAccessRoleArn: string | undefined;
|
|
582
582
|
/**
|
|
583
|
-
* <p>The endpoint for the
|
|
583
|
+
* <p>The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport
|
|
584
584
|
* protocol (http/https) is not specified.</p>
|
|
585
585
|
*/
|
|
586
586
|
EndpointUri: string | undefined;
|
|
@@ -588,14 +588,14 @@ export interface ElasticsearchSettings {
|
|
|
588
588
|
* <p>The maximum percentage of records that can fail to be written before a full load
|
|
589
589
|
* operation stops.</p>
|
|
590
590
|
* <p>To avoid early failure, this counter is only effective after 1000 records
|
|
591
|
-
* are transferred.
|
|
591
|
+
* are transferred. OpenSearch also has the concept of error monitoring during the
|
|
592
592
|
* last 10 minutes of an Observation Window. If transfer of all records fail in the
|
|
593
593
|
* last 10 minutes, the full load operation stops. </p>
|
|
594
594
|
*/
|
|
595
595
|
FullLoadErrorPercentage?: number;
|
|
596
596
|
/**
|
|
597
597
|
* <p>The maximum number of seconds for which DMS retries failed API requests to the
|
|
598
|
-
*
|
|
598
|
+
* OpenSearch cluster.</p>
|
|
599
599
|
*/
|
|
600
600
|
ErrorRetryDuration?: number;
|
|
601
601
|
}
|
|
@@ -609,6 +609,120 @@ export declare enum ReplicationEndpointTypeValue {
|
|
|
609
609
|
SOURCE = "source",
|
|
610
610
|
TARGET = "target"
|
|
611
611
|
}
|
|
612
|
+
export declare enum TargetDbType {
|
|
613
|
+
MULTIPLE_DATABASES = "multiple-databases",
|
|
614
|
+
SPECIFIC_DATABASE = "specific-database"
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
* <p>Settings in JSON format for the source GCP MySQL endpoint.</p>
|
|
618
|
+
*/
|
|
619
|
+
export interface GcpMySQLSettings {
|
|
620
|
+
/**
|
|
621
|
+
* <p>Specifies a script to run immediately after DMS connects to the endpoint.
|
|
622
|
+
* The migration task continues running regardless if the SQL statement succeeds or fails.</p>
|
|
623
|
+
*
|
|
624
|
+
* <p>For this parameter, provide the code of the script itself, not the name of a file containing the script. </p>
|
|
625
|
+
*/
|
|
626
|
+
AfterConnectScript?: string;
|
|
627
|
+
/**
|
|
628
|
+
* <p>Adjusts the behavior of DMS when migrating from an SQL Server source database
|
|
629
|
+
* that is hosted as part of an Always On availability group cluster. If you need DMS
|
|
630
|
+
* to poll all the nodes in the Always On cluster for transaction backups, set this attribute to <code>false</code>. </p>
|
|
631
|
+
*/
|
|
632
|
+
CleanSourceMetadataOnMismatch?: boolean;
|
|
633
|
+
/**
|
|
634
|
+
* <p>Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify
|
|
635
|
+
* the database using the <code>DatabaseName</code> request parameter on either the <code>CreateEndpoint</code>
|
|
636
|
+
* or <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create or modify a
|
|
637
|
+
* MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify
|
|
638
|
+
* the database only when you specify the schema in the table-mapping rules of the DMS task. </p>
|
|
639
|
+
*/
|
|
640
|
+
DatabaseName?: string;
|
|
641
|
+
/**
|
|
642
|
+
* <p>Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.</p>
|
|
643
|
+
* <p>Example: <code>eventsPollInterval=5;</code>
|
|
644
|
+
* </p>
|
|
645
|
+
* <p>In the example, DMS checks for changes in the binary logs every five seconds. </p>
|
|
646
|
+
*/
|
|
647
|
+
EventsPollInterval?: number;
|
|
648
|
+
/**
|
|
649
|
+
* <p>Specifies where to migrate source tables on the target, either to a single database or multiple databases.</p>
|
|
650
|
+
* <p>Example: <code>targetDbType=MULTIPLE_DATABASES</code>
|
|
651
|
+
* </p>
|
|
652
|
+
*/
|
|
653
|
+
TargetDbType?: TargetDbType | string;
|
|
654
|
+
/**
|
|
655
|
+
* <p>Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.</p>
|
|
656
|
+
* <p>Example: <code>maxFileSize=512</code>
|
|
657
|
+
* </p>
|
|
658
|
+
*/
|
|
659
|
+
MaxFileSize?: number;
|
|
660
|
+
/**
|
|
661
|
+
* <p>Improves performance when loading data into the MySQL-compatible target database. Specifies how many
|
|
662
|
+
* threads to use to load the data into the MySQL-compatible target database. Setting a large number of
|
|
663
|
+
* threads can have an adverse effect on database performance, because a separate connection is required
|
|
664
|
+
* for each thread. The default is one.</p>
|
|
665
|
+
*
|
|
666
|
+
* <p>Example: <code>parallelLoadThreads=1</code>
|
|
667
|
+
* </p>
|
|
668
|
+
*/
|
|
669
|
+
ParallelLoadThreads?: number;
|
|
670
|
+
/**
|
|
671
|
+
* <p>Endpoint connection password.</p>
|
|
672
|
+
*/
|
|
673
|
+
Password?: string;
|
|
674
|
+
/**
|
|
675
|
+
* <p></p>
|
|
676
|
+
*/
|
|
677
|
+
Port?: number;
|
|
678
|
+
/**
|
|
679
|
+
* <p>Endpoint TCP port.</p>
|
|
680
|
+
*/
|
|
681
|
+
ServerName?: string;
|
|
682
|
+
/**
|
|
683
|
+
* <p>Specifies the time zone for the source MySQL database.</p>
|
|
684
|
+
*
|
|
685
|
+
* <p>Example: <code>serverTimezone=US/Pacific;</code>
|
|
686
|
+
* </p>
|
|
687
|
+
*
|
|
688
|
+
* <p>Note: Do not enclose time zones in single quotes.</p>
|
|
689
|
+
*/
|
|
690
|
+
ServerTimezone?: string;
|
|
691
|
+
/**
|
|
692
|
+
* <p>Endpoint connection user name.</p>
|
|
693
|
+
*/
|
|
694
|
+
Username?: string;
|
|
695
|
+
/**
|
|
696
|
+
* <p>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
|
|
697
|
+
* as the trusted entity and grants the required permissions to access the value in
|
|
698
|
+
* <code>SecretsManagerSecret.</code> The role must allow the <code>iam:PassRole</code> action.
|
|
699
|
+
* <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret
|
|
700
|
+
* that allows access to the MySQL endpoint.</p>
|
|
701
|
+
* <note>
|
|
702
|
+
* <p>You can specify one of two sets of values for these permissions. You can specify
|
|
703
|
+
* the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text
|
|
704
|
+
* values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>.
|
|
705
|
+
* You can't specify both. For more information on creating this <code>SecretsManagerSecret</code>
|
|
706
|
+
* and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to
|
|
707
|
+
* access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the
|
|
708
|
+
* Database Migration Service User Guide.
|
|
709
|
+
*
|
|
710
|
+
* </p>
|
|
711
|
+
* </note>
|
|
712
|
+
*/
|
|
713
|
+
SecretsManagerAccessRoleArn?: string;
|
|
714
|
+
/**
|
|
715
|
+
* <p>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code>
|
|
716
|
+
* that contains the MySQL endpoint connection details. </p>
|
|
717
|
+
*/
|
|
718
|
+
SecretsManagerSecretId?: string;
|
|
719
|
+
}
|
|
720
|
+
export declare namespace GcpMySQLSettings {
|
|
721
|
+
/**
|
|
722
|
+
* @internal
|
|
723
|
+
*/
|
|
724
|
+
const filterSensitiveLog: (obj: GcpMySQLSettings) => any;
|
|
725
|
+
}
|
|
612
726
|
/**
|
|
613
727
|
* <p>Provides information that defines an IBM Db2 LUW endpoint.</p>
|
|
614
728
|
*/
|
|
@@ -1111,10 +1225,6 @@ export declare namespace MongoDbSettings {
|
|
|
1111
1225
|
*/
|
|
1112
1226
|
const filterSensitiveLog: (obj: MongoDbSettings) => any;
|
|
1113
1227
|
}
|
|
1114
|
-
export declare enum TargetDbType {
|
|
1115
|
-
MULTIPLE_DATABASES = "multiple-databases",
|
|
1116
|
-
SPECIFIC_DATABASE = "specific-database"
|
|
1117
|
-
}
|
|
1118
1228
|
/**
|
|
1119
1229
|
* <p>Provides information that defines a MySQL endpoint.</p>
|
|
1120
1230
|
*/
|
|
@@ -1145,7 +1255,7 @@ export interface MySQLSettings {
|
|
|
1145
1255
|
DatabaseName?: string;
|
|
1146
1256
|
/**
|
|
1147
1257
|
* <p>Specifies how often to check the binary log for new
|
|
1148
|
-
* changes/events when the database is idle.</p>
|
|
1258
|
+
* changes/events when the database is idle. The default is five seconds.</p>
|
|
1149
1259
|
* <p>Example: <code>eventsPollInterval=5;</code>
|
|
1150
1260
|
* </p>
|
|
1151
1261
|
* <p>In the example, DMS checks for changes in the binary
|
|
@@ -1170,7 +1280,7 @@ export interface MySQLSettings {
|
|
|
1170
1280
|
* <p>Improves performance when loading data into the MySQL-compatible target database.
|
|
1171
1281
|
* Specifies how many threads to use to load the data into the MySQL-compatible target
|
|
1172
1282
|
* database. Setting a large number of threads can have an adverse effect on database
|
|
1173
|
-
* performance, because a separate connection is required for each thread.</p>
|
|
1283
|
+
* performance, because a separate connection is required for each thread. The default is one.</p>
|
|
1174
1284
|
* <p>Example: <code>parallelLoadThreads=1</code>
|
|
1175
1285
|
* </p>
|
|
1176
1286
|
*/
|
|
@@ -1711,7 +1821,7 @@ export interface PostgreSQLSettings {
|
|
|
1711
1821
|
*/
|
|
1712
1822
|
Password?: string;
|
|
1713
1823
|
/**
|
|
1714
|
-
* <p>Endpoint TCP port.</p>
|
|
1824
|
+
* <p>Endpoint TCP port. The default is 5432.</p>
|
|
1715
1825
|
*/
|
|
1716
1826
|
Port?: number;
|
|
1717
1827
|
/**
|
|
@@ -2513,6 +2623,16 @@ export interface S3Settings {
|
|
|
2513
2623
|
* </note>
|
|
2514
2624
|
*/
|
|
2515
2625
|
CdcPath?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* <p>When set to true, this parameter uses the task start time as the timestamp column value instead of
|
|
2628
|
+
* the time data is written to target. For full load, when <code>useTaskStartTimeForFullLoadTimestamp</code>
|
|
2629
|
+
* is set to <code>true</code>, each row of the timestamp column contains the task start time. For CDC loads,
|
|
2630
|
+
* each row of the timestamp column contains the transaction commit time.</p>
|
|
2631
|
+
*
|
|
2632
|
+
* <p>When <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>false</code>, the full load timestamp
|
|
2633
|
+
* in the timestamp column increments with the time data arrives at the target. </p>
|
|
2634
|
+
*/
|
|
2635
|
+
UseTaskStartTimeForFullLoadTimestamp?: boolean;
|
|
2516
2636
|
/**
|
|
2517
2637
|
* <p>A value that enables DMS to specify a predefined (canned) access control list for
|
|
2518
2638
|
* objects created in an Amazon S3 bucket as .csv or .parquet files. For more information
|
|
@@ -2593,6 +2713,20 @@ export interface S3Settings {
|
|
|
2593
2713
|
* <code>y</code>, and <code>n</code>.</p>
|
|
2594
2714
|
*/
|
|
2595
2715
|
Rfc4180?: boolean;
|
|
2716
|
+
/**
|
|
2717
|
+
* <p>When creating an S3 target endpoint, set <code>DatePartitionTimezone</code> to convert
|
|
2718
|
+
* the current UTC time into a specified time zone. The conversion occurs when a date
|
|
2719
|
+
* partition folder is created and a CDC filename is generated. The time zone format is Area/Location.
|
|
2720
|
+
* Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>, as shown in the
|
|
2721
|
+
* following example.</p>
|
|
2722
|
+
* <p>
|
|
2723
|
+
* <code>s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH",
|
|
2724
|
+
* "DatePartitionDelimiter": "SLASH",
|
|
2725
|
+
* "DatePartitionTimezone":"<i>Asia/Seoul</i>", "BucketName":
|
|
2726
|
+
* "dms-nattarat-test"}'</code>
|
|
2727
|
+
* </p>
|
|
2728
|
+
*/
|
|
2729
|
+
DatePartitionTimezone?: string;
|
|
2596
2730
|
}
|
|
2597
2731
|
export declare namespace S3Settings {
|
|
2598
2732
|
/**
|
|
@@ -2619,7 +2753,7 @@ export interface SybaseSettings {
|
|
|
2619
2753
|
*/
|
|
2620
2754
|
Password?: string;
|
|
2621
2755
|
/**
|
|
2622
|
-
* <p>Endpoint TCP port.</p>
|
|
2756
|
+
* <p>Endpoint TCP port. The default is 5000.</p>
|
|
2623
2757
|
*/
|
|
2624
2758
|
Port?: number;
|
|
2625
2759
|
/**
|
|
@@ -2677,8 +2811,8 @@ export interface CreateEndpointMessage {
|
|
|
2677
2811
|
/**
|
|
2678
2812
|
* <p>The type of engine for the endpoint. Valid values, depending on the
|
|
2679
2813
|
* <code>EndpointType</code> value, include <code>"mysql"</code>, <code>"oracle"</code>,
|
|
2680
|
-
*
|
|
2681
|
-
*
|
|
2814
|
+
* <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>,
|
|
2815
|
+
* <code>"aurora-postgresql"</code>, <code>"opensearch"</code>, <code>"redshift"</code>, <code>"s3"</code>,
|
|
2682
2816
|
* <code>"db2"</code>, <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>,
|
|
2683
2817
|
* <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>, <code>"docdb"</code>,
|
|
2684
2818
|
* <code>"sqlserver"</code>, and <code>"neptune"</code>.</p>
|
|
@@ -2806,8 +2940,8 @@ export interface CreateEndpointMessage {
|
|
|
2806
2940
|
*/
|
|
2807
2941
|
KafkaSettings?: KafkaSettings;
|
|
2808
2942
|
/**
|
|
2809
|
-
* <p>Settings in JSON format for the target
|
|
2810
|
-
* 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
|
|
2943
|
+
* <p>Settings in JSON format for the target OpenSearch endpoint. For more information
|
|
2944
|
+
* 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 DMS</a> in
|
|
2811
2945
|
* the <i>Database Migration Service User Guide</i>.</p>
|
|
2812
2946
|
*/
|
|
2813
2947
|
ElasticsearchSettings?: ElasticsearchSettings;
|
|
@@ -2896,6 +3030,10 @@ export interface CreateEndpointMessage {
|
|
|
2896
3030
|
* <p>Settings in JSON format for the target Redis endpoint.</p>
|
|
2897
3031
|
*/
|
|
2898
3032
|
RedisSettings?: RedisSettings;
|
|
3033
|
+
/**
|
|
3034
|
+
* <p>Settings in JSON format for the source GCP MySQL endpoint.</p>
|
|
3035
|
+
*/
|
|
3036
|
+
GcpMySQLSettings?: GcpMySQLSettings;
|
|
2899
3037
|
}
|
|
2900
3038
|
export declare namespace CreateEndpointMessage {
|
|
2901
3039
|
/**
|
|
@@ -2938,7 +3076,7 @@ export interface Endpoint {
|
|
|
2938
3076
|
/**
|
|
2939
3077
|
* <p>The database engine name. Valid values, depending on the EndpointType, include
|
|
2940
3078
|
* <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>,
|
|
2941
|
-
* <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>,
|
|
3079
|
+
* <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"opensearch"</code>,
|
|
2942
3080
|
* <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"azuredb"</code>,
|
|
2943
3081
|
* <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>,
|
|
2944
3082
|
* <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>,
|
|
@@ -3020,25 +3158,7 @@ export interface Endpoint {
|
|
|
3020
3158
|
*/
|
|
3021
3159
|
S3Settings?: S3Settings;
|
|
3022
3160
|
/**
|
|
3023
|
-
* <p>The settings
|
|
3024
|
-
* <p>Possible settings include the following:</p>
|
|
3025
|
-
* <ul>
|
|
3026
|
-
* <li>
|
|
3027
|
-
* <p>
|
|
3028
|
-
* <code>ServiceAccessRoleArn</code> - - The Amazon Resource Name (ARN) used by the service access IAM role.
|
|
3029
|
-
* The role must allow the <code>iam:PassRole</code> action.</p>
|
|
3030
|
-
* </li>
|
|
3031
|
-
* <li>
|
|
3032
|
-
* <p>
|
|
3033
|
-
* <code>BucketName</code> - The name of the S3 bucket to use.</p>
|
|
3034
|
-
* </li>
|
|
3035
|
-
* </ul>
|
|
3036
|
-
* <p>Shorthand syntax for these settings is as follows:
|
|
3037
|
-
* <code>ServiceAccessRoleArn=string,BucketName=string,</code>
|
|
3038
|
-
* </p>
|
|
3039
|
-
* <p>JSON syntax for these settings is as follows: <code>{ "ServiceAccessRoleArn":
|
|
3040
|
-
* "string", "BucketName": "string"} </code>
|
|
3041
|
-
* </p>
|
|
3161
|
+
* <p>The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure. </p>
|
|
3042
3162
|
*/
|
|
3043
3163
|
DmsTransferSettings?: DmsTransferSettings;
|
|
3044
3164
|
/**
|
|
@@ -3057,7 +3177,7 @@ export interface Endpoint {
|
|
|
3057
3177
|
*/
|
|
3058
3178
|
KafkaSettings?: KafkaSettings;
|
|
3059
3179
|
/**
|
|
3060
|
-
* <p>The settings for the
|
|
3180
|
+
* <p>The settings for the OpenSearch source endpoint. For more information, see the
|
|
3061
3181
|
* <code>ElasticsearchSettings</code> structure.</p>
|
|
3062
3182
|
*/
|
|
3063
3183
|
ElasticsearchSettings?: ElasticsearchSettings;
|
|
@@ -3110,6 +3230,10 @@ export interface Endpoint {
|
|
|
3110
3230
|
* <code>RedisSettings</code> structure.</p>
|
|
3111
3231
|
*/
|
|
3112
3232
|
RedisSettings?: RedisSettings;
|
|
3233
|
+
/**
|
|
3234
|
+
* <p>Settings in JSON format for the source GCP MySQL endpoint.</p>
|
|
3235
|
+
*/
|
|
3236
|
+
GcpMySQLSettings?: GcpMySQLSettings;
|
|
3113
3237
|
}
|
|
3114
3238
|
export declare namespace Endpoint {
|
|
3115
3239
|
/**
|
|
@@ -3339,7 +3463,7 @@ export declare namespace KMSAccessDeniedFault {
|
|
|
3339
3463
|
const filterSensitiveLog: (obj: KMSAccessDeniedFault) => any;
|
|
3340
3464
|
}
|
|
3341
3465
|
/**
|
|
3342
|
-
* <p>The specified
|
|
3466
|
+
* <p>The specified KMS key isn't enabled.</p>
|
|
3343
3467
|
*/
|
|
3344
3468
|
export interface KMSDisabledFault extends __SmithyException, $MetadataBearer {
|
|
3345
3469
|
name: "KMSDisabledFault";
|
|
@@ -4486,7 +4610,7 @@ export declare namespace CreateReplicationTaskResponse {
|
|
|
4486
4610
|
}
|
|
4487
4611
|
export interface DeleteCertificateMessage {
|
|
4488
4612
|
/**
|
|
4489
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4613
|
+
* <p>The Amazon Resource Name (ARN) of the certificate.</p>
|
|
4490
4614
|
*/
|
|
4491
4615
|
CertificateArn: string | undefined;
|
|
4492
4616
|
}
|
|
@@ -4516,7 +4640,8 @@ export interface Certificate {
|
|
|
4516
4640
|
*/
|
|
4517
4641
|
CertificatePem?: string;
|
|
4518
4642
|
/**
|
|
4519
|
-
* <p>The location of an imported Oracle Wallet certificate for use with SSL
|
|
4643
|
+
* <p>The location of an imported Oracle Wallet certificate for use with SSL. Example: <code>filebase64("${path.root}/rds-ca-2019-root.sso")</code>
|
|
4644
|
+
* </p>
|
|
4520
4645
|
*/
|
|
4521
4646
|
CertificateWallet?: Uint8Array;
|
|
4522
4647
|
/**
|
|
@@ -4972,7 +5097,8 @@ export declare namespace Filter {
|
|
|
4972
5097
|
}
|
|
4973
5098
|
export interface DescribeCertificatesMessage {
|
|
4974
5099
|
/**
|
|
4975
|
-
* <p>Filters applied to the certificates described in the form of key-value pairs
|
|
5100
|
+
* <p>Filters applied to the certificates described in the form of key-value pairs.
|
|
5101
|
+
* Valid values are <code>certificate-arn</code> and <code>certificate-id</code>.</p>
|
|
4976
5102
|
*/
|
|
4977
5103
|
Filters?: Filter[];
|
|
4978
5104
|
/**
|
|
@@ -5391,7 +5517,7 @@ export interface DescribeEventsMessage {
|
|
|
5391
5517
|
*/
|
|
5392
5518
|
EventCategories?: string[];
|
|
5393
5519
|
/**
|
|
5394
|
-
* <p>Filters applied to events
|
|
5520
|
+
* <p>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</p>
|
|
5395
5521
|
*/
|
|
5396
5522
|
Filters?: Filter[];
|
|
5397
5523
|
/**
|
|
@@ -5480,6 +5606,7 @@ export interface DescribeEventSubscriptionsMessage {
|
|
|
5480
5606
|
SubscriptionName?: string;
|
|
5481
5607
|
/**
|
|
5482
5608
|
* <p>Filters applied to event subscriptions.</p>
|
|
5609
|
+
* <p>Valid filter names: event-subscription-arn | event-subscription-id </p>
|
|
5483
5610
|
*/
|
|
5484
5611
|
Filters?: Filter[];
|
|
5485
5612
|
/**
|
|
@@ -6520,8 +6647,9 @@ export interface ImportCertificateMessage {
|
|
|
6520
6647
|
CertificatePem?: string;
|
|
6521
6648
|
/**
|
|
6522
6649
|
* <p>The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a <code>.sso</code> file
|
|
6523
|
-
* using the <code>fileb://</code> prefix. You can't provide the certificate inline
|
|
6524
|
-
*
|
|
6650
|
+
* using the <code>fileb://</code> prefix. You can't provide the certificate inline.</p>
|
|
6651
|
+
* <p>Example: <code>filebase64("${path.root}/rds-ca-2019-root.sso")</code>
|
|
6652
|
+
* </p>
|
|
6525
6653
|
*/
|
|
6526
6654
|
CertificateWallet?: Uint8Array;
|
|
6527
6655
|
/**
|
|
@@ -6622,7 +6750,7 @@ export interface ModifyEndpointMessage {
|
|
|
6622
6750
|
* <p>The type of engine for the endpoint. Valid values, depending on the EndpointType,
|
|
6623
6751
|
* include
|
|
6624
6752
|
* <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>,
|
|
6625
|
-
* <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>,
|
|
6753
|
+
* <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"opensearch"</code>,
|
|
6626
6754
|
* <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"azuredb"</code>,
|
|
6627
6755
|
* <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>,
|
|
6628
6756
|
* <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>,
|
|
@@ -6729,8 +6857,8 @@ export interface ModifyEndpointMessage {
|
|
|
6729
6857
|
*/
|
|
6730
6858
|
KafkaSettings?: KafkaSettings;
|
|
6731
6859
|
/**
|
|
6732
|
-
* <p>Settings in JSON format for the target
|
|
6733
|
-
* 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
|
|
6860
|
+
* <p>Settings in JSON format for the target OpenSearch endpoint. For more information
|
|
6861
|
+
* 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 DMS</a> in
|
|
6734
6862
|
* the <i>Database Migration Service User Guide.</i>
|
|
6735
6863
|
* </p>
|
|
6736
6864
|
*/
|
|
@@ -6835,6 +6963,10 @@ export interface ModifyEndpointMessage {
|
|
|
6835
6963
|
* are replaced with the exact settings that you specify. </p>
|
|
6836
6964
|
*/
|
|
6837
6965
|
ExactSettings?: boolean;
|
|
6966
|
+
/**
|
|
6967
|
+
* <p>Settings in JSON format for the source GCP MySQL endpoint.</p>
|
|
6968
|
+
*/
|
|
6969
|
+
GcpMySQLSettings?: GcpMySQLSettings;
|
|
6838
6970
|
}
|
|
6839
6971
|
export declare namespace ModifyEndpointMessage {
|
|
6840
6972
|
/**
|
|
@@ -7399,7 +7531,13 @@ export interface StartReplicationTaskMessage {
|
|
|
7399
7531
|
*/
|
|
7400
7532
|
ReplicationTaskArn: string | undefined;
|
|
7401
7533
|
/**
|
|
7402
|
-
* <p>
|
|
7534
|
+
* <p>The type of replication task to start.</p>
|
|
7535
|
+
* <p>When the migration type is <code>full-load</code> or <code>full-load-and-cdc</code>, the only valid value
|
|
7536
|
+
* for the first run of the task is <code>start-replication</code>. You use <code>reload-target</code> to restart
|
|
7537
|
+
* the task and <code>resume-processing</code> to resume the task.</p>
|
|
7538
|
+
* <p>When the migration type is <code>cdc</code>, you use <code>start-replication</code> to start or restart
|
|
7539
|
+
* the task, and <code>resume-processing</code> to resume the task. <code>reload-target</code> is not a valid value for
|
|
7540
|
+
* a task with migration type of <code>cdc</code>.</p>
|
|
7403
7541
|
*/
|
|
7404
7542
|
StartReplicationTaskType: StartReplicationTaskTypeValue | string | undefined;
|
|
7405
7543
|
/**
|
|
@@ -260,6 +260,45 @@ export declare enum ReplicationEndpointTypeValue {
|
|
|
260
260
|
SOURCE = "source",
|
|
261
261
|
TARGET = "target"
|
|
262
262
|
}
|
|
263
|
+
export declare enum TargetDbType {
|
|
264
|
+
MULTIPLE_DATABASES = "multiple-databases",
|
|
265
|
+
SPECIFIC_DATABASE = "specific-database"
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
export interface GcpMySQLSettings {
|
|
269
|
+
|
|
270
|
+
AfterConnectScript?: string;
|
|
271
|
+
|
|
272
|
+
CleanSourceMetadataOnMismatch?: boolean;
|
|
273
|
+
|
|
274
|
+
DatabaseName?: string;
|
|
275
|
+
|
|
276
|
+
EventsPollInterval?: number;
|
|
277
|
+
|
|
278
|
+
TargetDbType?: TargetDbType | string;
|
|
279
|
+
|
|
280
|
+
MaxFileSize?: number;
|
|
281
|
+
|
|
282
|
+
ParallelLoadThreads?: number;
|
|
283
|
+
|
|
284
|
+
Password?: string;
|
|
285
|
+
|
|
286
|
+
Port?: number;
|
|
287
|
+
|
|
288
|
+
ServerName?: string;
|
|
289
|
+
|
|
290
|
+
ServerTimezone?: string;
|
|
291
|
+
|
|
292
|
+
Username?: string;
|
|
293
|
+
|
|
294
|
+
SecretsManagerAccessRoleArn?: string;
|
|
295
|
+
|
|
296
|
+
SecretsManagerSecretId?: string;
|
|
297
|
+
}
|
|
298
|
+
export declare namespace GcpMySQLSettings {
|
|
299
|
+
|
|
300
|
+
const filterSensitiveLog: (obj: GcpMySQLSettings) => any;
|
|
301
|
+
}
|
|
263
302
|
|
|
264
303
|
export interface IBMDb2Settings {
|
|
265
304
|
|
|
@@ -451,10 +490,6 @@ export declare namespace MongoDbSettings {
|
|
|
451
490
|
|
|
452
491
|
const filterSensitiveLog: (obj: MongoDbSettings) => any;
|
|
453
492
|
}
|
|
454
|
-
export declare enum TargetDbType {
|
|
455
|
-
MULTIPLE_DATABASES = "multiple-databases",
|
|
456
|
-
SPECIFIC_DATABASE = "specific-database"
|
|
457
|
-
}
|
|
458
493
|
|
|
459
494
|
export interface MySQLSettings {
|
|
460
495
|
|
|
@@ -851,6 +886,8 @@ export interface S3Settings {
|
|
|
851
886
|
|
|
852
887
|
CdcPath?: string;
|
|
853
888
|
|
|
889
|
+
UseTaskStartTimeForFullLoadTimestamp?: boolean;
|
|
890
|
+
|
|
854
891
|
CannedAclForObjects?: CannedAclForObjectsValue | string;
|
|
855
892
|
|
|
856
893
|
AddColumnName?: boolean;
|
|
@@ -866,6 +903,8 @@ export interface S3Settings {
|
|
|
866
903
|
MaxFileSize?: number;
|
|
867
904
|
|
|
868
905
|
Rfc4180?: boolean;
|
|
906
|
+
|
|
907
|
+
DatePartitionTimezone?: string;
|
|
869
908
|
}
|
|
870
909
|
export declare namespace S3Settings {
|
|
871
910
|
|
|
@@ -966,6 +1005,8 @@ export interface CreateEndpointMessage {
|
|
|
966
1005
|
DocDbSettings?: DocDbSettings;
|
|
967
1006
|
|
|
968
1007
|
RedisSettings?: RedisSettings;
|
|
1008
|
+
|
|
1009
|
+
GcpMySQLSettings?: GcpMySQLSettings;
|
|
969
1010
|
}
|
|
970
1011
|
export declare namespace CreateEndpointMessage {
|
|
971
1012
|
|
|
@@ -1041,6 +1082,8 @@ export interface Endpoint {
|
|
|
1041
1082
|
DocDbSettings?: DocDbSettings;
|
|
1042
1083
|
|
|
1043
1084
|
RedisSettings?: RedisSettings;
|
|
1085
|
+
|
|
1086
|
+
GcpMySQLSettings?: GcpMySQLSettings;
|
|
1044
1087
|
}
|
|
1045
1088
|
export declare namespace Endpoint {
|
|
1046
1089
|
|
|
@@ -2657,6 +2700,8 @@ export interface ModifyEndpointMessage {
|
|
|
2657
2700
|
RedisSettings?: RedisSettings;
|
|
2658
2701
|
|
|
2659
2702
|
ExactSettings?: boolean;
|
|
2703
|
+
|
|
2704
|
+
GcpMySQLSettings?: GcpMySQLSettings;
|
|
2660
2705
|
}
|
|
2661
2706
|
export declare namespace ModifyEndpointMessage {
|
|
2662
2707
|
|