@aws-mdaa/dms-constructs 1.2.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.
@@ -0,0 +1,2538 @@
1
+ /*!
2
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3
+ * SPDX-License-Identifier: Apache-2.0
4
+ */
5
+ import { MdaaConstructProps } from '@aws-mdaa/construct';
6
+ import { CfnEndpoint } from 'aws-cdk-lib/aws-dms';
7
+ import { IKey } from 'aws-cdk-lib/aws-kms';
8
+ import { Construct } from 'constructs';
9
+ /**
10
+ * Provides information that defines a SAP ASE endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
11
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
12
+ * @struct
13
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html
14
+ */
15
+ /**
16
+ * Q-ENHANCED-INTERFACE
17
+ * Sybase database settings configuration interface for DMS endpoint with secure credential management and IAM role-based access. Defines Sybase-specific properties for Database Migration Service including Secrets Manager integration for secure credential storage and IAM role configuration for accessing SAP ASE endpoints.
18
+ *
19
+ * Use cases: Sybase database migration; SAP ASE connectivity; Secure credential management; Enterprise database integration
20
+ *
21
+ * AWS: AWS DMS Sybase endpoint configuration with Secrets Manager integration and IAM role-based security
22
+ *
23
+ * Validation: Must include valid Secrets Manager secret ARN; IAM role must have appropriate DMS and Secrets Manager permissions
24
+ */
25
+ export interface SybaseSettingsProperty {
26
+ /**
27
+ * Q-ENHANCED-PROPERTY
28
+ * Optional IAM role ARN for DMS to access Secrets Manager secret containing Sybase endpoint credentials enabling secure credential management. Defines the IAM role that DMS assumes to retrieve database credentials from Secrets Manager for SAP ASE endpoint connectivity with role-based security.
29
+ *
30
+ * Use cases: Secure credential access; IAM role-based security; Secrets Manager integration; DMS authentication
31
+ *
32
+ * AWS: DMS Sybase endpoint secretsManagerAccessRoleArn setting for IAM role-based credential access
33
+ *
34
+ * Validation: Must be valid IAM role ARN if provided; role must have iam:PassRole and Secrets Manager access permissions
35
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanageraccessrolearn
36
+ */
37
+ readonly secretsManagerAccessRoleArn?: string;
38
+ /**
39
+ * Q-ENHANCED-PROPERTY
40
+ * Required Secrets Manager secret ARN containing Sybase endpoint connection details enabling secure credential storage for SAP ASE database connectivity. Defines the AWS Secrets Manager secret that stores database connection credentials including username, password, and connection parameters for Sybase endpoint access.
41
+ *
42
+ * Use cases: Secure credential storage; SAP ASE connectivity; Database authentication; Secrets management
43
+ *
44
+ * AWS: DMS Sybase endpoint secretsManagerSecretId setting for Secrets Manager secret reference
45
+ *
46
+ * Validation: Must be valid Secrets Manager secret ARN; secret must contain valid Sybase connection credentials
47
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanagersecretid
48
+ */
49
+ readonly secretsManagerSecretArn: string;
50
+ /**
51
+ * Q-ENHANCED-PROPERTY
52
+ * Optional KMS key ARN for encrypting Secrets Manager secret containing Sybase credentials enabling enhanced security for database connection details. Defines the KMS key used to encrypt the Secrets Manager secret that stores Sybase endpoint credentials for additional security layer.
53
+ *
54
+ * Use cases: Credential encryption; Enhanced security; KMS integration; Secrets Manager encryption
55
+ *
56
+ * AWS: DMS Sybase endpoint secretsManagerSecretKMSArn setting for KMS encryption of credentials
57
+ *
58
+ * Validation: Must be valid KMS key ARN if provided; enables encryption of Secrets Manager secret containing credentials
59
+ */
60
+ readonly secretsManagerSecretKMSArn?: string;
61
+ }
62
+ /**
63
+ * Provides information that defines an Oracle endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
64
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
65
+ * @struct
66
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html
67
+ */
68
+ /**
69
+ * Q-ENHANCED-INTERFACE
70
+ * Configuration interface for AWS DMS Oracle database endpoint settings providing replication and change data capture options. Provides Oracle-specific configuration properties for DMS endpoints including supplemental logging, archived log management, and advanced Oracle database features for secure and efficient data migration and replication.
71
+ *
72
+ * Use cases: Oracle database migration; Change data capture; Database replication; Oracle-specific configuration; Advanced Oracle features
73
+ *
74
+ * AWS: AWS Database Migration Service Oracle endpoint configuration with Oracle-specific settings and optimization parameters
75
+ *
76
+ * Validation: Boolean properties must be true/false; numeric properties must be valid integers; string properties must follow Oracle naming conventions
77
+ */
78
+ export interface OracleSettingsProperty {
79
+ /**
80
+ * Q-ENHANCED-PROPERTY
81
+ * Optional flag to disable Binary Reader access to redo logs through direct file access for Oracle RDS sources. Controls whether DMS accesses redo logs directly or through specified path prefix replacement, affecting change data capture performance and configuration for Oracle database replication.
82
+ *
83
+ * Use cases: RDS Oracle configuration; Change data capture optimization; Direct file access control; Performance tuning; Oracle replication setup
84
+ *
85
+ * AWS: AWS DMS Oracle endpoint accessAlternateDirectly setting for redo log access configuration
86
+ *
87
+ * Validation: Must be boolean value if provided; affects Oracle change data capture behavior and performance
88
+ **/
89
+ readonly accessAlternateDirectly?: boolean;
90
+ /**
91
+ * Q-ENHANCED-PROPERTY
92
+ * Optional additional archived log destination ID for Oracle primary/standby switchover scenarios. Specifies the destination for archive redo logs in switchover situations where the previous primary instance becomes standby, enabling continuous replication during Oracle database role changes.
93
+ *
94
+ * Use cases: Oracle switchover; High availability; Standby database configuration; Archive log management; Disaster recovery
95
+ *
96
+ * AWS: AWS DMS Oracle endpoint additionalArchivedLogDestId for switchover archive log destination
97
+ *
98
+ * Validation: Must be valid integer destination ID if provided; used for Oracle switchover scenarios and archive log management
99
+ **/
100
+ readonly additionalArchivedLogDestId?: number;
101
+ /**
102
+ * Q-ENHANCED-PROPERTY
103
+ * Optional flag to enable table-level supplemental logging for Oracle database migration tasks. Enables PRIMARY KEY supplemental logging on all selected tables for migration, providing necessary change data capture information while requiring database-level supplemental logging to be enabled separately.
104
+ *
105
+ * Use cases: Supplemental logging; Change data capture; Table-level logging; Oracle migration; Primary key tracking
106
+ *
107
+ * AWS: AWS DMS Oracle endpoint addSupplementalLogging for table-level supplemental logging configuration
108
+ *
109
+ * Validation: Must be boolean value if provided; requires database-level supplemental logging to be enabled for proper operation
110
+ **/
111
+ readonly addSupplementalLogging?: boolean;
112
+ /**
113
+ * Q-ENHANCED-PROPERTY
114
+ * Optional flag to enable replication of Oracle tables with nested tables or defined types for complex data structure migration. Allows DMS to replicate Oracle tables containing columns with nested tables or user-defined types, enabling migration of complex Oracle database schemas with advanced data structures.
115
+ *
116
+ * Use cases: Complex schema migration; Nested table replication; User-defined types; Advanced Oracle features; Complex data structures
117
+ *
118
+ * AWS: AWS DMS Oracle endpoint allowSelectNestedTables for complex data type replication support
119
+ *
120
+ * Validation: Must be boolean value if provided; enables replication of Oracle nested tables and defined types
121
+ **/
122
+ readonly allowSelectNestedTables?: boolean;
123
+ /**
124
+ * Q-ENHANCED-PROPERTY
125
+ * Optional archived redo log destination ID for Oracle change data capture configuration. Specifies the destination ID for archived redo logs matching the dest_id column in v$archived_log view, optimizing performance by ensuring correct log access from the start of replication operations.
126
+ *
127
+ * Use cases: Archived log configuration; Performance optimization; Change data capture; Log destination management; Oracle replication tuning
128
+ *
129
+ * AWS: AWS DMS Oracle endpoint archivedLogDestId for archived redo log destination specification
130
+ *
131
+ * Validation: Must be valid integer matching Oracle v$archived_log dest_id; improves performance through correct log access
132
+ **/
133
+ readonly archivedLogDestId?: number;
134
+ /**
135
+ * Q-ENHANCED-PROPERTY
136
+ * Optional flag to restrict DMS access to archived redo logs only for Oracle replication. When enabled, DMS accesses only archived redo logs, requiring ASM privileges if logs are stored on Automatic Storage Management, providing controlled access to Oracle change data.
137
+ *
138
+ * Use cases: Archived log only access; ASM storage; Controlled log access; Oracle security; Change data capture restriction
139
+ *
140
+ * AWS: AWS DMS Oracle endpoint archivedLogsOnly for restricted archived log access configuration
141
+ *
142
+ * Validation: Must be boolean value if provided; requires ASM privileges when archived logs are on ASM storage
143
+ **/
144
+ readonly archivedLogsOnly?: boolean;
145
+ /**
146
+ * Q-ENHANCED-PROPERTY
147
+ * Optional ASM server address for Oracle source endpoint Binary Reader configuration. Specifies the Automatic Storage Management server address for Oracle databases using ASM, enabling DMS Binary Reader access to Oracle databases with ASM storage for change data capture operations.
148
+ *
149
+ * Use cases: ASM configuration; Binary Reader setup; Oracle ASM access; Storage management; Change data capture with ASM
150
+ *
151
+ * AWS: AWS DMS Oracle endpoint asmServer for ASM server address configuration with Binary Reader
152
+ *
153
+ * Validation: Must be valid ASM server address if provided; required for Oracle databases using ASM storage with Binary Reader
154
+ **/
155
+ readonly asmServer?: string;
156
+ /**
157
+ * Q-ENHANCED-PROPERTY
158
+ * Optional character length semantics specification for Oracle character column interpretation. Determines whether character column lengths are measured in bytes or characters, affecting data type mapping and character handling during Oracle database migration and replication operations.
159
+ *
160
+ * Use cases: Character encoding; Data type mapping; Character column handling; Oracle character semantics; Migration accuracy
161
+ *
162
+ * AWS: AWS DMS Oracle endpoint charLengthSemantics for character column length interpretation
163
+ *
164
+ * Validation: Must be 'CHAR' for character-based or default for byte-based; affects character column length calculation
165
+ **/
166
+ readonly charLengthSemantics?: string;
167
+ /**
168
+ * Q-ENHANCED-PROPERTY
169
+ * Optional flag to enable direct path loading without database logging for Oracle target performance optimization. Increases commit rate on Oracle target databases by writing directly to tables without creating database log trails, improving performance for bulk data loading operations.
170
+ *
171
+ * Use cases: Performance optimization; Bulk loading; Direct path loading; Oracle target optimization; High-speed migration
172
+ *
173
+ * AWS: AWS DMS Oracle endpoint directPathNoLog for direct path loading without logging
174
+ *
175
+ * Validation: Must be boolean value if provided; improves performance but bypasses Oracle database logging mechanisms
176
+ **/
177
+ readonly directPathNoLog?: boolean;
178
+ /**
179
+ * Q-ENHANCED-PROPERTY
180
+ * Optional flag to enable parallel loading when direct path full load is active for Oracle target performance optimization. Enables parallel load operations when useDirectPathFullLoad is set, requiring target tables without constraints or indexes for maximum performance during bulk data migration.
181
+ *
182
+ * Use cases: Parallel loading; Performance optimization; Bulk migration; Direct path loading; High-speed data transfer
183
+ *
184
+ * AWS: AWS DMS Oracle endpoint directPathParallelLoad for parallel loading with direct path full load
185
+ *
186
+ * Validation: Must be boolean value if provided; requires useDirectPathFullLoad enabled and target tables without constraints/indexes
187
+ **/
188
+ readonly directPathParallelLoad?: boolean;
189
+ /**
190
+ * Q-ENHANCED-PROPERTY
191
+ * Optional flag to enable homogeneous tablespace replication for Oracle target database consistency. Creates existing tables and indexes under the same tablespace on the target database, maintaining Oracle tablespace organization and storage structure during migration operations.
192
+ *
193
+ * Use cases: Tablespace consistency; Oracle structure preservation; Storage organization; Database layout maintenance; Migration fidelity
194
+ *
195
+ * AWS: AWS DMS Oracle endpoint enableHomogenousTablespace for tablespace replication and consistency
196
+ *
197
+ * Validation: Must be boolean value if provided; maintains Oracle tablespace structure and organization on target database
198
+ **/
199
+ readonly enableHomogenousTablespace?: boolean;
200
+ /**
201
+ * Q-ENHANCED-PROPERTY
202
+ * Optional array of additional archived log destination IDs for Oracle Data Guard switchover scenarios. Specifies multiple destinations for archived redo logs in primary-to-multiple-standby setups, enabling DMS to access correct archive logs during Oracle Data Guard switchover operations.
203
+ *
204
+ * Use cases: Data Guard switchover; Multiple standby configuration; Archive log management; High availability; Disaster recovery
205
+ *
206
+ * AWS: AWS DMS Oracle endpoint extraArchivedLogDestIds for multiple archived log destination configuration
207
+ *
208
+ * Validation: Must be array of valid integer destination IDs if provided; used with archivedLogDestId for switchover scenarios
209
+ * **/
210
+ readonly extraArchivedLogDestIds?: Array<number>;
211
+ /**
212
+ * Q-ENHANCED-PROPERTY
213
+ * Optional flag to cause task failure when LOB column size exceeds specified LobMaxSize limit. Forces task failure instead of LOB data truncation when actual LOB size is greater than LobMaxSize in limited LOB mode, ensuring data integrity and preventing silent data loss.
214
+ *
215
+ * Use cases: Data integrity; LOB handling; Error handling; Data validation; Migration quality control
216
+ *
217
+ * AWS: AWS DMS Oracle endpoint failTasksOnLobTruncation for LOB size validation and error handling
218
+ *
219
+ * Validation: Must be boolean value if provided; causes task failure instead of LOB truncation when size limits exceeded
220
+ **/
221
+ readonly failTasksOnLobTruncation?: boolean;
222
+ /**
223
+ * Q-ENHANCED-PROPERTY
224
+ * Optional number data type scale specification for Oracle NUMBER data type conversion precision. Defines the scale for NUMBER data type conversion up to 38 or FLOAT, controlling precision and scale during Oracle numeric data migration with default precision 38, scale 10.
225
+ *
226
+ * Use cases: Numeric precision; Data type conversion; Oracle NUMBER handling; Precision control; Migration accuracy
227
+ *
228
+ * AWS: AWS DMS Oracle endpoint numberDatatypeScale for NUMBER data type conversion precision
229
+ *
230
+ * Validation: Must be integer between 0-38 or FLOAT if provided; controls Oracle NUMBER data type conversion precision and scale
231
+ **/
232
+ readonly numberDatatypeScale?: number;
233
+ /**
234
+ * Q-ENHANCED-PROPERTY
235
+ * Optional Oracle path prefix for Binary Reader redo log access configuration. Specifies the default Oracle root path for accessing redo logs when using Binary Reader for change data capture from Amazon RDS for Oracle sources, enabling proper redo log access and change data capture operations.
236
+ *
237
+ * Use cases: Binary Reader configuration; Redo log access; RDS Oracle sources; Change data capture; Path configuration
238
+ *
239
+ * AWS: AWS DMS Oracle endpoint oraclePathPrefix for Binary Reader redo log access path specification
240
+ *
241
+ * Validation: Must be valid Oracle path string if provided; required for Binary Reader access to RDS Oracle redo logs
242
+ **/
243
+ readonly oraclePathPrefix?: string;
244
+ /**
245
+ * Q-ENHANCED-PROPERTY
246
+ * Optional number of parallel ASM read threads for Oracle change data capture performance optimization. Configures the number of threads (2-8) for CDC load operations using Oracle Automatic Storage Management, working with readAheadBlocks for optimized ASM performance during change data capture.
247
+ *
248
+ * Use cases: ASM performance; CDC optimization; Thread configuration; Parallel processing; Oracle ASM tuning
249
+ *
250
+ * AWS: AWS DMS Oracle endpoint parallelAsmReadThreads for ASM CDC performance optimization
251
+ *
252
+ * Validation: Must be integer between 2-8 if provided; used with readAheadBlocks for ASM performance tuning
253
+ **/
254
+ readonly parallelAsmReadThreads?: number;
255
+ /**
256
+ * Q-ENHANCED-PROPERTY
257
+ * Optional number of read-ahead blocks for Oracle ASM change data capture performance optimization. Configures read-ahead blocks (1000-200000) for CDC load operations using Oracle Automatic Storage Management, working with parallelAsmReadThreads for optimized ASM performance during change data capture.
258
+ *
259
+ * Use cases: ASM performance; CDC optimization; Block configuration; Read-ahead tuning; Oracle ASM optimization
260
+ *
261
+ * AWS: AWS DMS Oracle endpoint readAheadBlocks for ASM CDC read-ahead performance optimization
262
+ *
263
+ * Validation: Must be integer between 1000-200000 if provided; used with parallelAsmReadThreads for ASM performance tuning
264
+ **/
265
+ readonly readAheadBlocks?: number;
266
+ /**
267
+ * Q-ENHANCED-PROPERTY
268
+ * Optional flag to enable tablespace name reading for Oracle tablespace replication support. Enables DMS to read and replicate tablespace information during Oracle database migration, supporting tablespace-aware migration and maintaining Oracle storage organization on target databases.
269
+ *
270
+ * Use cases: Tablespace replication; Storage organization; Oracle structure preservation; Tablespace awareness; Migration fidelity
271
+ *
272
+ * AWS: AWS DMS Oracle endpoint readTableSpaceName for tablespace replication and organization support
273
+ *
274
+ * Validation: Must be boolean value if provided; enables tablespace name reading and replication during Oracle migration
275
+ **/
276
+ readonly readTableSpaceName?: boolean;
277
+ /**
278
+ * Q-ENHANCED-PROPERTY
279
+ * Optional flag to enable path prefix replacement for Binary Reader redo log access. Instructs DMS to replace the default Oracle root with usePathPrefix setting for redo log access when using Binary Reader for change data capture from Amazon RDS for Oracle sources.
280
+ *
281
+ * Use cases: Path replacement; Binary Reader configuration; RDS Oracle access; Redo log path management; Change data capture setup
282
+ *
283
+ * AWS: AWS DMS Oracle endpoint replacePathPrefix for Binary Reader path replacement configuration
284
+ *
285
+ * Validation: Must be boolean value if provided; enables path prefix replacement for Binary Reader redo log access
286
+ **/
287
+ readonly replacePathPrefix?: boolean;
288
+ /**
289
+ * Q-ENHANCED-PROPERTY
290
+ * Optional retry interval in seconds for Oracle connection query retry operations. Specifies the wait time before resending queries to Oracle database, providing resilience and error recovery for Oracle database connectivity issues during migration and replication operations.
291
+ *
292
+ * Use cases: Connection resilience; Error recovery; Query retry; Oracle connectivity; Network reliability
293
+ *
294
+ * AWS: AWS DMS Oracle endpoint retryInterval for query retry timing and connection resilience
295
+ *
296
+ * Validation: Must be positive integer in seconds if provided; controls query retry timing for Oracle connection resilience
297
+ **/
298
+ readonly retryInterval?: number;
299
+ /**
300
+ * Q-ENHANCED-PROPERTY
301
+ * Optional IAM role ARN for AWS Secrets Manager access to Oracle endpoint credentials. Specifies the IAM role with required permissions to access SecretsManagerSecret containing Oracle endpoint credentials, enabling secure credential management and access control for Oracle database connections.
302
+ *
303
+ * Use cases: Credential management; Secrets Manager integration; Secure access; IAM role configuration; Oracle authentication
304
+ *
305
+ * AWS: AWS IAM role ARN for Secrets Manager access to Oracle endpoint credentials and authentication
306
+ *
307
+ * Validation: Must be valid IAM role ARN if provided; requires iam:PassRole action and Secrets Manager access permissions
308
+ **/
309
+ readonly secretsManagerAccessRoleArn?: string;
310
+ /**
311
+ * Q-ENHANCED-PROPERTY
312
+ * Optional IAM role ARN for AWS Secrets Manager access to Oracle ASM credentials when using Advanced Storage Manager. Specifies the IAM role with required permissions to access SecretsManagerOracleAsmSecret containing Oracle ASM connection details, enabling secure ASM credential management for Oracle endpoints with ASM storage.
313
+ *
314
+ * Use cases: ASM credential management; Secrets Manager integration; Oracle ASM access; Secure ASM authentication; Advanced storage configuration
315
+ *
316
+ * AWS: AWS IAM role ARN for Secrets Manager access to Oracle ASM credentials and authentication
317
+ *
318
+ * Validation: Must be valid IAM role ARN if provided; required for Oracle endpoints using ASM; mutually exclusive with clear-text ASM credentials
319
+ **/
320
+ readonly secretsManagerOracleAsmAccessRoleArn?: string;
321
+ /**
322
+ * Q-ENHANCED-PROPERTY
323
+ * Optional Secrets Manager secret ARN containing Oracle ASM connection details for Advanced Storage Manager endpoints. Specifies the full ARN of the secret containing Oracle ASM connection information, enabling secure storage and access of ASM credentials for Oracle endpoints using Advanced Storage Manager.
324
+ *
325
+ * Use cases: ASM secret storage; Secure ASM credentials; Oracle ASM configuration; Advanced storage authentication; Secret management
326
+ *
327
+ * AWS: AWS Secrets Manager secret ARN containing Oracle ASM connection details and credentials
328
+ *
329
+ * Validation: Must be valid Secrets Manager secret ARN if provided; required for Oracle endpoints using ASM with Secrets Manager
330
+ **/
331
+ readonly secretsManagerOracleAsmSecretArn?: string;
332
+ /**
333
+ * Q-ENHANCED-PROPERTY
334
+ * Required Secrets Manager secret ARN containing Oracle endpoint connection details for secure credential management. Specifies the full ARN of the secret containing Oracle database connection information including credentials, enabling secure storage and access of Oracle endpoint authentication details.
335
+ *
336
+ * Use cases: Secure credential storage; Oracle authentication; Secrets Manager integration; Database connection security; Credential management
337
+ *
338
+ * AWS: AWS Secrets Manager secret ARN containing Oracle endpoint connection details and credentials
339
+ *
340
+ * Validation: Must be valid Secrets Manager secret ARN; required for secure Oracle endpoint credential management and authentication
341
+ **/
342
+ readonly secretsManagerSecretArn: string;
343
+ /**
344
+ * Q-ENHANCED-PROPERTY
345
+ * Optional KMS key ARN for encrypting Oracle endpoint credentials secret in Secrets Manager. Specifies the KMS key used to encrypt the credentials secret, providing additional encryption layer for Oracle endpoint authentication information stored in AWS Secrets Manager.
346
+ *
347
+ * Use cases: Credential encryption; KMS integration; Enhanced security; Secret encryption; Oracle credential protection
348
+ *
349
+ * AWS: AWS KMS key ARN for encrypting Secrets Manager secret containing Oracle endpoint credentials
350
+ *
351
+ * Validation: Must be valid KMS key ARN if provided; provides additional encryption for Oracle credentials in Secrets Manager
352
+ **/
353
+ readonly secretsManagerSecretKMSArn?: string;
354
+ /**
355
+ * Q-ENHANCED-PROPERTY
356
+ * Optional custom function name for converting Oracle SDO_GEOMETRY to GEOJSON format during spatial data migration. Specifies a custom function to handle spatial data conversion, defaulting to SDO2GEOJSON function if available, enabling proper handling of Oracle spatial data types during migration operations.
357
+ *
358
+ * Use cases: Spatial data conversion; GEOJSON transformation; Oracle spatial types; Custom function usage; Spatial data migration
359
+ *
360
+ * AWS: AWS DMS Oracle endpoint spatial data conversion function for SDO_GEOMETRY to GEOJSON transformation
361
+ *
362
+ * Validation: Must be valid Oracle function name if provided; function must be accessible and mimic SDO2GEOJSON operation
363
+ **/
364
+ readonly spatialDataOptionToGeoJsonFunctionName?: string;
365
+ /**
366
+ * Q-ENHANCED-PROPERTY
367
+ * Optional standby delay time in minutes for Oracle Active Data Guard standby database synchronization. Specifies the time lag between primary and standby databases when using Oracle Active Data Guard standby as CDC source, enabling replication from standby instances without impacting production databases.
368
+ *
369
+ * Use cases: Active Data Guard; Standby replication; Production isolation; CDC from standby; Database synchronization delay
370
+ *
371
+ * AWS: AWS DMS Oracle endpoint standby delay configuration for Active Data Guard standby database replication
372
+ *
373
+ * Validation: Must be positive integer in minutes if provided; controls synchronization delay for Active Data Guard standby sources
374
+ **/
375
+ readonly standbyDelayTime?: number;
376
+ /**
377
+ * Q-ENHANCED-PROPERTY
378
+ * Optional flag to enable alternate folder usage for online redo logs with Binary Reader for Oracle RDS sources. Instructs DMS Binary Reader to use specified prefix replacement for accessing online redo logs, enabling proper change data capture from Amazon RDS for Oracle databases with custom redo log configurations.
379
+ *
380
+ * Use cases: Binary Reader configuration; Online redo log access; RDS Oracle sources; Prefix replacement; Change data capture optimization
381
+ *
382
+ * AWS: AWS DMS Oracle endpoint useAlternateFolderForOnline for Binary Reader online redo log access configuration
383
+ *
384
+ * Validation: Must be boolean value if provided; enables alternate folder usage for Binary Reader online redo log access
385
+ **/
386
+ readonly useAlternateFolderForOnline?: boolean;
387
+ /**
388
+ * Q-ENHANCED-PROPERTY
389
+ * Optional flag to enable Binary Reader utility for Oracle change data capture operations. Enables Binary Reader for change data capture requiring UseLogminerReader to be disabled, providing alternative method for accessing Oracle redo logs with additional configuration for RDS Oracle sources and ASM environments.
390
+ *
391
+ * Use cases: Binary Reader CDC; Alternative log access; Oracle ASM support; RDS Oracle configuration; Change data capture method selection
392
+ *
393
+ * AWS: AWS DMS Oracle endpoint useBFile for Binary Reader utility change data capture configuration
394
+ *
395
+ * Validation: Must be boolean value if provided; requires UseLogminerReader set to false; additional attributes needed for RDS Oracle
396
+ **/
397
+ readonly useBFile?: boolean;
398
+ /**
399
+ * Q-ENHANCED-PROPERTY
400
+ * Optional flag to enable direct path full load for Oracle target database performance optimization. Uses Oracle Call Interface (OCI) direct path protocol for bulk-loading Oracle target tables during full load operations, providing improved performance for large data migration scenarios.
401
+ *
402
+ * Use cases: Performance optimization; Bulk loading; Full load acceleration; Oracle target optimization; Large data migration
403
+ *
404
+ * AWS: AWS DMS Oracle endpoint useDirectPathFullLoad for direct path protocol bulk loading optimization
405
+ *
406
+ * Validation: Must be boolean value if provided; enables OCI direct path protocol for bulk-loading Oracle target tables
407
+ **/
408
+ readonly useDirectPathFullLoad?: boolean;
409
+ /**
410
+ * Q-ENHANCED-PROPERTY
411
+ * Optional flag to enable Oracle LogMiner utility for change data capture operations (default method). Controls whether to use LogMiner (default) or Binary Reader for accessing redo logs, with LogMiner being the standard method and Binary Reader requiring additional configuration for binary file access.
412
+ *
413
+ * Use cases: LogMiner CDC; Standard log access; Change data capture method; Oracle replication; Log access method selection
414
+ *
415
+ * AWS: AWS DMS Oracle endpoint useLogminerReader for LogMiner utility change data capture configuration
416
+ *
417
+ * Validation: Must be boolean value if provided; default true for LogMiner; set false to enable Binary Reader with useBFile
418
+ **/
419
+ readonly useLogminerReader?: boolean;
420
+ /**
421
+ * Q-ENHANCED-PROPERTY
422
+ * Optional path prefix for Binary Reader redo log access replacement in Oracle RDS sources. Specifies the path prefix to replace the default Oracle root for accessing redo logs when using Binary Reader for change data capture from Amazon RDS for Oracle databases.
423
+ *
424
+ * Use cases: Binary Reader configuration; Path replacement; RDS Oracle access; Redo log path management; Custom path configuration
425
+ *
426
+ * AWS: AWS DMS Oracle endpoint usePathPrefix for Binary Reader path prefix replacement configuration
427
+ *
428
+ * Validation: Must be valid path prefix string if provided; used with Binary Reader for RDS Oracle redo log access replacement
429
+ **/
430
+ readonly usePathPrefix?: string;
431
+ }
432
+ /**
433
+ * Provides information that defines a MySQL endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
434
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
435
+ * @struct
436
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html
437
+ */
438
+ /**
439
+ * Q-ENHANCED-INTERFACE
440
+ * MySQL database settings configuration interface for DMS providing database migration and MySQL-specific capabilities. Defines MySQL-specific properties for Database Migration Service including connection settings, replication configuration, and MySQL migration parameters for MySQL database migration workflows.
441
+ *
442
+ * Use cases: MySQL database migration; Database replication; Connection configuration; MySQL migration workflows; Database connectivity; DMS integration
443
+ *
444
+ * AWS: AWS DMS MySQL endpoint configuration with MySQL-specific migration settings and replication management
445
+ *
446
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
447
+ */
448
+ export interface MySqlSettingsProperty {
449
+ /**
450
+ * Q-ENHANCED-PROPERTY
451
+ * Optional SQL script to execute immediately after DMS connects to the MySQL endpoint for initialization tasks. Provides custom initialization logic that runs after connection establishment, with migration task continuing regardless of script success or failure, enabling database-specific setup and configuration.
452
+ *
453
+ * Use cases: Database initialization; Connection setup; Custom configuration; Post-connection tasks; Database preparation
454
+ *
455
+ * AWS: AWS DMS MySQL endpoint afterConnectScript for post-connection initialization and setup
456
+ *
457
+ * Validation: Must be valid SQL script code if provided; script content not filename; migration continues regardless of execution result
458
+ **/
459
+ readonly afterConnectScript?: string;
460
+ /**
461
+ * Q-ENHANCED-PROPERTY
462
+ * Optional flag to clean and recreate table metadata on replication instance when mismatches occur. Handles situations where DDL operations cause cached table metadata differences on the replication instance, ensuring metadata consistency during MySQL database migration and replication operations.
463
+ *
464
+ * Use cases: Metadata consistency; DDL handling; Cache management; Replication reliability; Table structure synchronization
465
+ *
466
+ * AWS: AWS DMS MySQL endpoint cleanSourceMetadataOnMismatch for metadata consistency and cache management
467
+ *
468
+ * Validation: Must be boolean value if provided; enables automatic metadata cleanup and recreation on mismatch detection
469
+ **/
470
+ readonly cleanSourceMetadataOnMismatch?: boolean;
471
+ /**
472
+ * Q-ENHANCED-PROPERTY
473
+ * Optional polling interval in seconds for checking MySQL binary log changes when database is idle. Specifies how frequently DMS checks binary logs for new changes during idle periods, with default of 5 seconds, affecting change detection latency and system resource usage during MySQL replication.
474
+ *
475
+ * Use cases: Change detection; Polling frequency; Performance tuning; Idle monitoring; Binary log processing
476
+ *
477
+ * AWS: AWS DMS MySQL endpoint eventsPollInterval for binary log change detection frequency
478
+ *
479
+ * Validation: Must be positive integer in seconds if provided; default 5 seconds; affects change detection latency and resource usage
480
+ **/
481
+ readonly eventsPollInterval?: number;
482
+ /**
483
+ * Q-ENHANCED-PROPERTY
484
+ * Optional maximum CSV file size in KB for MySQL data transfer operations. Specifies the maximum size limit for CSV files used in data transfer to MySQL-compatible databases, controlling file size for bulk data operations and affecting transfer performance and memory usage.
485
+ *
486
+ * Use cases: File size control; Bulk data transfer; Performance optimization; Memory management; CSV processing
487
+ *
488
+ * AWS: AWS DMS MySQL endpoint maxFileSize for CSV file size limits in data transfer operations
489
+ *
490
+ * Validation: Must be positive integer in KB if provided; controls CSV file size for MySQL data transfer operations
491
+ **/
492
+ readonly maxFileSize?: number;
493
+ /**
494
+ * Q-ENHANCED-PROPERTY
495
+ * Optional number of parallel threads for loading data into MySQL-compatible target databases for performance optimization. Specifies thread count for parallel data loading with each thread requiring separate connection, affecting performance and database load with default of 1 thread for MySQL target operations.
496
+ *
497
+ * Use cases: Performance optimization; Parallel loading; Thread configuration; MySQL target optimization; Load balancing
498
+ *
499
+ * AWS: AWS DMS MySQL endpoint parallelLoadThreads for parallel data loading performance optimization
500
+ *
501
+ * Validation: Must be positive integer if provided; default 1; higher values may impact database performance due to connection overhead
502
+ **/
503
+ readonly parallelLoadThreads?: number;
504
+ /**
505
+ * Q-ENHANCED-PROPERTY
506
+ * Optional IAM role ARN for AWS Secrets Manager access to MySQL endpoint credentials. Specifies the IAM role with required permissions to access SecretsManagerSecret containing MySQL endpoint credentials, enabling secure credential management and access control for MySQL database connections.
507
+ *
508
+ * Use cases: Credential management; Secrets Manager integration; Secure access; IAM role configuration; MySQL authentication
509
+ *
510
+ * AWS: AWS IAM role ARN for Secrets Manager access to MySQL endpoint credentials and authentication
511
+ *
512
+ * Validation: Must be valid IAM role ARN if provided; requires iam:PassRole action and Secrets Manager access permissions
513
+ **/
514
+ readonly secretsManagerAccessRoleArn?: string;
515
+ /**
516
+ * Q-ENHANCED-PROPERTY
517
+ * Required Secrets Manager secret ARN containing MySQL endpoint connection details for secure credential management. Specifies the full ARN of the secret containing MySQL database connection information including credentials, enabling secure storage and access of MySQL endpoint authentication details.
518
+ *
519
+ * Use cases: Secure credential storage; MySQL authentication; Secrets Manager integration; Database connection security; Credential management
520
+ *
521
+ * AWS: AWS Secrets Manager secret ARN containing MySQL endpoint connection details and credentials
522
+ *
523
+ * Validation: Must be valid Secrets Manager secret ARN; required for secure MySQL endpoint credential management and authentication
524
+ **/
525
+ readonly secretsManagerSecretArn: string;
526
+ /**
527
+ * Q-ENHANCED-PROPERTY
528
+ * Optional KMS key ARN for encrypting MySQL endpoint credentials secret in Secrets Manager. Specifies the KMS key used to encrypt the credentials secret, providing additional encryption layer for MySQL endpoint authentication information stored in AWS Secrets Manager.
529
+ *
530
+ * Use cases: Credential encryption; KMS integration; Enhanced security; Secret encryption; MySQL credential protection
531
+ *
532
+ * AWS: AWS KMS key ARN for encrypting Secrets Manager secret containing MySQL endpoint credentials
533
+ *
534
+ * Validation: Must be valid KMS key ARN if provided; provides additional encryption for MySQL credentials in Secrets Manager
535
+ **/
536
+ readonly secretsManagerSecretKMSArn?: string;
537
+ /**
538
+ * Q-ENHANCED-PROPERTY
539
+ * Optional time zone specification for MySQL source database configuration. Specifies the time zone for the source MySQL database affecting timestamp handling and data conversion during migration, ensuring proper time zone handling and data consistency across different time zones.
540
+ *
541
+ * Use cases: Time zone configuration; Timestamp handling; Data consistency; MySQL configuration; Time zone conversion
542
+ *
543
+ * AWS: AWS DMS MySQL endpoint serverTimezone for source database time zone configuration
544
+ *
545
+ * Validation: Must be valid time zone string if provided; do not enclose in single quotes; affects timestamp data handling
546
+ **/
547
+ readonly serverTimezone?: string;
548
+ /**
549
+ * Q-ENHANCED-PROPERTY
550
+ * Optional target database type specification for MySQL migration destination configuration. Specifies whether to migrate source tables to a single database or multiple databases on the target, with SPECIFIC_DATABASE requiring DatabaseName parameter and MULTIPLE_DATABASES preserving source database structure.
551
+ *
552
+ * Use cases: Database structure preservation; Migration strategy; Target configuration; Database organization; Schema mapping
553
+ *
554
+ * AWS: AWS DMS MySQL endpoint targetDbType for target database structure and migration destination configuration
555
+ *
556
+ * Validation: Must be valid target type if provided; SPECIFIC_DATABASE requires DatabaseName parameter; MULTIPLE_DATABASES preserves structure
557
+ **/
558
+ readonly targetDbType?: string;
559
+ }
560
+ /**
561
+ * Provides information that defines an Amazon S3 endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
562
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see [Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [Extra connection attributes when using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the *AWS Database Migration Service User Guide* .
563
+ * @struct
564
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html
565
+ */
566
+ /**
567
+ * Q-ENHANCED-INTERFACE
568
+ * S3 settings configuration interface for DMS providing data lake integration and file-based migration capabilities. Defines S3-specific properties for Database Migration Service including data format configuration, compression settings, and S3 integration for database-to-data lake migration workflows.
569
+ *
570
+ * Use cases: Database to data lake migration; S3 data integration; Data format configuration; File-based migration; Data lake workflows; DMS S3 integration
571
+ *
572
+ * AWS: AWS DMS S3 endpoint configuration with data lake integration and file format management
573
+ *
574
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
575
+ */
576
+ export interface S3SettingsProperty {
577
+ /**
578
+ * Q-ENHANCED-PROPERTY
579
+ * Optional flag to add column name information to CSV output files for S3 data lake integration. Enables column headers in CSV files when migrating data to S3, improving data usability and self-documentation for data lake consumers with default false value and support for boolean or y/n values.
580
+ *
581
+ * Use cases: CSV headers; Data documentation; Data lake usability; Self-describing data; CSV format enhancement
582
+ *
583
+ * AWS: AWS DMS S3 endpoint addColumnName for CSV column header inclusion in data lake files
584
+ *
585
+ * Validation: Must be boolean, 'y', or 'n' if provided; default false; improves CSV data usability in S3 data lake
586
+ **/
587
+ readonly addColumnName?: boolean;
588
+ /**
589
+ * Q-ENHANCED-PROPERTY
590
+ * Optional S3 bucket folder name for organizing migrated data with hierarchical structure. Specifies a folder prefix for table organization in S3 bucket, creating path structure as bucketFolder/schema_name/table_name/ instead of default schema_name/table_name/ for better data organization.
591
+ *
592
+ * Use cases: Data organization; Folder structure; S3 hierarchy; Data lake organization; Path management
593
+ *
594
+ * AWS: AWS DMS S3 endpoint bucketFolder for hierarchical data organization in S3 bucket structure
595
+ *
596
+ * Validation: Must be valid S3 folder name if provided; creates bucketFolder/schema_name/table_name/ path structure
597
+ **/
598
+ readonly bucketFolder?: string;
599
+ /**
600
+ * Q-ENHANCED-PROPERTY
601
+ * Required S3 bucket name for DMS data migration destination in data lake architecture. Specifies the target S3 bucket where migrated database data will be stored, serving as the primary destination for database-to-data lake migration workflows and data storage.
602
+ *
603
+ * Use cases: Data lake destination; S3 storage; Migration target; Data repository; Database migration endpoint
604
+ *
605
+ * AWS: AWS S3 bucket name for DMS data migration destination and data lake storage
606
+ *
607
+ * Validation: Must be valid S3 bucket name; required for S3 endpoint configuration and data migration destination
608
+ **/
609
+ readonly bucketName: string;
610
+ /**
611
+ * Q-ENHANCED-PROPERTY
612
+ * Optional predefined access control list (ACL) for S3 objects created during data migration. Specifies canned ACL for CSV and Parquet files created in S3 bucket, controlling object-level permissions with options including NONE, PRIVATE, PUBLIC_READ, and BUCKET_OWNER_FULL_CONTROL for security management.
613
+ *
614
+ * Use cases: Access control; S3 permissions; Object security; Data lake security; File permissions
615
+ *
616
+ * AWS: AWS S3 canned ACL for objects created by DMS during data migration to S3 bucket
617
+ *
618
+ * Validation: Must be valid S3 canned ACL if provided; default NONE; controls object-level permissions in S3 bucket
619
+ **/
620
+ readonly cannedAclForObjects?: string;
621
+ /**
622
+ * Q-ENHANCED-PROPERTY
623
+ * Optional flag to enable CDC INSERT and UPDATE operations capture to S3 files for change tracking. Enables writing INSERT and UPDATE operations to CSV or Parquet files during change data capture, with operation indication controlled by IncludeOpForFullLoad parameter, mutually exclusive with CdcInsertsOnly.
624
+ *
625
+ * Use cases: Change data capture; INSERT/UPDATE tracking; Data lake CDC; Operation logging; change tracking
626
+ *
627
+ * AWS: AWS DMS S3 endpoint cdcInsertsAndUpdates for CDC INSERT and UPDATE operations capture
628
+ *
629
+ * Validation: Must be boolean or 'y' if provided; mutually exclusive with CdcInsertsOnly; requires DMS version 3.3.1+
630
+ **/
631
+ readonly cdcInsertsAndUpdates?: boolean;
632
+ /**
633
+ * Q-ENHANCED-PROPERTY
634
+ * Optional flag to enable CDC INSERT-only operations capture to S3 files for insert-focused change tracking. Enables writing only INSERT operations to CSV or Parquet files during change data capture, with operation indication controlled by IncludeOpForFullLoad parameter, mutually exclusive with CdcInsertsAndUpdates.
635
+ *
636
+ * Use cases: Insert-only CDC; Append-only data lakes; INSERT tracking; Simplified change capture; Insert-focused replication
637
+ *
638
+ * AWS: AWS DMS S3 endpoint cdcInsertsOnly for CDC INSERT-only operations capture
639
+ *
640
+ * Validation: Must be boolean or 'y' if provided; mutually exclusive with CdcInsertsAndUpdates; requires DMS version 3.1.4+
641
+ **/
642
+ readonly cdcInsertsOnly?: boolean;
643
+ /**
644
+ * Q-ENHANCED-PROPERTY
645
+ * Optional maximum batch interval in seconds for CDC file output to S3 for time-based file creation. Specifies the maximum time interval before triggering file output to S3, working with CdcMinFileSize where first condition met triggers write, with default 60 seconds for CDC file management.
646
+ *
647
+ * Use cases: File timing control; CDC batching; Time-based triggers; File output scheduling; Batch interval management
648
+ *
649
+ * AWS: AWS DMS S3 endpoint cdcMaxBatchInterval for time-based CDC file output triggering
650
+ *
651
+ * Validation: Must be positive integer in seconds if provided; default 60; works with CdcMinFileSize for file output triggering
652
+ **/
653
+ readonly cdcMaxBatchInterval?: number;
654
+ /**
655
+ * Q-ENHANCED-PROPERTY
656
+ * Optional minimum file size in kilobytes for CDC file output to S3 for size-based file creation. Specifies the minimum file size before triggering file output to S3, working with CdcMaxBatchInterval where first condition met triggers write, with default 32 MB for CDC file management.
657
+ *
658
+ * Use cases: File size control; CDC batching; Size-based triggers; File output optimization; Batch size management
659
+ *
660
+ * AWS: AWS DMS S3 endpoint cdcMinFileSize for size-based CDC file output triggering
661
+ *
662
+ * Validation: Must be positive integer in KB if provided; default 32 MB; works with CdcMaxBatchInterval for file output triggering
663
+ **/
664
+ readonly cdcMinFileSize?: number;
665
+ /**
666
+ * Q-ENHANCED-PROPERTY
667
+ * Optional CDC folder path specification for change data capture file organization in S3. Specifies the folder path for CDC files in S3 bucket, required for S3 sources with CDC and optional for targets, enabling transaction order preservation and organized CDC file storage in data lake architecture.
668
+ *
669
+ * Use cases: CDC organization; Transaction order; File path management; S3 CDC structure; Change data organization
670
+ *
671
+ * AWS: AWS DMS S3 endpoint cdcPath for CDC file organization and transaction order preservation
672
+ *
673
+ * Validation: Must be valid S3 folder path if provided; required for S3 sources with CDC; supports DMS version 3.4.2+
674
+ **/
675
+ readonly cdcPath?: string;
676
+ /**
677
+ * Q-ENHANCED-PROPERTY
678
+ * Optional compression type for S3 target files to optimize storage and transfer performance. Specifies compression method for CSV and Parquet files with GZIP enabling compression and NONE (default) for uncompressed files, affecting storage costs and data transfer performance in data lake operations.
679
+ *
680
+ * Use cases: Storage optimization; Compression; Performance tuning; Cost optimization; File size reduction
681
+ *
682
+ * AWS: AWS DMS S3 endpoint compressionType for target file compression and storage optimization
683
+ *
684
+ * Validation: Must be GZIP or NONE if provided; default NONE; applies to both CSV and Parquet file formats
685
+ **/
686
+ readonly compressionType?: string;
687
+ /**
688
+ * Q-ENHANCED-PROPERTY
689
+ * Optional column delimiter for CSV file format in S3 data lake integration. Specifies the character used to separate columns in CSV files for both source and target operations, with default comma delimiter, affecting CSV file structure and data parsing in data lake workflows.
690
+ *
691
+ * Use cases: CSV formatting; Column separation; Data parsing; File structure; CSV customization
692
+ *
693
+ * AWS: AWS DMS S3 endpoint csvDelimiter for CSV column separation and file formatting
694
+ *
695
+ * Validation: Must be valid delimiter character if provided; default comma; affects CSV file structure and parsing
696
+ **/
697
+ readonly csvDelimiter?: string;
698
+ /**
699
+ * Q-ENHANCED-PROPERTY
700
+ * Optional string value for columns not included in supplemental log during CDC CSV operations. Specifies the value to use for columns not in supplemental log when UseCsvNoSupValue is true, with null value used if not specified, affecting CDC data completeness in CSV format.
701
+ *
702
+ * Use cases: Supplemental log handling; CDC data completeness; Missing column values; CSV CDC operations; Data consistency
703
+ *
704
+ * AWS: AWS DMS S3 endpoint csvNoSupValue for supplemental log column handling in CDC CSV operations
705
+ *
706
+ * Validation: Must be valid string value if provided; used when UseCsvNoSupValue is true; supports DMS version 3.4.1+
707
+ **/
708
+ readonly csvNoSupValue?: string;
709
+ /**
710
+ * Q-ENHANCED-PROPERTY
711
+ * Optional null value representation for CSV files in S3 data lake operations. Specifies how DMS treats null values when writing to target, allowing user-defined string as null representation to differentiate between empty strings and null values, with default NULL value for CSV null handling.
712
+ *
713
+ * Use cases: Null value handling; CSV formatting; Data representation; Empty string differentiation; Target compatibility
714
+ *
715
+ * AWS: AWS DMS S3 endpoint csvNullValue for null value representation in CSV files
716
+ *
717
+ * Validation: Must be valid string if provided; default NULL; differentiates empty strings from null values in CSV format
718
+ **/
719
+ readonly csvNullValue?: string;
720
+ /**
721
+ * Q-ENHANCED-PROPERTY
722
+ * Optional row delimiter for CSV files in S3 data lake integration. Specifies the character used to separate rows in CSV files for both source and target operations, with default carriage return (\n), affecting CSV file structure and data parsing in data lake workflows.
723
+ *
724
+ * Use cases: CSV formatting; Row separation; Data parsing; File structure; CSV customization
725
+ *
726
+ * AWS: AWS DMS S3 endpoint csvRowDelimiter for CSV row separation and file formatting
727
+ *
728
+ * Validation: Must be valid delimiter character if provided; default carriage return (\n); affects CSV file structure and parsing
729
+ **/
730
+ readonly csvRowDelimiter?: string;
731
+ /**
732
+ * Q-ENHANCED-PROPERTY
733
+ * Optional data format specification for S3 output files in data lake architecture. Specifies the output file format with CSV for row-based comma-separated values and Parquet for columnar storage with efficient compression and faster query response, affecting data lake performance and storage.
734
+ *
735
+ * Use cases: Data format selection; Storage optimization; Query performance; Compression efficiency; Data lake architecture
736
+ *
737
+ * AWS: AWS DMS S3 endpoint dataFormat for output file format selection and data lake optimization
738
+ *
739
+ * Validation: Must be 'csv' or 'parquet' if provided; affects storage efficiency and query performance in data lake
740
+ **/
741
+ readonly dataFormat?: string;
742
+ /**
743
+ * Q-ENHANCED-PROPERTY
744
+ * Optional data page size in bytes for Parquet file format optimization. Specifies the size of one data page for Parquet files with default 1 MiB (1024 * 1024 bytes), affecting Parquet file structure, compression efficiency, and query performance in columnar data lake storage.
745
+ *
746
+ * Use cases: Parquet optimization; Page size tuning; Compression efficiency; Query performance; Columnar storage optimization
747
+ *
748
+ * AWS: AWS DMS S3 endpoint dataPageSize for Parquet file page size optimization and performance tuning
749
+ *
750
+ * Validation: Must be positive integer in bytes if provided; default 1 MiB; applies only to Parquet file format
751
+ **/
752
+ readonly dataPageSize?: number;
753
+ /**
754
+ * Q-ENHANCED-PROPERTY
755
+ * Optional date partition delimiter for S3 folder partitioning organization. Specifies the delimiter character used in date-based folder partitioning with default SLASH, used when DatePartitionedEnabled is true for organizing data lake files by transaction commit dates in hierarchical folder structure.
756
+ *
757
+ * Use cases: Date partitioning; Folder organization; Data lake structure; Time-based organization; Partition delimiter
758
+ *
759
+ * AWS: AWS DMS S3 endpoint datePartitionDelimiter for date-based folder partitioning organization
760
+ *
761
+ * Validation: Must be valid delimiter if provided; default SLASH; used when DatePartitionedEnabled is true
762
+ **/
763
+ readonly datePartitionDelimiter?: string;
764
+ /**
765
+ * Q-ENHANCED-PROPERTY
766
+ * Optional flag to enable date-based folder partitioning for S3 bucket organization. Enables partitioning S3 bucket folders based on transaction commit dates with default false, providing time-based data organization for improved data lake query performance and data management.
767
+ *
768
+ * Use cases: Date-based partitioning; Data organization; Query optimization; Time-based structure; Data lake management
769
+ *
770
+ * AWS: AWS DMS S3 endpoint datePartitionEnabled for date-based folder partitioning and data organization
771
+ *
772
+ * Validation: Must be boolean if provided; default false; enables date-based folder partitioning for data lake organization
773
+ **/
774
+ readonly datePartitionEnabled?: boolean;
775
+ /**
776
+ * Q-ENHANCED-PROPERTY
777
+ * Optional date format sequence for folder partitioning organization in S3 data lake. Specifies the date format sequence for folder partitioning with default YYYYMMDD, used when DatePartitionedEnabled is true for consistent date-based folder naming and organization.
778
+ *
779
+ * Use cases: Date format specification; Folder naming; Partition sequence; Date organization; Consistent naming
780
+ *
781
+ * AWS: AWS DMS S3 endpoint datePartitionSequence for date format specification in folder partitioning
782
+ *
783
+ * Validation: Must be valid date format if provided; default YYYYMMDD; used when DatePartitionedEnabled is true
784
+ **/
785
+ readonly datePartitionSequence?: string;
786
+ /**
787
+ * Q-ENHANCED-PROPERTY
788
+ * Optional time zone specification for date partition folder creation and CDC file naming. Converts UTC time to specified time zone when creating date partition folders and CDC file names, using Area/Location format when DatePartitionedEnabled is true for consistent time zone handling.
789
+ *
790
+ * Use cases: Time zone conversion; Date partition timing; CDC file naming; Time zone consistency; Global data management
791
+ *
792
+ * AWS: AWS DMS S3 endpoint datePartitionTimezone for time zone conversion in date partitioning
793
+ *
794
+ * Validation: Must be valid Area/Location time zone format if provided; used when DatePartitionedEnabled is true
795
+ **/
796
+ readonly datePartitionTimezone?: string;
797
+ /**
798
+ * Q-ENHANCED-PROPERTY
799
+ * Optional maximum dictionary page size limit for Parquet column encoding optimization. Specifies the maximum size of encoded dictionary page for columns with default 1 MiB, reverting to PLAIN encoding when exceeded, affecting Parquet compression efficiency and query performance in columnar data lake storage.
800
+ *
801
+ * Use cases: Parquet optimization; Dictionary encoding; Compression efficiency; Column storage optimization; Encoding performance
802
+ *
803
+ * AWS: AWS DMS S3 endpoint dictPageSizeLimit for Parquet dictionary page size optimization and encoding control
804
+ *
805
+ * Validation: Must be positive integer in bytes if provided; default 1 MiB; applies only to Parquet file format
806
+ **/
807
+ readonly dictPageSizeLimit?: number;
808
+ /**
809
+ * Q-ENHANCED-PROPERTY
810
+ * Optional flag to enable statistics collection for Parquet pages and row groups for query optimization. Enables collection of NULL, DISTINCT, MAX, and MIN statistics with default true, improving query performance and data analysis capabilities in Parquet columnar data lake storage.
811
+ *
812
+ * Use cases: Query optimization; Statistics collection; Parquet performance; Data analysis; Query planning
813
+ *
814
+ * AWS: AWS DMS S3 endpoint enableStatistics for Parquet statistics collection and query optimization
815
+ *
816
+ * Validation: Must be boolean if provided; default true; applies only to Parquet file format; improves query performance
817
+ **/
818
+ readonly enableStatistics?: boolean;
819
+ /**
820
+ * Q-ENHANCED-PROPERTY
821
+ * Optional encoding type specification for Parquet file compression and storage optimization. Specifies encoding method with RLE_DICTIONARY (default) for efficient repeated value storage, PLAIN for no encoding, and PLAIN_DICTIONARY for column-specific dictionary encoding, affecting compression and performance.
822
+ *
823
+ * Use cases: Compression optimization; Encoding selection; Storage efficiency; Parquet performance; Data compression
824
+ *
825
+ * AWS: AWS DMS S3 endpoint encodingType for Parquet encoding method selection and compression optimization
826
+ *
827
+ * Validation: Must be RLE_DICTIONARY, PLAIN, or PLAIN_DICTIONARY if provided; default RLE_DICTIONARY; affects Parquet compression
828
+ **/
829
+ readonly encodingType?: string;
830
+ /**
831
+ * Q-ENHANCED-PROPERTY
832
+ * Optional external table definition for S3 source configuration in data lake integration. Specifies the table definition when using S3 as source, required for S3 source endpoints to define table structure and schema for data processing and migration operations.
833
+ *
834
+ * Use cases: S3 source configuration; Table definition; Schema specification; Data structure; Source table mapping
835
+ *
836
+ * AWS: AWS DMS S3 endpoint externalTableDefinition for S3 source table structure and schema definition
837
+ *
838
+ * Validation: Must be valid table definition if provided; required when S3 is used as source; defines table structure and schema
839
+ **/
840
+ readonly externalTableDefinition?: string;
841
+ /**
842
+ * Q-ENHANCED-PROPERTY
843
+ * Optional number of header rows to ignore in CSV files for S3 source processing. Specifies whether to ignore the first row header in CSV files with 1 enabling the feature and 0 (default) disabling it, affecting CSV file parsing and data processing in S3 source operations.
844
+ *
845
+ * Use cases: CSV header handling; File parsing; Data processing; Header row management; CSV source configuration
846
+ *
847
+ * AWS: AWS DMS S3 endpoint ignoreHeaderRows for CSV header row handling in S3 source processing
848
+ *
849
+ * Validation: Must be 0 or 1 if provided; default 0; controls CSV header row processing in S3 source operations
850
+ **/
851
+ readonly ignoreHeaderRows?: number;
852
+ /**
853
+ * Q-ENHANCED-PROPERTY
854
+ * Optional flag to include INSERT operation indicators in full load CSV output for consistency with CDC operations. Enables recording INSERT operations as 'I' annotation in first field of CSV files during full load, providing consistency with CDC load format and operation tracking.
855
+ *
856
+ * Use cases: Operation tracking; Full load consistency; CDC compatibility; INSERT indication; Data lineage
857
+ *
858
+ * AWS: AWS DMS S3 endpoint includeOpForFullLoad for INSERT operation indication in full load CSV output
859
+ *
860
+ * Validation: Must be boolean or 'y' if provided; requires DMS version 3.1.4+; works with CdcInsertsOnly and CdcInsertsAndUpdates
861
+ **/
862
+ readonly includeOpForFullLoad?: boolean;
863
+ /**
864
+ * Q-ENHANCED-PROPERTY
865
+ * Optional maximum CSV file size in KB for S3 target during full load migration operations. Specifies the maximum size limit for CSV files created during full load migration with default 1 GB (1,048,576 KB), controlling file size and affecting data lake file organization and performance.
866
+ *
867
+ * Use cases: File size control; Full load optimization; Storage management; File organization; Performance tuning
868
+ *
869
+ * AWS: AWS DMS S3 endpoint maxFileSize for CSV file size limits during full load migration
870
+ *
871
+ * Validation: Must be integer between 1-1,048,576 KB if provided; default 1 GB; controls CSV file size during full load
872
+ **/
873
+ readonly maxFileSize?: number;
874
+ /**
875
+ * Q-ENHANCED-PROPERTY
876
+ * Optional flag to set TIMESTAMP column precision to milliseconds in Parquet files for Athena and Glue compatibility. Enables millisecond precision for TIMESTAMP columns in Parquet format instead of microsecond precision, ensuring compatibility with Amazon Athena and AWS Glue query engines that handle only millisecond precision.
877
+ *
878
+ * Use cases: Athena compatibility; Glue integration; Timestamp precision; Parquet optimization; Query engine compatibility
879
+ *
880
+ * AWS: AWS DMS S3 endpoint parquetTimestampInMillisecond for TIMESTAMP precision in Parquet files
881
+ *
882
+ * Validation: Must be boolean or 'y' if provided; requires DMS version 3.1.4+; applies only to Parquet format; CSV always uses microsecond
883
+ **/
884
+ readonly parquetTimestampInMillisecond?: boolean;
885
+ /**
886
+ * Q-ENHANCED-PROPERTY
887
+ * Optional Apache Parquet format version specification for S3 data lake columnar storage. Specifies the Parquet format version with parquet_1_0 (default) or parquet_2_0 options, affecting file compatibility, features, and performance characteristics in columnar data lake storage operations.
888
+ *
889
+ * Use cases: Parquet version selection; Format compatibility; Feature availability; Performance optimization; Columnar storage
890
+ *
891
+ * AWS: AWS DMS S3 endpoint parquetVersion for Apache Parquet format version specification
892
+ *
893
+ * Validation: Must be 'parquet_1_0' or 'parquet_2_0' if provided; default parquet_1_0; affects Parquet file compatibility and features
894
+ **/
895
+ readonly parquetVersion?: string;
896
+ /**
897
+ * Q-ENHANCED-PROPERTY
898
+ * Optional flag to preserve transaction order for CDC loads in S3 target for data consistency. Enables saving transaction order for change data capture loads on S3 target specified by CdcPath, ensuring transactional consistency and proper ordering in data lake CDC operations.
899
+ *
900
+ * Use cases: Transaction consistency; CDC ordering; Data integrity; Transaction preservation; Change data consistency
901
+ *
902
+ * AWS: AWS DMS S3 endpoint preserveTransactions for CDC transaction order preservation in S3 target
903
+ *
904
+ * Validation: Must be boolean if provided; requires CdcPath setting; supports DMS version 3.4.2+; ensures transaction order consistency
905
+ **/
906
+ readonly preserveTransactions?: boolean;
907
+ /**
908
+ * Q-ENHANCED-PROPERTY
909
+ * Optional flag to enable RFC 4180 compliance for CSV quotation mark handling in S3 operations. Controls quotation mark behavior with true (default) requiring paired quotation marks and proper escaping, and false allowing delimiters within strings, affecting CSV parsing and data integrity.
910
+ *
911
+ * Use cases: CSV compliance; Quotation handling; RFC 4180 standard; Data parsing; CSV formatting
912
+ *
913
+ * AWS: AWS DMS S3 endpoint rfc4180 for CSV quotation mark handling and RFC 4180 compliance
914
+ *
915
+ * Validation: Must be boolean, 'y', or 'n' if provided; default true; affects CSV quotation mark handling and delimiter behavior
916
+ **/
917
+ readonly rfc4180?: boolean;
918
+ /**
919
+ * Q-ENHANCED-PROPERTY
920
+ * Optional number of rows in Parquet row group for read/write performance optimization. Specifies row group size with default 10,000 rows, balancing faster reads (smaller groups) against slower writes (more groups), with maximum 64MB limit for Parquet file performance tuning.
921
+ *
922
+ * Use cases: Parquet optimization; Read performance; Write performance; Row group tuning; Columnar storage optimization
923
+ *
924
+ * AWS: AWS DMS S3 endpoint rowGroupLength for Parquet row group size optimization and performance tuning
925
+ *
926
+ * Validation: Must be positive integer if provided; default 10,000; maximum 64MB (64*1024*1024 bytes); applies only to Parquet format
927
+ **/
928
+ readonly rowGroupLength?: number;
929
+ /**
930
+ * Q-ENHANCED-PROPERTY
931
+ * Required KMS key ID for server-side encryption when using SSE_KMS encryption mode for S3 data lake security. Specifies the AWS KMS key for encrypting S3 objects, requiring attached policy enabling IAM user permissions and key usage for secure data lake storage and compliance.
932
+ *
933
+ * Use cases: Data encryption; KMS integration; S3 security; Compliance requirements; Data protection
934
+ *
935
+ * AWS: AWS KMS key ID for S3 server-side encryption with customer-managed keys
936
+ *
937
+ * Validation: Must be valid KMS key ID; required when EncryptionMode is SSE_KMS; requires proper IAM permissions and key policy
938
+ **/
939
+ readonly serverSideEncryptionKmsKeyId: string;
940
+ /**
941
+ * Q-ENHANCED-PROPERTY
942
+ * Optional IAM role ARN for DMS service access to S3 bucket operations for data lake integration. Specifies the service role enabling DMS to read and write S3 objects, requiring iam:PassRole action for secure S3 bucket access and data migration operations.
943
+ *
944
+ * Use cases: Service access; IAM role configuration; S3 permissions; Secure access; Data migration authorization
945
+ *
946
+ * AWS: AWS IAM role ARN for DMS service access to S3 bucket operations and data lake integration
947
+ *
948
+ * Validation: Must be valid IAM role ARN if provided; requires iam:PassRole action; enables S3 read/write operations
949
+ **/
950
+ readonly serviceAccessRoleArn?: string;
951
+ /**
952
+ * Q-ENHANCED-PROPERTY
953
+ * Optional timestamp column name for adding migration timing information to S3 data lake files. Adds STRING column with timestamp information to CSV or Parquet files, containing transfer timestamps for full load and commit timestamps for CDC, with microsecond precision format yyyy-MM-dd HH:mm:ss.SSSSSS.
954
+ *
955
+ * Use cases: Data lineage; Migration tracking; Timestamp information; Data auditing; Change tracking
956
+ *
957
+ * AWS: AWS DMS S3 endpoint timestampColumnName for migration timestamp tracking in data lake files
958
+ *
959
+ * Validation: Must be valid column name if provided; requires DMS version 3.1.4+; adds timestamp column to output files
960
+ **/
961
+ readonly timestampColumnName?: string;
962
+ /**
963
+ * Q-ENHANCED-PROPERTY
964
+ * Optional flag to use task start time for full load timestamp column instead of data arrival time. Controls timestamp behavior with true using task start time for full load and transaction commit time for CDC, and false using incremental data arrival time for full load operations.
965
+ *
966
+ * Use cases: Timestamp consistency; Task timing; Full load timing; Timestamp behavior; Data lineage
967
+ *
968
+ * AWS: AWS DMS S3 endpoint useTaskStartTimeForFullLoadTimestamp for timestamp column behavior control
969
+ *
970
+ * Validation: Must be boolean if provided; affects timestamp column behavior for full load operations; CDC always uses commit time
971
+ **/
972
+ readonly useTaskStartTimeForFullLoadTimestamp?: boolean;
973
+ /**
974
+ * Q-ENHANCED-PROPERTY
975
+ * Optional flag to use CsvNoSupValue for columns not in supplemental log during CDC CSV operations. Controls handling of columns not included in supplemental log with true using CsvNoSupValue and false using null value, affecting CDC data completeness in CSV format operations.
976
+ *
977
+ * Use cases: Supplemental log handling; CDC data completeness; Missing column values; CSV CDC operations; Data consistency
978
+ *
979
+ * AWS: AWS DMS S3 endpoint useCsvNoSupValue for supplemental log column handling in CDC CSV operations
980
+ *
981
+ * Validation: Must be boolean if provided; works with CsvNoSupValue setting; applies only to CDC loads in CSV format
982
+ **/
983
+ readonly useCsvNoSupValue?: boolean;
984
+ }
985
+ /**
986
+ * Provides information that describes an Amazon Kinesis Data Stream endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
987
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide* .
988
+ * @struct
989
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html
990
+ */
991
+ /**
992
+ * Q-ENHANCED-INTERFACE
993
+ * Kinesis settings configuration interface for DMS providing streaming data integration and real-time migration capabilities. Defines Kinesis-specific properties for Database Migration Service including streaming configuration, data format settings, and Kinesis integration for real-time database streaming workflows.
994
+ *
995
+ * Use cases: Real-time database streaming; Streaming data integration; Kinesis data streams; Real-time migration; Database streaming workflows; DMS Kinesis integration
996
+ *
997
+ * AWS: AWS DMS Kinesis endpoint configuration with streaming data integration and real-time migration capabilities
998
+ *
999
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1000
+ */
1001
+ export interface KinesisSettingsProperty {
1002
+ /**
1003
+ * Q-ENHANCED-PROPERTY
1004
+ * Optional flag to show detailed control information for table and column changes in Kinesis message output for change tracking. Enables detailed control information including table definition, column definition, and table/column changes in Kinesis streaming output with default false for enhanced change visibility.
1005
+ *
1006
+ * Use cases: Change tracking; Control information; Table monitoring; Column changes; Detailed streaming
1007
+ *
1008
+ * AWS: AWS DMS Kinesis endpoint includeControlDetails for detailed control information in streaming output
1009
+ *
1010
+ * Validation: Must be boolean if provided; default false; enables detailed control information in Kinesis message output
1011
+ **/
1012
+ readonly includeControlDetails?: boolean;
1013
+ /**
1014
+ * Q-ENHANCED-PROPERTY
1015
+ * Optional flag to include NULL and empty columns in records migrated to Kinesis endpoint for complete data representation. Enables inclusion of NULL and empty column values in Kinesis streaming output with default false, ensuring complete data representation in real-time streaming operations.
1016
+ *
1017
+ * Use cases: Complete data representation; NULL handling; Empty column inclusion; Data completeness; Streaming integrity
1018
+ *
1019
+ * AWS: AWS DMS Kinesis endpoint includeNullAndEmpty for NULL and empty column inclusion in streaming output
1020
+ *
1021
+ * Validation: Must be boolean if provided; default false; includes NULL and empty columns in Kinesis streaming records
1022
+ **/
1023
+ readonly includeNullAndEmpty?: boolean;
1024
+ /**
1025
+ * Q-ENHANCED-PROPERTY
1026
+ * Optional flag to show partition value in Kinesis message output unless partition type is schema-table-type. Enables partition value visibility in Kinesis streaming output with default false, providing partition information for data organization and routing in streaming operations.
1027
+ *
1028
+ * Use cases: Partition visibility; Data organization; Streaming routing; Partition information; Message organization
1029
+ *
1030
+ * AWS: AWS DMS Kinesis endpoint includePartitionValue for partition value visibility in streaming output
1031
+ *
1032
+ * Validation: Must be boolean if provided; default false; shows partition value unless partition type is schema-table-type
1033
+ **/
1034
+ readonly includePartitionValue?: boolean;
1035
+ /**
1036
+ * Q-ENHANCED-PROPERTY
1037
+ * Optional flag to include DDL operations that change table structure in control data for schema change tracking. Enables inclusion of DDL operations like rename-table, drop-table, add-column, drop-column, and rename-column in control data with default false for schema evolution tracking.
1038
+ *
1039
+ * Use cases: Schema change tracking; DDL monitoring; Table structure changes; Schema evolution; Control data enhancement
1040
+ *
1041
+ * AWS: AWS DMS Kinesis endpoint includeTableAlterOperations for DDL operation inclusion in control data
1042
+ *
1043
+ * Validation: Must be boolean if provided; default false; includes DDL operations in control data for schema change tracking
1044
+ **/
1045
+ readonly includeTableAlterOperations?: boolean;
1046
+ /**
1047
+ * Q-ENHANCED-PROPERTY
1048
+ * Optional flag to provide detailed transaction information from source database for transaction tracking. Enables detailed transaction information including commit timestamp, log position, transaction_id, previous transaction_id, and transaction_record_id with default false for enhanced transaction visibility in streaming.
1049
+ *
1050
+ * Use cases: Transaction tracking; Commit information; Transaction details; Log position tracking; Transaction lineage
1051
+ *
1052
+ * AWS: AWS DMS Kinesis endpoint includeTransactionDetails for detailed transaction information in streaming output
1053
+ *
1054
+ * Validation: Must be boolean if provided; default false; provides detailed transaction information from source database
1055
+ **/
1056
+ readonly includeTransactionDetails?: boolean;
1057
+ /**
1058
+ * Q-ENHANCED-PROPERTY
1059
+ * Optional output format specification for records created on Kinesis endpoint for streaming data format control. Specifies message format with JSON (default) for formatted output or JSON_UNFORMATTED for single-line output without tabs, affecting streaming data structure and readability.
1060
+ *
1061
+ * Use cases: Message formatting; JSON structure; Output format; Streaming format; Data structure control
1062
+ *
1063
+ * AWS: AWS DMS Kinesis endpoint messageFormat for streaming record output format specification
1064
+ *
1065
+ * Validation: Must be 'JSON' or 'JSON_UNFORMATTED' if provided; default JSON; controls streaming message format and structure
1066
+ **/
1067
+ readonly messageFormat?: string;
1068
+ /**
1069
+ * Q-ENHANCED-PROPERTY
1070
+ * Optional flag to avoid adding '0x' prefix to raw data in hexadecimal format for cleaner data representation. Enables migration of RAW data type columns without '0x' prefix, particularly useful for LOB columns from Oracle sources to Kinesis targets for cleaner hexadecimal data representation.
1071
+ *
1072
+ * Use cases: Hexadecimal formatting; RAW data migration; LOB handling; Data format control; Oracle to Kinesis migration
1073
+ *
1074
+ * AWS: AWS DMS Kinesis endpoint noHexPrefix for hexadecimal data formatting control in streaming output
1075
+ *
1076
+ * Validation: Must be boolean if provided; removes '0x' prefix from hexadecimal RAW data in streaming output
1077
+ **/
1078
+ readonly noHexPrefix?: boolean;
1079
+ /**
1080
+ * Q-ENHANCED-PROPERTY
1081
+ * Optional flag to prefix schema and table names to partition values for improved data distribution across Kinesis shards. Enables schema and table name prefixing when partition type is primary-key-type, improving data distribution and reducing throttling for tables with limited primary key ranges.
1082
+ *
1083
+ * Use cases: Data distribution; Shard optimization; Throttling prevention; Partition strategy; Performance optimization
1084
+ *
1085
+ * AWS: AWS DMS Kinesis endpoint partitionIncludeSchemaTable for partition value prefixing and shard distribution
1086
+ *
1087
+ * Validation: Must be boolean if provided; default false; improves data distribution when partition type is primary-key-type
1088
+ **/
1089
+ readonly partitionIncludeSchemaTable?: boolean;
1090
+ /**
1091
+ * Q-ENHANCED-PROPERTY
1092
+ * Optional IAM role ARN for DMS service access to Kinesis data stream for secure streaming operations. Specifies the IAM role enabling DMS to write to Kinesis data stream, requiring iam:PassRole action for secure streaming data integration and real-time data migration operations.
1093
+ *
1094
+ * Use cases: Service access; IAM role configuration; Kinesis permissions; Secure streaming; Data migration authorization
1095
+ *
1096
+ * AWS: AWS IAM role ARN for DMS service access to Kinesis data stream operations and streaming integration
1097
+ *
1098
+ * Validation: Must be valid IAM role ARN if provided; requires iam:PassRole action; enables Kinesis data stream write operations
1099
+ **/
1100
+ readonly serviceAccessRoleArn?: string;
1101
+ /**
1102
+ * Q-ENHANCED-PROPERTY
1103
+ * Required Amazon Kinesis Data Streams endpoint ARN for DMS streaming destination configuration. Specifies the target Kinesis data stream where migrated database data will be streamed, serving as the primary destination for real-time database streaming workflows and data integration.
1104
+ *
1105
+ * Use cases: Streaming destination; Kinesis integration; Real-time migration; Data stream target; Database streaming endpoint
1106
+ *
1107
+ * AWS: Amazon Kinesis Data Streams ARN for DMS streaming destination and real-time data integration
1108
+ *
1109
+ * Validation: Must be valid Kinesis Data Streams ARN; required for Kinesis endpoint configuration and streaming destination
1110
+ **/
1111
+ readonly streamArn: string;
1112
+ }
1113
+ /**
1114
+ * Provides information that defines an Amazon Redshift endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1115
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
1116
+ * @struct
1117
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html
1118
+ */
1119
+ /**
1120
+ * Q-ENHANCED-INTERFACE
1121
+ * Redshift settings configuration interface for DMS providing data warehouse integration and bulk loading capabilities. Defines Redshift-specific properties for Database Migration Service including data loading configuration, S3 integration, and Redshift optimization for data warehouse migration workflows.
1122
+ *
1123
+ * Use cases: Data warehouse migration; Redshift integration; Bulk data loading; Data warehouse workflows; S3 staging; DMS Redshift integration
1124
+ *
1125
+ * AWS: AWS DMS Redshift endpoint configuration with data warehouse integration and bulk loading optimization
1126
+ *
1127
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and Redshift-specific requirements
1128
+ */
1129
+ export interface RedshiftSettingsProperty {
1130
+ /**
1131
+ * Q-ENHANCED-PROPERTY
1132
+ * Optional flag to allow any date format including invalid formats for flexible date handling in Redshift data warehouse. Enables loading of any date format including invalid formats like 00/00/00 00:00:00 without errors, with false default, requiring DATEFORMAT parameter for proper date handling.
1133
+ *
1134
+ * Use cases: Flexible date handling; Invalid date processing; Date format tolerance; Data warehouse loading; TIMESTAMP/DATE columns
1135
+ *
1136
+ * AWS: AWS DMS Redshift endpoint acceptAnyDate for flexible date format handling in data warehouse loading
1137
+ *
1138
+ * Validation: Must be boolean if provided; default false; applies only to TIMESTAMP and DATE columns; requires DATEFORMAT parameter
1139
+ **/
1140
+ readonly acceptAnyDate?: boolean;
1141
+ /**
1142
+ * Q-ENHANCED-PROPERTY
1143
+ * Optional SQL script to execute after connecting to Redshift endpoint for initialization and setup tasks. Provides custom initialization logic that runs after connection establishment to Redshift data warehouse, enabling database-specific setup and configuration for data warehouse operations.
1144
+ *
1145
+ * Use cases: Database initialization; Connection setup; Custom configuration; Post-connection tasks; Data warehouse preparation
1146
+ *
1147
+ * AWS: AWS DMS Redshift endpoint afterConnectScript for post-connection initialization and setup
1148
+ *
1149
+ * Validation: Must be valid SQL script code if provided; script content not filename; enables custom Redshift initialization
1150
+ **/
1151
+ readonly afterConnectScript?: string;
1152
+ /**
1153
+ * Q-ENHANCED-PROPERTY
1154
+ * Optional S3 folder for storing CSV files before uploading to Redshift cluster for staged data loading. Specifies S3 folder where CSV files are stored before Redshift COPY operations, with full load using BucketFolder/TableID path and CDC using BucketFolder/NetChangesTableID path for organized data staging.
1155
+ *
1156
+ * Use cases: Data staging; S3 organization; CSV storage; Redshift COPY operations; Staged loading
1157
+ *
1158
+ * AWS: AWS S3 folder path for DMS Redshift CSV file staging and COPY operation organization
1159
+ *
1160
+ * Validation: Must be valid S3 folder path if provided; used for CSV staging before Redshift COPY operations
1161
+ **/
1162
+ readonly bucketFolder?: string;
1163
+ /**
1164
+ * Q-ENHANCED-PROPERTY
1165
+ * Required S3 bucket name for intermediate CSV file storage before Redshift data loading operations. Specifies the S3 bucket where CSV files are stored before uploading to Redshift cluster, serving as staging area for Redshift COPY operations and data warehouse loading workflows.
1166
+ *
1167
+ * Use cases: Data staging; S3 storage; CSV intermediate storage; Redshift loading; Data warehouse staging
1168
+ *
1169
+ * AWS: AWS S3 bucket name for DMS Redshift CSV file staging and data warehouse loading operations
1170
+ *
1171
+ * Validation: Must be valid S3 bucket name; required for Redshift endpoint configuration and CSV staging operations
1172
+ **/
1173
+ readonly bucketName: string;
1174
+ /**
1175
+ * Q-ENHANCED-PROPERTY
1176
+ * Optional flag to enable case-sensitive schema names in Redshift data warehouse for precise schema handling. Enables case-sensitive schema name support when Redshift is configured for case sensitivity with default false, ensuring proper schema name handling and data organization in data warehouse operations.
1177
+ *
1178
+ * Use cases: Case-sensitive schemas; Schema name precision; Data organization; Redshift configuration; Schema handling
1179
+ *
1180
+ * AWS: AWS DMS Redshift endpoint caseSensitiveNames for case-sensitive schema name handling
1181
+ *
1182
+ * Validation: Must be boolean if provided; default false; requires Redshift configured for case-sensitive schema names
1183
+ **/
1184
+ readonly caseSensitiveNames?: boolean;
1185
+ /**
1186
+ * Q-ENHANCED-PROPERTY
1187
+ * Optional flag to enable automatic compression for empty Redshift tables for storage optimization. Enables automatic compression when table is empty even with existing encodings other than RAW, with true default, optimizing storage efficiency and query performance in data warehouse operations.
1188
+ *
1189
+ * Use cases: Storage optimization; Compression management; Performance tuning; Data warehouse optimization; Automatic encoding
1190
+ *
1191
+ * AWS: AWS DMS Redshift endpoint compUpdate for automatic compression and storage optimization
1192
+ *
1193
+ * Validation: Must be boolean if provided; default true; applies automatic compression to empty tables regardless of existing encodings
1194
+ **/
1195
+ readonly compUpdate?: boolean;
1196
+ /**
1197
+ * Q-ENHANCED-PROPERTY
1198
+ * Optional connection timeout in milliseconds for Redshift endpoint connection establishment. Specifies the maximum time to wait for initial connection establishment to Redshift data warehouse, controlling connection reliability and timeout behavior for data warehouse connectivity.
1199
+ *
1200
+ * Use cases: Connection reliability; Timeout control; Network configuration; Connection management; Data warehouse connectivity
1201
+ *
1202
+ * AWS: AWS DMS Redshift endpoint connectionTimeout for connection establishment timeout control
1203
+ *
1204
+ * Validation: Must be positive integer in milliseconds if provided; controls initial connection timeout for Redshift endpoint
1205
+ **/
1206
+ readonly connectionTimeout?: number;
1207
+ /**
1208
+ * Q-ENHANCED-PROPERTY
1209
+ * Optional date format specification for Redshift data loading and date handling. Specifies date format with 'auto' for automatic recognition, custom format string in quotes, or NULL for default YYYY-MM-DD format, enabling flexible date parsing and data warehouse date handling.
1210
+ *
1211
+ * Use cases: Date format specification; Flexible date parsing; Data warehouse loading; Date handling; Format recognition
1212
+ *
1213
+ * AWS: AWS DMS Redshift endpoint dateFormat for date format specification and parsing control
1214
+ *
1215
+ * Validation: Must be 'auto', quoted format string, or NULL if provided; default YYYY-MM-DD; use 'auto' for mixed formats
1216
+ **/
1217
+ readonly dateFormat?: string;
1218
+ /**
1219
+ * Q-ENHANCED-PROPERTY
1220
+ * Optional flag to migrate empty CHAR and VARCHAR fields as NULL for consistent null handling. Enables migration of empty string fields as NULL values with true setting and false default, ensuring consistent null representation in Redshift data warehouse operations.
1221
+ *
1222
+ * Use cases: NULL handling; Empty string processing; Data consistency; Redshift migration; Field representation
1223
+ *
1224
+ * AWS: AWS DMS Redshift endpoint emptyAsNull for empty field NULL conversion and consistent data representation
1225
+ *
1226
+ * Validation: Must be boolean if provided; default false; converts empty CHAR/VARCHAR fields to NULL when true
1227
+ **/
1228
+ readonly emptyAsNull?: boolean;
1229
+ /**
1230
+ * Q-ENHANCED-PROPERTY
1231
+ * Optional flag to override auto-generated IDENTITY column values with explicit source values for full-load migration. Enables tables with IDENTITY columns to use explicit values from source data files instead of auto-generated values, applicable only to full-load migration tasks.
1232
+ *
1233
+ * Use cases: IDENTITY column handling; Explicit value loading; Full-load migration; Source value preservation; Identity management
1234
+ *
1235
+ * AWS: AWS DMS Redshift endpoint explicitIds for IDENTITY column value override in full-load migration
1236
+ *
1237
+ * Validation: Must be boolean if provided; default false; applies only to full-load migration tasks with IDENTITY columns
1238
+ **/
1239
+ readonly explicitIds?: boolean;
1240
+ /**
1241
+ * Q-ENHANCED-PROPERTY
1242
+ * Optional number of parallel threads for single file upload to optimize S3 multipart upload performance. Specifies thread count (1-64) for uploading single CSV files to S3 using multipart upload with default 10, affecting upload performance and throughput for Redshift staging operations.
1243
+ *
1244
+ * Use cases: Upload optimization; Parallel processing; S3 multipart upload; Performance tuning; File transfer optimization
1245
+ *
1246
+ * AWS: AWS S3 multipart upload thread configuration for DMS Redshift CSV file upload optimization
1247
+ *
1248
+ * Validation: Must be integer between 1-64 if provided; default 10; controls parallel streams for S3 multipart upload
1249
+ **/
1250
+ readonly fileTransferUploadStreams?: number;
1251
+ /**
1252
+ * Q-ENHANCED-PROPERTY
1253
+ * Optional timeout in milliseconds for Redshift cluster operations including COPY, INSERT, DELETE, and UPDATE. Specifies maximum wait time for DMS operations on Redshift cluster, controlling operation timeout behavior and preventing hung operations in data warehouse loading.
1254
+ *
1255
+ * Use cases: Operation timeout; Performance control; Redshift operations; Timeout management; Data warehouse loading
1256
+ *
1257
+ * AWS: AWS DMS Redshift endpoint loadTimeout for cluster operation timeout control and performance management
1258
+ *
1259
+ * Validation: Must be positive integer in milliseconds if provided; controls timeout for Redshift COPY/INSERT/DELETE/UPDATE operations
1260
+ **/
1261
+ readonly loadTimeout?: number;
1262
+ /**
1263
+ * Q-ENHANCED-PROPERTY
1264
+ * Optional flag to migrate boolean type as native boolean in Redshift for proper data type representation. Enables migration of boolean values as boolean type instead of default varchar(1), requiring setting on both source and target endpoints for proper boolean data type handling in data warehouse.
1265
+ *
1266
+ * Use cases: Boolean type preservation; Data type accuracy; Redshift native types; Type mapping; Data warehouse optimization
1267
+ *
1268
+ * AWS: AWS DMS Redshift endpoint mapBooleanAsBoolean for native boolean type migration and data type preservation
1269
+ *
1270
+ * Validation: Must be boolean if provided; must be set on both source and target endpoints; preserves boolean data type in Redshift
1271
+ **/
1272
+ readonly mapBooleanAsBoolean?: boolean;
1273
+ /**
1274
+ * Q-ENHANCED-PROPERTY
1275
+ * Optional maximum CSV file size in KB for S3 staging and Redshift data transfer optimization. Specifies maximum size limit for CSV files used in S3 bucket loading and Redshift data transfer with default 1 GB (1048576KB), affecting staging performance and transfer efficiency.
1276
+ *
1277
+ * Use cases: File size control; S3 staging optimization; Transfer performance; Data warehouse loading; Storage management
1278
+ *
1279
+ * AWS: AWS DMS Redshift endpoint maxFileSize for CSV file size limits in S3 staging and data transfer
1280
+ *
1281
+ * Validation: Must be positive integer in KB if provided; default 1 GB; controls CSV file size for S3 staging and Redshift transfer
1282
+ **/
1283
+ readonly maxFileSize?: number;
1284
+ /**
1285
+ * Q-ENHANCED-PROPERTY
1286
+ * Optional flag to remove surrounding quotation marks from strings in incoming data for cleaner data processing. Enables removal of quotation marks while retaining all characters within quotes including delimiters, with false default, affecting string data processing in Redshift migration.
1287
+ *
1288
+ * Use cases: String processing; Quotation handling; Data cleaning; Character processing; String formatting
1289
+ *
1290
+ * AWS: AWS DMS Redshift endpoint removeQuotes for quotation mark removal and string data processing
1291
+ *
1292
+ * Validation: Must be boolean if provided; default false; removes surrounding quotation marks while preserving internal content
1293
+ **/
1294
+ readonly removeQuotes?: boolean;
1295
+ /**
1296
+ * Q-ENHANCED-PROPERTY
1297
+ * Optional replacement character for invalid characters specified in ReplaceInvalidChars for data cleaning. Specifies the substitution character for invalid characters during data migration with default "?" character, working with ReplaceInvalidChars for character replacement and data cleaning.
1298
+ *
1299
+ * Use cases: Character replacement; Data cleaning; Invalid character handling; String processing; Data sanitization
1300
+ *
1301
+ * AWS: AWS DMS Redshift endpoint replaceChars for invalid character replacement and data cleaning
1302
+ *
1303
+ * Validation: Must be valid replacement character if provided; default "?"; works with ReplaceInvalidChars for character substitution
1304
+ **/
1305
+ readonly replaceChars?: string;
1306
+ /**
1307
+ * Q-ENHANCED-PROPERTY
1308
+ * Optional list of characters to replace during data migration for data cleaning. Specifies characters that should be replaced using ReplaceChars substitution, enabling data sanitization and character normalization during Redshift data warehouse migration operations.
1309
+ *
1310
+ * Use cases: Character filtering; Data sanitization; Invalid character removal; String normalization; Data cleaning
1311
+ *
1312
+ * AWS: AWS DMS Redshift endpoint replaceInvalidChars for character filtering and data sanitization
1313
+ *
1314
+ * Validation: Must be valid character list if provided; works with ReplaceChars for character replacement and data cleaning
1315
+ **/
1316
+ readonly replaceInvalidChars?: string;
1317
+ /**
1318
+ * Q-ENHANCED-PROPERTY
1319
+ * Optional IAM role ARN for AWS Secrets Manager access to Redshift endpoint credentials. Specifies the IAM role with required permissions to access SecretsManagerSecret containing Redshift endpoint credentials, enabling secure credential management and access control for data warehouse connections.
1320
+ *
1321
+ * Use cases: Credential management; Secrets Manager integration; Secure access; IAM role configuration; Redshift authentication
1322
+ *
1323
+ * AWS: AWS IAM role ARN for Secrets Manager access to Redshift endpoint credentials and authentication
1324
+ *
1325
+ * Validation: Must be valid IAM role ARN if provided; requires iam:PassRole action and Secrets Manager access permissions
1326
+ **/
1327
+ readonly secretsManagerAccessRoleArn?: string;
1328
+ /**
1329
+ * Q-ENHANCED-PROPERTY
1330
+ * Required Secrets Manager secret ARN containing Redshift endpoint connection details for secure credential management. Specifies the full ARN of the secret containing Redshift database connection information including credentials, enabling secure storage and access of Redshift endpoint authentication details.
1331
+ *
1332
+ * Use cases: Secure credential storage; Redshift authentication; Secrets Manager integration; Database connection security; Credential management
1333
+ *
1334
+ * AWS: AWS Secrets Manager secret ARN containing Redshift endpoint connection details and credentials
1335
+ *
1336
+ * Validation: Must be valid Secrets Manager secret ARN; required for secure Redshift endpoint credential management and authentication
1337
+ **/
1338
+ readonly secretsManagerSecretArn: string;
1339
+ /**
1340
+ * Q-ENHANCED-PROPERTY
1341
+ * Optional KMS key ARN for encrypting Redshift endpoint credentials secret in Secrets Manager. Specifies the KMS key used to encrypt the credentials secret, providing additional encryption layer for Redshift endpoint authentication information stored in AWS Secrets Manager.
1342
+ *
1343
+ * Use cases: Credential encryption; KMS integration; Enhanced security; Secret encryption; Redshift credential protection
1344
+ *
1345
+ * AWS: AWS KMS key ARN for encrypting Secrets Manager secret containing Redshift endpoint credentials
1346
+ *
1347
+ * Validation: Must be valid KMS key ARN if provided; provides additional encryption for Redshift credentials in Secrets Manager
1348
+ **/
1349
+ readonly secretsManagerSecretKMSArn?: string;
1350
+ /**
1351
+ * Q-ENHANCED-PROPERTY
1352
+ * Required KMS key ID for server-side encryption when using SSE_KMS encryption mode for Redshift S3 staging security. Specifies the AWS KMS key for encrypting S3 staging objects, requiring attached policy enabling IAM user permissions and key usage for secure data warehouse staging and compliance.
1353
+ *
1354
+ * Use cases: Data encryption; KMS integration; S3 security; Compliance requirements; Data protection
1355
+ *
1356
+ * AWS: AWS KMS key ID for S3 server-side encryption with customer-managed keys in Redshift staging
1357
+ *
1358
+ * Validation: Must be valid KMS key ID; required when EncryptionMode is SSE_KMS; requires proper IAM permissions and key policy
1359
+ **/
1360
+ readonly serverSideEncryptionKmsKeyId: string;
1361
+ /**
1362
+ * Q-ENHANCED-PROPERTY
1363
+ * Optional IAM role ARN for DMS service access to Redshift service operations for data warehouse integration. Specifies the service role enabling DMS to access Redshift service, requiring iam:PassRole action for secure Redshift access and data warehouse migration operations.
1364
+ *
1365
+ * Use cases: Service access; IAM role configuration; Redshift permissions; Secure access; Data warehouse authorization
1366
+ *
1367
+ * AWS: AWS IAM role ARN for DMS service access to Redshift service operations and data warehouse integration
1368
+ *
1369
+ * Validation: Must be valid IAM role ARN if provided; requires iam:PassRole action; enables Redshift service access operations
1370
+ **/
1371
+ readonly serviceAccessRoleArn?: string;
1372
+ /**
1373
+ * Q-ENHANCED-PROPERTY
1374
+ * Optional time format specification for Redshift data loading and time handling. Specifies time format with 'auto' for automatic recognition, custom timeformat_string, epochsecs, or epochmillisecs options, enabling flexible time parsing and data warehouse time handling with default 10.
1375
+ *
1376
+ * Use cases: Time format specification; Flexible time parsing; Data warehouse loading; Time handling; Format recognition
1377
+ *
1378
+ * AWS: AWS DMS Redshift endpoint timeFormat for time format specification and parsing control
1379
+ *
1380
+ * Validation: Must be 'auto', timeformat_string, 'epochsecs', or 'epochmillisecs' if provided; default 10; use 'auto' for mixed formats
1381
+ **/
1382
+ readonly timeFormat?: string;
1383
+ /**
1384
+ * Q-ENHANCED-PROPERTY
1385
+ * Optional flag to remove trailing white space characters from VARCHAR strings for cleaner data processing. Enables removal of trailing whitespace from VARCHAR columns with true setting and false default, improving data quality and consistency in Redshift data warehouse operations.
1386
+ *
1387
+ * Use cases: Data cleaning; Whitespace removal; VARCHAR processing; Data quality; String normalization
1388
+ *
1389
+ * AWS: AWS DMS Redshift endpoint trimBlanks for trailing whitespace removal from VARCHAR columns
1390
+ *
1391
+ * Validation: Must be boolean if provided; default false; applies only to VARCHAR data type columns; removes trailing whitespace
1392
+ **/
1393
+ readonly trimBlanks?: boolean;
1394
+ /**
1395
+ * Q-ENHANCED-PROPERTY
1396
+ * Optional flag to truncate data in columns to fit column size limits for data integrity in Redshift. Enables truncation of data in VARCHAR or CHAR columns to appropriate character limits for rows 4MB or less, with false default, ensuring data fits column constraints in data warehouse operations.
1397
+ *
1398
+ * Use cases: Data truncation; Column size compliance; Data integrity; VARCHAR/CHAR handling; Size constraint management
1399
+ *
1400
+ * AWS: AWS DMS Redshift endpoint truncateColumns for data truncation and column size compliance
1401
+ *
1402
+ * Validation: Must be boolean if provided; default false; applies only to VARCHAR/CHAR columns with rows ≤4MB; ensures data fits columns
1403
+ **/
1404
+ readonly truncateColumns?: boolean;
1405
+ /**
1406
+ * Q-ENHANCED-PROPERTY
1407
+ * Optional in-memory file write buffer size in KB for CSV file generation performance optimization. Specifies buffer size for generating CSV files on local disk at DMS replication instance with default 1000KB (1MB), affecting CSV generation performance and memory usage.
1408
+ *
1409
+ * Use cases: Performance optimization; Buffer management; CSV generation; Memory optimization; File write performance
1410
+ *
1411
+ * AWS: AWS DMS Redshift endpoint writeBufferSize for CSV file generation buffer optimization and performance tuning
1412
+ *
1413
+ * Validation: Must be positive integer in KB if provided; default 1000KB; controls in-memory buffer size for CSV file generation
1414
+ **/
1415
+ readonly writeBufferSize?: number;
1416
+ }
1417
+ /**
1418
+ * Provides information that defines a MongoDB endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1419
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Endpoint configuration settings when using MongoDB as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide* .
1420
+ * @struct
1421
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html
1422
+ */
1423
+ /**
1424
+ * Q-ENHANCED-INTERFACE
1425
+ * MongoDB settings configuration interface for DMS providing NoSQL database migration and document database capabilities. Defines MongoDB-specific properties for Database Migration Service including document migration, authentication settings, and MongoDB integration for NoSQL database migration workflows.
1426
+ *
1427
+ * Use cases: NoSQL database migration; Document database migration; MongoDB connectivity; NoSQL migration workflows; Document data migration; DMS MongoDB integration
1428
+ *
1429
+ * AWS: AWS DMS MongoDB endpoint configuration with NoSQL database migration and document database capabilities
1430
+ *
1431
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1432
+ */
1433
+ export interface MongoDbSettingsProperty {
1434
+ /**
1435
+ * Q-ENHANCED-PROPERTY
1436
+ * Optional authentication mechanism for MongoDB source endpoint access with version-specific defaults. Specifies authentication method with default "mongodb_cr" for MongoDB 2.x and "scram_sha_1" for MongoDB 3.x+, not used when AuthType is "no", enabling secure MongoDB database connectivity and authentication.
1437
+ *
1438
+ * Use cases: MongoDB authentication; Version-specific auth; Database security; Connection authentication; MongoDB connectivity
1439
+ *
1440
+ * AWS: AWS DMS MongoDB endpoint authMechanism for authentication method specification and secure database access
1441
+ *
1442
+ * Validation: Must be valid MongoDB authentication mechanism if provided; version-dependent defaults; not used when AuthType is "no"
1443
+ **/
1444
+ readonly authMechanism?: string;
1445
+ /**
1446
+ * Q-ENHANCED-PROPERTY
1447
+ * Optional MongoDB database name for authentication with default "admin" database. Specifies the database used for authentication operations, not used when AuthType is "no", enabling proper authentication context and database-specific access control for MongoDB migration operations.
1448
+ *
1449
+ * Use cases: Authentication database; MongoDB auth context; Database-specific auth; Authentication scope; MongoDB security
1450
+ *
1451
+ * AWS: AWS DMS MongoDB endpoint authSource for authentication database specification and access control
1452
+ *
1453
+ * Validation: Must be valid MongoDB database name if provided; default "admin"; not used when AuthType is "no"
1454
+ **/
1455
+ readonly authSource?: string;
1456
+ /**
1457
+ * Q-ENHANCED-PROPERTY
1458
+ * Optional authentication type for MongoDB source endpoint access control. Specifies authentication type with "no" disabling username/password requirements and allowing empty credentials, enabling flexible authentication configuration for MongoDB database connectivity and migration operations.
1459
+ *
1460
+ * Use cases: Authentication control; MongoDB security; Credential management; Access control; Database authentication
1461
+ *
1462
+ * AWS: AWS DMS MongoDB endpoint authType for authentication type specification and access control
1463
+ *
1464
+ * Validation: Must be valid authentication type if provided; "no" disables username/password requirements; controls MongoDB authentication
1465
+ **/
1466
+ readonly authType?: string;
1467
+ /**
1468
+ * Q-ENHANCED-PROPERTY
1469
+ * Optional database name on MongoDB source endpoint for migration scope specification. Specifies the target database name for MongoDB migration operations, defining the scope of data migration and database-specific operations for NoSQL document database migration workflows.
1470
+ *
1471
+ * Use cases: Database scope; Migration target; MongoDB database selection; Data scope; Database specification
1472
+ *
1473
+ * AWS: AWS DMS MongoDB endpoint databaseName for migration database specification and scope definition
1474
+ *
1475
+ * Validation: Must be valid MongoDB database name if provided; defines migration scope and target database for operations
1476
+ **/
1477
+ readonly databaseName?: string;
1478
+ /**
1479
+ * Q-ENHANCED-PROPERTY
1480
+ * Optional number of documents to preview for document organization analysis when using table mode. Specifies document count for preview analysis with default 1000, used when NestingLevel is "one", enabling proper document structure analysis and table mode configuration.
1481
+ *
1482
+ * Use cases: Document analysis; Structure preview; Table mode configuration; Document organization; Schema analysis
1483
+ *
1484
+ * AWS: AWS DMS MongoDB endpoint docsToInvestigate for document structure analysis and table mode configuration
1485
+ *
1486
+ * Validation: Must be positive integer greater than 0 if provided; default 1000; used when NestingLevel is "one"
1487
+ **/
1488
+ readonly docsToInvestigate?: string;
1489
+ /**
1490
+ * Q-ENHANCED-PROPERTY
1491
+ * Optional flag to specify document ID extraction when using document mode. Specifies whether to extract document ID with default "false", used when NestingLevel is "none", enabling document ID handling and document mode configuration for MongoDB migration operations.
1492
+ *
1493
+ * Use cases: Document ID extraction; Document mode; ID handling; Document configuration; MongoDB document processing
1494
+ *
1495
+ * AWS: AWS DMS MongoDB endpoint extractDocId for document ID extraction and document mode configuration
1496
+ *
1497
+ * Validation: Must be "true" or "false" if provided; default "false"; used when NestingLevel is "none"
1498
+ **/
1499
+ readonly extractDocId?: string;
1500
+ /**
1501
+ * Q-ENHANCED-PROPERTY
1502
+ * Optional nesting level specification for document or table mode selection. Specifies migration mode with "none" for document mode and "one" for table mode, with default "none", controlling how MongoDB documents are processed and migrated in NoSQL database operations.
1503
+ *
1504
+ * Use cases: Migration mode; Document processing; Table mode; Document mode; MongoDB structure handling
1505
+ *
1506
+ * AWS: AWS DMS MongoDB endpoint nestingLevel for migration mode specification and document processing control
1507
+ *
1508
+ * Validation: Must be "none" or "one" if provided; default "none"; "none" uses document mode, "one" uses table mode
1509
+ **/
1510
+ readonly nestingLevel?: string;
1511
+ /**
1512
+ * The port value for the MongoDB source endpoint.
1513
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port
1514
+ */
1515
+ readonly port?: number;
1516
+ /**
1517
+ * The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
1518
+ * The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
1519
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanageraccessrolearn
1520
+ */
1521
+ readonly secretsManagerAccessRoleArn?: string;
1522
+ /**
1523
+ * The full ARN of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details.
1524
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanagersecretid
1525
+ */
1526
+ readonly secretsManagerSecretArn: string;
1527
+ /**
1528
+ * The ID of the KMS key used to encrypt the credentials secret.
1529
+ */
1530
+ readonly secretsManagerSecretKMSArn?: string;
1531
+ /**
1532
+ * The name of the server on the MongoDB source endpoint.
1533
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername
1534
+ */
1535
+ readonly serverName?: string;
1536
+ }
1537
+ /**
1538
+ * Provides information that defines an IBMDB2 endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1539
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
1540
+ * @struct
1541
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html
1542
+ */
1543
+ /**
1544
+ * Q-ENHANCED-INTERFACE
1545
+ * IBM DB2 settings configuration interface for DMS providing mainframe database migration and enterprise database capabilities. Defines IBM DB2-specific properties for Database Migration Service including mainframe connectivity, enterprise features, and DB2 integration for enterprise database migration workflows.
1546
+ *
1547
+ * Use cases: Mainframe database migration; Enterprise database migration; IBM DB2 connectivity; Mainframe integration; Enterprise migration workflows; DMS DB2 integration
1548
+ *
1549
+ * AWS: AWS DMS IBM DB2 endpoint configuration with mainframe database migration and enterprise database capabilities
1550
+ *
1551
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1552
+ */
1553
+ export interface IbmDb2SettingsProperty {
1554
+ /**
1555
+ * Q-ENHANCED-PROPERTY
1556
+ * Optional log sequence number (LSN) for IBM DB2 change data capture (CDC) replication starting point enabling precise replication control. Specifies the exact LSN where ongoing replication should begin for CDC operations, providing fine-grained control over data synchronization starting points in mainframe database migration scenarios.
1557
+ *
1558
+ * Use cases: CDC replication control; Precise replication starting points; Mainframe data synchronization; Log-based replication; Data migration control
1559
+ *
1560
+ * AWS: AWS DMS IBM DB2 current LSN for CDC replication starting point control and log-based data synchronization
1561
+ *
1562
+ * Validation: Must be valid LSN string if provided; used for CDC replication; optional for replication starting point control
1563
+ **/
1564
+ readonly currentLsn?: string;
1565
+ /**
1566
+ * Q-ENHANCED-PROPERTY
1567
+ * Optional maximum bytes per read operation for IBM DB2 data transfer performance optimization enabling throughput tuning. Defines the maximum number of kilobytes that will be read in a single operation during data migration, allowing performance optimization for mainframe database transfers with configurable read buffer sizes.
1568
+ *
1569
+ * Use cases: Performance optimization; Throughput tuning; Read buffer configuration; Migration performance; Mainframe data transfer optimization
1570
+ *
1571
+ * AWS: AWS DMS IBM DB2 maximum kilobytes per read for data transfer performance optimization and throughput control
1572
+ *
1573
+ * Validation: Must be positive number if provided; defaults to 64 KB; optional for performance tuning
1574
+ **/
1575
+ readonly maxKBytesPerRead?: number;
1576
+ /**
1577
+ * The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
1578
+ * The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
1579
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn
1580
+ */
1581
+ readonly secretsManagerAccessRoleArn?: string;
1582
+ /**
1583
+ * The full ARN of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details.
1584
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanagersecretid
1585
+ */
1586
+ readonly secretsManagerSecretArn: string;
1587
+ /**
1588
+ * The ID of the KMS key used to encrypt the credentials secret.
1589
+ */
1590
+ readonly secretsManagerSecretKMSArn?: string;
1591
+ /**
1592
+ * Enables ongoing replication (CDC) as a BOOLEAN value.
1593
+ * The default is true.
1594
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-setdatacapturechanges
1595
+ */
1596
+ readonly setDataCaptureChanges?: boolean;
1597
+ }
1598
+ /**
1599
+ * Provides information that defines an Amazon Neptune endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1600
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see [Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide* .
1601
+ * @struct
1602
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html
1603
+ */
1604
+ /**
1605
+ * Q-ENHANCED-INTERFACE
1606
+ * Neptune settings configuration interface for DMS providing graph database migration and graph data capabilities. Defines Neptune-specific properties for Database Migration Service including graph data migration, graph database connectivity, and Neptune integration for graph database migration workflows.
1607
+ *
1608
+ * Use cases: Graph database migration; Graph data migration; Neptune connectivity; Graph database workflows; Graph data integration; DMS Neptune integration
1609
+ *
1610
+ * AWS: AWS DMS Neptune endpoint configuration with graph database migration and graph data capabilities
1611
+ *
1612
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1613
+ */
1614
+ export interface NeptuneSettingsProperty {
1615
+ /**
1616
+ * Q-ENHANCED-PROPERTY
1617
+ * Optional retry duration in milliseconds for DMS bulk-load operations to Neptune target database enabling resilient graph data migration with configurable error recovery. Defines the wait time before retrying failed bulk-load operations for migrated graph data to ensure reliable data transfer to Neptune.
1618
+ *
1619
+ * Use cases: Graph data migration resilience; Bulk-load error recovery; Neptune migration optimization; Retry configuration
1620
+ *
1621
+ * AWS: DMS Neptune endpoint errorRetryDuration setting for bulk-load retry timing configuration
1622
+ *
1623
+ * Validation: Must be positive integer in milliseconds; default is 250ms; controls retry timing for failed bulk operations
1624
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-errorretryduration
1625
+ */
1626
+ readonly errorRetryDuration?: number;
1627
+ /**
1628
+ * Q-ENHANCED-PROPERTY
1629
+ * Optional maximum file size in kilobytes for CSV files containing migrated graph data before DMS bulk-loads to Neptune target database enabling optimized batch processing. Defines the size threshold for CSV files storing graph data before triggering bulk-load operations to Neptune, optimizing memory usage and transfer efficiency.
1630
+ *
1631
+ * Use cases: Graph data batch optimization; Memory management; CSV file size control; Neptune bulk-load efficiency
1632
+ *
1633
+ * AWS: DMS Neptune endpoint maxFileSize setting for CSV file size threshold configuration
1634
+ *
1635
+ * Validation: Must be positive integer in kilobytes; default is 1,048,576 KB (1GB); controls CSV batch size for bulk operations
1636
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxfilesize
1637
+ */
1638
+ readonly maxFileSize?: number;
1639
+ /**
1640
+ * Q-ENHANCED-PROPERTY
1641
+ * Optional maximum retry count for DMS bulk-load operations to Neptune target database enabling configurable resilience for graph data migration. Defines the number of retry attempts for failed bulk-load operations before raising an error, ensuring reliable graph data transfer with controlled retry behavior.
1642
+ *
1643
+ * Use cases: Graph migration resilience; Bulk-load retry control; Neptune migration reliability; Error handling configuration
1644
+ *
1645
+ * AWS: DMS Neptune endpoint maxRetryCount setting for bulk-load retry attempt configuration
1646
+ *
1647
+ * Validation: Must be positive integer; default is 5 retries; controls maximum retry attempts for failed bulk operations
1648
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxretrycount
1649
+ */
1650
+ readonly maxRetryCount?: number;
1651
+ /**
1652
+ * Q-ENHANCED-PROPERTY
1653
+ * Optional S3 bucket folder path for storing migrated graph data during DMS Neptune migration enabling organized data staging and processing. Defines the folder structure within the S3 bucket for temporary storage of graph data CSV files before bulk-loading to Neptune target database.
1654
+ *
1655
+ * Use cases: Graph data organization; S3 staging structure; Migration data management; Temporary storage organization
1656
+ *
1657
+ * AWS: DMS Neptune endpoint s3BucketFolder setting for S3 staging folder path configuration
1658
+ *
1659
+ * Validation: Must be valid S3 folder path if provided; enables organized staging of graph migration data
1660
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketfolder
1661
+ */
1662
+ readonly s3BucketFolder?: string;
1663
+ /**
1664
+ * Q-ENHANCED-PROPERTY
1665
+ * Required S3 bucket name for temporary storage of migrated graph data during DMS Neptune migration enabling staged data processing and bulk-loading. Defines the S3 bucket where DMS stores CSV files containing graph data before bulk-loading to Neptune target database.
1666
+ *
1667
+ * Use cases: Graph data staging; Neptune migration storage; Temporary CSV storage; Bulk-load data preparation
1668
+ *
1669
+ * AWS: DMS Neptune endpoint s3BucketName setting for S3 staging bucket configuration
1670
+ *
1671
+ * Validation: Must be valid S3 bucket name; required for Neptune endpoint configuration; bucket must exist and be accessible
1672
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketname
1673
+ */
1674
+ readonly s3BucketName: string;
1675
+ /**
1676
+ * Q-ENHANCED-PROPERTY
1677
+ * Optional IAM service role ARN for DMS Neptune endpoint access enabling secure authentication and authorization for graph database operations. Defines the IAM role that DMS assumes to access Neptune target database with required permissions for bulk-loading and graph data operations.
1678
+ *
1679
+ * Use cases: Neptune access control; DMS service authentication; IAM role-based security; Graph database permissions
1680
+ *
1681
+ * AWS: DMS Neptune endpoint serviceAccessRoleArn setting for IAM role-based authentication
1682
+ *
1683
+ * Validation: Must be valid IAM role ARN if provided; role must have iam:PassRole permission and Neptune access policies
1684
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-serviceaccessrolearn
1685
+ */
1686
+ readonly serviceAccessRoleArn?: string;
1687
+ }
1688
+ /**
1689
+ * Provides information that defines an OpenSearch endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1690
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see [Extra connection attributes when using OpenSearch as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide* .
1691
+ * @struct
1692
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html
1693
+ */
1694
+ /**
1695
+ * Q-ENHANCED-INTERFACE
1696
+ * Elasticsearch settings configuration interface for DMS providing search engine migration and search data capabilities. Defines Elasticsearch-specific properties for Database Migration Service including search data migration, index configuration, and Elasticsearch integration for search engine migration workflows.
1697
+ *
1698
+ * Use cases: Search engine migration; Search data migration; Elasticsearch connectivity; Search index migration; Search data integration; DMS Elasticsearch integration
1699
+ *
1700
+ * AWS: AWS DMS Elasticsearch endpoint configuration with search engine migration and search data capabilities
1701
+ *
1702
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1703
+ */
1704
+ export interface ElasticsearchSettingsProperty {
1705
+ /**
1706
+ * Q-ENHANCED-PROPERTY
1707
+ * Optional OpenSearch cluster endpoint URI for DMS target connectivity enabling search engine data migration and indexing. Defines the connection endpoint for OpenSearch cluster where DMS will migrate and index data from source databases for search and analytics capabilities.
1708
+ *
1709
+ * Use cases: Search engine migration; Data indexing; OpenSearch connectivity; Search data integration
1710
+ *
1711
+ * AWS: DMS Elasticsearch endpoint endpointUri setting for OpenSearch cluster connectivity
1712
+ *
1713
+ * Validation: Must be valid HTTPS URI if provided; DMS uses HTTPS by default for secure search engine connectivity
1714
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-endpointuri
1715
+ */
1716
+ readonly endpointUri?: string;
1717
+ /**
1718
+ * Q-ENHANCED-PROPERTY
1719
+ * Optional maximum retry duration in seconds for failed DMS API requests to OpenSearch cluster enabling resilient search data migration. Defines the maximum time DMS will retry failed API requests to the OpenSearch cluster for improved reliability and fault tolerance during search data migration.
1720
+ *
1721
+ * Use cases: Search migration resilience; API retry configuration; OpenSearch connectivity reliability; Migration fault tolerance
1722
+ *
1723
+ * AWS: DMS Elasticsearch endpoint errorRetryDuration setting for API retry timing configuration
1724
+ *
1725
+ * Validation: Must be positive integer in seconds if provided; controls maximum retry duration for failed OpenSearch API requests
1726
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-errorretryduration
1727
+ */
1728
+ readonly errorRetryDuration?: number;
1729
+ /**
1730
+ * Q-ENHANCED-PROPERTY
1731
+ * Optional maximum percentage of failed records before stopping full load operation enabling controlled search data migration quality. Defines the failure threshold for record writes to OpenSearch before DMS stops the full load operation to prevent data quality issues in search indexes.
1732
+ *
1733
+ * Use cases: Data quality control; Migration failure thresholds; Search index quality; Load operation control
1734
+ *
1735
+ * AWS: DMS Elasticsearch endpoint fullLoadErrorPercentage setting for data quality control
1736
+ *
1737
+ * Validation: Must be percentage value between 0-100 if provided; controls failure threshold for full load operations
1738
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage
1739
+ */
1740
+ readonly fullLoadErrorPercentage?: number;
1741
+ /**
1742
+ * Q-ENHANCED-PROPERTY
1743
+ * Optional IAM service role ARN for DMS OpenSearch endpoint access enabling secure authentication and authorization for search engine operations. Defines the IAM role that DMS assumes to access OpenSearch cluster with required permissions for indexing and search operations.
1744
+ *
1745
+ * Use cases: OpenSearch access control; DMS service authentication; IAM role-based security; Search engine permissions
1746
+ *
1747
+ * AWS: DMS Elasticsearch endpoint serviceAccessRoleArn setting for IAM role-based authentication
1748
+ *
1749
+ * Validation: Must be valid IAM role ARN if provided; role must have iam:PassRole permission and OpenSearch access policies
1750
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn
1751
+ */
1752
+ readonly serviceAccessRoleArn?: string;
1753
+ }
1754
+ /**
1755
+ * Provides information that defines a DocumentDB endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1756
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide* .
1757
+ * @struct
1758
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html
1759
+ */
1760
+ /**
1761
+ * Q-ENHANCED-INTERFACE
1762
+ * DocumentDB settings configuration interface for DMS providing document database migration and MongoDB-compatible capabilities. Defines DocumentDB-specific properties for Database Migration Service including document migration, MongoDB compatibility, and DocumentDB integration for document database migration workflows.
1763
+ *
1764
+ * Use cases: Document database migration; MongoDB-compatible migration; DocumentDB connectivity; Document data migration; MongoDB compatibility; DMS DocumentDB integration
1765
+ *
1766
+ * AWS: AWS DMS DocumentDB endpoint configuration with document database migration and MongoDB-compatible capabilities
1767
+ *
1768
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1769
+ */
1770
+ export interface DocDbSettingsProperty {
1771
+ /**
1772
+ * Q-ENHANCED-PROPERTY
1773
+ * Optional number of documents to preview for determining document organization and schema inference in DocumentDB migration. Defines the sample size for document analysis when nesting level is set to "one" for table mode migration, enabling proper schema detection and data mapping.
1774
+ *
1775
+ * Use cases: Document schema inference; Migration planning; Table mode configuration; Document organization analysis
1776
+ *
1777
+ * AWS: DMS DocumentDB endpoint docsToInvestigate setting for document sampling and schema analysis
1778
+ *
1779
+ * Validation: Must be positive integer greater than 0 if provided; default is 1000; used for document organization analysis
1780
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-docstoinvestigate
1781
+ */
1782
+ readonly docsToInvestigate?: number;
1783
+ /**
1784
+ * Q-ENHANCED-PROPERTY
1785
+ * Optional flag to extract document ID during DocumentDB migration enabling document identification and tracking. Specifies whether to extract the document ID when nesting level is set to "none" for document mode migration, enabling document-level tracking and identification.
1786
+ *
1787
+ * Use cases: Document identification; Document mode migration; Document tracking; ID extraction
1788
+ *
1789
+ * AWS: DMS DocumentDB endpoint extractDocId setting for document ID extraction configuration
1790
+ *
1791
+ * Validation: Must be boolean value if provided; default is false; used when nesting level is "none"
1792
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-extractdocid
1793
+ */
1794
+ readonly extractDocId?: boolean;
1795
+ /**
1796
+ * Q-ENHANCED-PROPERTY
1797
+ * Optional nesting level specification for DocumentDB migration mode selection enabling document or table mode migration. Defines the migration approach with "none" for document mode preserving document structure or "one" for table mode flattening documents into relational format.
1798
+ *
1799
+ * Use cases: Migration mode selection; Document structure preservation; Table mode flattening; Migration strategy configuration
1800
+ *
1801
+ * AWS: DMS DocumentDB endpoint nestingLevel setting for migration mode configuration
1802
+ *
1803
+ * Validation: Must be "none" or "one" if provided; default is "none"; determines document vs table migration mode
1804
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-nestinglevel
1805
+ */
1806
+ readonly nestingLevel?: string;
1807
+ /**
1808
+ * Q-ENHANCED-PROPERTY
1809
+ * Optional IAM role ARN for DMS to access Secrets Manager secret containing DocumentDB credentials enabling secure credential management. Defines the IAM role that DMS assumes to retrieve database credentials from Secrets Manager for DocumentDB endpoint connectivity with role-based security.
1810
+ *
1811
+ * Use cases: Secure credential access; IAM role-based security; Secrets Manager integration; DMS authentication
1812
+ *
1813
+ * AWS: DMS DocumentDB endpoint secretsManagerAccessRoleArn setting for IAM role-based credential access
1814
+ *
1815
+ * Validation: Must be valid IAM role ARN if provided; role must have iam:PassRole and Secrets Manager access permissions
1816
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanageraccessrolearn
1817
+ */
1818
+ readonly secretsManagerAccessRoleArn?: string;
1819
+ /**
1820
+ * Q-ENHANCED-PROPERTY
1821
+ * Required Secrets Manager secret ARN containing DocumentDB endpoint connection details enabling secure credential storage for document database connectivity. Defines the AWS Secrets Manager secret that stores database connection credentials including username, password, and connection parameters for DocumentDB endpoint access.
1822
+ *
1823
+ * Use cases: Secure credential storage; DocumentDB connectivity; Database authentication; Secrets management
1824
+ *
1825
+ * AWS: DMS DocumentDB endpoint secretsManagerSecretId setting for Secrets Manager secret reference
1826
+ *
1827
+ * Validation: Must be valid Secrets Manager secret ARN; required; secret must contain valid DocumentDB connection credentials
1828
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanagersecretid
1829
+ */
1830
+ readonly secretsManagerSecretArn: string;
1831
+ /**
1832
+ * Q-ENHANCED-PROPERTY
1833
+ * Optional KMS key ARN for encrypting Secrets Manager secret containing DocumentDB credentials enabling enhanced security for database connection details. Defines the KMS key used to encrypt the Secrets Manager secret that stores DocumentDB endpoint credentials for additional security layer.
1834
+ *
1835
+ * Use cases: Credential encryption; Enhanced security; KMS integration; Secrets Manager encryption
1836
+ *
1837
+ * AWS: DMS DocumentDB endpoint secretsManagerSecretKMSArn setting for KMS encryption of credentials
1838
+ *
1839
+ * Validation: Must be valid KMS key ARN if provided; enables encryption of Secrets Manager secret containing credentials
1840
+ */
1841
+ readonly secretsManagerSecretKMSArn?: string;
1842
+ }
1843
+ /**
1844
+ * Provides information, including the Amazon Resource Name (ARN) of the IAM role used to define an Amazon DynamoDB target endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1845
+ * This information also includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide* .
1846
+ * @struct
1847
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html
1848
+ */
1849
+ /**
1850
+ * Q-ENHANCED-INTERFACE
1851
+ * DynamoDB settings configuration interface for DMS providing NoSQL database migration and serverless database capabilities. Defines DynamoDB-specific properties for Database Migration Service including NoSQL migration, serverless database connectivity, and DynamoDB integration for serverless database migration workflows.
1852
+ *
1853
+ * Use cases: NoSQL database migration; Serverless database migration; DynamoDB connectivity; NoSQL data migration; Serverless data integration; DMS DynamoDB integration
1854
+ *
1855
+ * AWS: AWS DMS DynamoDB endpoint configuration with NoSQL database migration and serverless database capabilities
1856
+ *
1857
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1858
+ */
1859
+ export interface DynamoDbSettingsProperty {
1860
+ /**
1861
+ * Q-ENHANCED-PROPERTY
1862
+ * Optional IAM service role ARN for DMS DynamoDB endpoint access enabling secure authentication and authorization for NoSQL database operations. Defines the IAM role that DMS assumes to access DynamoDB tables with required permissions for data migration and NoSQL operations.
1863
+ *
1864
+ * Use cases: DynamoDB access control; DMS service authentication; IAM role-based security; NoSQL database permissions
1865
+ *
1866
+ * AWS: DMS DynamoDB endpoint serviceAccessRoleArn setting for IAM role-based authentication
1867
+ *
1868
+ * Validation: Must be valid IAM role ARN if provided; role must have iam:PassRole permission and DynamoDB access policies
1869
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html#cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn
1870
+ */
1871
+ readonly serviceAccessRoleArn?: string;
1872
+ }
1873
+ /**
1874
+ * Provides information that defines a Microsoft SQL Server endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
1875
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
1876
+ * @struct
1877
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html
1878
+ */
1879
+ /**
1880
+ * Q-ENHANCED-INTERFACE
1881
+ * Microsoft SQL Server settings configuration interface for DMS providing SQL Server migration and enterprise database capabilities. Defines SQL Server-specific properties for Database Migration Service including enterprise features, backup integration, and SQL Server migration for enterprise database migration workflows.
1882
+ *
1883
+ * Use cases: SQL Server migration; Enterprise database migration; SQL Server connectivity; Enterprise migration workflows; Database backup integration; DMS SQL Server integration
1884
+ *
1885
+ * AWS: AWS DMS Microsoft SQL Server endpoint configuration with enterprise database migration and SQL Server capabilities
1886
+ *
1887
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
1888
+ */
1889
+ export interface MicrosoftSqlServerSettingsProperty {
1890
+ /**
1891
+ * Q-ENHANCED-PROPERTY
1892
+ * Optional BCP packet size in bytes for SQL Server data transfer optimization enabling performance tuning for bulk data operations. Defines the maximum packet size used for Bulk Copy Program (BCP) operations during SQL Server data migration for optimal network utilization and transfer performance.
1893
+ *
1894
+ * Use cases: SQL Server performance tuning; Bulk data transfer optimization; Network utilization; Migration performance
1895
+ *
1896
+ * AWS: DMS Microsoft SQL Server endpoint bcpPacketSize setting for BCP transfer optimization
1897
+ *
1898
+ * Validation: Must be valid packet size in bytes if provided; affects BCP transfer performance and network utilization
1899
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-bcppacketsize
1900
+ */
1901
+ readonly bcpPacketSize?: number;
1902
+ /**
1903
+ * Q-ENHANCED-PROPERTY
1904
+ * Optional file group specification for DMS internal control tables enabling SQL Server storage organization and performance optimization. Defines the file group where DMS creates internal control tables (awsdms_apply_exception, awsdms_apply, awsdms_changes) for organized storage management and performance tuning.
1905
+ *
1906
+ * Use cases: SQL Server storage organization; Performance optimization; File group management; Control table organization
1907
+ *
1908
+ * AWS: DMS Microsoft SQL Server endpoint controlTablesFileGroup setting for internal table storage organization
1909
+ *
1910
+ * Validation: Must be valid SQL Server file group name if provided; affects DMS internal table storage location
1911
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-controltablesfilegroup
1912
+ */
1913
+ readonly controlTablesFileGroup?: string;
1914
+ /**
1915
+ * Q-ENHANCED-PROPERTY
1916
+ * Optional database name for SQL Server endpoint connectivity enabling specific database targeting within SQL Server instance. Defines the target database name within the SQL Server instance for focused migration operations and database-specific connectivity.
1917
+ *
1918
+ * Use cases: Database-specific migration; SQL Server database targeting; Multi-database instance management; Database connectivity
1919
+ *
1920
+ * AWS: DMS Microsoft SQL Server endpoint databaseName setting for specific database connectivity
1921
+ *
1922
+ * Validation: Must be valid SQL Server database name if provided; targets specific database within SQL Server instance
1923
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-databasename
1924
+ */
1925
+ readonly databaseName?: string;
1926
+ /**
1927
+ * Q-ENHANCED-PROPERTY
1928
+ * Optional flag to force LOB lookup on inline LOB data enabling large object handling in SQL Server migration. Forces DMS to perform LOB lookup operations on inline LOB data for complete large object migration and data integrity in SQL Server environments.
1929
+ *
1930
+ * Use cases: Large object migration; SQL Server LOB handling; Data integrity; Complete data migration
1931
+ *
1932
+ * AWS: DMS Microsoft SQL Server endpoint forceLobLookup setting for LOB data handling configuration
1933
+ *
1934
+ * Validation: Must be boolean value if provided; affects LOB data migration behavior and completeness
1935
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-forceloblookup
1936
+ */
1937
+ readonly forceLobLookup?: boolean;
1938
+ /**
1939
+ * Q-ENHANCED-PROPERTY
1940
+ * Optional TCP port number for SQL Server endpoint connectivity enabling custom port configuration for database connections. Defines the network port for SQL Server database connectivity allowing for non-standard port configurations and network security requirements.
1941
+ *
1942
+ * Use cases: Custom port configuration; Network security; SQL Server connectivity; Port management
1943
+ *
1944
+ * AWS: DMS Microsoft SQL Server endpoint port setting for database connectivity configuration
1945
+ *
1946
+ * Validation: Must be valid TCP port number if provided; enables custom SQL Server port connectivity
1947
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-port
1948
+ */
1949
+ readonly port?: number;
1950
+ /**
1951
+ * Q-ENHANCED-PROPERTY
1952
+ * Optional flag to query single Always On node in SQL Server Always On availability groups enabling optimized connectivity for high availability environments. Directs DMS to query only a single node in Always On availability groups for improved performance and reduced resource utilization in high availability SQL Server deployments.
1953
+ *
1954
+ * Use cases: Always On availability groups; High availability optimization; Performance tuning; Resource optimization
1955
+ *
1956
+ * AWS: DMS Microsoft SQL Server endpoint querySingleAlwaysOnNode setting for Always On optimization
1957
+ *
1958
+ * Validation: Must be boolean value if provided; optimizes connectivity for Always On availability groups
1959
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-querysinglealwaysonnode
1960
+ */
1961
+ readonly querySingleAlwaysOnNode?: boolean;
1962
+ /**
1963
+ * Q-ENHANCED-PROPERTY
1964
+ * Optional flag to read changes only from transaction log backups enabling controlled transaction log management in SQL Server migration. When enabled, DMS reads changes only from transaction log backups rather than active transaction logs, providing better control over log file growth and replication latency.
1965
+ *
1966
+ * Use cases: Transaction log management; Log file growth control; Replication latency control; Backup-based replication
1967
+ *
1968
+ * AWS: DMS Microsoft SQL Server endpoint readBackupOnly setting for transaction log management
1969
+ *
1970
+ * Validation: Must be boolean value if provided; affects transaction log reading behavior and log file growth
1971
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-readbackuponly
1972
+ */
1973
+ readonly readBackupOnly?: boolean;
1974
+ /**
1975
+ * Q-ENHANCED-PROPERTY
1976
+ * Optional safeguard policy for transaction log truncation prevention enabling controlled log management in SQL Server replication. Defines the method for preventing transaction log truncation with options for transaction-based or sp_repldone-based approaches for optimal log management and replication coordination.
1977
+ *
1978
+ * Use cases: Transaction log truncation prevention; Log management; Replication coordination; Parallel task management
1979
+ *
1980
+ * AWS: DMS Microsoft SQL Server endpoint safeguardPolicy setting for transaction log management
1981
+ *
1982
+ * Validation: Must be valid safeguard policy value if provided; controls transaction log truncation prevention method
1983
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-safeguardpolicy
1984
+ */
1985
+ readonly safeguardPolicy?: string;
1986
+ /**
1987
+ * Q-ENHANCED-PROPERTY
1988
+ * Optional IAM role ARN for DMS to access Secrets Manager secret containing SQL Server credentials enabling secure credential management. Defines the IAM role that DMS assumes to retrieve database credentials from Secrets Manager for SQL Server endpoint connectivity with role-based security.
1989
+ *
1990
+ * Use cases: Secure credential access; IAM role-based security; Secrets Manager integration; DMS authentication
1991
+ *
1992
+ * AWS: DMS Microsoft SQL Server endpoint secretsManagerAccessRoleArn setting for IAM role-based credential access
1993
+ *
1994
+ * Validation: Must be valid IAM role ARN if provided; role must have iam:PassRole and Secrets Manager access permissions
1995
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanageraccessrolearn
1996
+ */
1997
+ readonly secretsManagerAccessRoleArn?: string;
1998
+ /**
1999
+ * Q-ENHANCED-PROPERTY
2000
+ * Required Secrets Manager secret ARN containing SQL Server endpoint connection details enabling secure credential storage for database connectivity. Defines the AWS Secrets Manager secret that stores database connection credentials including username, password, and connection parameters for SQL Server endpoint access.
2001
+ *
2002
+ * Use cases: Secure credential storage; SQL Server connectivity; Database authentication; Secrets management
2003
+ *
2004
+ * AWS: DMS Microsoft SQL Server endpoint secretsManagerSecretId setting for Secrets Manager secret reference
2005
+ *
2006
+ * Validation: Must be valid Secrets Manager secret ARN; required; secret must contain valid SQL Server connection credentials
2007
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanagersecretid
2008
+ */
2009
+ readonly secretsManagerSecretArn: string;
2010
+ /**
2011
+ * Q-ENHANCED-PROPERTY
2012
+ * Optional KMS key ARN for encrypting Secrets Manager secret containing SQL Server credentials enabling enhanced security for database connection details. Defines the KMS key used to encrypt the Secrets Manager secret that stores SQL Server endpoint credentials for additional security layer.
2013
+ *
2014
+ * Use cases: Credential encryption; Enhanced security; KMS integration; Secrets Manager encryption
2015
+ *
2016
+ * AWS: DMS Microsoft SQL Server endpoint secretsManagerSecretKMSArn setting for KMS encryption of credentials
2017
+ *
2018
+ * Validation: Must be valid KMS key ARN if provided; enables encryption of Secrets Manager secret containing credentials
2019
+ */
2020
+ readonly secretsManagerSecretKMSArn?: string;
2021
+ /**
2022
+ * Q-ENHANCED-PROPERTY
2023
+ * Optional fully qualified domain name for SQL Server endpoint connectivity enabling precise server identification and network routing. Defines the complete server name including domain for SQL Server database connectivity, typically from RDS DescribeDBInstances endpoint address for managed instances.
2024
+ *
2025
+ * Use cases: Server identification; Network routing; SQL Server connectivity; RDS integration
2026
+ *
2027
+ * AWS: DMS Microsoft SQL Server endpoint serverName setting for database server identification
2028
+ *
2029
+ * Validation: Must be valid FQDN if provided; enables precise SQL Server server identification and connectivity
2030
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-servername
2031
+ */
2032
+ readonly serverName?: string;
2033
+ /**
2034
+ * Q-ENHANCED-PROPERTY
2035
+ * Optional transaction log access mode for CDC data fetching enabling optimized change data capture in SQL Server migration. Defines the method for accessing transaction log data for change data capture operations, affecting CDC performance and resource utilization in SQL Server replication.
2036
+ *
2037
+ * Use cases: CDC optimization; Transaction log access; Change data capture; Replication performance
2038
+ *
2039
+ * AWS: DMS Microsoft SQL Server endpoint tlogAccessMode setting for CDC data access configuration
2040
+ *
2041
+ * Validation: Must be valid transaction log access mode if provided; affects CDC data fetching behavior and performance
2042
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-tlogaccessmode
2043
+ */
2044
+ readonly tlogAccessMode?: string;
2045
+ /**
2046
+ * Q-ENHANCED-PROPERTY
2047
+ * Optional flag to right-trim spaces in CHAR and NCHAR data types during SQL Server migration enabling data formatting consistency. Controls whether DMS removes trailing spaces from CHAR and NCHAR columns during migration for consistent data formatting and storage optimization.
2048
+ *
2049
+ * Use cases: Data formatting consistency; Space trimming; Character data optimization; Migration data quality
2050
+ *
2051
+ * AWS: DMS Microsoft SQL Server endpoint trimSpaceInChar setting for character data formatting
2052
+ *
2053
+ * Validation: Must be boolean value if provided; default is true; affects character data formatting during migration
2054
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-trimspaceinchar
2055
+ */
2056
+ readonly trimSpaceInChar?: boolean;
2057
+ /**
2058
+ * Q-ENHANCED-PROPERTY
2059
+ * Optional flag to use BCP for full-load operations enabling optimized bulk data transfer in SQL Server migration. Controls whether DMS uses Bulk Copy Program (BCP) for full-load operations, providing high-performance data transfer but requiring consideration of identity columns and table structure compatibility.
2060
+ *
2061
+ * Use cases: Bulk data transfer optimization; Full-load performance; SQL Server migration optimization; High-volume data transfer
2062
+ *
2063
+ * AWS: DMS Microsoft SQL Server endpoint useBcpFullLoad setting for bulk copy optimization
2064
+ *
2065
+ * Validation: Must be boolean value if provided; affects full-load performance and identity column handling
2066
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usebcpfullload
2067
+ */
2068
+ readonly useBcpFullLoad?: boolean;
2069
+ /**
2070
+ * Q-ENHANCED-PROPERTY
2071
+ * Optional boolean flag to enable processing of third-party transaction log backups for SQL Server DMS migration enabling backup-based replication. Controls whether DMS will process third-party transaction log backups created in native format for SQL Server migration scenarios, providing flexibility for backup-based data migration strategies.
2072
+ *
2073
+ * Use cases: Third-party backup processing; Backup-based migration; Transaction log processing; SQL Server migration; Native backup integration
2074
+ *
2075
+ * AWS: AWS DMS SQL Server third-party backup device processing for backup-based migration and transaction log handling
2076
+ *
2077
+ * Validation: Must be boolean value if provided; optional for third-party backup processing control
2078
+ **/
2079
+ readonly useThirdPartyBackupDevice?: boolean;
2080
+ }
2081
+ /**
2082
+ * Provides information that defines a GCP MySQL endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
2083
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
2084
+ * @struct
2085
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html
2086
+ */
2087
+ export interface GcpMySQLSettingsProperty {
2088
+ /**
2089
+ * Specifies a script to run immediately after AWS DMS connects to the endpoint.
2090
+ * The migration task continues running regardless if the SQL statement succeeds or fails.
2091
+ * For this parameter, provide the code of the script itself, not the name of a file containing the script.
2092
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-afterconnectscript
2093
+ */
2094
+ readonly afterConnectScript?: string;
2095
+ /**
2096
+ * Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.
2097
+ * If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to `false` .
2098
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-cleansourcemetadataonmismatch
2099
+ */
2100
+ readonly cleanSourceMetadataOnMismatch?: boolean;
2101
+ /**
2102
+ * Database name for the endpoint.
2103
+ * For a MySQL source or target endpoint, don't explicitly specify the database using the `DatabaseName` request parameter on either the `CreateEndpoint` or `ModifyEndpoint` API call. Specifying `DatabaseName` when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task.
2104
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-databasename
2105
+ */
2106
+ readonly databaseName?: string;
2107
+ /**
2108
+ * Specifies how often to check the binary log for new changes/events when the database is idle.
2109
+ * The default is five seconds.
2110
+ * Example: `eventsPollInterval=5;`
2111
+ * In the example, AWS DMS checks for changes in the binary logs every five seconds.
2112
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-eventspollinterval
2113
+ */
2114
+ readonly eventsPollInterval?: number;
2115
+ /**
2116
+ * Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
2117
+ * Example: `maxFileSize=512`
2118
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-maxfilesize
2119
+ */
2120
+ readonly maxFileSize?: number;
2121
+ /**
2122
+ * Improves performance when loading data into the MySQL-compatible target database.
2123
+ * Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.
2124
+ * Example: `parallelLoadThreads=1`
2125
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-parallelloadthreads
2126
+ */
2127
+ readonly parallelLoadThreads?: number;
2128
+ /**
2129
+ * The port used by the endpoint database.
2130
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-port
2131
+ */
2132
+ readonly port?: number;
2133
+ /**
2134
+ * The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
2135
+ * > You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId` . Or you can specify clear-text values for `UserName` , `Password` , `ServerName` , and `Port` . You can't specify both.
2136
+ * >
2137
+ * > For more information on creating this `SecretsManagerSecret` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide* .
2138
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-secretsmanageraccessrolearn
2139
+ */
2140
+ readonly secretsManagerAccessRoleArn?: string;
2141
+ /**
2142
+ * The full ARN of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
2143
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-secretsmanagersecretid
2144
+ */
2145
+ readonly secretsManagerSecretArn: string;
2146
+ /**
2147
+ * The ID of the KMS key used to encrypt the credentials secret.
2148
+ */
2149
+ readonly secretsManagerSecretKMSArn?: string;
2150
+ /**
2151
+ * Endpoint TCP port.
2152
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-servername
2153
+ */
2154
+ readonly serverName?: string;
2155
+ /**
2156
+ * Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
2157
+ * Example: `serverTimezone=US/Pacific;`
2158
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-servertimezone
2159
+ */
2160
+ readonly serverTimezone?: string;
2161
+ }
2162
+ /**
2163
+ * Provides information that defines a PostgreSQL endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.
2164
+ * This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Extra connection attributes when using PostgreSQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) and [Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
2165
+ * @struct
2166
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html
2167
+ */
2168
+ /**
2169
+ * Q-ENHANCED-INTERFACE
2170
+ * PostgreSQL settings configuration interface for DMS providing PostgreSQL migration and open-source database capabilities. Defines PostgreSQL-specific properties for Database Migration Service including advanced PostgreSQL features, replication settings, and PostgreSQL integration for open-source database migration workflows.
2171
+ *
2172
+ * Use cases: PostgreSQL migration; Open-source database migration; PostgreSQL connectivity; Advanced PostgreSQL features; Database replication; DMS PostgreSQL integration
2173
+ *
2174
+ * AWS: AWS DMS PostgreSQL endpoint configuration with PostgreSQL migration and open-source database capabilities
2175
+ *
2176
+ * Validation: Configuration must be valid for DMS migration; properties must conform to AWS DMS and database-specific requirements
2177
+ */
2178
+ export interface PostgreSqlSettingsProperty {
2179
+ /**
2180
+ * Q-ENHANCED-PROPERTY
2181
+ * Optional SQL script executed after connecting to PostgreSQL source for change data capture (CDC) optimization enabling performance tuning and constraint bypassing. Provides custom SQL commands that run immediately after DMS connects to the PostgreSQL database, commonly used to bypass foreign keys and triggers during bulk loading for improved migration performance.
2182
+ *
2183
+ * Use cases: CDC performance optimization; Constraint bypassing; Custom connection setup; Migration performance tuning; Bulk load optimization
2184
+ *
2185
+ * AWS: AWS DMS PostgreSQL after-connect script for CDC optimization and custom connection configuration
2186
+ *
2187
+ * Validation: Must be valid SQL script if provided; commonly used for session configuration; optional for connection customization
2188
+ **/
2189
+ readonly afterConnectScript?: string;
2190
+ /**
2191
+ * Q-ENHANCED-PROPERTY
2192
+ * Optional Babelfish for Aurora PostgreSQL database name for DMS endpoint configuration enabling SQL Server compatibility layer access. Specifies the database name when using Babelfish for Aurora PostgreSQL, which provides SQL Server compatibility on top of PostgreSQL for cross-database migration scenarios.
2193
+ *
2194
+ * Use cases: Babelfish database access; SQL Server compatibility; Aurora PostgreSQL with Babelfish; Cross-database migration; SQL Server to PostgreSQL migration
2195
+ *
2196
+ * AWS: AWS DMS Babelfish for Aurora PostgreSQL database name for SQL Server compatibility layer access
2197
+ *
2198
+ * Validation: Must be valid database name if provided; used with Babelfish-enabled Aurora PostgreSQL; optional for Babelfish configuration
2199
+ **/
2200
+ readonly babelfishDatabaseName?: string;
2201
+ /**
2202
+ * Q-ENHANCED-PROPERTY
2203
+ * Optional boolean flag to enable DDL event capture for PostgreSQL DMS migration enabling schema change tracking and replication. Controls whether DMS will capture DDL events by creating artifacts in the PostgreSQL database, allowing schema changes to be tracked and replicated during migration operations.
2204
+ *
2205
+ * Use cases: DDL event capture; Schema change tracking; DDL replication; Database schema migration; Change data capture
2206
+ *
2207
+ * AWS: AWS DMS PostgreSQL DDL capture for schema change tracking and DDL event replication
2208
+ *
2209
+ * Validation: Must be boolean value if provided; optional for DDL capture control
2210
+ **/
2211
+ readonly captureDdls?: boolean;
2212
+ /**
2213
+ * Q-ENHANCED-PROPERTY
2214
+ * Optional database mode specification for PostgreSQL-compatible endpoints requiring additional configuration enabling specialized endpoint handling. Defines the default behavior for handling PostgreSQL-compatible endpoints such as Babelfish endpoints that require specific configuration and compatibility settings.
2215
+ *
2216
+ * Use cases: PostgreSQL-compatible endpoint handling; Babelfish endpoint configuration; Specialized database modes; Endpoint compatibility; Database-specific settings
2217
+ *
2218
+ * AWS: AWS DMS PostgreSQL database mode for PostgreSQL-compatible endpoint handling and specialized configuration
2219
+ *
2220
+ * Validation: Must be valid database mode string if provided; optional for specialized endpoint configuration
2221
+ **/
2222
+ readonly databaseMode?: string;
2223
+ /**
2224
+ * The schema in which the operational DDL database artifacts are created.
2225
+ * Example: `ddlArtifactsSchema=xyzddlschema;`
2226
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema
2227
+ */
2228
+ readonly ddlArtifactsSchema?: string;
2229
+ /**
2230
+ * Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
2231
+ * Example: `executeTimeout=100;`
2232
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout
2233
+ */
2234
+ readonly executeTimeout?: number;
2235
+ /**
2236
+ * When set to `true` , this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize` .
2237
+ * If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
2238
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation
2239
+ */
2240
+ readonly failTasksOnLobTruncation?: boolean;
2241
+ /**
2242
+ * Q-ENHANCED-PROPERTY
2243
+ * Optional boolean flag to enable WAL heartbeat feature for PostgreSQL DMS migration preventing storage full scenarios and maintaining replication slot health. Enables write-ahead log heartbeat that mimics dummy transactions to keep restart_lsn moving and prevent idle logical replication slots from holding old WAL logs.
2244
+ *
2245
+ * Use cases: WAL heartbeat management; Storage full prevention; Replication slot maintenance; Logical replication optimization; WAL log management
2246
+ *
2247
+ * AWS: AWS DMS PostgreSQL WAL heartbeat for replication slot maintenance and storage optimization
2248
+ *
2249
+ * Validation: Must be boolean value if provided; optional for WAL heartbeat control
2250
+ **/
2251
+ readonly heartbeatEnable?: boolean;
2252
+ /**
2253
+ * Q-ENHANCED-PROPERTY
2254
+ * Optional WAL heartbeat frequency in minutes for PostgreSQL DMS migration enabling configurable heartbeat timing and replication optimization. Defines how frequently the WAL heartbeat feature will execute dummy transactions to maintain replication slot health and prevent storage issues.
2255
+ *
2256
+ * Use cases: Heartbeat frequency control; Replication optimization; WAL management timing; Storage optimization; Performance tuning
2257
+ *
2258
+ * AWS: AWS DMS PostgreSQL WAL heartbeat frequency for configurable replication slot maintenance timing
2259
+ *
2260
+ * Validation: Must be positive number in minutes if provided; optional for heartbeat frequency control
2261
+ **/
2262
+ readonly heartbeatFrequency?: number;
2263
+ /**
2264
+ * Sets the schema in which the heartbeat artifacts are created.
2265
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema
2266
+ */
2267
+ readonly heartbeatSchema?: string;
2268
+ /**
2269
+ * When true, lets PostgreSQL migrate the boolean type as boolean.
2270
+ * By default, PostgreSQL migrates booleans as `varchar(5)` . You must set this setting on both the source and target endpoints for it to take effect.
2271
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean
2272
+ */
2273
+ readonly mapBooleanAsBoolean?: boolean;
2274
+ /**
2275
+ * Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
2276
+ * Example: `maxFileSize=512`
2277
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize
2278
+ */
2279
+ readonly maxFileSize?: number;
2280
+ /**
2281
+ * Specifies the plugin to use to create a replication slot.
2282
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname
2283
+ */
2284
+ readonly pluginName?: string;
2285
+ /**
2286
+ * The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
2287
+ * The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
2288
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanageraccessrolearn
2289
+ */
2290
+ readonly secretsManagerAccessRoleArn?: string;
2291
+ /**
2292
+ * The full ARN of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details.
2293
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanagersecretid
2294
+ */
2295
+ readonly secretsManagerSecretArn: string;
2296
+ /**
2297
+ * The ID of the KMS key used to encrypt the credentials secret.
2298
+ */
2299
+ readonly secretsManagerSecretKMSArn?: string;
2300
+ /**
2301
+ * Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
2302
+ * When used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of `CdcStartPosition` . If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error.
2303
+ * For more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the *AWS Database Migration Service User Guide* . For more information about using `CdcStartPosition` , see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) , [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) , and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) .
2304
+ * See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname
2305
+ */
2306
+ readonly slotName?: string;
2307
+ }
2308
+ export type MdaaEndpointType = 'source' | 'target';
2309
+ export type MdaaEndpointEngine = `mysql` | `oracle` | `postgres` | `mariadb` | `aurora` | `aurora-postgresql` | `opensearch` | `redshift` | `redshift-serverless` | `s3` | `db2` | `azuredb` | `sybase` | `dynamodb` | `mongodb` | `kinesis` | `kafka` | `elasticsearch` | `docdb` | `sqlserver` | `neptune`;
2310
+ export interface MdaaEndpointProps extends MdaaConstructProps {
2311
+ readonly certificateArn?: string;
2312
+ /**
2313
+ * Q-ENHANCED-PROPERTY
2314
+ * Optional database name specification for endpoint connectivity controlling target database selection and migration scope. Defines the specific database within the database server for migration operations and data transfer targeting.
2315
+ *
2316
+ * Use cases: Database targeting; Migration scope; Specific database selection; Data transfer control
2317
+ *
2318
+ * AWS: Database name for DMS endpoint connectivity and migration targeting
2319
+ *
2320
+ * Validation: Must be valid database name if provided; not applicable for MySQL endpoints
2321
+ **/
2322
+ readonly databaseName?: string;
2323
+ readonly endpointIdentifier: string;
2324
+ /**
2325
+ * Q-ENHANCED-PROPERTY
2326
+ * Required endpoint type specification controlling migration direction and data flow for source or target configuration. Defines whether the endpoint serves as a data source or target destination for migration operations and data transfer direction.
2327
+ *
2328
+ * Use cases: Migration direction; Data flow control; Source/target specification; Migration architecture
2329
+ *
2330
+ * AWS: DMS endpoint type for migration direction and data flow configuration
2331
+ *
2332
+ * Validation: Must be 'source' or 'target'; required for endpoint role and migration direction specification
2333
+ * **/
2334
+ readonly endpointType: MdaaEndpointType;
2335
+ /**
2336
+ * Q-ENHANCED-PROPERTY
2337
+ * Required database engine specification controlling database type and connectivity protocols for endpoint configuration. Defines the specific database engine type for appropriate connectivity, protocol selection, and database-specific optimization.
2338
+ *
2339
+ * Use cases: Database engine specification; Connectivity protocols; Engine-specific optimization; Database compatibility
2340
+ *
2341
+ * AWS: DMS endpoint engine name for database type specification and connectivity configuration
2342
+ *
2343
+ * Validation: Must be valid engine name (mysql, oracle, postgres, etc.); required for database connectivity
2344
+ * **/
2345
+ readonly engineName: MdaaEndpointEngine;
2346
+ readonly extraConnectionAttributes?: string;
2347
+ readonly kmsKey: IKey;
2348
+ /**
2349
+ * Q-ENHANCED-PROPERTY
2350
+ * Optional database port specification for endpoint connectivity controlling network connection parameters and database access. Defines the network port for database connectivity enabling proper network routing and database server access.
2351
+ *
2352
+ * Use cases: Network connectivity; Port specification; Database access; Network routing
2353
+ *
2354
+ * AWS: Database port for DMS endpoint network connectivity and database server access
2355
+ *
2356
+ * Validation: Must be valid port number if provided; enables proper network connectivity to database server
2357
+ **/
2358
+ readonly port?: number;
2359
+ readonly resourceIdentifier?: string;
2360
+ /**
2361
+ * Q-ENHANCED-PROPERTY
2362
+ * Optional server name specification for database server connectivity enabling network-based database access and server identification. Defines the hostname or IP address of the database server for network connectivity and database access.
2363
+ *
2364
+ * Use cases: Server connectivity; Network access; Database server identification; Hostname specification
2365
+ *
2366
+ * AWS: Database server name for DMS endpoint network connectivity and server access
2367
+ *
2368
+ * Validation: Must be valid hostname or IP address if provided; enables network connectivity to database server
2369
+ **/
2370
+ readonly serverName?: string;
2371
+ readonly sslMode?: string;
2372
+ /**
2373
+ * Q-ENHANCED-PROPERTY
2374
+ * Optional DocumentDB settings for DocumentDB endpoint configuration enabling NoSQL document database connectivity and optimization. Provides DocumentDB-specific configuration for document database migration and connectivity optimization.
2375
+ *
2376
+ * Use cases: DocumentDB connectivity; NoSQL migration; Document database optimization; MongoDB compatibility
2377
+ *
2378
+ * AWS: DocumentDB settings for DMS endpoint NoSQL document database connectivity and optimization
2379
+ *
2380
+ * Validation: Must be valid DocDbSettingsProperty if provided; enables DocumentDB-specific connectivity
2381
+ * **/
2382
+ readonly docDbSettings?: DocDbSettingsProperty;
2383
+ /**
2384
+ * Q-ENHANCED-PROPERTY
2385
+ * Optional DynamoDB settings for DynamoDB endpoint configuration enabling NoSQL key-value database connectivity and object mapping. Provides DynamoDB-specific configuration for NoSQL migration and object mapping optimization.
2386
+ *
2387
+ * Use cases: DynamoDB connectivity; NoSQL migration; Object mapping; Key-value database optimization
2388
+ *
2389
+ * AWS: DynamoDB settings for DMS endpoint NoSQL key-value database connectivity and object mapping
2390
+ *
2391
+ * Validation: Must be valid DynamoDbSettingsProperty if provided; enables DynamoDB-specific connectivity
2392
+ * **/
2393
+ readonly dynamoDbSettings?: DynamoDbSettingsProperty;
2394
+ /**
2395
+ * Q-ENHANCED-PROPERTY
2396
+ * Optional Elasticsearch settings for OpenSearch endpoint configuration enabling search engine connectivity and document indexing. Provides OpenSearch/Elasticsearch-specific configuration for search engine migration and document indexing optimization.
2397
+ *
2398
+ * Use cases: Search engine connectivity; Document indexing; OpenSearch migration; Search optimization
2399
+ *
2400
+ * AWS: OpenSearch/Elasticsearch settings for DMS endpoint search engine connectivity and indexing
2401
+ *
2402
+ * Validation: Must be valid ElasticsearchSettingsProperty if provided; enables search engine connectivity
2403
+ * **/
2404
+ readonly elasticsearchSettings?: ElasticsearchSettingsProperty;
2405
+ /**
2406
+ * Q-ENHANCED-PROPERTY
2407
+ * Optional IBM Db2 settings for Db2 LUW endpoint configuration enabling mainframe database connectivity and optimization. Provides IBM Db2-specific configuration for mainframe database migration and connectivity optimization.
2408
+ *
2409
+ * Use cases: IBM Db2 connectivity; Mainframe migration; Enterprise database optimization; Legacy system integration
2410
+ *
2411
+ * AWS: IBM Db2 settings for DMS endpoint mainframe database connectivity and optimization
2412
+ *
2413
+ * Validation: Must be valid IbmDb2SettingsProperty if provided; enables IBM Db2-specific connectivity
2414
+ * **/
2415
+ readonly ibmDb2Settings?: IbmDb2SettingsProperty;
2416
+ /**
2417
+ * Q-ENHANCED-PROPERTY
2418
+ * Optional Kinesis settings for Kinesis Data Streams endpoint configuration enabling real-time streaming and object mapping. Provides Kinesis-specific configuration for real-time data streaming and object mapping optimization.
2419
+ *
2420
+ * Use cases: Real-time streaming; Data streams; Object mapping; Stream processing
2421
+ *
2422
+ * AWS: Kinesis Data Streams settings for DMS endpoint real-time streaming and object mapping
2423
+ *
2424
+ * Validation: Must be valid KinesisSettingsProperty if provided; enables Kinesis streaming connectivity
2425
+ * **/
2426
+ readonly kinesisSettings?: KinesisSettingsProperty;
2427
+ /**
2428
+ * Q-ENHANCED-PROPERTY
2429
+ * Optional Microsoft SQL Server settings for SQL Server endpoint configuration enabling enterprise database connectivity and optimization. Provides SQL Server-specific configuration for enterprise database migration and connectivity optimization.
2430
+ *
2431
+ * Use cases: SQL Server connectivity; Enterprise migration; Windows database optimization; Microsoft ecosystem integration
2432
+ *
2433
+ * AWS: Microsoft SQL Server settings for DMS endpoint enterprise database connectivity and optimization
2434
+ *
2435
+ * Validation: Must be valid MicrosoftSqlServerSettingsProperty if provided; enables SQL Server connectivity
2436
+ * **/
2437
+ readonly microsoftSqlServerSettings?: MicrosoftSqlServerSettingsProperty;
2438
+ /**
2439
+ * Q-ENHANCED-PROPERTY
2440
+ * Optional MongoDB settings for MongoDB endpoint configuration enabling NoSQL document database connectivity and optimization. Provides MongoDB-specific configuration for document database migration and connectivity optimization.
2441
+ *
2442
+ * Use cases: MongoDB connectivity; Document database migration; NoSQL optimization; Document store integration
2443
+ *
2444
+ * AWS: MongoDB settings for DMS endpoint NoSQL document database connectivity and optimization
2445
+ *
2446
+ * Validation: Must be valid MongoDbSettingsProperty if provided; enables MongoDB-specific connectivity
2447
+ * **/
2448
+ readonly mongoDbSettings?: MongoDbSettingsProperty;
2449
+ /**
2450
+ * Q-ENHANCED-PROPERTY
2451
+ * Optional MySQL settings for MySQL endpoint configuration enabling relational database connectivity and optimization. Provides MySQL-specific configuration for relational database migration and connectivity optimization.
2452
+ *
2453
+ * Use cases: MySQL connectivity; Relational migration; Open-source database optimization; Web application integration
2454
+ *
2455
+ * AWS: MySQL settings for DMS endpoint relational database connectivity and optimization
2456
+ *
2457
+ * Validation: Must be valid MySqlSettingsProperty if provided; enables MySQL-specific connectivity
2458
+ * **/
2459
+ readonly mySqlSettings?: MySqlSettingsProperty;
2460
+ /**
2461
+ * Q-ENHANCED-PROPERTY
2462
+ * Optional Neptune settings for Neptune endpoint configuration enabling graph database connectivity and optimization. Provides Neptune-specific configuration for graph database migration and connectivity optimization.
2463
+ *
2464
+ * Use cases: Graph database connectivity; Neptune migration; Graph data optimization; Relationship data processing
2465
+ *
2466
+ * AWS: Amazon Neptune settings for DMS endpoint graph database connectivity and optimization
2467
+ *
2468
+ * Validation: Must be valid NeptuneSettingsProperty if provided; enables Neptune-specific connectivity
2469
+ * **/
2470
+ readonly neptuneSettings?: NeptuneSettingsProperty;
2471
+ /**
2472
+ * Q-ENHANCED-PROPERTY
2473
+ * Optional Oracle settings for Oracle endpoint configuration enabling enterprise database connectivity and optimization. Provides Oracle-specific configuration for enterprise database migration and connectivity optimization.
2474
+ *
2475
+ * Use cases: Oracle connectivity; Enterprise migration; Commercial database optimization; Oracle ecosystem integration
2476
+ *
2477
+ * AWS: Oracle Database settings for DMS endpoint enterprise database connectivity and optimization
2478
+ *
2479
+ * Validation: Must be valid OracleSettingsProperty if provided; enables Oracle-specific connectivity
2480
+ * **/
2481
+ readonly oracleSettings?: OracleSettingsProperty;
2482
+ /**
2483
+ * Q-ENHANCED-PROPERTY
2484
+ * Optional PostgreSQL settings for PostgreSQL endpoint configuration enabling open-source relational database connectivity and optimization. Provides PostgreSQL-specific configuration for relational database migration and connectivity optimization.
2485
+ *
2486
+ * Use cases: PostgreSQL connectivity; Open-source migration; Advanced relational features; Enterprise-grade database
2487
+ *
2488
+ * AWS: PostgreSQL settings for DMS endpoint relational database connectivity and optimization
2489
+ *
2490
+ * Validation: Must be valid PostgreSqlSettingsProperty if provided; enables PostgreSQL-specific connectivity
2491
+ * **/
2492
+ readonly postgreSqlSettings?: PostgreSqlSettingsProperty;
2493
+ /**
2494
+ * Q-ENHANCED-PROPERTY
2495
+ * Optional Redshift settings for Redshift endpoint configuration enabling data warehouse connectivity and optimization. Provides Redshift-specific configuration for data warehouse migration and analytics optimization.
2496
+ *
2497
+ * Use cases: Data warehouse connectivity; Analytics migration; Redshift optimization; Business intelligence integration
2498
+ *
2499
+ * AWS: Amazon Redshift settings for DMS endpoint data warehouse connectivity and analytics optimization
2500
+ *
2501
+ * Validation: Must be valid RedshiftSettingsProperty if provided; enables Redshift-specific connectivity
2502
+ * **/
2503
+ readonly redshiftSettings?: RedshiftSettingsProperty;
2504
+ /**
2505
+ * Q-ENHANCED-PROPERTY
2506
+ * Optional S3 settings for S3 endpoint configuration enabling object storage connectivity and file-based data transfer. Provides S3-specific configuration for object storage migration and file-based data transfer optimization.
2507
+ *
2508
+ * Use cases: Object storage connectivity; File-based migration; S3 optimization; Data lake integration
2509
+ *
2510
+ * AWS: Amazon S3 settings for DMS endpoint object storage connectivity and file-based data transfer
2511
+ *
2512
+ * Validation: Must be valid S3SettingsProperty if provided; enables S3-specific connectivity and file transfer
2513
+ * **/
2514
+ readonly s3Settings?: S3SettingsProperty;
2515
+ /**
2516
+ * Q-ENHANCED-PROPERTY
2517
+ * Optional Sybase settings for SAP ASE endpoint configuration enabling enterprise database connectivity and optimization. Provides Sybase/SAP ASE-specific configuration for enterprise database migration and connectivity optimization.
2518
+ *
2519
+ * Use cases: Sybase connectivity; SAP ASE migration; Enterprise database optimization; Legacy system integration
2520
+ *
2521
+ * AWS: Sybase/SAP ASE settings for DMS endpoint enterprise database connectivity and optimization
2522
+ *
2523
+ * Validation: Must be valid SybaseSettingsProperty if provided; enables Sybase/SAP ASE connectivity
2524
+ * **/
2525
+ readonly sybaseSettings?: SybaseSettingsProperty;
2526
+ }
2527
+ /**
2528
+ * Reusable CDK construct for a compliant DMS Endpoint.
2529
+ * Specifically, enforces KMS Encryption, and prevents use of plaintext credentials.
2530
+ */
2531
+ export declare class MdaaEndpoint extends CfnEndpoint {
2532
+ /** Overrides specific compliance-related properties. */
2533
+ private static setProps;
2534
+ private static setNeptuneSettings;
2535
+ private static setS3Settings;
2536
+ private static setRedshiftSettings;
2537
+ constructor(scope: Construct, id: string, props: MdaaEndpointProps);
2538
+ }