@aws-mdaa/dms-constructs 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +474 -679
- package/lib/endpoint.d.ts +168 -2022
- package/lib/endpoint.js +2 -2
- package/lib/replication_instance.d.ts +3 -30
- package/lib/replication_instance.js +2 -2
- package/package.json +13 -11
package/.jsii
CHANGED
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
"url": "https://aws.amazon.com/solutions"
|
|
8
8
|
},
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@aws-mdaa/construct": "1.
|
|
11
|
-
"@aws-mdaa/naming": "1.
|
|
10
|
+
"@aws-mdaa/construct": "1.5.0",
|
|
11
|
+
"@aws-mdaa/naming": "1.5.0",
|
|
12
12
|
"aws-cdk-lib": "2.220.0",
|
|
13
13
|
"cdk-nag": "2.37.55",
|
|
14
14
|
"constructs": "10.0.96"
|
|
@@ -4198,29 +4198,28 @@
|
|
|
4198
4198
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
4199
4199
|
"datatype": true,
|
|
4200
4200
|
"docs": {
|
|
4201
|
-
"remarks": "
|
|
4201
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
4202
4202
|
"stability": "experimental",
|
|
4203
|
-
"summary": "
|
|
4203
|
+
"summary": "Provides information that defines a DocumentDB endpoint."
|
|
4204
4204
|
},
|
|
4205
4205
|
"fqn": "@aws-mdaa/dms-constructs.DocDbSettingsProperty",
|
|
4206
4206
|
"kind": "interface",
|
|
4207
4207
|
"locationInModule": {
|
|
4208
4208
|
"filename": "lib/endpoint.ts",
|
|
4209
|
-
"line":
|
|
4209
|
+
"line": 413
|
|
4210
4210
|
},
|
|
4211
4211
|
"name": "DocDbSettingsProperty",
|
|
4212
4212
|
"properties": [
|
|
4213
4213
|
{
|
|
4214
4214
|
"abstract": true,
|
|
4215
4215
|
"docs": {
|
|
4216
|
-
"remarks": "Defines the AWS Secrets Manager secret that stores database connection credentials including username, password, and connection parameters for DocumentDB endpoint access.\n\nUse cases: Secure credential storage; DocumentDB connectivity; Database authentication; Secrets management\n\nAWS: DMS DocumentDB endpoint secretsManagerSecretId setting for Secrets Manager secret reference\n\nValidation: Must be valid Secrets Manager secret ARN; required; secret must contain valid DocumentDB connection credentials\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanagersecretid",
|
|
4217
4216
|
"stability": "experimental",
|
|
4218
|
-
"summary": "
|
|
4217
|
+
"summary": "Secrets Manager secret ARN containing DocumentDB endpoint connection details enabling."
|
|
4219
4218
|
},
|
|
4220
4219
|
"immutable": true,
|
|
4221
4220
|
"locationInModule": {
|
|
4222
4221
|
"filename": "lib/endpoint.ts",
|
|
4223
|
-
"line":
|
|
4222
|
+
"line": 421
|
|
4224
4223
|
},
|
|
4225
4224
|
"name": "secretsManagerSecretArn",
|
|
4226
4225
|
"type": {
|
|
@@ -4230,14 +4229,13 @@
|
|
|
4230
4229
|
{
|
|
4231
4230
|
"abstract": true,
|
|
4232
4231
|
"docs": {
|
|
4233
|
-
"remarks": "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.\n\nUse cases: Document schema inference; Migration planning; Table mode configuration; Document organization analysis\n\nAWS: DMS DocumentDB endpoint docsToInvestigate setting for document sampling and schema analysis\n\nValidation: Must be positive integer greater than 0 if provided; default is 1000; used for document organization analysis\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-docstoinvestigate",
|
|
4234
4232
|
"stability": "experimental",
|
|
4235
|
-
"summary": "
|
|
4233
|
+
"summary": "Number of documents to preview for determining document organization and schema inference."
|
|
4236
4234
|
},
|
|
4237
4235
|
"immutable": true,
|
|
4238
4236
|
"locationInModule": {
|
|
4239
4237
|
"filename": "lib/endpoint.ts",
|
|
4240
|
-
"line":
|
|
4238
|
+
"line": 415
|
|
4241
4239
|
},
|
|
4242
4240
|
"name": "docsToInvestigate",
|
|
4243
4241
|
"optional": true,
|
|
@@ -4248,14 +4246,12 @@
|
|
|
4248
4246
|
{
|
|
4249
4247
|
"abstract": true,
|
|
4250
4248
|
"docs": {
|
|
4251
|
-
"
|
|
4252
|
-
"stability": "experimental",
|
|
4253
|
-
"summary": "Q-ENHANCED-PROPERTY Optional flag to extract document ID during DocumentDB migration enabling document identification and tracking."
|
|
4249
|
+
"stability": "experimental"
|
|
4254
4250
|
},
|
|
4255
4251
|
"immutable": true,
|
|
4256
4252
|
"locationInModule": {
|
|
4257
4253
|
"filename": "lib/endpoint.ts",
|
|
4258
|
-
"line":
|
|
4254
|
+
"line": 416
|
|
4259
4255
|
},
|
|
4260
4256
|
"name": "extractDocId",
|
|
4261
4257
|
"optional": true,
|
|
@@ -4266,14 +4262,13 @@
|
|
|
4266
4262
|
{
|
|
4267
4263
|
"abstract": true,
|
|
4268
4264
|
"docs": {
|
|
4269
|
-
"remarks": "Defines the migration approach with \"none\" for document mode preserving document structure or \"one\" for table mode flattening documents into relational format.\n\nUse cases: Migration mode selection; Document structure preservation; Table mode flattening; Migration strategy configuration\n\nAWS: DMS DocumentDB endpoint nestingLevel setting for migration mode configuration\n\nValidation: Must be \"none\" or \"one\" if provided; default is \"none\"; determines document vs table migration mode\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-nestinglevel",
|
|
4270
4265
|
"stability": "experimental",
|
|
4271
|
-
"summary": "
|
|
4266
|
+
"summary": "Nesting level specification for DocumentDB migration mode selection enabling document or table mode migration."
|
|
4272
4267
|
},
|
|
4273
4268
|
"immutable": true,
|
|
4274
4269
|
"locationInModule": {
|
|
4275
4270
|
"filename": "lib/endpoint.ts",
|
|
4276
|
-
"line":
|
|
4271
|
+
"line": 418
|
|
4277
4272
|
},
|
|
4278
4273
|
"name": "nestingLevel",
|
|
4279
4274
|
"optional": true,
|
|
@@ -4284,14 +4279,12 @@
|
|
|
4284
4279
|
{
|
|
4285
4280
|
"abstract": true,
|
|
4286
4281
|
"docs": {
|
|
4287
|
-
"
|
|
4288
|
-
"stability": "experimental",
|
|
4289
|
-
"summary": "Q-ENHANCED-PROPERTY Optional IAM role ARN for DMS to access Secrets Manager secret containing DocumentDB credentials enabling secure credential management."
|
|
4282
|
+
"stability": "experimental"
|
|
4290
4283
|
},
|
|
4291
4284
|
"immutable": true,
|
|
4292
4285
|
"locationInModule": {
|
|
4293
4286
|
"filename": "lib/endpoint.ts",
|
|
4294
|
-
"line":
|
|
4287
|
+
"line": 419
|
|
4295
4288
|
},
|
|
4296
4289
|
"name": "secretsManagerAccessRoleArn",
|
|
4297
4290
|
"optional": true,
|
|
@@ -4302,14 +4295,12 @@
|
|
|
4302
4295
|
{
|
|
4303
4296
|
"abstract": true,
|
|
4304
4297
|
"docs": {
|
|
4305
|
-
"
|
|
4306
|
-
"stability": "experimental",
|
|
4307
|
-
"summary": "Q-ENHANCED-PROPERTY Optional KMS key ARN for encrypting Secrets Manager secret containing DocumentDB credentials enabling enhanced security for database connection details."
|
|
4298
|
+
"stability": "experimental"
|
|
4308
4299
|
},
|
|
4309
4300
|
"immutable": true,
|
|
4310
4301
|
"locationInModule": {
|
|
4311
4302
|
"filename": "lib/endpoint.ts",
|
|
4312
|
-
"line":
|
|
4303
|
+
"line": 422
|
|
4313
4304
|
},
|
|
4314
4305
|
"name": "secretsManagerSecretKMSArn",
|
|
4315
4306
|
"optional": true,
|
|
@@ -4324,29 +4315,28 @@
|
|
|
4324
4315
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
4325
4316
|
"datatype": true,
|
|
4326
4317
|
"docs": {
|
|
4327
|
-
"remarks": "
|
|
4318
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
4328
4319
|
"stability": "experimental",
|
|
4329
|
-
"summary": "
|
|
4320
|
+
"summary": "Provides information, including the Amazon Resource Name (ARN) of the IAM role used to define an Amazon DynamoDB target endpoint."
|
|
4330
4321
|
},
|
|
4331
4322
|
"fqn": "@aws-mdaa/dms-constructs.DynamoDbSettingsProperty",
|
|
4332
4323
|
"kind": "interface",
|
|
4333
4324
|
"locationInModule": {
|
|
4334
4325
|
"filename": "lib/endpoint.ts",
|
|
4335
|
-
"line":
|
|
4326
|
+
"line": 430
|
|
4336
4327
|
},
|
|
4337
4328
|
"name": "DynamoDbSettingsProperty",
|
|
4338
4329
|
"properties": [
|
|
4339
4330
|
{
|
|
4340
4331
|
"abstract": true,
|
|
4341
4332
|
"docs": {
|
|
4342
|
-
"remarks": "Defines the IAM role that DMS assumes to access DynamoDB tables with required permissions for data migration and NoSQL operations.\n\nUse cases: DynamoDB access control; DMS service authentication; IAM role-based security; NoSQL database permissions\n\nAWS: DMS DynamoDB endpoint serviceAccessRoleArn setting for IAM role-based authentication\n\nValidation: Must be valid IAM role ARN if provided; role must have iam:PassRole permission and DynamoDB access policies\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html#cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn",
|
|
4343
4333
|
"stability": "experimental",
|
|
4344
|
-
"summary": "
|
|
4334
|
+
"summary": "IAM service role ARN for DMS DynamoDB endpoint access enabling secure authentication and."
|
|
4345
4335
|
},
|
|
4346
4336
|
"immutable": true,
|
|
4347
4337
|
"locationInModule": {
|
|
4348
4338
|
"filename": "lib/endpoint.ts",
|
|
4349
|
-
"line":
|
|
4339
|
+
"line": 432
|
|
4350
4340
|
},
|
|
4351
4341
|
"name": "serviceAccessRoleArn",
|
|
4352
4342
|
"optional": true,
|
|
@@ -4361,29 +4351,28 @@
|
|
|
4361
4351
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
4362
4352
|
"datatype": true,
|
|
4363
4353
|
"docs": {
|
|
4364
|
-
"remarks": "
|
|
4354
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
4365
4355
|
"stability": "experimental",
|
|
4366
|
-
"summary": "
|
|
4356
|
+
"summary": "Provides information that defines an OpenSearch endpoint."
|
|
4367
4357
|
},
|
|
4368
4358
|
"fqn": "@aws-mdaa/dms-constructs.ElasticsearchSettingsProperty",
|
|
4369
4359
|
"kind": "interface",
|
|
4370
4360
|
"locationInModule": {
|
|
4371
4361
|
"filename": "lib/endpoint.ts",
|
|
4372
|
-
"line":
|
|
4362
|
+
"line": 399
|
|
4373
4363
|
},
|
|
4374
4364
|
"name": "ElasticsearchSettingsProperty",
|
|
4375
4365
|
"properties": [
|
|
4376
4366
|
{
|
|
4377
4367
|
"abstract": true,
|
|
4378
4368
|
"docs": {
|
|
4379
|
-
"remarks": "Defines the connection endpoint for OpenSearch cluster where DMS will migrate and index data from source databases for search and analytics capabilities.\n\nUse cases: Search engine migration; Data indexing; OpenSearch connectivity; Search data integration\n\nAWS: DMS Elasticsearch endpoint endpointUri setting for OpenSearch cluster connectivity\n\nValidation: Must be valid HTTPS URI if provided; DMS uses HTTPS by default for secure search engine connectivity\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-endpointuri",
|
|
4380
4369
|
"stability": "experimental",
|
|
4381
|
-
"summary": "
|
|
4370
|
+
"summary": "OpenSearch cluster endpoint URI for DMS target connectivity enabling search engine data migration and indexing."
|
|
4382
4371
|
},
|
|
4383
4372
|
"immutable": true,
|
|
4384
4373
|
"locationInModule": {
|
|
4385
4374
|
"filename": "lib/endpoint.ts",
|
|
4386
|
-
"line":
|
|
4375
|
+
"line": 401
|
|
4387
4376
|
},
|
|
4388
4377
|
"name": "endpointUri",
|
|
4389
4378
|
"optional": true,
|
|
@@ -4394,14 +4383,12 @@
|
|
|
4394
4383
|
{
|
|
4395
4384
|
"abstract": true,
|
|
4396
4385
|
"docs": {
|
|
4397
|
-
"
|
|
4398
|
-
"stability": "experimental",
|
|
4399
|
-
"summary": "Q-ENHANCED-PROPERTY Optional maximum retry duration in seconds for failed DMS API requests to OpenSearch cluster enabling resilient search data migration."
|
|
4386
|
+
"stability": "experimental"
|
|
4400
4387
|
},
|
|
4401
4388
|
"immutable": true,
|
|
4402
4389
|
"locationInModule": {
|
|
4403
4390
|
"filename": "lib/endpoint.ts",
|
|
4404
|
-
"line":
|
|
4391
|
+
"line": 402
|
|
4405
4392
|
},
|
|
4406
4393
|
"name": "errorRetryDuration",
|
|
4407
4394
|
"optional": true,
|
|
@@ -4412,14 +4399,13 @@
|
|
|
4412
4399
|
{
|
|
4413
4400
|
"abstract": true,
|
|
4414
4401
|
"docs": {
|
|
4415
|
-
"remarks": "Defines the failure threshold for record writes to OpenSearch before DMS stops the full load operation to prevent data quality issues in search indexes.\n\nUse cases: Data quality control; Migration failure thresholds; Search index quality; Load operation control\n\nAWS: DMS Elasticsearch endpoint fullLoadErrorPercentage setting for data quality control\n\nValidation: Must be percentage value between 0-100 if provided; controls failure threshold for full load operations\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage",
|
|
4416
4402
|
"stability": "experimental",
|
|
4417
|
-
"summary": "
|
|
4403
|
+
"summary": "Maximum percentage of failed records before stopping full load operation enabling."
|
|
4418
4404
|
},
|
|
4419
4405
|
"immutable": true,
|
|
4420
4406
|
"locationInModule": {
|
|
4421
4407
|
"filename": "lib/endpoint.ts",
|
|
4422
|
-
"line":
|
|
4408
|
+
"line": 404
|
|
4423
4409
|
},
|
|
4424
4410
|
"name": "fullLoadErrorPercentage",
|
|
4425
4411
|
"optional": true,
|
|
@@ -4430,14 +4416,12 @@
|
|
|
4430
4416
|
{
|
|
4431
4417
|
"abstract": true,
|
|
4432
4418
|
"docs": {
|
|
4433
|
-
"
|
|
4434
|
-
"stability": "experimental",
|
|
4435
|
-
"summary": "Q-ENHANCED-PROPERTY Optional IAM service role ARN for DMS OpenSearch endpoint access enabling secure authentication and authorization for search engine operations."
|
|
4419
|
+
"stability": "experimental"
|
|
4436
4420
|
},
|
|
4437
4421
|
"immutable": true,
|
|
4438
4422
|
"locationInModule": {
|
|
4439
4423
|
"filename": "lib/endpoint.ts",
|
|
4440
|
-
"line":
|
|
4424
|
+
"line": 405
|
|
4441
4425
|
},
|
|
4442
4426
|
"name": "serviceAccessRoleArn",
|
|
4443
4427
|
"optional": true,
|
|
@@ -4460,7 +4444,7 @@
|
|
|
4460
4444
|
"kind": "interface",
|
|
4461
4445
|
"locationInModule": {
|
|
4462
4446
|
"filename": "lib/endpoint.ts",
|
|
4463
|
-
"line":
|
|
4447
|
+
"line": 473
|
|
4464
4448
|
},
|
|
4465
4449
|
"name": "GcpMySQLSettingsProperty",
|
|
4466
4450
|
"properties": [
|
|
@@ -4474,7 +4458,7 @@
|
|
|
4474
4458
|
"immutable": true,
|
|
4475
4459
|
"locationInModule": {
|
|
4476
4460
|
"filename": "lib/endpoint.ts",
|
|
4477
|
-
"line":
|
|
4461
|
+
"line": 531
|
|
4478
4462
|
},
|
|
4479
4463
|
"name": "secretsManagerSecretArn",
|
|
4480
4464
|
"type": {
|
|
@@ -4491,7 +4475,7 @@
|
|
|
4491
4475
|
"immutable": true,
|
|
4492
4476
|
"locationInModule": {
|
|
4493
4477
|
"filename": "lib/endpoint.ts",
|
|
4494
|
-
"line":
|
|
4478
|
+
"line": 480
|
|
4495
4479
|
},
|
|
4496
4480
|
"name": "afterConnectScript",
|
|
4497
4481
|
"optional": true,
|
|
@@ -4509,7 +4493,7 @@
|
|
|
4509
4493
|
"immutable": true,
|
|
4510
4494
|
"locationInModule": {
|
|
4511
4495
|
"filename": "lib/endpoint.ts",
|
|
4512
|
-
"line":
|
|
4496
|
+
"line": 486
|
|
4513
4497
|
},
|
|
4514
4498
|
"name": "cleanSourceMetadataOnMismatch",
|
|
4515
4499
|
"optional": true,
|
|
@@ -4527,7 +4511,7 @@
|
|
|
4527
4511
|
"immutable": true,
|
|
4528
4512
|
"locationInModule": {
|
|
4529
4513
|
"filename": "lib/endpoint.ts",
|
|
4530
|
-
"line":
|
|
4514
|
+
"line": 492
|
|
4531
4515
|
},
|
|
4532
4516
|
"name": "databaseName",
|
|
4533
4517
|
"optional": true,
|
|
@@ -4545,7 +4529,7 @@
|
|
|
4545
4529
|
"immutable": true,
|
|
4546
4530
|
"locationInModule": {
|
|
4547
4531
|
"filename": "lib/endpoint.ts",
|
|
4548
|
-
"line":
|
|
4532
|
+
"line": 500
|
|
4549
4533
|
},
|
|
4550
4534
|
"name": "eventsPollInterval",
|
|
4551
4535
|
"optional": true,
|
|
@@ -4562,7 +4546,7 @@
|
|
|
4562
4546
|
"immutable": true,
|
|
4563
4547
|
"locationInModule": {
|
|
4564
4548
|
"filename": "lib/endpoint.ts",
|
|
4565
|
-
"line":
|
|
4549
|
+
"line": 506
|
|
4566
4550
|
},
|
|
4567
4551
|
"name": "maxFileSize",
|
|
4568
4552
|
"optional": true,
|
|
@@ -4580,7 +4564,7 @@
|
|
|
4580
4564
|
"immutable": true,
|
|
4581
4565
|
"locationInModule": {
|
|
4582
4566
|
"filename": "lib/endpoint.ts",
|
|
4583
|
-
"line":
|
|
4567
|
+
"line": 513
|
|
4584
4568
|
},
|
|
4585
4569
|
"name": "parallelLoadThreads",
|
|
4586
4570
|
"optional": true,
|
|
@@ -4598,7 +4582,7 @@
|
|
|
4598
4582
|
"immutable": true,
|
|
4599
4583
|
"locationInModule": {
|
|
4600
4584
|
"filename": "lib/endpoint.ts",
|
|
4601
|
-
"line":
|
|
4585
|
+
"line": 518
|
|
4602
4586
|
},
|
|
4603
4587
|
"name": "port",
|
|
4604
4588
|
"optional": true,
|
|
@@ -4615,7 +4599,7 @@
|
|
|
4615
4599
|
"immutable": true,
|
|
4616
4600
|
"locationInModule": {
|
|
4617
4601
|
"filename": "lib/endpoint.ts",
|
|
4618
|
-
"line":
|
|
4602
|
+
"line": 526
|
|
4619
4603
|
},
|
|
4620
4604
|
"name": "secretsManagerAccessRoleArn",
|
|
4621
4605
|
"optional": true,
|
|
@@ -4632,7 +4616,7 @@
|
|
|
4632
4616
|
"immutable": true,
|
|
4633
4617
|
"locationInModule": {
|
|
4634
4618
|
"filename": "lib/endpoint.ts",
|
|
4635
|
-
"line":
|
|
4619
|
+
"line": 535
|
|
4636
4620
|
},
|
|
4637
4621
|
"name": "secretsManagerSecretKMSArn",
|
|
4638
4622
|
"optional": true,
|
|
@@ -4650,7 +4634,7 @@
|
|
|
4650
4634
|
"immutable": true,
|
|
4651
4635
|
"locationInModule": {
|
|
4652
4636
|
"filename": "lib/endpoint.ts",
|
|
4653
|
-
"line":
|
|
4637
|
+
"line": 540
|
|
4654
4638
|
},
|
|
4655
4639
|
"name": "serverName",
|
|
4656
4640
|
"optional": true,
|
|
@@ -4668,7 +4652,7 @@
|
|
|
4668
4652
|
"immutable": true,
|
|
4669
4653
|
"locationInModule": {
|
|
4670
4654
|
"filename": "lib/endpoint.ts",
|
|
4671
|
-
"line":
|
|
4655
|
+
"line": 546
|
|
4672
4656
|
},
|
|
4673
4657
|
"name": "serverTimezone",
|
|
4674
4658
|
"optional": true,
|
|
@@ -4683,15 +4667,15 @@
|
|
|
4683
4667
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
4684
4668
|
"datatype": true,
|
|
4685
4669
|
"docs": {
|
|
4686
|
-
"remarks": "
|
|
4670
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
4687
4671
|
"stability": "experimental",
|
|
4688
|
-
"summary": "
|
|
4672
|
+
"summary": "Provides information that defines an IBMDB2 endpoint."
|
|
4689
4673
|
},
|
|
4690
4674
|
"fqn": "@aws-mdaa/dms-constructs.IbmDb2SettingsProperty",
|
|
4691
4675
|
"kind": "interface",
|
|
4692
4676
|
"locationInModule": {
|
|
4693
4677
|
"filename": "lib/endpoint.ts",
|
|
4694
|
-
"line":
|
|
4678
|
+
"line": 349
|
|
4695
4679
|
},
|
|
4696
4680
|
"name": "IbmDb2SettingsProperty",
|
|
4697
4681
|
"properties": [
|
|
@@ -4705,7 +4689,7 @@
|
|
|
4705
4689
|
"immutable": true,
|
|
4706
4690
|
"locationInModule": {
|
|
4707
4691
|
"filename": "lib/endpoint.ts",
|
|
4708
|
-
"line":
|
|
4692
|
+
"line": 364
|
|
4709
4693
|
},
|
|
4710
4694
|
"name": "secretsManagerSecretArn",
|
|
4711
4695
|
"type": {
|
|
@@ -4715,14 +4699,13 @@
|
|
|
4715
4699
|
{
|
|
4716
4700
|
"abstract": true,
|
|
4717
4701
|
"docs": {
|
|
4718
|
-
"remarks": "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.\n\nUse cases: CDC replication control; Precise replication starting points; Mainframe data synchronization; Log-based replication; Data migration control\n\nAWS: AWS DMS IBM DB2 current LSN for CDC replication starting point control and log-based data synchronization\n\nValidation: Must be valid LSN string if provided; used for CDC replication; optional for replication starting point control",
|
|
4719
4702
|
"stability": "experimental",
|
|
4720
|
-
"summary": "
|
|
4703
|
+
"summary": "Log sequence number (LSN) for IBM DB2 change data capture (CDC) replication starting point."
|
|
4721
4704
|
},
|
|
4722
4705
|
"immutable": true,
|
|
4723
4706
|
"locationInModule": {
|
|
4724
4707
|
"filename": "lib/endpoint.ts",
|
|
4725
|
-
"line":
|
|
4708
|
+
"line": 351
|
|
4726
4709
|
},
|
|
4727
4710
|
"name": "currentLsn",
|
|
4728
4711
|
"optional": true,
|
|
@@ -4733,14 +4716,13 @@
|
|
|
4733
4716
|
{
|
|
4734
4717
|
"abstract": true,
|
|
4735
4718
|
"docs": {
|
|
4736
|
-
"remarks": "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.\n\nUse cases: Performance optimization; Throughput tuning; Read buffer configuration; Migration performance; Mainframe data transfer optimization\n\nAWS: AWS DMS IBM DB2 maximum kilobytes per read for data transfer performance optimization and throughput control\n\nValidation: Must be positive number if provided; defaults to 64 KB; optional for performance tuning",
|
|
4737
4719
|
"stability": "experimental",
|
|
4738
|
-
"summary": "
|
|
4720
|
+
"summary": "Maximum bytes per read operation for IBM DB2 data transfer performance optimization enabling throughput tuning."
|
|
4739
4721
|
},
|
|
4740
4722
|
"immutable": true,
|
|
4741
4723
|
"locationInModule": {
|
|
4742
4724
|
"filename": "lib/endpoint.ts",
|
|
4743
|
-
"line":
|
|
4725
|
+
"line": 353
|
|
4744
4726
|
},
|
|
4745
4727
|
"name": "maxKBytesPerRead",
|
|
4746
4728
|
"optional": true,
|
|
@@ -4758,7 +4740,7 @@
|
|
|
4758
4740
|
"immutable": true,
|
|
4759
4741
|
"locationInModule": {
|
|
4760
4742
|
"filename": "lib/endpoint.ts",
|
|
4761
|
-
"line":
|
|
4743
|
+
"line": 359
|
|
4762
4744
|
},
|
|
4763
4745
|
"name": "secretsManagerAccessRoleArn",
|
|
4764
4746
|
"optional": true,
|
|
@@ -4775,7 +4757,7 @@
|
|
|
4775
4757
|
"immutable": true,
|
|
4776
4758
|
"locationInModule": {
|
|
4777
4759
|
"filename": "lib/endpoint.ts",
|
|
4778
|
-
"line":
|
|
4760
|
+
"line": 368
|
|
4779
4761
|
},
|
|
4780
4762
|
"name": "secretsManagerSecretKMSArn",
|
|
4781
4763
|
"optional": true,
|
|
@@ -4793,7 +4775,7 @@
|
|
|
4793
4775
|
"immutable": true,
|
|
4794
4776
|
"locationInModule": {
|
|
4795
4777
|
"filename": "lib/endpoint.ts",
|
|
4796
|
-
"line":
|
|
4778
|
+
"line": 374
|
|
4797
4779
|
},
|
|
4798
4780
|
"name": "setDataCaptureChanges",
|
|
4799
4781
|
"optional": true,
|
|
@@ -4808,29 +4790,28 @@
|
|
|
4808
4790
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
4809
4791
|
"datatype": true,
|
|
4810
4792
|
"docs": {
|
|
4811
|
-
"remarks": "
|
|
4793
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
4812
4794
|
"stability": "experimental",
|
|
4813
|
-
"summary": "
|
|
4795
|
+
"summary": "Provides information that describes an Amazon Kinesis Data Stream endpoint."
|
|
4814
4796
|
},
|
|
4815
4797
|
"fqn": "@aws-mdaa/dms-constructs.KinesisSettingsProperty",
|
|
4816
4798
|
"kind": "interface",
|
|
4817
4799
|
"locationInModule": {
|
|
4818
4800
|
"filename": "lib/endpoint.ts",
|
|
4819
|
-
"line":
|
|
4801
|
+
"line": 213
|
|
4820
4802
|
},
|
|
4821
4803
|
"name": "KinesisSettingsProperty",
|
|
4822
4804
|
"properties": [
|
|
4823
4805
|
{
|
|
4824
4806
|
"abstract": true,
|
|
4825
4807
|
"docs": {
|
|
4826
|
-
"remarks": "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.\n\nUse cases: Streaming destination; Kinesis integration; Real-time migration; Data stream target; Database streaming endpoint\n\nAWS: Amazon Kinesis Data Streams ARN for DMS streaming destination and real-time data integration\n\nValidation: Must be valid Kinesis Data Streams ARN; required for Kinesis endpoint configuration and streaming destination",
|
|
4827
4808
|
"stability": "experimental",
|
|
4828
|
-
"summary": "
|
|
4809
|
+
"summary": "Amazon Kinesis Data Streams endpoint ARN for DMS streaming destination configuration."
|
|
4829
4810
|
},
|
|
4830
4811
|
"immutable": true,
|
|
4831
4812
|
"locationInModule": {
|
|
4832
4813
|
"filename": "lib/endpoint.ts",
|
|
4833
|
-
"line":
|
|
4814
|
+
"line": 233
|
|
4834
4815
|
},
|
|
4835
4816
|
"name": "streamArn",
|
|
4836
4817
|
"type": {
|
|
@@ -4840,14 +4821,13 @@
|
|
|
4840
4821
|
{
|
|
4841
4822
|
"abstract": true,
|
|
4842
4823
|
"docs": {
|
|
4843
|
-
"remarks": "Enables detailed control information including table definition, column definition, and table/column changes in Kinesis streaming output with default false for enhanced change visibility.\n\nUse cases: Change tracking; Control information; Table monitoring; Column changes; Detailed streaming\n\nAWS: AWS DMS Kinesis endpoint includeControlDetails for detailed control information in streaming output\n\nValidation: Must be boolean if provided; default false; enables detailed control information in Kinesis message output",
|
|
4844
4824
|
"stability": "experimental",
|
|
4845
|
-
"summary": "
|
|
4825
|
+
"summary": "Flag to show detailed control information for table and column changes in Kinesis message."
|
|
4846
4826
|
},
|
|
4847
4827
|
"immutable": true,
|
|
4848
4828
|
"locationInModule": {
|
|
4849
4829
|
"filename": "lib/endpoint.ts",
|
|
4850
|
-
"line":
|
|
4830
|
+
"line": 215
|
|
4851
4831
|
},
|
|
4852
4832
|
"name": "includeControlDetails",
|
|
4853
4833
|
"optional": true,
|
|
@@ -4858,14 +4838,13 @@
|
|
|
4858
4838
|
{
|
|
4859
4839
|
"abstract": true,
|
|
4860
4840
|
"docs": {
|
|
4861
|
-
"remarks": "Enables inclusion of NULL and empty column values in Kinesis streaming output with default false, ensuring complete data representation in real-time streaming operations.\n\nUse cases: Complete data representation; NULL handling; Empty column inclusion; Data completeness; Streaming integrity\n\nAWS: AWS DMS Kinesis endpoint includeNullAndEmpty for NULL and empty column inclusion in streaming output\n\nValidation: Must be boolean if provided; default false; includes NULL and empty columns in Kinesis streaming records",
|
|
4862
4841
|
"stability": "experimental",
|
|
4863
|
-
"summary": "
|
|
4842
|
+
"summary": "Flag to include NULL and empty columns in records migrated to Kinesis endpoint for complete."
|
|
4864
4843
|
},
|
|
4865
4844
|
"immutable": true,
|
|
4866
4845
|
"locationInModule": {
|
|
4867
4846
|
"filename": "lib/endpoint.ts",
|
|
4868
|
-
"line":
|
|
4847
|
+
"line": 217
|
|
4869
4848
|
},
|
|
4870
4849
|
"name": "includeNullAndEmpty",
|
|
4871
4850
|
"optional": true,
|
|
@@ -4876,14 +4855,13 @@
|
|
|
4876
4855
|
{
|
|
4877
4856
|
"abstract": true,
|
|
4878
4857
|
"docs": {
|
|
4879
|
-
"remarks": "Enables partition value visibility in Kinesis streaming output with default false, providing partition information for data organization and routing in streaming operations.\n\nUse cases: Partition visibility; Data organization; Streaming routing; Partition information; Message organization\n\nAWS: AWS DMS Kinesis endpoint includePartitionValue for partition value visibility in streaming output\n\nValidation: Must be boolean if provided; default false; shows partition value unless partition type is schema-table-type",
|
|
4880
4858
|
"stability": "experimental",
|
|
4881
|
-
"summary": "
|
|
4859
|
+
"summary": "Flag to show partition value in Kinesis message output unless partition type is schema-table-type."
|
|
4882
4860
|
},
|
|
4883
4861
|
"immutable": true,
|
|
4884
4862
|
"locationInModule": {
|
|
4885
4863
|
"filename": "lib/endpoint.ts",
|
|
4886
|
-
"line":
|
|
4864
|
+
"line": 219
|
|
4887
4865
|
},
|
|
4888
4866
|
"name": "includePartitionValue",
|
|
4889
4867
|
"optional": true,
|
|
@@ -4894,14 +4872,13 @@
|
|
|
4894
4872
|
{
|
|
4895
4873
|
"abstract": true,
|
|
4896
4874
|
"docs": {
|
|
4897
|
-
"remarks": "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.\n\nUse cases: Schema change tracking; DDL monitoring; Table structure changes; Schema evolution; Control data enhancement\n\nAWS: AWS DMS Kinesis endpoint includeTableAlterOperations for DDL operation inclusion in control data\n\nValidation: Must be boolean if provided; default false; includes DDL operations in control data for schema change tracking",
|
|
4898
4875
|
"stability": "experimental",
|
|
4899
|
-
"summary": "
|
|
4876
|
+
"summary": "Flag to include DDL operations that change table structure in control data for schema change tracking."
|
|
4900
4877
|
},
|
|
4901
4878
|
"immutable": true,
|
|
4902
4879
|
"locationInModule": {
|
|
4903
4880
|
"filename": "lib/endpoint.ts",
|
|
4904
|
-
"line":
|
|
4881
|
+
"line": 221
|
|
4905
4882
|
},
|
|
4906
4883
|
"name": "includeTableAlterOperations",
|
|
4907
4884
|
"optional": true,
|
|
@@ -4912,14 +4889,13 @@
|
|
|
4912
4889
|
{
|
|
4913
4890
|
"abstract": true,
|
|
4914
4891
|
"docs": {
|
|
4915
|
-
"remarks": "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.\n\nUse cases: Transaction tracking; Commit information; Transaction details; Log position tracking; Transaction lineage\n\nAWS: AWS DMS Kinesis endpoint includeTransactionDetails for detailed transaction information in streaming output\n\nValidation: Must be boolean if provided; default false; provides detailed transaction information from source database",
|
|
4916
4892
|
"stability": "experimental",
|
|
4917
|
-
"summary": "
|
|
4893
|
+
"summary": "Flag to provide detailed transaction information from source database for transaction tracking."
|
|
4918
4894
|
},
|
|
4919
4895
|
"immutable": true,
|
|
4920
4896
|
"locationInModule": {
|
|
4921
4897
|
"filename": "lib/endpoint.ts",
|
|
4922
|
-
"line":
|
|
4898
|
+
"line": 223
|
|
4923
4899
|
},
|
|
4924
4900
|
"name": "includeTransactionDetails",
|
|
4925
4901
|
"optional": true,
|
|
@@ -4930,14 +4906,13 @@
|
|
|
4930
4906
|
{
|
|
4931
4907
|
"abstract": true,
|
|
4932
4908
|
"docs": {
|
|
4933
|
-
"remarks": "Specifies message format with JSON (default) for formatted output or JSON_UNFORMATTED for single-line output without tabs, affecting streaming data structure and readability.\n\nUse cases: Message formatting; JSON structure; Output format; Streaming format; Data structure control\n\nAWS: AWS DMS Kinesis endpoint messageFormat for streaming record output format specification\n\nValidation: Must be 'JSON' or 'JSON_UNFORMATTED' if provided; default JSON; controls streaming message format and structure",
|
|
4934
4909
|
"stability": "experimental",
|
|
4935
|
-
"summary": "
|
|
4910
|
+
"summary": "Output format specification for records created on Kinesis endpoint for streaming data format control."
|
|
4936
4911
|
},
|
|
4937
4912
|
"immutable": true,
|
|
4938
4913
|
"locationInModule": {
|
|
4939
4914
|
"filename": "lib/endpoint.ts",
|
|
4940
|
-
"line":
|
|
4915
|
+
"line": 225
|
|
4941
4916
|
},
|
|
4942
4917
|
"name": "messageFormat",
|
|
4943
4918
|
"optional": true,
|
|
@@ -4948,14 +4923,13 @@
|
|
|
4948
4923
|
{
|
|
4949
4924
|
"abstract": true,
|
|
4950
4925
|
"docs": {
|
|
4951
|
-
"remarks": "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.\n\nUse cases: Hexadecimal formatting; RAW data migration; LOB handling; Data format control; Oracle to Kinesis migration\n\nAWS: AWS DMS Kinesis endpoint noHexPrefix for hexadecimal data formatting control in streaming output\n\nValidation: Must be boolean if provided; removes '0x' prefix from hexadecimal RAW data in streaming output",
|
|
4952
4926
|
"stability": "experimental",
|
|
4953
|
-
"summary": "
|
|
4927
|
+
"summary": "Flag to avoid adding '0x' prefix to raw data in hexadecimal format for cleaner data representation."
|
|
4954
4928
|
},
|
|
4955
4929
|
"immutable": true,
|
|
4956
4930
|
"locationInModule": {
|
|
4957
4931
|
"filename": "lib/endpoint.ts",
|
|
4958
|
-
"line":
|
|
4932
|
+
"line": 227
|
|
4959
4933
|
},
|
|
4960
4934
|
"name": "noHexPrefix",
|
|
4961
4935
|
"optional": true,
|
|
@@ -4966,14 +4940,13 @@
|
|
|
4966
4940
|
{
|
|
4967
4941
|
"abstract": true,
|
|
4968
4942
|
"docs": {
|
|
4969
|
-
"remarks": "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.\n\nUse cases: Data distribution; Shard optimization; Throttling prevention; Partition strategy; Performance optimization\n\nAWS: AWS DMS Kinesis endpoint partitionIncludeSchemaTable for partition value prefixing and shard distribution\n\nValidation: Must be boolean if provided; default false; improves data distribution when partition type is primary-key-type",
|
|
4970
4943
|
"stability": "experimental",
|
|
4971
|
-
"summary": "
|
|
4944
|
+
"summary": "Flag to prefix schema and table names to partition values for improved data distribution across Kinesis shards."
|
|
4972
4945
|
},
|
|
4973
4946
|
"immutable": true,
|
|
4974
4947
|
"locationInModule": {
|
|
4975
4948
|
"filename": "lib/endpoint.ts",
|
|
4976
|
-
"line":
|
|
4949
|
+
"line": 229
|
|
4977
4950
|
},
|
|
4978
4951
|
"name": "partitionIncludeSchemaTable",
|
|
4979
4952
|
"optional": true,
|
|
@@ -4984,14 +4957,13 @@
|
|
|
4984
4957
|
{
|
|
4985
4958
|
"abstract": true,
|
|
4986
4959
|
"docs": {
|
|
4987
|
-
"remarks": "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.\n\nUse cases: Service access; IAM role configuration; Kinesis permissions; Secure streaming; Data migration authorization\n\nAWS: AWS IAM role ARN for DMS service access to Kinesis data stream operations and streaming integration\n\nValidation: Must be valid IAM role ARN if provided; requires iam:PassRole action; enables Kinesis data stream write operations",
|
|
4988
4960
|
"stability": "experimental",
|
|
4989
|
-
"summary": "
|
|
4961
|
+
"summary": "IAM role ARN for DMS service access to Kinesis data stream for secure streaming operations."
|
|
4990
4962
|
},
|
|
4991
4963
|
"immutable": true,
|
|
4992
4964
|
"locationInModule": {
|
|
4993
4965
|
"filename": "lib/endpoint.ts",
|
|
4994
|
-
"line":
|
|
4966
|
+
"line": 231
|
|
4995
4967
|
},
|
|
4996
4968
|
"name": "serviceAccessRoleArn",
|
|
4997
4969
|
"optional": true,
|
|
@@ -5017,7 +4989,7 @@
|
|
|
5017
4989
|
},
|
|
5018
4990
|
"locationInModule": {
|
|
5019
4991
|
"filename": "lib/endpoint.ts",
|
|
5020
|
-
"line":
|
|
4992
|
+
"line": 740
|
|
5021
4993
|
},
|
|
5022
4994
|
"parameters": [
|
|
5023
4995
|
{
|
|
@@ -5043,7 +5015,7 @@
|
|
|
5043
5015
|
"kind": "class",
|
|
5044
5016
|
"locationInModule": {
|
|
5045
5017
|
"filename": "lib/endpoint.ts",
|
|
5046
|
-
"line":
|
|
5018
|
+
"line": 704
|
|
5047
5019
|
},
|
|
5048
5020
|
"name": "MdaaEndpoint",
|
|
5049
5021
|
"symbolId": "lib/endpoint:MdaaEndpoint"
|
|
@@ -5061,7 +5033,7 @@
|
|
|
5061
5033
|
"kind": "interface",
|
|
5062
5034
|
"locationInModule": {
|
|
5063
5035
|
"filename": "lib/endpoint.ts",
|
|
5064
|
-
"line":
|
|
5036
|
+
"line": 653
|
|
5065
5037
|
},
|
|
5066
5038
|
"name": "MdaaEndpointProps",
|
|
5067
5039
|
"properties": [
|
|
@@ -5073,7 +5045,7 @@
|
|
|
5073
5045
|
"immutable": true,
|
|
5074
5046
|
"locationInModule": {
|
|
5075
5047
|
"filename": "lib/endpoint.ts",
|
|
5076
|
-
"line":
|
|
5048
|
+
"line": 657
|
|
5077
5049
|
},
|
|
5078
5050
|
"name": "endpointIdentifier",
|
|
5079
5051
|
"type": {
|
|
@@ -5083,14 +5055,13 @@
|
|
|
5083
5055
|
{
|
|
5084
5056
|
"abstract": true,
|
|
5085
5057
|
"docs": {
|
|
5086
|
-
"remarks": "Defines whether the endpoint serves as a data source or target destination for migration operations and data transfer direction.\n\nUse cases: Migration direction; Data flow control; Source/target specification; Migration architecture\n\nAWS: DMS endpoint type for migration direction and data flow configuration\n\nValidation: Must be 'source' or 'target'; required for endpoint role and migration direction specification\n *",
|
|
5087
5058
|
"stability": "experimental",
|
|
5088
|
-
"summary": "
|
|
5059
|
+
"summary": "Endpoint type specification controlling migration direction and data flow for source or target configuration."
|
|
5089
5060
|
},
|
|
5090
5061
|
"immutable": true,
|
|
5091
5062
|
"locationInModule": {
|
|
5092
5063
|
"filename": "lib/endpoint.ts",
|
|
5093
|
-
"line":
|
|
5064
|
+
"line": 659
|
|
5094
5065
|
},
|
|
5095
5066
|
"name": "endpointType",
|
|
5096
5067
|
"type": {
|
|
@@ -5100,14 +5071,13 @@
|
|
|
5100
5071
|
{
|
|
5101
5072
|
"abstract": true,
|
|
5102
5073
|
"docs": {
|
|
5103
|
-
"remarks": "Defines the specific database engine type for appropriate connectivity, protocol selection, and database-specific optimization.\n\nUse cases: Database engine specification; Connectivity protocols; Engine-specific optimization; Database compatibility\n\nAWS: DMS endpoint engine name for database type specification and connectivity configuration\n\nValidation: Must be valid engine name (mysql, oracle, postgres, etc.); required for database connectivity\n *",
|
|
5104
5074
|
"stability": "experimental",
|
|
5105
|
-
"summary": "
|
|
5075
|
+
"summary": "Database engine specification controlling database type and connectivity protocols for endpoint configuration."
|
|
5106
5076
|
},
|
|
5107
5077
|
"immutable": true,
|
|
5108
5078
|
"locationInModule": {
|
|
5109
5079
|
"filename": "lib/endpoint.ts",
|
|
5110
|
-
"line":
|
|
5080
|
+
"line": 661
|
|
5111
5081
|
},
|
|
5112
5082
|
"name": "engineName",
|
|
5113
5083
|
"type": {
|
|
@@ -5122,7 +5092,7 @@
|
|
|
5122
5092
|
"immutable": true,
|
|
5123
5093
|
"locationInModule": {
|
|
5124
5094
|
"filename": "lib/endpoint.ts",
|
|
5125
|
-
"line":
|
|
5095
|
+
"line": 663
|
|
5126
5096
|
},
|
|
5127
5097
|
"name": "kmsKey",
|
|
5128
5098
|
"type": {
|
|
@@ -5137,7 +5107,7 @@
|
|
|
5137
5107
|
"immutable": true,
|
|
5138
5108
|
"locationInModule": {
|
|
5139
5109
|
"filename": "lib/endpoint.ts",
|
|
5140
|
-
"line":
|
|
5110
|
+
"line": 654
|
|
5141
5111
|
},
|
|
5142
5112
|
"name": "certificateArn",
|
|
5143
5113
|
"optional": true,
|
|
@@ -5148,14 +5118,13 @@
|
|
|
5148
5118
|
{
|
|
5149
5119
|
"abstract": true,
|
|
5150
5120
|
"docs": {
|
|
5151
|
-
"remarks": "Defines the specific database within the database server for migration operations and data transfer targeting.\n\nUse cases: Database targeting; Migration scope; Specific database selection; Data transfer control\n\nAWS: Database name for DMS endpoint connectivity and migration targeting\n\nValidation: Must be valid database name if provided; not applicable for MySQL endpoints",
|
|
5152
5121
|
"stability": "experimental",
|
|
5153
|
-
"summary": "
|
|
5122
|
+
"summary": "Database name specification for endpoint connectivity controlling target database selection."
|
|
5154
5123
|
},
|
|
5155
5124
|
"immutable": true,
|
|
5156
5125
|
"locationInModule": {
|
|
5157
5126
|
"filename": "lib/endpoint.ts",
|
|
5158
|
-
"line":
|
|
5127
|
+
"line": 656
|
|
5159
5128
|
},
|
|
5160
5129
|
"name": "databaseName",
|
|
5161
5130
|
"optional": true,
|
|
@@ -5166,14 +5135,13 @@
|
|
|
5166
5135
|
{
|
|
5167
5136
|
"abstract": true,
|
|
5168
5137
|
"docs": {
|
|
5169
|
-
"remarks": "Provides DocumentDB-specific configuration for document database migration and connectivity optimization.\n\nUse cases: DocumentDB connectivity; NoSQL migration; Document database optimization; MongoDB compatibility\n\nAWS: DocumentDB settings for DMS endpoint NoSQL document database connectivity and optimization\n\nValidation: Must be valid DocDbSettingsProperty if provided; enables DocumentDB-specific connectivity\n *",
|
|
5170
5138
|
"stability": "experimental",
|
|
5171
|
-
"summary": "
|
|
5139
|
+
"summary": "DocumentDB settings for DocumentDB endpoint configuration enabling NoSQL document database."
|
|
5172
5140
|
},
|
|
5173
5141
|
"immutable": true,
|
|
5174
5142
|
"locationInModule": {
|
|
5175
5143
|
"filename": "lib/endpoint.ts",
|
|
5176
|
-
"line":
|
|
5144
|
+
"line": 671
|
|
5177
5145
|
},
|
|
5178
5146
|
"name": "docDbSettings",
|
|
5179
5147
|
"optional": true,
|
|
@@ -5184,14 +5152,13 @@
|
|
|
5184
5152
|
{
|
|
5185
5153
|
"abstract": true,
|
|
5186
5154
|
"docs": {
|
|
5187
|
-
"remarks": "Provides DynamoDB-specific configuration for NoSQL migration and object mapping optimization.\n\nUse cases: DynamoDB connectivity; NoSQL migration; Object mapping; Key-value database optimization\n\nAWS: DynamoDB settings for DMS endpoint NoSQL key-value database connectivity and object mapping\n\nValidation: Must be valid DynamoDbSettingsProperty if provided; enables DynamoDB-specific connectivity\n *",
|
|
5188
5155
|
"stability": "experimental",
|
|
5189
|
-
"summary": "
|
|
5156
|
+
"summary": "DynamoDB settings for DynamoDB endpoint configuration enabling NoSQL key-value database."
|
|
5190
5157
|
},
|
|
5191
5158
|
"immutable": true,
|
|
5192
5159
|
"locationInModule": {
|
|
5193
5160
|
"filename": "lib/endpoint.ts",
|
|
5194
|
-
"line":
|
|
5161
|
+
"line": 673
|
|
5195
5162
|
},
|
|
5196
5163
|
"name": "dynamoDbSettings",
|
|
5197
5164
|
"optional": true,
|
|
@@ -5202,14 +5169,13 @@
|
|
|
5202
5169
|
{
|
|
5203
5170
|
"abstract": true,
|
|
5204
5171
|
"docs": {
|
|
5205
|
-
"remarks": "Provides OpenSearch/Elasticsearch-specific configuration for search engine migration and document indexing optimization.\n\nUse cases: Search engine connectivity; Document indexing; OpenSearch migration; Search optimization\n\nAWS: OpenSearch/Elasticsearch settings for DMS endpoint search engine connectivity and indexing\n\nValidation: Must be valid ElasticsearchSettingsProperty if provided; enables search engine connectivity\n *",
|
|
5206
5172
|
"stability": "experimental",
|
|
5207
|
-
"summary": "
|
|
5173
|
+
"summary": "Elasticsearch settings for OpenSearch endpoint configuration enabling search engine."
|
|
5208
5174
|
},
|
|
5209
5175
|
"immutable": true,
|
|
5210
5176
|
"locationInModule": {
|
|
5211
5177
|
"filename": "lib/endpoint.ts",
|
|
5212
|
-
"line":
|
|
5178
|
+
"line": 675
|
|
5213
5179
|
},
|
|
5214
5180
|
"name": "elasticsearchSettings",
|
|
5215
5181
|
"optional": true,
|
|
@@ -5225,7 +5191,7 @@
|
|
|
5225
5191
|
"immutable": true,
|
|
5226
5192
|
"locationInModule": {
|
|
5227
5193
|
"filename": "lib/endpoint.ts",
|
|
5228
|
-
"line":
|
|
5194
|
+
"line": 662
|
|
5229
5195
|
},
|
|
5230
5196
|
"name": "extraConnectionAttributes",
|
|
5231
5197
|
"optional": true,
|
|
@@ -5236,14 +5202,13 @@
|
|
|
5236
5202
|
{
|
|
5237
5203
|
"abstract": true,
|
|
5238
5204
|
"docs": {
|
|
5239
|
-
"remarks": "Provides IBM Db2-specific configuration for mainframe database migration and connectivity optimization.\n\nUse cases: IBM Db2 connectivity; Mainframe migration; Enterprise database optimization; Legacy system integration\n\nAWS: IBM Db2 settings for DMS endpoint mainframe database connectivity and optimization\n\nValidation: Must be valid IbmDb2SettingsProperty if provided; enables IBM Db2-specific connectivity\n *",
|
|
5240
5205
|
"stability": "experimental",
|
|
5241
|
-
"summary": "
|
|
5206
|
+
"summary": "IBM Db2 settings for Db2 LUW endpoint configuration enabling mainframe database connectivity and optimization."
|
|
5242
5207
|
},
|
|
5243
5208
|
"immutable": true,
|
|
5244
5209
|
"locationInModule": {
|
|
5245
5210
|
"filename": "lib/endpoint.ts",
|
|
5246
|
-
"line":
|
|
5211
|
+
"line": 677
|
|
5247
5212
|
},
|
|
5248
5213
|
"name": "ibmDb2Settings",
|
|
5249
5214
|
"optional": true,
|
|
@@ -5254,14 +5219,13 @@
|
|
|
5254
5219
|
{
|
|
5255
5220
|
"abstract": true,
|
|
5256
5221
|
"docs": {
|
|
5257
|
-
"remarks": "Provides Kinesis-specific configuration for real-time data streaming and object mapping optimization.\n\nUse cases: Real-time streaming; Data streams; Object mapping; Stream processing\n\nAWS: Kinesis Data Streams settings for DMS endpoint real-time streaming and object mapping\n\nValidation: Must be valid KinesisSettingsProperty if provided; enables Kinesis streaming connectivity\n *",
|
|
5258
5222
|
"stability": "experimental",
|
|
5259
|
-
"summary": "
|
|
5223
|
+
"summary": "Kinesis settings for Kinesis Data Streams endpoint configuration enabling real-time."
|
|
5260
5224
|
},
|
|
5261
5225
|
"immutable": true,
|
|
5262
5226
|
"locationInModule": {
|
|
5263
5227
|
"filename": "lib/endpoint.ts",
|
|
5264
|
-
"line":
|
|
5228
|
+
"line": 679
|
|
5265
5229
|
},
|
|
5266
5230
|
"name": "kinesisSettings",
|
|
5267
5231
|
"optional": true,
|
|
@@ -5272,14 +5236,13 @@
|
|
|
5272
5236
|
{
|
|
5273
5237
|
"abstract": true,
|
|
5274
5238
|
"docs": {
|
|
5275
|
-
"remarks": "Provides SQL Server-specific configuration for enterprise database migration and connectivity optimization.\n\nUse cases: SQL Server connectivity; Enterprise migration; Windows database optimization; Microsoft ecosystem integration\n\nAWS: Microsoft SQL Server settings for DMS endpoint enterprise database connectivity and optimization\n\nValidation: Must be valid MicrosoftSqlServerSettingsProperty if provided; enables SQL Server connectivity\n *",
|
|
5276
5239
|
"stability": "experimental",
|
|
5277
|
-
"summary": "
|
|
5240
|
+
"summary": "Microsoft SQL Server settings for SQL Server endpoint configuration enabling enterprise."
|
|
5278
5241
|
},
|
|
5279
5242
|
"immutable": true,
|
|
5280
5243
|
"locationInModule": {
|
|
5281
5244
|
"filename": "lib/endpoint.ts",
|
|
5282
|
-
"line":
|
|
5245
|
+
"line": 681
|
|
5283
5246
|
},
|
|
5284
5247
|
"name": "microsoftSqlServerSettings",
|
|
5285
5248
|
"optional": true,
|
|
@@ -5290,14 +5253,13 @@
|
|
|
5290
5253
|
{
|
|
5291
5254
|
"abstract": true,
|
|
5292
5255
|
"docs": {
|
|
5293
|
-
"remarks": "Provides MongoDB-specific configuration for document database migration and connectivity optimization.\n\nUse cases: MongoDB connectivity; Document database migration; NoSQL optimization; Document store integration\n\nAWS: MongoDB settings for DMS endpoint NoSQL document database connectivity and optimization\n\nValidation: Must be valid MongoDbSettingsProperty if provided; enables MongoDB-specific connectivity\n *",
|
|
5294
5256
|
"stability": "experimental",
|
|
5295
|
-
"summary": "
|
|
5257
|
+
"summary": "MongoDB settings for MongoDB endpoint configuration enabling NoSQL document database."
|
|
5296
5258
|
},
|
|
5297
5259
|
"immutable": true,
|
|
5298
5260
|
"locationInModule": {
|
|
5299
5261
|
"filename": "lib/endpoint.ts",
|
|
5300
|
-
"line":
|
|
5262
|
+
"line": 683
|
|
5301
5263
|
},
|
|
5302
5264
|
"name": "mongoDbSettings",
|
|
5303
5265
|
"optional": true,
|
|
@@ -5308,14 +5270,13 @@
|
|
|
5308
5270
|
{
|
|
5309
5271
|
"abstract": true,
|
|
5310
5272
|
"docs": {
|
|
5311
|
-
"remarks": "Provides MySQL-specific configuration for relational database migration and connectivity optimization.\n\nUse cases: MySQL connectivity; Relational migration; Open-source database optimization; Web application integration\n\nAWS: MySQL settings for DMS endpoint relational database connectivity and optimization\n\nValidation: Must be valid MySqlSettingsProperty if provided; enables MySQL-specific connectivity\n *",
|
|
5312
5273
|
"stability": "experimental",
|
|
5313
|
-
"summary": "
|
|
5274
|
+
"summary": "MySQL settings for MySQL endpoint configuration enabling relational database connectivity and optimization."
|
|
5314
5275
|
},
|
|
5315
5276
|
"immutable": true,
|
|
5316
5277
|
"locationInModule": {
|
|
5317
5278
|
"filename": "lib/endpoint.ts",
|
|
5318
|
-
"line":
|
|
5279
|
+
"line": 685
|
|
5319
5280
|
},
|
|
5320
5281
|
"name": "mySqlSettings",
|
|
5321
5282
|
"optional": true,
|
|
@@ -5326,14 +5287,13 @@
|
|
|
5326
5287
|
{
|
|
5327
5288
|
"abstract": true,
|
|
5328
5289
|
"docs": {
|
|
5329
|
-
"remarks": "Provides Neptune-specific configuration for graph database migration and connectivity optimization.\n\nUse cases: Graph database connectivity; Neptune migration; Graph data optimization; Relationship data processing\n\nAWS: Amazon Neptune settings for DMS endpoint graph database connectivity and optimization\n\nValidation: Must be valid NeptuneSettingsProperty if provided; enables Neptune-specific connectivity\n *",
|
|
5330
5290
|
"stability": "experimental",
|
|
5331
|
-
"summary": "
|
|
5291
|
+
"summary": "Neptune settings for Neptune endpoint configuration enabling graph database connectivity and optimization."
|
|
5332
5292
|
},
|
|
5333
5293
|
"immutable": true,
|
|
5334
5294
|
"locationInModule": {
|
|
5335
5295
|
"filename": "lib/endpoint.ts",
|
|
5336
|
-
"line":
|
|
5296
|
+
"line": 687
|
|
5337
5297
|
},
|
|
5338
5298
|
"name": "neptuneSettings",
|
|
5339
5299
|
"optional": true,
|
|
@@ -5344,14 +5304,13 @@
|
|
|
5344
5304
|
{
|
|
5345
5305
|
"abstract": true,
|
|
5346
5306
|
"docs": {
|
|
5347
|
-
"remarks": "Provides Oracle-specific configuration for enterprise database migration and connectivity optimization.\n\nUse cases: Oracle connectivity; Enterprise migration; Commercial database optimization; Oracle ecosystem integration\n\nAWS: Oracle Database settings for DMS endpoint enterprise database connectivity and optimization\n\nValidation: Must be valid OracleSettingsProperty if provided; enables Oracle-specific connectivity\n *",
|
|
5348
5307
|
"stability": "experimental",
|
|
5349
|
-
"summary": "
|
|
5308
|
+
"summary": "Oracle settings for Oracle endpoint configuration enabling enterprise database connectivity and optimization."
|
|
5350
5309
|
},
|
|
5351
5310
|
"immutable": true,
|
|
5352
5311
|
"locationInModule": {
|
|
5353
5312
|
"filename": "lib/endpoint.ts",
|
|
5354
|
-
"line":
|
|
5313
|
+
"line": 689
|
|
5355
5314
|
},
|
|
5356
5315
|
"name": "oracleSettings",
|
|
5357
5316
|
"optional": true,
|
|
@@ -5362,14 +5321,13 @@
|
|
|
5362
5321
|
{
|
|
5363
5322
|
"abstract": true,
|
|
5364
5323
|
"docs": {
|
|
5365
|
-
"remarks": "Defines the network port for database connectivity enabling proper network routing and database server access.\n\nUse cases: Network connectivity; Port specification; Database access; Network routing\n\nAWS: Database port for DMS endpoint network connectivity and database server access\n\nValidation: Must be valid port number if provided; enables proper network connectivity to database server",
|
|
5366
5324
|
"stability": "experimental",
|
|
5367
|
-
"summary": "
|
|
5325
|
+
"summary": "Database port specification for endpoint connectivity controlling network connection."
|
|
5368
5326
|
},
|
|
5369
5327
|
"immutable": true,
|
|
5370
5328
|
"locationInModule": {
|
|
5371
5329
|
"filename": "lib/endpoint.ts",
|
|
5372
|
-
"line":
|
|
5330
|
+
"line": 665
|
|
5373
5331
|
},
|
|
5374
5332
|
"name": "port",
|
|
5375
5333
|
"optional": true,
|
|
@@ -5380,14 +5338,13 @@
|
|
|
5380
5338
|
{
|
|
5381
5339
|
"abstract": true,
|
|
5382
5340
|
"docs": {
|
|
5383
|
-
"remarks": "Provides PostgreSQL-specific configuration for relational database migration and connectivity optimization.\n\nUse cases: PostgreSQL connectivity; Open-source migration; Advanced relational features; Enterprise-grade database\n\nAWS: PostgreSQL settings for DMS endpoint relational database connectivity and optimization\n\nValidation: Must be valid PostgreSqlSettingsProperty if provided; enables PostgreSQL-specific connectivity\n *",
|
|
5384
5341
|
"stability": "experimental",
|
|
5385
|
-
"summary": "
|
|
5342
|
+
"summary": "PostgreSQL settings for PostgreSQL endpoint configuration enabling open-source relational."
|
|
5386
5343
|
},
|
|
5387
5344
|
"immutable": true,
|
|
5388
5345
|
"locationInModule": {
|
|
5389
5346
|
"filename": "lib/endpoint.ts",
|
|
5390
|
-
"line":
|
|
5347
|
+
"line": 691
|
|
5391
5348
|
},
|
|
5392
5349
|
"name": "postgreSqlSettings",
|
|
5393
5350
|
"optional": true,
|
|
@@ -5398,14 +5355,13 @@
|
|
|
5398
5355
|
{
|
|
5399
5356
|
"abstract": true,
|
|
5400
5357
|
"docs": {
|
|
5401
|
-
"remarks": "Provides Redshift-specific configuration for data warehouse migration and analytics optimization.\n\nUse cases: Data warehouse connectivity; Analytics migration; Redshift optimization; Business intelligence integration\n\nAWS: Amazon Redshift settings for DMS endpoint data warehouse connectivity and analytics optimization\n\nValidation: Must be valid RedshiftSettingsProperty if provided; enables Redshift-specific connectivity\n *",
|
|
5402
5358
|
"stability": "experimental",
|
|
5403
|
-
"summary": "
|
|
5359
|
+
"summary": "Redshift settings for Redshift endpoint configuration enabling data warehouse connectivity and optimization."
|
|
5404
5360
|
},
|
|
5405
5361
|
"immutable": true,
|
|
5406
5362
|
"locationInModule": {
|
|
5407
5363
|
"filename": "lib/endpoint.ts",
|
|
5408
|
-
"line":
|
|
5364
|
+
"line": 693
|
|
5409
5365
|
},
|
|
5410
5366
|
"name": "redshiftSettings",
|
|
5411
5367
|
"optional": true,
|
|
@@ -5421,7 +5377,7 @@
|
|
|
5421
5377
|
"immutable": true,
|
|
5422
5378
|
"locationInModule": {
|
|
5423
5379
|
"filename": "lib/endpoint.ts",
|
|
5424
|
-
"line":
|
|
5380
|
+
"line": 666
|
|
5425
5381
|
},
|
|
5426
5382
|
"name": "resourceIdentifier",
|
|
5427
5383
|
"optional": true,
|
|
@@ -5432,14 +5388,13 @@
|
|
|
5432
5388
|
{
|
|
5433
5389
|
"abstract": true,
|
|
5434
5390
|
"docs": {
|
|
5435
|
-
"remarks": "Provides S3-specific configuration for object storage migration and file-based data transfer optimization.\n\nUse cases: Object storage connectivity; File-based migration; S3 optimization; Data lake integration\n\nAWS: Amazon S3 settings for DMS endpoint object storage connectivity and file-based data transfer\n\nValidation: Must be valid S3SettingsProperty if provided; enables S3-specific connectivity and file transfer\n *",
|
|
5436
5391
|
"stability": "experimental",
|
|
5437
|
-
"summary": "
|
|
5392
|
+
"summary": "S3 settings for S3 endpoint configuration enabling object storage connectivity and file-based data transfer."
|
|
5438
5393
|
},
|
|
5439
5394
|
"immutable": true,
|
|
5440
5395
|
"locationInModule": {
|
|
5441
5396
|
"filename": "lib/endpoint.ts",
|
|
5442
|
-
"line":
|
|
5397
|
+
"line": 695
|
|
5443
5398
|
},
|
|
5444
5399
|
"name": "s3Settings",
|
|
5445
5400
|
"optional": true,
|
|
@@ -5450,14 +5405,13 @@
|
|
|
5450
5405
|
{
|
|
5451
5406
|
"abstract": true,
|
|
5452
5407
|
"docs": {
|
|
5453
|
-
"remarks": "Defines the hostname or IP address of the database server for network connectivity and database access.\n\nUse cases: Server connectivity; Network access; Database server identification; Hostname specification\n\nAWS: Database server name for DMS endpoint network connectivity and server access\n\nValidation: Must be valid hostname or IP address if provided; enables network connectivity to database server",
|
|
5454
5408
|
"stability": "experimental",
|
|
5455
|
-
"summary": "
|
|
5409
|
+
"summary": "Server name specification for database server connectivity enabling network-based database."
|
|
5456
5410
|
},
|
|
5457
5411
|
"immutable": true,
|
|
5458
5412
|
"locationInModule": {
|
|
5459
5413
|
"filename": "lib/endpoint.ts",
|
|
5460
|
-
"line":
|
|
5414
|
+
"line": 668
|
|
5461
5415
|
},
|
|
5462
5416
|
"name": "serverName",
|
|
5463
5417
|
"optional": true,
|
|
@@ -5473,7 +5427,7 @@
|
|
|
5473
5427
|
"immutable": true,
|
|
5474
5428
|
"locationInModule": {
|
|
5475
5429
|
"filename": "lib/endpoint.ts",
|
|
5476
|
-
"line":
|
|
5430
|
+
"line": 669
|
|
5477
5431
|
},
|
|
5478
5432
|
"name": "sslMode",
|
|
5479
5433
|
"optional": true,
|
|
@@ -5484,14 +5438,13 @@
|
|
|
5484
5438
|
{
|
|
5485
5439
|
"abstract": true,
|
|
5486
5440
|
"docs": {
|
|
5487
|
-
"remarks": "Provides Sybase/SAP ASE-specific configuration for enterprise database migration and connectivity optimization.\n\nUse cases: Sybase connectivity; SAP ASE migration; Enterprise database optimization; Legacy system integration\n\nAWS: Sybase/SAP ASE settings for DMS endpoint enterprise database connectivity and optimization\n\nValidation: Must be valid SybaseSettingsProperty if provided; enables Sybase/SAP ASE connectivity\n *",
|
|
5488
5441
|
"stability": "experimental",
|
|
5489
|
-
"summary": "
|
|
5442
|
+
"summary": "Sybase settings for SAP ASE endpoint configuration enabling enterprise database connectivity and optimization."
|
|
5490
5443
|
},
|
|
5491
5444
|
"immutable": true,
|
|
5492
5445
|
"locationInModule": {
|
|
5493
5446
|
"filename": "lib/endpoint.ts",
|
|
5494
|
-
"line":
|
|
5447
|
+
"line": 697
|
|
5495
5448
|
},
|
|
5496
5449
|
"name": "sybaseSettings",
|
|
5497
5450
|
"optional": true,
|
|
@@ -5517,7 +5470,7 @@
|
|
|
5517
5470
|
},
|
|
5518
5471
|
"locationInModule": {
|
|
5519
5472
|
"filename": "lib/replication_instance.ts",
|
|
5520
|
-
"line":
|
|
5473
|
+
"line": 51
|
|
5521
5474
|
},
|
|
5522
5475
|
"parameters": [
|
|
5523
5476
|
{
|
|
@@ -5543,7 +5496,7 @@
|
|
|
5543
5496
|
"kind": "class",
|
|
5544
5497
|
"locationInModule": {
|
|
5545
5498
|
"filename": "lib/replication_instance.ts",
|
|
5546
|
-
"line":
|
|
5499
|
+
"line": 37
|
|
5547
5500
|
},
|
|
5548
5501
|
"name": "MdaaReplicationInstance",
|
|
5549
5502
|
"symbolId": "lib/replication_instance:MdaaReplicationInstance"
|
|
@@ -5573,7 +5526,7 @@
|
|
|
5573
5526
|
"immutable": true,
|
|
5574
5527
|
"locationInModule": {
|
|
5575
5528
|
"filename": "lib/replication_instance.ts",
|
|
5576
|
-
"line":
|
|
5529
|
+
"line": 21
|
|
5577
5530
|
},
|
|
5578
5531
|
"name": "kmsKey",
|
|
5579
5532
|
"type": {
|
|
@@ -5588,7 +5541,7 @@
|
|
|
5588
5541
|
"immutable": true,
|
|
5589
5542
|
"locationInModule": {
|
|
5590
5543
|
"filename": "lib/replication_instance.ts",
|
|
5591
|
-
"line":
|
|
5544
|
+
"line": 25
|
|
5592
5545
|
},
|
|
5593
5546
|
"name": "replicationInstanceClass",
|
|
5594
5547
|
"type": {
|
|
@@ -5603,7 +5556,7 @@
|
|
|
5603
5556
|
"immutable": true,
|
|
5604
5557
|
"locationInModule": {
|
|
5605
5558
|
"filename": "lib/replication_instance.ts",
|
|
5606
|
-
"line":
|
|
5559
|
+
"line": 27
|
|
5607
5560
|
},
|
|
5608
5561
|
"name": "replicationSubnetGroupIdentifier",
|
|
5609
5562
|
"type": {
|
|
@@ -5679,14 +5632,13 @@
|
|
|
5679
5632
|
{
|
|
5680
5633
|
"abstract": true,
|
|
5681
5634
|
"docs": {
|
|
5682
|
-
"remarks": "Defines the specific availability zone for replication instance deployment for network proximity and disaster recovery planning.\n\nUse cases: Geographic placement; Latency optimization; Disaster recovery; Network proximity\n\nAWS: DMS replication instance availability zone for geographic placement and network optimization\n\nValidation: Must be valid availability zone name if provided; controls instance placement and network proximity",
|
|
5683
5635
|
"stability": "experimental",
|
|
5684
|
-
"summary": "
|
|
5636
|
+
"summary": "Availability zone specification for replication instance placement controlling geographic."
|
|
5685
5637
|
},
|
|
5686
5638
|
"immutable": true,
|
|
5687
5639
|
"locationInModule": {
|
|
5688
5640
|
"filename": "lib/replication_instance.ts",
|
|
5689
|
-
"line":
|
|
5641
|
+
"line": 18
|
|
5690
5642
|
},
|
|
5691
5643
|
"name": "availabilityZone",
|
|
5692
5644
|
"optional": true,
|
|
@@ -5697,14 +5649,13 @@
|
|
|
5697
5649
|
{
|
|
5698
5650
|
"abstract": true,
|
|
5699
5651
|
"docs": {
|
|
5700
|
-
"remarks": "Provides control over DMS engine version for feature access, compatibility, and performance characteristics.\n\nUse cases: Version management; Feature access; Compatibility control; Performance optimization\n\nAWS: DMS replication instance engine version for feature access and compatibility management\n\nValidation: Must be valid DMS engine version if provided; defaults to latest available version",
|
|
5701
5652
|
"stability": "experimental",
|
|
5702
|
-
"summary": "
|
|
5653
|
+
"summary": "DMS engine version specification for feature access and compatibility control enabling."
|
|
5703
5654
|
},
|
|
5704
5655
|
"immutable": true,
|
|
5705
5656
|
"locationInModule": {
|
|
5706
5657
|
"filename": "lib/replication_instance.ts",
|
|
5707
|
-
"line":
|
|
5658
|
+
"line": 20
|
|
5708
5659
|
},
|
|
5709
5660
|
"name": "engineVersion",
|
|
5710
5661
|
"optional": true,
|
|
@@ -5720,7 +5671,7 @@
|
|
|
5720
5671
|
"immutable": true,
|
|
5721
5672
|
"locationInModule": {
|
|
5722
5673
|
"filename": "lib/replication_instance.ts",
|
|
5723
|
-
"line":
|
|
5674
|
+
"line": 22
|
|
5724
5675
|
},
|
|
5725
5676
|
"name": "multiAz",
|
|
5726
5677
|
"optional": true,
|
|
@@ -5740,14 +5691,13 @@
|
|
|
5740
5691
|
{
|
|
5741
5692
|
"abstract": true,
|
|
5742
5693
|
"docs": {
|
|
5743
|
-
"remarks": "Defines the weekly time range for system maintenance activities with minimal impact on migration operations.\n\nUse cases: Maintenance scheduling; Operational timing; Impact control; System updates\n\nAWS: DMS replication instance maintenance window for system updates and operational scheduling\n\nValidation: Must be valid time range format (ddd:hh24:mi-ddd:hh24:mi) if provided; minimum 30-minute window",
|
|
5744
5694
|
"stability": "experimental",
|
|
5745
|
-
"summary": "
|
|
5695
|
+
"summary": "Maintenance window specification for system updates and maintenance operations controlling."
|
|
5746
5696
|
},
|
|
5747
5697
|
"immutable": true,
|
|
5748
5698
|
"locationInModule": {
|
|
5749
5699
|
"filename": "lib/replication_instance.ts",
|
|
5750
|
-
"line":
|
|
5700
|
+
"line": 24
|
|
5751
5701
|
},
|
|
5752
5702
|
"name": "preferredMaintenanceWindow",
|
|
5753
5703
|
"optional": true,
|
|
@@ -5763,7 +5713,7 @@
|
|
|
5763
5713
|
"immutable": true,
|
|
5764
5714
|
"locationInModule": {
|
|
5765
5715
|
"filename": "lib/replication_instance.ts",
|
|
5766
|
-
"line":
|
|
5716
|
+
"line": 26
|
|
5767
5717
|
},
|
|
5768
5718
|
"name": "replicationInstanceIdentifier",
|
|
5769
5719
|
"optional": true,
|
|
@@ -5779,7 +5729,7 @@
|
|
|
5779
5729
|
"immutable": true,
|
|
5780
5730
|
"locationInModule": {
|
|
5781
5731
|
"filename": "lib/replication_instance.ts",
|
|
5782
|
-
"line":
|
|
5732
|
+
"line": 28
|
|
5783
5733
|
},
|
|
5784
5734
|
"name": "resourceIdentifier",
|
|
5785
5735
|
"optional": true,
|
|
@@ -5795,7 +5745,7 @@
|
|
|
5795
5745
|
"immutable": true,
|
|
5796
5746
|
"locationInModule": {
|
|
5797
5747
|
"filename": "lib/replication_instance.ts",
|
|
5798
|
-
"line":
|
|
5748
|
+
"line": 29
|
|
5799
5749
|
},
|
|
5800
5750
|
"name": "tags",
|
|
5801
5751
|
"optional": true,
|
|
@@ -5816,7 +5766,7 @@
|
|
|
5816
5766
|
"immutable": true,
|
|
5817
5767
|
"locationInModule": {
|
|
5818
5768
|
"filename": "lib/replication_instance.ts",
|
|
5819
|
-
"line":
|
|
5769
|
+
"line": 30
|
|
5820
5770
|
},
|
|
5821
5771
|
"name": "vpcSecurityGroupIds",
|
|
5822
5772
|
"optional": true,
|
|
@@ -5836,29 +5786,27 @@
|
|
|
5836
5786
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
5837
5787
|
"datatype": true,
|
|
5838
5788
|
"docs": {
|
|
5839
|
-
"remarks": "
|
|
5789
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
5840
5790
|
"stability": "experimental",
|
|
5841
|
-
"summary": "
|
|
5791
|
+
"summary": "Provides information that defines a Microsoft SQL Server endpoint."
|
|
5842
5792
|
},
|
|
5843
5793
|
"fqn": "@aws-mdaa/dms-constructs.MicrosoftSqlServerSettingsProperty",
|
|
5844
5794
|
"kind": "interface",
|
|
5845
5795
|
"locationInModule": {
|
|
5846
5796
|
"filename": "lib/endpoint.ts",
|
|
5847
|
-
"line":
|
|
5797
|
+
"line": 440
|
|
5848
5798
|
},
|
|
5849
5799
|
"name": "MicrosoftSqlServerSettingsProperty",
|
|
5850
5800
|
"properties": [
|
|
5851
5801
|
{
|
|
5852
5802
|
"abstract": true,
|
|
5853
5803
|
"docs": {
|
|
5854
|
-
"
|
|
5855
|
-
"stability": "experimental",
|
|
5856
|
-
"summary": "Q-ENHANCED-PROPERTY Required Secrets Manager secret ARN containing SQL Server endpoint connection details enabling secure credential storage for database connectivity."
|
|
5804
|
+
"stability": "experimental"
|
|
5857
5805
|
},
|
|
5858
5806
|
"immutable": true,
|
|
5859
5807
|
"locationInModule": {
|
|
5860
5808
|
"filename": "lib/endpoint.ts",
|
|
5861
|
-
"line":
|
|
5809
|
+
"line": 456
|
|
5862
5810
|
},
|
|
5863
5811
|
"name": "secretsManagerSecretArn",
|
|
5864
5812
|
"type": {
|
|
@@ -5868,14 +5816,13 @@
|
|
|
5868
5816
|
{
|
|
5869
5817
|
"abstract": true,
|
|
5870
5818
|
"docs": {
|
|
5871
|
-
"remarks": "Defines the maximum packet size used for Bulk Copy Program (BCP) operations during SQL Server data migration for optimal network utilization and transfer performance.\n\nUse cases: SQL Server performance tuning; Bulk data transfer optimization; Network utilization; Migration performance\n\nAWS: DMS Microsoft SQL Server endpoint bcpPacketSize setting for BCP transfer optimization\n\nValidation: Must be valid packet size in bytes if provided; affects BCP transfer performance and network utilization\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-bcppacketsize",
|
|
5872
5819
|
"stability": "experimental",
|
|
5873
|
-
"summary": "
|
|
5820
|
+
"summary": "BCP packet size in bytes for SQL Server data transfer optimization enabling performance."
|
|
5874
5821
|
},
|
|
5875
5822
|
"immutable": true,
|
|
5876
5823
|
"locationInModule": {
|
|
5877
5824
|
"filename": "lib/endpoint.ts",
|
|
5878
|
-
"line":
|
|
5825
|
+
"line": 442
|
|
5879
5826
|
},
|
|
5880
5827
|
"name": "bcpPacketSize",
|
|
5881
5828
|
"optional": true,
|
|
@@ -5886,14 +5833,12 @@
|
|
|
5886
5833
|
{
|
|
5887
5834
|
"abstract": true,
|
|
5888
5835
|
"docs": {
|
|
5889
|
-
"
|
|
5890
|
-
"stability": "experimental",
|
|
5891
|
-
"summary": "Q-ENHANCED-PROPERTY Optional file group specification for DMS internal control tables enabling SQL Server storage organization and performance optimization."
|
|
5836
|
+
"stability": "experimental"
|
|
5892
5837
|
},
|
|
5893
5838
|
"immutable": true,
|
|
5894
5839
|
"locationInModule": {
|
|
5895
5840
|
"filename": "lib/endpoint.ts",
|
|
5896
|
-
"line":
|
|
5841
|
+
"line": 443
|
|
5897
5842
|
},
|
|
5898
5843
|
"name": "controlTablesFileGroup",
|
|
5899
5844
|
"optional": true,
|
|
@@ -5904,14 +5849,13 @@
|
|
|
5904
5849
|
{
|
|
5905
5850
|
"abstract": true,
|
|
5906
5851
|
"docs": {
|
|
5907
|
-
"remarks": "Defines the target database name within the SQL Server instance for focused migration operations and database-specific connectivity.\n\nUse cases: Database-specific migration; SQL Server database targeting; Multi-database instance management; Database connectivity\n\nAWS: DMS Microsoft SQL Server endpoint databaseName setting for specific database connectivity\n\nValidation: Must be valid SQL Server database name if provided; targets specific database within SQL Server instance\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-databasename",
|
|
5908
5852
|
"stability": "experimental",
|
|
5909
|
-
"summary": "
|
|
5853
|
+
"summary": "Database name for SQL Server endpoint connectivity enabling specific database targeting."
|
|
5910
5854
|
},
|
|
5911
5855
|
"immutable": true,
|
|
5912
5856
|
"locationInModule": {
|
|
5913
5857
|
"filename": "lib/endpoint.ts",
|
|
5914
|
-
"line":
|
|
5858
|
+
"line": 445
|
|
5915
5859
|
},
|
|
5916
5860
|
"name": "databaseName",
|
|
5917
5861
|
"optional": true,
|
|
@@ -5922,14 +5866,12 @@
|
|
|
5922
5866
|
{
|
|
5923
5867
|
"abstract": true,
|
|
5924
5868
|
"docs": {
|
|
5925
|
-
"
|
|
5926
|
-
"stability": "experimental",
|
|
5927
|
-
"summary": "Q-ENHANCED-PROPERTY Optional flag to force LOB lookup on inline LOB data enabling large object handling in SQL Server migration."
|
|
5869
|
+
"stability": "experimental"
|
|
5928
5870
|
},
|
|
5929
5871
|
"immutable": true,
|
|
5930
5872
|
"locationInModule": {
|
|
5931
5873
|
"filename": "lib/endpoint.ts",
|
|
5932
|
-
"line":
|
|
5874
|
+
"line": 446
|
|
5933
5875
|
},
|
|
5934
5876
|
"name": "forceLobLookup",
|
|
5935
5877
|
"optional": true,
|
|
@@ -5940,14 +5882,13 @@
|
|
|
5940
5882
|
{
|
|
5941
5883
|
"abstract": true,
|
|
5942
5884
|
"docs": {
|
|
5943
|
-
"remarks": "Defines the network port for SQL Server database connectivity allowing for non-standard port configurations and network security requirements.\n\nUse cases: Custom port configuration; Network security; SQL Server connectivity; Port management\n\nAWS: DMS Microsoft SQL Server endpoint port setting for database connectivity configuration\n\nValidation: Must be valid TCP port number if provided; enables custom SQL Server port connectivity\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-port",
|
|
5944
5885
|
"stability": "experimental",
|
|
5945
|
-
"summary": "
|
|
5886
|
+
"summary": "TCP port number for SQL Server endpoint connectivity enabling custom port configuration for."
|
|
5946
5887
|
},
|
|
5947
5888
|
"immutable": true,
|
|
5948
5889
|
"locationInModule": {
|
|
5949
5890
|
"filename": "lib/endpoint.ts",
|
|
5950
|
-
"line":
|
|
5891
|
+
"line": 449
|
|
5951
5892
|
},
|
|
5952
5893
|
"name": "port",
|
|
5953
5894
|
"optional": true,
|
|
@@ -5958,14 +5899,12 @@
|
|
|
5958
5899
|
{
|
|
5959
5900
|
"abstract": true,
|
|
5960
5901
|
"docs": {
|
|
5961
|
-
"
|
|
5962
|
-
"stability": "experimental",
|
|
5963
|
-
"summary": "Q-ENHANCED-PROPERTY Optional flag to query single Always On node in SQL Server Always On availability groups enabling optimized connectivity for high availability environments."
|
|
5902
|
+
"stability": "experimental"
|
|
5964
5903
|
},
|
|
5965
5904
|
"immutable": true,
|
|
5966
5905
|
"locationInModule": {
|
|
5967
5906
|
"filename": "lib/endpoint.ts",
|
|
5968
|
-
"line":
|
|
5907
|
+
"line": 450
|
|
5969
5908
|
},
|
|
5970
5909
|
"name": "querySingleAlwaysOnNode",
|
|
5971
5910
|
"optional": true,
|
|
@@ -5976,14 +5915,13 @@
|
|
|
5976
5915
|
{
|
|
5977
5916
|
"abstract": true,
|
|
5978
5917
|
"docs": {
|
|
5979
|
-
"remarks": "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.\n\nUse cases: Transaction log management; Log file growth control; Replication latency control; Backup-based replication\n\nAWS: DMS Microsoft SQL Server endpoint readBackupOnly setting for transaction log management\n\nValidation: Must be boolean value if provided; affects transaction log reading behavior and log file growth\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-readbackuponly",
|
|
5980
5918
|
"stability": "experimental",
|
|
5981
|
-
"summary": "
|
|
5919
|
+
"summary": "Flag to read changes only from transaction log backups enabling controlled transaction log."
|
|
5982
5920
|
},
|
|
5983
5921
|
"immutable": true,
|
|
5984
5922
|
"locationInModule": {
|
|
5985
5923
|
"filename": "lib/endpoint.ts",
|
|
5986
|
-
"line":
|
|
5924
|
+
"line": 452
|
|
5987
5925
|
},
|
|
5988
5926
|
"name": "readBackupOnly",
|
|
5989
5927
|
"optional": true,
|
|
@@ -5994,14 +5932,12 @@
|
|
|
5994
5932
|
{
|
|
5995
5933
|
"abstract": true,
|
|
5996
5934
|
"docs": {
|
|
5997
|
-
"
|
|
5998
|
-
"stability": "experimental",
|
|
5999
|
-
"summary": "Q-ENHANCED-PROPERTY Optional safeguard policy for transaction log truncation prevention enabling controlled log management in SQL Server replication."
|
|
5935
|
+
"stability": "experimental"
|
|
6000
5936
|
},
|
|
6001
5937
|
"immutable": true,
|
|
6002
5938
|
"locationInModule": {
|
|
6003
5939
|
"filename": "lib/endpoint.ts",
|
|
6004
|
-
"line":
|
|
5940
|
+
"line": 453
|
|
6005
5941
|
},
|
|
6006
5942
|
"name": "safeguardPolicy",
|
|
6007
5943
|
"optional": true,
|
|
@@ -6012,14 +5948,13 @@
|
|
|
6012
5948
|
{
|
|
6013
5949
|
"abstract": true,
|
|
6014
5950
|
"docs": {
|
|
6015
|
-
"remarks": "Defines the IAM role that DMS assumes to retrieve database credentials from Secrets Manager for SQL Server endpoint connectivity with role-based security.\n\nUse cases: Secure credential access; IAM role-based security; Secrets Manager integration; DMS authentication\n\nAWS: DMS Microsoft SQL Server endpoint secretsManagerAccessRoleArn setting for IAM role-based credential access\n\nValidation: Must be valid IAM role ARN if provided; role must have iam:PassRole and Secrets Manager access permissions\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanageraccessrolearn",
|
|
6016
5951
|
"stability": "experimental",
|
|
6017
|
-
"summary": "
|
|
5952
|
+
"summary": "IAM role ARN for DMS to access Secrets Manager secret containing SQL Server credentials."
|
|
6018
5953
|
},
|
|
6019
5954
|
"immutable": true,
|
|
6020
5955
|
"locationInModule": {
|
|
6021
5956
|
"filename": "lib/endpoint.ts",
|
|
6022
|
-
"line":
|
|
5957
|
+
"line": 455
|
|
6023
5958
|
},
|
|
6024
5959
|
"name": "secretsManagerAccessRoleArn",
|
|
6025
5960
|
"optional": true,
|
|
@@ -6030,14 +5965,13 @@
|
|
|
6030
5965
|
{
|
|
6031
5966
|
"abstract": true,
|
|
6032
5967
|
"docs": {
|
|
6033
|
-
"remarks": "Defines the KMS key used to encrypt the Secrets Manager secret that stores SQL Server endpoint credentials for additional security layer.\n\nUse cases: Credential encryption; Enhanced security; KMS integration; Secrets Manager encryption\n\nAWS: DMS Microsoft SQL Server endpoint secretsManagerSecretKMSArn setting for KMS encryption of credentials\n\nValidation: Must be valid KMS key ARN if provided; enables encryption of Secrets Manager secret containing credentials",
|
|
6034
5968
|
"stability": "experimental",
|
|
6035
|
-
"summary": "
|
|
5969
|
+
"summary": "KMS key ARN for encrypting Secrets Manager secret containing SQL Server credentials."
|
|
6036
5970
|
},
|
|
6037
5971
|
"immutable": true,
|
|
6038
5972
|
"locationInModule": {
|
|
6039
5973
|
"filename": "lib/endpoint.ts",
|
|
6040
|
-
"line":
|
|
5974
|
+
"line": 458
|
|
6041
5975
|
},
|
|
6042
5976
|
"name": "secretsManagerSecretKMSArn",
|
|
6043
5977
|
"optional": true,
|
|
@@ -6048,14 +5982,12 @@
|
|
|
6048
5982
|
{
|
|
6049
5983
|
"abstract": true,
|
|
6050
5984
|
"docs": {
|
|
6051
|
-
"
|
|
6052
|
-
"stability": "experimental",
|
|
6053
|
-
"summary": "Q-ENHANCED-PROPERTY Optional fully qualified domain name for SQL Server endpoint connectivity enabling precise server identification and network routing."
|
|
5985
|
+
"stability": "experimental"
|
|
6054
5986
|
},
|
|
6055
5987
|
"immutable": true,
|
|
6056
5988
|
"locationInModule": {
|
|
6057
5989
|
"filename": "lib/endpoint.ts",
|
|
6058
|
-
"line":
|
|
5990
|
+
"line": 459
|
|
6059
5991
|
},
|
|
6060
5992
|
"name": "serverName",
|
|
6061
5993
|
"optional": true,
|
|
@@ -6066,14 +5998,13 @@
|
|
|
6066
5998
|
{
|
|
6067
5999
|
"abstract": true,
|
|
6068
6000
|
"docs": {
|
|
6069
|
-
"remarks": "Defines the method for accessing transaction log data for change data capture operations, affecting CDC performance and resource utilization in SQL Server replication.\n\nUse cases: CDC optimization; Transaction log access; Change data capture; Replication performance\n\nAWS: DMS Microsoft SQL Server endpoint tlogAccessMode setting for CDC data access configuration\n\nValidation: Must be valid transaction log access mode if provided; affects CDC data fetching behavior and performance\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-tlogaccessmode",
|
|
6070
6001
|
"stability": "experimental",
|
|
6071
|
-
"summary": "
|
|
6002
|
+
"summary": "Transaction log access mode for CDC data fetching enabling optimized change data capture in."
|
|
6072
6003
|
},
|
|
6073
6004
|
"immutable": true,
|
|
6074
6005
|
"locationInModule": {
|
|
6075
6006
|
"filename": "lib/endpoint.ts",
|
|
6076
|
-
"line":
|
|
6007
|
+
"line": 461
|
|
6077
6008
|
},
|
|
6078
6009
|
"name": "tlogAccessMode",
|
|
6079
6010
|
"optional": true,
|
|
@@ -6084,14 +6015,12 @@
|
|
|
6084
6015
|
{
|
|
6085
6016
|
"abstract": true,
|
|
6086
6017
|
"docs": {
|
|
6087
|
-
"
|
|
6088
|
-
"stability": "experimental",
|
|
6089
|
-
"summary": "Q-ENHANCED-PROPERTY Optional flag to right-trim spaces in CHAR and NCHAR data types during SQL Server migration enabling data formatting consistency."
|
|
6018
|
+
"stability": "experimental"
|
|
6090
6019
|
},
|
|
6091
6020
|
"immutable": true,
|
|
6092
6021
|
"locationInModule": {
|
|
6093
6022
|
"filename": "lib/endpoint.ts",
|
|
6094
|
-
"line":
|
|
6023
|
+
"line": 462
|
|
6095
6024
|
},
|
|
6096
6025
|
"name": "trimSpaceInChar",
|
|
6097
6026
|
"optional": true,
|
|
@@ -6102,14 +6031,13 @@
|
|
|
6102
6031
|
{
|
|
6103
6032
|
"abstract": true,
|
|
6104
6033
|
"docs": {
|
|
6105
|
-
"remarks": "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.\n\nUse cases: Bulk data transfer optimization; Full-load performance; SQL Server migration optimization; High-volume data transfer\n\nAWS: DMS Microsoft SQL Server endpoint useBcpFullLoad setting for bulk copy optimization\n\nValidation: Must be boolean value if provided; affects full-load performance and identity column handling\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usebcpfullload",
|
|
6106
6034
|
"stability": "experimental",
|
|
6107
|
-
"summary": "
|
|
6035
|
+
"summary": "Flag to use BCP for full-load operations enabling optimized bulk data transfer in SQL Server migration."
|
|
6108
6036
|
},
|
|
6109
6037
|
"immutable": true,
|
|
6110
6038
|
"locationInModule": {
|
|
6111
6039
|
"filename": "lib/endpoint.ts",
|
|
6112
|
-
"line":
|
|
6040
|
+
"line": 464
|
|
6113
6041
|
},
|
|
6114
6042
|
"name": "useBcpFullLoad",
|
|
6115
6043
|
"optional": true,
|
|
@@ -6120,14 +6048,12 @@
|
|
|
6120
6048
|
{
|
|
6121
6049
|
"abstract": true,
|
|
6122
6050
|
"docs": {
|
|
6123
|
-
"
|
|
6124
|
-
"stability": "experimental",
|
|
6125
|
-
"summary": "Q-ENHANCED-PROPERTY Optional boolean flag to enable processing of third-party transaction log backups for SQL Server DMS migration enabling backup-based replication."
|
|
6051
|
+
"stability": "experimental"
|
|
6126
6052
|
},
|
|
6127
6053
|
"immutable": true,
|
|
6128
6054
|
"locationInModule": {
|
|
6129
6055
|
"filename": "lib/endpoint.ts",
|
|
6130
|
-
"line":
|
|
6056
|
+
"line": 465
|
|
6131
6057
|
},
|
|
6132
6058
|
"name": "useThirdPartyBackupDevice",
|
|
6133
6059
|
"optional": true,
|
|
@@ -6142,15 +6068,15 @@
|
|
|
6142
6068
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
6143
6069
|
"datatype": true,
|
|
6144
6070
|
"docs": {
|
|
6145
|
-
"remarks": "
|
|
6071
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
6146
6072
|
"stability": "experimental",
|
|
6147
|
-
"summary": "
|
|
6073
|
+
"summary": "Provides information that defines a MongoDB endpoint."
|
|
6148
6074
|
},
|
|
6149
6075
|
"fqn": "@aws-mdaa/dms-constructs.MongoDbSettingsProperty",
|
|
6150
6076
|
"kind": "interface",
|
|
6151
6077
|
"locationInModule": {
|
|
6152
6078
|
"filename": "lib/endpoint.ts",
|
|
6153
|
-
"line":
|
|
6079
|
+
"line": 301
|
|
6154
6080
|
},
|
|
6155
6081
|
"name": "MongoDbSettingsProperty",
|
|
6156
6082
|
"properties": [
|
|
@@ -6164,7 +6090,7 @@
|
|
|
6164
6090
|
"immutable": true,
|
|
6165
6091
|
"locationInModule": {
|
|
6166
6092
|
"filename": "lib/endpoint.ts",
|
|
6167
|
-
"line":
|
|
6093
|
+
"line": 332
|
|
6168
6094
|
},
|
|
6169
6095
|
"name": "secretsManagerSecretArn",
|
|
6170
6096
|
"type": {
|
|
@@ -6174,14 +6100,13 @@
|
|
|
6174
6100
|
{
|
|
6175
6101
|
"abstract": true,
|
|
6176
6102
|
"docs": {
|
|
6177
|
-
"remarks": "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.\n\nUse cases: MongoDB authentication; Version-specific auth; Database security; Connection authentication; MongoDB connectivity\n\nAWS: AWS DMS MongoDB endpoint authMechanism for authentication method specification and secure database access\n\nValidation: Must be valid MongoDB authentication mechanism if provided; version-dependent defaults; not used when AuthType is \"no\"",
|
|
6178
6103
|
"stability": "experimental",
|
|
6179
|
-
"summary": "
|
|
6104
|
+
"summary": "Authentication mechanism for MongoDB source endpoint access with version-specific defaults."
|
|
6180
6105
|
},
|
|
6181
6106
|
"immutable": true,
|
|
6182
6107
|
"locationInModule": {
|
|
6183
6108
|
"filename": "lib/endpoint.ts",
|
|
6184
|
-
"line":
|
|
6109
|
+
"line": 303
|
|
6185
6110
|
},
|
|
6186
6111
|
"name": "authMechanism",
|
|
6187
6112
|
"optional": true,
|
|
@@ -6192,14 +6117,13 @@
|
|
|
6192
6117
|
{
|
|
6193
6118
|
"abstract": true,
|
|
6194
6119
|
"docs": {
|
|
6195
|
-
"remarks": "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.\n\nUse cases: Authentication database; MongoDB auth context; Database-specific auth; Authentication scope; MongoDB security\n\nAWS: AWS DMS MongoDB endpoint authSource for authentication database specification and access control\n\nValidation: Must be valid MongoDB database name if provided; default \"admin\"; not used when AuthType is \"no\"",
|
|
6196
6120
|
"stability": "experimental",
|
|
6197
|
-
"summary": "
|
|
6121
|
+
"summary": "MongoDB database name for authentication with default \"admin\" database."
|
|
6198
6122
|
},
|
|
6199
6123
|
"immutable": true,
|
|
6200
6124
|
"locationInModule": {
|
|
6201
6125
|
"filename": "lib/endpoint.ts",
|
|
6202
|
-
"line":
|
|
6126
|
+
"line": 305
|
|
6203
6127
|
},
|
|
6204
6128
|
"name": "authSource",
|
|
6205
6129
|
"optional": true,
|
|
@@ -6210,14 +6134,13 @@
|
|
|
6210
6134
|
{
|
|
6211
6135
|
"abstract": true,
|
|
6212
6136
|
"docs": {
|
|
6213
|
-
"remarks": "Specifies authentication type with \"no\" disabling username/password requirements and allowing empty credentials, enabling flexible authentication configuration for MongoDB database connectivity and migration operations.\n\nUse cases: Authentication control; MongoDB security; Credential management; Access control; Database authentication\n\nAWS: AWS DMS MongoDB endpoint authType for authentication type specification and access control\n\nValidation: Must be valid authentication type if provided; \"no\" disables username/password requirements; controls MongoDB authentication",
|
|
6214
6137
|
"stability": "experimental",
|
|
6215
|
-
"summary": "
|
|
6138
|
+
"summary": "Authentication type for MongoDB source endpoint access control."
|
|
6216
6139
|
},
|
|
6217
6140
|
"immutable": true,
|
|
6218
6141
|
"locationInModule": {
|
|
6219
6142
|
"filename": "lib/endpoint.ts",
|
|
6220
|
-
"line":
|
|
6143
|
+
"line": 307
|
|
6221
6144
|
},
|
|
6222
6145
|
"name": "authType",
|
|
6223
6146
|
"optional": true,
|
|
@@ -6228,14 +6151,13 @@
|
|
|
6228
6151
|
{
|
|
6229
6152
|
"abstract": true,
|
|
6230
6153
|
"docs": {
|
|
6231
|
-
"remarks": "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.\n\nUse cases: Database scope; Migration target; MongoDB database selection; Data scope; Database specification\n\nAWS: AWS DMS MongoDB endpoint databaseName for migration database specification and scope definition\n\nValidation: Must be valid MongoDB database name if provided; defines migration scope and target database for operations",
|
|
6232
6154
|
"stability": "experimental",
|
|
6233
|
-
"summary": "
|
|
6155
|
+
"summary": "Database name on MongoDB source endpoint for migration scope specification."
|
|
6234
6156
|
},
|
|
6235
6157
|
"immutable": true,
|
|
6236
6158
|
"locationInModule": {
|
|
6237
6159
|
"filename": "lib/endpoint.ts",
|
|
6238
|
-
"line":
|
|
6160
|
+
"line": 309
|
|
6239
6161
|
},
|
|
6240
6162
|
"name": "databaseName",
|
|
6241
6163
|
"optional": true,
|
|
@@ -6246,14 +6168,13 @@
|
|
|
6246
6168
|
{
|
|
6247
6169
|
"abstract": true,
|
|
6248
6170
|
"docs": {
|
|
6249
|
-
"remarks": "Specifies document count for preview analysis with default 1000, used when NestingLevel is \"one\", enabling proper document structure analysis and table mode configuration.\n\nUse cases: Document analysis; Structure preview; Table mode configuration; Document organization; Schema analysis\n\nAWS: AWS DMS MongoDB endpoint docsToInvestigate for document structure analysis and table mode configuration\n\nValidation: Must be positive integer greater than 0 if provided; default 1000; used when NestingLevel is \"one\"",
|
|
6250
6171
|
"stability": "experimental",
|
|
6251
|
-
"summary": "
|
|
6172
|
+
"summary": "Number of documents to preview for document organization analysis when using table mode."
|
|
6252
6173
|
},
|
|
6253
6174
|
"immutable": true,
|
|
6254
6175
|
"locationInModule": {
|
|
6255
6176
|
"filename": "lib/endpoint.ts",
|
|
6256
|
-
"line":
|
|
6177
|
+
"line": 311
|
|
6257
6178
|
},
|
|
6258
6179
|
"name": "docsToInvestigate",
|
|
6259
6180
|
"optional": true,
|
|
@@ -6264,14 +6185,13 @@
|
|
|
6264
6185
|
{
|
|
6265
6186
|
"abstract": true,
|
|
6266
6187
|
"docs": {
|
|
6267
|
-
"remarks": "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.\n\nUse cases: Document ID extraction; Document mode; ID handling; Document configuration; MongoDB document processing\n\nAWS: AWS DMS MongoDB endpoint extractDocId for document ID extraction and document mode configuration\n\nValidation: Must be \"true\" or \"false\" if provided; default \"false\"; used when NestingLevel is \"none\"",
|
|
6268
6188
|
"stability": "experimental",
|
|
6269
|
-
"summary": "
|
|
6189
|
+
"summary": "Flag to specify document ID extraction when using document mode."
|
|
6270
6190
|
},
|
|
6271
6191
|
"immutable": true,
|
|
6272
6192
|
"locationInModule": {
|
|
6273
6193
|
"filename": "lib/endpoint.ts",
|
|
6274
|
-
"line":
|
|
6194
|
+
"line": 313
|
|
6275
6195
|
},
|
|
6276
6196
|
"name": "extractDocId",
|
|
6277
6197
|
"optional": true,
|
|
@@ -6282,14 +6202,13 @@
|
|
|
6282
6202
|
{
|
|
6283
6203
|
"abstract": true,
|
|
6284
6204
|
"docs": {
|
|
6285
|
-
"remarks": "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.\n\nUse cases: Migration mode; Document processing; Table mode; Document mode; MongoDB structure handling\n\nAWS: AWS DMS MongoDB endpoint nestingLevel for migration mode specification and document processing control\n\nValidation: Must be \"none\" or \"one\" if provided; default \"none\"; \"none\" uses document mode, \"one\" uses table mode",
|
|
6286
6205
|
"stability": "experimental",
|
|
6287
|
-
"summary": "
|
|
6206
|
+
"summary": "Nesting level specification for document or table mode selection."
|
|
6288
6207
|
},
|
|
6289
6208
|
"immutable": true,
|
|
6290
6209
|
"locationInModule": {
|
|
6291
6210
|
"filename": "lib/endpoint.ts",
|
|
6292
|
-
"line":
|
|
6211
|
+
"line": 315
|
|
6293
6212
|
},
|
|
6294
6213
|
"name": "nestingLevel",
|
|
6295
6214
|
"optional": true,
|
|
@@ -6307,7 +6226,7 @@
|
|
|
6307
6226
|
"immutable": true,
|
|
6308
6227
|
"locationInModule": {
|
|
6309
6228
|
"filename": "lib/endpoint.ts",
|
|
6310
|
-
"line":
|
|
6229
|
+
"line": 321
|
|
6311
6230
|
},
|
|
6312
6231
|
"name": "port",
|
|
6313
6232
|
"optional": true,
|
|
@@ -6325,7 +6244,7 @@
|
|
|
6325
6244
|
"immutable": true,
|
|
6326
6245
|
"locationInModule": {
|
|
6327
6246
|
"filename": "lib/endpoint.ts",
|
|
6328
|
-
"line":
|
|
6247
|
+
"line": 327
|
|
6329
6248
|
},
|
|
6330
6249
|
"name": "secretsManagerAccessRoleArn",
|
|
6331
6250
|
"optional": true,
|
|
@@ -6342,7 +6261,7 @@
|
|
|
6342
6261
|
"immutable": true,
|
|
6343
6262
|
"locationInModule": {
|
|
6344
6263
|
"filename": "lib/endpoint.ts",
|
|
6345
|
-
"line":
|
|
6264
|
+
"line": 336
|
|
6346
6265
|
},
|
|
6347
6266
|
"name": "secretsManagerSecretKMSArn",
|
|
6348
6267
|
"optional": true,
|
|
@@ -6360,7 +6279,7 @@
|
|
|
6360
6279
|
"immutable": true,
|
|
6361
6280
|
"locationInModule": {
|
|
6362
6281
|
"filename": "lib/endpoint.ts",
|
|
6363
|
-
"line":
|
|
6282
|
+
"line": 341
|
|
6364
6283
|
},
|
|
6365
6284
|
"name": "serverName",
|
|
6366
6285
|
"optional": true,
|
|
@@ -6375,29 +6294,28 @@
|
|
|
6375
6294
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
6376
6295
|
"datatype": true,
|
|
6377
6296
|
"docs": {
|
|
6378
|
-
"remarks": "
|
|
6297
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
6379
6298
|
"stability": "experimental",
|
|
6380
|
-
"summary": "
|
|
6299
|
+
"summary": "Provides information that defines a MySQL endpoint."
|
|
6381
6300
|
},
|
|
6382
6301
|
"fqn": "@aws-mdaa/dms-constructs.MySqlSettingsProperty",
|
|
6383
6302
|
"kind": "interface",
|
|
6384
6303
|
"locationInModule": {
|
|
6385
6304
|
"filename": "lib/endpoint.ts",
|
|
6386
|
-
"line":
|
|
6305
|
+
"line": 103
|
|
6387
6306
|
},
|
|
6388
6307
|
"name": "MySqlSettingsProperty",
|
|
6389
6308
|
"properties": [
|
|
6390
6309
|
{
|
|
6391
6310
|
"abstract": true,
|
|
6392
6311
|
"docs": {
|
|
6393
|
-
"remarks": "Specifies the full ARN of the secret containing MySQL database connection information including credentials, enabling secure storage and access of MySQL endpoint authentication details.\n\nUse cases: Secure credential storage; MySQL authentication; Secrets Manager integration; Database connection security; Credential management\n\nAWS: AWS Secrets Manager secret ARN containing MySQL endpoint connection details and credentials\n\nValidation: Must be valid Secrets Manager secret ARN; required for secure MySQL endpoint credential management and authentication",
|
|
6394
6312
|
"stability": "experimental",
|
|
6395
|
-
"summary": "
|
|
6313
|
+
"summary": "Secrets Manager secret ARN containing MySQL endpoint connection details for secure credential management."
|
|
6396
6314
|
},
|
|
6397
6315
|
"immutable": true,
|
|
6398
6316
|
"locationInModule": {
|
|
6399
6317
|
"filename": "lib/endpoint.ts",
|
|
6400
|
-
"line":
|
|
6318
|
+
"line": 117
|
|
6401
6319
|
},
|
|
6402
6320
|
"name": "secretsManagerSecretArn",
|
|
6403
6321
|
"type": {
|
|
@@ -6407,14 +6325,13 @@
|
|
|
6407
6325
|
{
|
|
6408
6326
|
"abstract": true,
|
|
6409
6327
|
"docs": {
|
|
6410
|
-
"remarks": "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.\n\nUse cases: Database initialization; Connection setup; Custom configuration; Post-connection tasks; Database preparation\n\nAWS: AWS DMS MySQL endpoint afterConnectScript for post-connection initialization and setup\n\nValidation: Must be valid SQL script code if provided; script content not filename; migration continues regardless of execution result",
|
|
6411
6328
|
"stability": "experimental",
|
|
6412
|
-
"summary": "
|
|
6329
|
+
"summary": "SQL script to execute immediately after DMS connects to the MySQL endpoint for initialization tasks."
|
|
6413
6330
|
},
|
|
6414
6331
|
"immutable": true,
|
|
6415
6332
|
"locationInModule": {
|
|
6416
6333
|
"filename": "lib/endpoint.ts",
|
|
6417
|
-
"line":
|
|
6334
|
+
"line": 105
|
|
6418
6335
|
},
|
|
6419
6336
|
"name": "afterConnectScript",
|
|
6420
6337
|
"optional": true,
|
|
@@ -6425,14 +6342,13 @@
|
|
|
6425
6342
|
{
|
|
6426
6343
|
"abstract": true,
|
|
6427
6344
|
"docs": {
|
|
6428
|
-
"remarks": "Handles situations where DDL operations cause cached table metadata differences on the replication instance, ensuring metadata consistency during MySQL database migration and replication operations.\n\nUse cases: Metadata consistency; DDL handling; Cache management; Replication reliability; Table structure synchronization\n\nAWS: AWS DMS MySQL endpoint cleanSourceMetadataOnMismatch for metadata consistency and cache management\n\nValidation: Must be boolean value if provided; enables automatic metadata cleanup and recreation on mismatch detection",
|
|
6429
6345
|
"stability": "experimental",
|
|
6430
|
-
"summary": "
|
|
6346
|
+
"summary": "Flag to clean and recreate table metadata on replication instance when mismatches occur."
|
|
6431
6347
|
},
|
|
6432
6348
|
"immutable": true,
|
|
6433
6349
|
"locationInModule": {
|
|
6434
6350
|
"filename": "lib/endpoint.ts",
|
|
6435
|
-
"line":
|
|
6351
|
+
"line": 107
|
|
6436
6352
|
},
|
|
6437
6353
|
"name": "cleanSourceMetadataOnMismatch",
|
|
6438
6354
|
"optional": true,
|
|
@@ -6443,14 +6359,13 @@
|
|
|
6443
6359
|
{
|
|
6444
6360
|
"abstract": true,
|
|
6445
6361
|
"docs": {
|
|
6446
|
-
"remarks": "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.\n\nUse cases: Change detection; Polling frequency; Performance tuning; Idle monitoring; Binary log processing\n\nAWS: AWS DMS MySQL endpoint eventsPollInterval for binary log change detection frequency\n\nValidation: Must be positive integer in seconds if provided; default 5 seconds; affects change detection latency and resource usage",
|
|
6447
6362
|
"stability": "experimental",
|
|
6448
|
-
"summary": "
|
|
6363
|
+
"summary": "Polling interval in seconds for checking MySQL binary log changes when database is idle."
|
|
6449
6364
|
},
|
|
6450
6365
|
"immutable": true,
|
|
6451
6366
|
"locationInModule": {
|
|
6452
6367
|
"filename": "lib/endpoint.ts",
|
|
6453
|
-
"line":
|
|
6368
|
+
"line": 109
|
|
6454
6369
|
},
|
|
6455
6370
|
"name": "eventsPollInterval",
|
|
6456
6371
|
"optional": true,
|
|
@@ -6461,14 +6376,13 @@
|
|
|
6461
6376
|
{
|
|
6462
6377
|
"abstract": true,
|
|
6463
6378
|
"docs": {
|
|
6464
|
-
"remarks": "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.\n\nUse cases: File size control; Bulk data transfer; Performance optimization; Memory management; CSV processing\n\nAWS: AWS DMS MySQL endpoint maxFileSize for CSV file size limits in data transfer operations\n\nValidation: Must be positive integer in KB if provided; controls CSV file size for MySQL data transfer operations",
|
|
6465
6379
|
"stability": "experimental",
|
|
6466
|
-
"summary": "
|
|
6380
|
+
"summary": "Maximum CSV file size in KB for MySQL data transfer operations."
|
|
6467
6381
|
},
|
|
6468
6382
|
"immutable": true,
|
|
6469
6383
|
"locationInModule": {
|
|
6470
6384
|
"filename": "lib/endpoint.ts",
|
|
6471
|
-
"line":
|
|
6385
|
+
"line": 111
|
|
6472
6386
|
},
|
|
6473
6387
|
"name": "maxFileSize",
|
|
6474
6388
|
"optional": true,
|
|
@@ -6479,14 +6393,13 @@
|
|
|
6479
6393
|
{
|
|
6480
6394
|
"abstract": true,
|
|
6481
6395
|
"docs": {
|
|
6482
|
-
"remarks": "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.\n\nUse cases: Performance optimization; Parallel loading; Thread configuration; MySQL target optimization; Load balancing\n\nAWS: AWS DMS MySQL endpoint parallelLoadThreads for parallel data loading performance optimization\n\nValidation: Must be positive integer if provided; default 1; higher values may impact database performance due to connection overhead",
|
|
6483
6396
|
"stability": "experimental",
|
|
6484
|
-
"summary": "
|
|
6397
|
+
"summary": "Number of parallel threads for loading data into MySQL-compatible target databases for."
|
|
6485
6398
|
},
|
|
6486
6399
|
"immutable": true,
|
|
6487
6400
|
"locationInModule": {
|
|
6488
6401
|
"filename": "lib/endpoint.ts",
|
|
6489
|
-
"line":
|
|
6402
|
+
"line": 113
|
|
6490
6403
|
},
|
|
6491
6404
|
"name": "parallelLoadThreads",
|
|
6492
6405
|
"optional": true,
|
|
@@ -6497,14 +6410,13 @@
|
|
|
6497
6410
|
{
|
|
6498
6411
|
"abstract": true,
|
|
6499
6412
|
"docs": {
|
|
6500
|
-
"remarks": "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.\n\nUse cases: Credential management; Secrets Manager integration; Secure access; IAM role configuration; MySQL authentication\n\nAWS: AWS IAM role ARN for Secrets Manager access to MySQL endpoint credentials and authentication\n\nValidation: Must be valid IAM role ARN if provided; requires iam:PassRole action and Secrets Manager access permissions",
|
|
6501
6413
|
"stability": "experimental",
|
|
6502
|
-
"summary": "
|
|
6414
|
+
"summary": "IAM role ARN for AWS Secrets Manager access to MySQL endpoint credentials."
|
|
6503
6415
|
},
|
|
6504
6416
|
"immutable": true,
|
|
6505
6417
|
"locationInModule": {
|
|
6506
6418
|
"filename": "lib/endpoint.ts",
|
|
6507
|
-
"line":
|
|
6419
|
+
"line": 115
|
|
6508
6420
|
},
|
|
6509
6421
|
"name": "secretsManagerAccessRoleArn",
|
|
6510
6422
|
"optional": true,
|
|
@@ -6515,14 +6427,13 @@
|
|
|
6515
6427
|
{
|
|
6516
6428
|
"abstract": true,
|
|
6517
6429
|
"docs": {
|
|
6518
|
-
"remarks": "Specifies the KMS key used to encrypt the credentials secret, providing additional encryption layer for MySQL endpoint authentication information stored in AWS Secrets Manager.\n\nUse cases: Credential encryption; KMS integration; Enhanced security; Secret encryption; MySQL credential protection\n\nAWS: AWS KMS key ARN for encrypting Secrets Manager secret containing MySQL endpoint credentials\n\nValidation: Must be valid KMS key ARN if provided; provides additional encryption for MySQL credentials in Secrets Manager",
|
|
6519
6430
|
"stability": "experimental",
|
|
6520
|
-
"summary": "
|
|
6431
|
+
"summary": "KMS key ARN for encrypting MySQL endpoint credentials secret in Secrets Manager."
|
|
6521
6432
|
},
|
|
6522
6433
|
"immutable": true,
|
|
6523
6434
|
"locationInModule": {
|
|
6524
6435
|
"filename": "lib/endpoint.ts",
|
|
6525
|
-
"line":
|
|
6436
|
+
"line": 119
|
|
6526
6437
|
},
|
|
6527
6438
|
"name": "secretsManagerSecretKMSArn",
|
|
6528
6439
|
"optional": true,
|
|
@@ -6533,14 +6444,13 @@
|
|
|
6533
6444
|
{
|
|
6534
6445
|
"abstract": true,
|
|
6535
6446
|
"docs": {
|
|
6536
|
-
"remarks": "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.\n\nUse cases: Time zone configuration; Timestamp handling; Data consistency; MySQL configuration; Time zone conversion\n\nAWS: AWS DMS MySQL endpoint serverTimezone for source database time zone configuration\n\nValidation: Must be valid time zone string if provided; do not enclose in single quotes; affects timestamp data handling",
|
|
6537
6447
|
"stability": "experimental",
|
|
6538
|
-
"summary": "
|
|
6448
|
+
"summary": "Time zone specification for MySQL source database configuration."
|
|
6539
6449
|
},
|
|
6540
6450
|
"immutable": true,
|
|
6541
6451
|
"locationInModule": {
|
|
6542
6452
|
"filename": "lib/endpoint.ts",
|
|
6543
|
-
"line":
|
|
6453
|
+
"line": 121
|
|
6544
6454
|
},
|
|
6545
6455
|
"name": "serverTimezone",
|
|
6546
6456
|
"optional": true,
|
|
@@ -6551,14 +6461,13 @@
|
|
|
6551
6461
|
{
|
|
6552
6462
|
"abstract": true,
|
|
6553
6463
|
"docs": {
|
|
6554
|
-
"remarks": "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.\n\nUse cases: Database structure preservation; Migration strategy; Target configuration; Database organization; Schema mapping\n\nAWS: AWS DMS MySQL endpoint targetDbType for target database structure and migration destination configuration\n\nValidation: Must be valid target type if provided; SPECIFIC_DATABASE requires DatabaseName parameter; MULTIPLE_DATABASES preserves structure",
|
|
6555
6464
|
"stability": "experimental",
|
|
6556
|
-
"summary": "
|
|
6465
|
+
"summary": "Target database type specification for MySQL migration destination configuration."
|
|
6557
6466
|
},
|
|
6558
6467
|
"immutable": true,
|
|
6559
6468
|
"locationInModule": {
|
|
6560
6469
|
"filename": "lib/endpoint.ts",
|
|
6561
|
-
"line":
|
|
6470
|
+
"line": 123
|
|
6562
6471
|
},
|
|
6563
6472
|
"name": "targetDbType",
|
|
6564
6473
|
"optional": true,
|
|
@@ -6573,29 +6482,28 @@
|
|
|
6573
6482
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
6574
6483
|
"datatype": true,
|
|
6575
6484
|
"docs": {
|
|
6576
|
-
"remarks": "
|
|
6485
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
6577
6486
|
"stability": "experimental",
|
|
6578
|
-
"summary": "
|
|
6487
|
+
"summary": "Provides information that defines an Amazon Neptune endpoint."
|
|
6579
6488
|
},
|
|
6580
6489
|
"fqn": "@aws-mdaa/dms-constructs.NeptuneSettingsProperty",
|
|
6581
6490
|
"kind": "interface",
|
|
6582
6491
|
"locationInModule": {
|
|
6583
6492
|
"filename": "lib/endpoint.ts",
|
|
6584
|
-
"line":
|
|
6493
|
+
"line": 382
|
|
6585
6494
|
},
|
|
6586
6495
|
"name": "NeptuneSettingsProperty",
|
|
6587
6496
|
"properties": [
|
|
6588
6497
|
{
|
|
6589
6498
|
"abstract": true,
|
|
6590
6499
|
"docs": {
|
|
6591
|
-
"remarks": "Defines the S3 bucket where DMS stores CSV files containing graph data before bulk-loading to Neptune target database.\n\nUse cases: Graph data staging; Neptune migration storage; Temporary CSV storage; Bulk-load data preparation\n\nAWS: DMS Neptune endpoint s3BucketName setting for S3 staging bucket configuration\n\nValidation: Must be valid S3 bucket name; required for Neptune endpoint configuration; bucket must exist and be accessible\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketname",
|
|
6592
6500
|
"stability": "experimental",
|
|
6593
|
-
"summary": "
|
|
6501
|
+
"summary": "S3 bucket name for temporary storage of migrated graph data during DMS Neptune migration."
|
|
6594
6502
|
},
|
|
6595
6503
|
"immutable": true,
|
|
6596
6504
|
"locationInModule": {
|
|
6597
6505
|
"filename": "lib/endpoint.ts",
|
|
6598
|
-
"line":
|
|
6506
|
+
"line": 390
|
|
6599
6507
|
},
|
|
6600
6508
|
"name": "s3BucketName",
|
|
6601
6509
|
"type": {
|
|
@@ -6605,14 +6513,13 @@
|
|
|
6605
6513
|
{
|
|
6606
6514
|
"abstract": true,
|
|
6607
6515
|
"docs": {
|
|
6608
|
-
"remarks": "Defines the wait time before retrying failed bulk-load operations for migrated graph data to ensure reliable data transfer to Neptune.\n\nUse cases: Graph data migration resilience; Bulk-load error recovery; Neptune migration optimization; Retry configuration\n\nAWS: DMS Neptune endpoint errorRetryDuration setting for bulk-load retry timing configuration\n\nValidation: Must be positive integer in milliseconds; default is 250ms; controls retry timing for failed bulk operations\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-errorretryduration",
|
|
6609
6516
|
"stability": "experimental",
|
|
6610
|
-
"summary": "
|
|
6517
|
+
"summary": "Retry duration in milliseconds for DMS bulk-load operations to Neptune target database."
|
|
6611
6518
|
},
|
|
6612
6519
|
"immutable": true,
|
|
6613
6520
|
"locationInModule": {
|
|
6614
6521
|
"filename": "lib/endpoint.ts",
|
|
6615
|
-
"line":
|
|
6522
|
+
"line": 384
|
|
6616
6523
|
},
|
|
6617
6524
|
"name": "errorRetryDuration",
|
|
6618
6525
|
"optional": true,
|
|
@@ -6623,14 +6530,12 @@
|
|
|
6623
6530
|
{
|
|
6624
6531
|
"abstract": true,
|
|
6625
6532
|
"docs": {
|
|
6626
|
-
"
|
|
6627
|
-
"stability": "experimental",
|
|
6628
|
-
"summary": "Q-ENHANCED-PROPERTY 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."
|
|
6533
|
+
"stability": "experimental"
|
|
6629
6534
|
},
|
|
6630
6535
|
"immutable": true,
|
|
6631
6536
|
"locationInModule": {
|
|
6632
6537
|
"filename": "lib/endpoint.ts",
|
|
6633
|
-
"line":
|
|
6538
|
+
"line": 385
|
|
6634
6539
|
},
|
|
6635
6540
|
"name": "maxFileSize",
|
|
6636
6541
|
"optional": true,
|
|
@@ -6641,14 +6546,13 @@
|
|
|
6641
6546
|
{
|
|
6642
6547
|
"abstract": true,
|
|
6643
6548
|
"docs": {
|
|
6644
|
-
"remarks": "Defines the number of retry attempts for failed bulk-load operations before raising an error, ensuring reliable graph data transfer with controlled retry behavior.\n\nUse cases: Graph migration resilience; Bulk-load retry control; Neptune migration reliability; Error handling configuration\n\nAWS: DMS Neptune endpoint maxRetryCount setting for bulk-load retry attempt configuration\n\nValidation: Must be positive integer; default is 5 retries; controls maximum retry attempts for failed bulk operations\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxretrycount",
|
|
6645
6549
|
"stability": "experimental",
|
|
6646
|
-
"summary": "
|
|
6550
|
+
"summary": "Maximum retry count for DMS bulk-load operations to Neptune target database enabling."
|
|
6647
6551
|
},
|
|
6648
6552
|
"immutable": true,
|
|
6649
6553
|
"locationInModule": {
|
|
6650
6554
|
"filename": "lib/endpoint.ts",
|
|
6651
|
-
"line":
|
|
6555
|
+
"line": 387
|
|
6652
6556
|
},
|
|
6653
6557
|
"name": "maxRetryCount",
|
|
6654
6558
|
"optional": true,
|
|
@@ -6659,14 +6563,12 @@
|
|
|
6659
6563
|
{
|
|
6660
6564
|
"abstract": true,
|
|
6661
6565
|
"docs": {
|
|
6662
|
-
"
|
|
6663
|
-
"stability": "experimental",
|
|
6664
|
-
"summary": "Q-ENHANCED-PROPERTY Optional S3 bucket folder path for storing migrated graph data during DMS Neptune migration enabling organized data staging and processing."
|
|
6566
|
+
"stability": "experimental"
|
|
6665
6567
|
},
|
|
6666
6568
|
"immutable": true,
|
|
6667
6569
|
"locationInModule": {
|
|
6668
6570
|
"filename": "lib/endpoint.ts",
|
|
6669
|
-
"line":
|
|
6571
|
+
"line": 388
|
|
6670
6572
|
},
|
|
6671
6573
|
"name": "s3BucketFolder",
|
|
6672
6574
|
"optional": true,
|
|
@@ -6677,14 +6579,12 @@
|
|
|
6677
6579
|
{
|
|
6678
6580
|
"abstract": true,
|
|
6679
6581
|
"docs": {
|
|
6680
|
-
"
|
|
6681
|
-
"stability": "experimental",
|
|
6682
|
-
"summary": "Q-ENHANCED-PROPERTY Optional IAM service role ARN for DMS Neptune endpoint access enabling secure authentication and authorization for graph database operations."
|
|
6582
|
+
"stability": "experimental"
|
|
6683
6583
|
},
|
|
6684
6584
|
"immutable": true,
|
|
6685
6585
|
"locationInModule": {
|
|
6686
6586
|
"filename": "lib/endpoint.ts",
|
|
6687
|
-
"line":
|
|
6587
|
+
"line": 391
|
|
6688
6588
|
},
|
|
6689
6589
|
"name": "serviceAccessRoleArn",
|
|
6690
6590
|
"optional": true,
|
|
@@ -6699,29 +6599,28 @@
|
|
|
6699
6599
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
6700
6600
|
"datatype": true,
|
|
6701
6601
|
"docs": {
|
|
6702
|
-
"remarks": "
|
|
6602
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
6703
6603
|
"stability": "experimental",
|
|
6704
|
-
"summary": "
|
|
6604
|
+
"summary": "Provides information that defines an Oracle endpoint."
|
|
6705
6605
|
},
|
|
6706
6606
|
"fqn": "@aws-mdaa/dms-constructs.OracleSettingsProperty",
|
|
6707
6607
|
"kind": "interface",
|
|
6708
6608
|
"locationInModule": {
|
|
6709
6609
|
"filename": "lib/endpoint.ts",
|
|
6710
|
-
"line":
|
|
6610
|
+
"line": 30
|
|
6711
6611
|
},
|
|
6712
6612
|
"name": "OracleSettingsProperty",
|
|
6713
6613
|
"properties": [
|
|
6714
6614
|
{
|
|
6715
6615
|
"abstract": true,
|
|
6716
6616
|
"docs": {
|
|
6717
|
-
"remarks": "Specifies the full ARN of the secret containing Oracle database connection information including credentials, enabling secure storage and access of Oracle endpoint authentication details.\n\nUse cases: Secure credential storage; Oracle authentication; Secrets Manager integration; Database connection security; Credential management\n\nAWS: AWS Secrets Manager secret ARN containing Oracle endpoint connection details and credentials\n\nValidation: Must be valid Secrets Manager secret ARN; required for secure Oracle endpoint credential management and authentication",
|
|
6718
6617
|
"stability": "experimental",
|
|
6719
|
-
"summary": "
|
|
6618
|
+
"summary": "Secrets Manager secret ARN containing Oracle endpoint connection details for secure credential management."
|
|
6720
6619
|
},
|
|
6721
6620
|
"immutable": true,
|
|
6722
6621
|
"locationInModule": {
|
|
6723
6622
|
"filename": "lib/endpoint.ts",
|
|
6724
|
-
"line":
|
|
6623
|
+
"line": 78
|
|
6725
6624
|
},
|
|
6726
6625
|
"name": "secretsManagerSecretArn",
|
|
6727
6626
|
"type": {
|
|
@@ -6731,14 +6630,13 @@
|
|
|
6731
6630
|
{
|
|
6732
6631
|
"abstract": true,
|
|
6733
6632
|
"docs": {
|
|
6734
|
-
"remarks": "Controls whether DMS accesses redo logs directly or through specified path prefix replacement, affecting change data capture performance and configuration for Oracle database replication.\n\nUse cases: RDS Oracle configuration; Change data capture optimization; Direct file access control; Performance tuning; Oracle replication setup\n\nAWS: AWS DMS Oracle endpoint accessAlternateDirectly setting for redo log access configuration\n\nValidation: Must be boolean value if provided; affects Oracle change data capture behavior and performance",
|
|
6735
6633
|
"stability": "experimental",
|
|
6736
|
-
"summary": "
|
|
6634
|
+
"summary": "Flag to disable Binary Reader access to redo logs through direct file access for Oracle RDS sources."
|
|
6737
6635
|
},
|
|
6738
6636
|
"immutable": true,
|
|
6739
6637
|
"locationInModule": {
|
|
6740
6638
|
"filename": "lib/endpoint.ts",
|
|
6741
|
-
"line":
|
|
6639
|
+
"line": 32
|
|
6742
6640
|
},
|
|
6743
6641
|
"name": "accessAlternateDirectly",
|
|
6744
6642
|
"optional": true,
|
|
@@ -6749,14 +6647,13 @@
|
|
|
6749
6647
|
{
|
|
6750
6648
|
"abstract": true,
|
|
6751
6649
|
"docs": {
|
|
6752
|
-
"remarks": "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.\n\nUse cases: Oracle switchover; High availability; Standby database configuration; Archive log management; Disaster recovery\n\nAWS: AWS DMS Oracle endpoint additionalArchivedLogDestId for switchover archive log destination\n\nValidation: Must be valid integer destination ID if provided; used for Oracle switchover scenarios and archive log management",
|
|
6753
6650
|
"stability": "experimental",
|
|
6754
|
-
"summary": "
|
|
6651
|
+
"summary": "Additional archived log destination ID for Oracle primary/standby switchover scenarios."
|
|
6755
6652
|
},
|
|
6756
6653
|
"immutable": true,
|
|
6757
6654
|
"locationInModule": {
|
|
6758
6655
|
"filename": "lib/endpoint.ts",
|
|
6759
|
-
"line":
|
|
6656
|
+
"line": 34
|
|
6760
6657
|
},
|
|
6761
6658
|
"name": "additionalArchivedLogDestId",
|
|
6762
6659
|
"optional": true,
|
|
@@ -6767,14 +6664,13 @@
|
|
|
6767
6664
|
{
|
|
6768
6665
|
"abstract": true,
|
|
6769
6666
|
"docs": {
|
|
6770
|
-
"remarks": "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.\n\nUse cases: Supplemental logging; Change data capture; Table-level logging; Oracle migration; Primary key tracking\n\nAWS: AWS DMS Oracle endpoint addSupplementalLogging for table-level supplemental logging configuration\n\nValidation: Must be boolean value if provided; requires database-level supplemental logging to be enabled for proper operation",
|
|
6771
6667
|
"stability": "experimental",
|
|
6772
|
-
"summary": "
|
|
6668
|
+
"summary": "Flag to enable table-level supplemental logging for Oracle database migration tasks."
|
|
6773
6669
|
},
|
|
6774
6670
|
"immutable": true,
|
|
6775
6671
|
"locationInModule": {
|
|
6776
6672
|
"filename": "lib/endpoint.ts",
|
|
6777
|
-
"line":
|
|
6673
|
+
"line": 36
|
|
6778
6674
|
},
|
|
6779
6675
|
"name": "addSupplementalLogging",
|
|
6780
6676
|
"optional": true,
|
|
@@ -6785,14 +6681,13 @@
|
|
|
6785
6681
|
{
|
|
6786
6682
|
"abstract": true,
|
|
6787
6683
|
"docs": {
|
|
6788
|
-
"remarks": "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.\n\nUse cases: Complex schema migration; Nested table replication; User-defined types; Advanced Oracle features; Complex data structures\n\nAWS: AWS DMS Oracle endpoint allowSelectNestedTables for complex data type replication support\n\nValidation: Must be boolean value if provided; enables replication of Oracle nested tables and defined types",
|
|
6789
6684
|
"stability": "experimental",
|
|
6790
|
-
"summary": "
|
|
6685
|
+
"summary": "Flag to enable replication of Oracle tables with nested tables or defined types for complex."
|
|
6791
6686
|
},
|
|
6792
6687
|
"immutable": true,
|
|
6793
6688
|
"locationInModule": {
|
|
6794
6689
|
"filename": "lib/endpoint.ts",
|
|
6795
|
-
"line":
|
|
6690
|
+
"line": 38
|
|
6796
6691
|
},
|
|
6797
6692
|
"name": "allowSelectNestedTables",
|
|
6798
6693
|
"optional": true,
|
|
@@ -6803,14 +6698,13 @@
|
|
|
6803
6698
|
{
|
|
6804
6699
|
"abstract": true,
|
|
6805
6700
|
"docs": {
|
|
6806
|
-
"remarks": "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.\n\nUse cases: Archived log configuration; Performance optimization; Change data capture; Log destination management; Oracle replication tuning\n\nAWS: AWS DMS Oracle endpoint archivedLogDestId for archived redo log destination specification\n\nValidation: Must be valid integer matching Oracle v$archived_log dest_id; improves performance through correct log access",
|
|
6807
6701
|
"stability": "experimental",
|
|
6808
|
-
"summary": "
|
|
6702
|
+
"summary": "Archived redo log destination ID for Oracle change data capture configuration."
|
|
6809
6703
|
},
|
|
6810
6704
|
"immutable": true,
|
|
6811
6705
|
"locationInModule": {
|
|
6812
6706
|
"filename": "lib/endpoint.ts",
|
|
6813
|
-
"line":
|
|
6707
|
+
"line": 40
|
|
6814
6708
|
},
|
|
6815
6709
|
"name": "archivedLogDestId",
|
|
6816
6710
|
"optional": true,
|
|
@@ -6821,14 +6715,13 @@
|
|
|
6821
6715
|
{
|
|
6822
6716
|
"abstract": true,
|
|
6823
6717
|
"docs": {
|
|
6824
|
-
"remarks": "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.\n\nUse cases: Archived log only access; ASM storage; Controlled log access; Oracle security; Change data capture restriction\n\nAWS: AWS DMS Oracle endpoint archivedLogsOnly for restricted archived log access configuration\n\nValidation: Must be boolean value if provided; requires ASM privileges when archived logs are on ASM storage",
|
|
6825
6718
|
"stability": "experimental",
|
|
6826
|
-
"summary": "
|
|
6719
|
+
"summary": "Flag to restrict DMS access to archived redo logs only for Oracle replication."
|
|
6827
6720
|
},
|
|
6828
6721
|
"immutable": true,
|
|
6829
6722
|
"locationInModule": {
|
|
6830
6723
|
"filename": "lib/endpoint.ts",
|
|
6831
|
-
"line":
|
|
6724
|
+
"line": 42
|
|
6832
6725
|
},
|
|
6833
6726
|
"name": "archivedLogsOnly",
|
|
6834
6727
|
"optional": true,
|
|
@@ -6839,14 +6732,13 @@
|
|
|
6839
6732
|
{
|
|
6840
6733
|
"abstract": true,
|
|
6841
6734
|
"docs": {
|
|
6842
|
-
"remarks": "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.\n\nUse cases: ASM configuration; Binary Reader setup; Oracle ASM access; Storage management; Change data capture with ASM\n\nAWS: AWS DMS Oracle endpoint asmServer for ASM server address configuration with Binary Reader\n\nValidation: Must be valid ASM server address if provided; required for Oracle databases using ASM storage with Binary Reader",
|
|
6843
6735
|
"stability": "experimental",
|
|
6844
|
-
"summary": "
|
|
6736
|
+
"summary": "ASM server address for Oracle source endpoint Binary Reader configuration."
|
|
6845
6737
|
},
|
|
6846
6738
|
"immutable": true,
|
|
6847
6739
|
"locationInModule": {
|
|
6848
6740
|
"filename": "lib/endpoint.ts",
|
|
6849
|
-
"line":
|
|
6741
|
+
"line": 44
|
|
6850
6742
|
},
|
|
6851
6743
|
"name": "asmServer",
|
|
6852
6744
|
"optional": true,
|
|
@@ -6857,14 +6749,13 @@
|
|
|
6857
6749
|
{
|
|
6858
6750
|
"abstract": true,
|
|
6859
6751
|
"docs": {
|
|
6860
|
-
"remarks": "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.\n\nUse cases: Character encoding; Data type mapping; Character column handling; Oracle character semantics; Migration accuracy\n\nAWS: AWS DMS Oracle endpoint charLengthSemantics for character column length interpretation\n\nValidation: Must be 'CHAR' for character-based or default for byte-based; affects character column length calculation",
|
|
6861
6752
|
"stability": "experimental",
|
|
6862
|
-
"summary": "
|
|
6753
|
+
"summary": "Character length semantics specification for Oracle character column interpretation."
|
|
6863
6754
|
},
|
|
6864
6755
|
"immutable": true,
|
|
6865
6756
|
"locationInModule": {
|
|
6866
6757
|
"filename": "lib/endpoint.ts",
|
|
6867
|
-
"line":
|
|
6758
|
+
"line": 46
|
|
6868
6759
|
},
|
|
6869
6760
|
"name": "charLengthSemantics",
|
|
6870
6761
|
"optional": true,
|
|
@@ -6875,14 +6766,13 @@
|
|
|
6875
6766
|
{
|
|
6876
6767
|
"abstract": true,
|
|
6877
6768
|
"docs": {
|
|
6878
|
-
"remarks": "Increases commit rate on Oracle target databases by writing directly to tables without creating database log trails, improving performance for bulk data loading operations.\n\nUse cases: Performance optimization; Bulk loading; Direct path loading; Oracle target optimization; High-speed migration\n\nAWS: AWS DMS Oracle endpoint directPathNoLog for direct path loading without logging\n\nValidation: Must be boolean value if provided; improves performance but bypasses Oracle database logging mechanisms",
|
|
6879
6769
|
"stability": "experimental",
|
|
6880
|
-
"summary": "
|
|
6770
|
+
"summary": "Flag to enable direct path loading without database logging for Oracle target performance optimization."
|
|
6881
6771
|
},
|
|
6882
6772
|
"immutable": true,
|
|
6883
6773
|
"locationInModule": {
|
|
6884
6774
|
"filename": "lib/endpoint.ts",
|
|
6885
|
-
"line":
|
|
6775
|
+
"line": 48
|
|
6886
6776
|
},
|
|
6887
6777
|
"name": "directPathNoLog",
|
|
6888
6778
|
"optional": true,
|
|
@@ -6893,14 +6783,13 @@
|
|
|
6893
6783
|
{
|
|
6894
6784
|
"abstract": true,
|
|
6895
6785
|
"docs": {
|
|
6896
|
-
"remarks": "Enables parallel load operations when useDirectPathFullLoad is set, requiring target tables without constraints or indexes for maximum performance during bulk data migration.\n\nUse cases: Parallel loading; Performance optimization; Bulk migration; Direct path loading; High-speed data transfer\n\nAWS: AWS DMS Oracle endpoint directPathParallelLoad for parallel loading with direct path full load\n\nValidation: Must be boolean value if provided; requires useDirectPathFullLoad enabled and target tables without constraints/indexes",
|
|
6897
6786
|
"stability": "experimental",
|
|
6898
|
-
"summary": "
|
|
6787
|
+
"summary": "Flag to enable parallel loading when direct path full load is active for Oracle target."
|
|
6899
6788
|
},
|
|
6900
6789
|
"immutable": true,
|
|
6901
6790
|
"locationInModule": {
|
|
6902
6791
|
"filename": "lib/endpoint.ts",
|
|
6903
|
-
"line":
|
|
6792
|
+
"line": 50
|
|
6904
6793
|
},
|
|
6905
6794
|
"name": "directPathParallelLoad",
|
|
6906
6795
|
"optional": true,
|
|
@@ -6911,14 +6800,13 @@
|
|
|
6911
6800
|
{
|
|
6912
6801
|
"abstract": true,
|
|
6913
6802
|
"docs": {
|
|
6914
|
-
"remarks": "Creates existing tables and indexes under the same tablespace on the target database, maintaining Oracle tablespace organization and storage structure during migration operations.\n\nUse cases: Tablespace consistency; Oracle structure preservation; Storage organization; Database layout maintenance; Migration fidelity\n\nAWS: AWS DMS Oracle endpoint enableHomogenousTablespace for tablespace replication and consistency\n\nValidation: Must be boolean value if provided; maintains Oracle tablespace structure and organization on target database",
|
|
6915
6803
|
"stability": "experimental",
|
|
6916
|
-
"summary": "
|
|
6804
|
+
"summary": "Flag to enable homogeneous tablespace replication for Oracle target database consistency."
|
|
6917
6805
|
},
|
|
6918
6806
|
"immutable": true,
|
|
6919
6807
|
"locationInModule": {
|
|
6920
6808
|
"filename": "lib/endpoint.ts",
|
|
6921
|
-
"line":
|
|
6809
|
+
"line": 52
|
|
6922
6810
|
},
|
|
6923
6811
|
"name": "enableHomogenousTablespace",
|
|
6924
6812
|
"optional": true,
|
|
@@ -6929,14 +6817,13 @@
|
|
|
6929
6817
|
{
|
|
6930
6818
|
"abstract": true,
|
|
6931
6819
|
"docs": {
|
|
6932
|
-
"remarks": "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.\n\nUse cases: Data Guard switchover; Multiple standby configuration; Archive log management; High availability; Disaster recovery\n\nAWS: AWS DMS Oracle endpoint extraArchivedLogDestIds for multiple archived log destination configuration\n\nValidation: Must be array of valid integer destination IDs if provided; used with archivedLogDestId for switchover scenarios\n *",
|
|
6933
6820
|
"stability": "experimental",
|
|
6934
|
-
"summary": "
|
|
6821
|
+
"summary": "Array of additional archived log destination IDs for Oracle Data Guard switchover scenarios."
|
|
6935
6822
|
},
|
|
6936
6823
|
"immutable": true,
|
|
6937
6824
|
"locationInModule": {
|
|
6938
6825
|
"filename": "lib/endpoint.ts",
|
|
6939
|
-
"line":
|
|
6826
|
+
"line": 54
|
|
6940
6827
|
},
|
|
6941
6828
|
"name": "extraArchivedLogDestIds",
|
|
6942
6829
|
"optional": true,
|
|
@@ -6952,14 +6839,13 @@
|
|
|
6952
6839
|
{
|
|
6953
6840
|
"abstract": true,
|
|
6954
6841
|
"docs": {
|
|
6955
|
-
"remarks": "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.\n\nUse cases: Data integrity; LOB handling; Error handling; Data validation; Migration quality control\n\nAWS: AWS DMS Oracle endpoint failTasksOnLobTruncation for LOB size validation and error handling\n\nValidation: Must be boolean value if provided; causes task failure instead of LOB truncation when size limits exceeded",
|
|
6956
6842
|
"stability": "experimental",
|
|
6957
|
-
"summary": "
|
|
6843
|
+
"summary": "Flag to cause task failure when LOB column size exceeds specified LobMaxSize limit."
|
|
6958
6844
|
},
|
|
6959
6845
|
"immutable": true,
|
|
6960
6846
|
"locationInModule": {
|
|
6961
6847
|
"filename": "lib/endpoint.ts",
|
|
6962
|
-
"line":
|
|
6848
|
+
"line": 56
|
|
6963
6849
|
},
|
|
6964
6850
|
"name": "failTasksOnLobTruncation",
|
|
6965
6851
|
"optional": true,
|
|
@@ -6970,14 +6856,13 @@
|
|
|
6970
6856
|
{
|
|
6971
6857
|
"abstract": true,
|
|
6972
6858
|
"docs": {
|
|
6973
|
-
"remarks": "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.\n\nUse cases: Numeric precision; Data type conversion; Oracle NUMBER handling; Precision control; Migration accuracy\n\nAWS: AWS DMS Oracle endpoint numberDatatypeScale for NUMBER data type conversion precision\n\nValidation: Must be integer between 0-38 or FLOAT if provided; controls Oracle NUMBER data type conversion precision and scale",
|
|
6974
6859
|
"stability": "experimental",
|
|
6975
|
-
"summary": "
|
|
6860
|
+
"summary": "Number data type scale specification for Oracle NUMBER data type conversion precision."
|
|
6976
6861
|
},
|
|
6977
6862
|
"immutable": true,
|
|
6978
6863
|
"locationInModule": {
|
|
6979
6864
|
"filename": "lib/endpoint.ts",
|
|
6980
|
-
"line":
|
|
6865
|
+
"line": 58
|
|
6981
6866
|
},
|
|
6982
6867
|
"name": "numberDatatypeScale",
|
|
6983
6868
|
"optional": true,
|
|
@@ -6988,14 +6873,13 @@
|
|
|
6988
6873
|
{
|
|
6989
6874
|
"abstract": true,
|
|
6990
6875
|
"docs": {
|
|
6991
|
-
"remarks": "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.\n\nUse cases: Binary Reader configuration; Redo log access; RDS Oracle sources; Change data capture; Path configuration\n\nAWS: AWS DMS Oracle endpoint oraclePathPrefix for Binary Reader redo log access path specification\n\nValidation: Must be valid Oracle path string if provided; required for Binary Reader access to RDS Oracle redo logs",
|
|
6992
6876
|
"stability": "experimental",
|
|
6993
|
-
"summary": "
|
|
6877
|
+
"summary": "Oracle path prefix for Binary Reader redo log access configuration."
|
|
6994
6878
|
},
|
|
6995
6879
|
"immutable": true,
|
|
6996
6880
|
"locationInModule": {
|
|
6997
6881
|
"filename": "lib/endpoint.ts",
|
|
6998
|
-
"line":
|
|
6882
|
+
"line": 60
|
|
6999
6883
|
},
|
|
7000
6884
|
"name": "oraclePathPrefix",
|
|
7001
6885
|
"optional": true,
|
|
@@ -7006,14 +6890,13 @@
|
|
|
7006
6890
|
{
|
|
7007
6891
|
"abstract": true,
|
|
7008
6892
|
"docs": {
|
|
7009
|
-
"remarks": "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.\n\nUse cases: ASM performance; CDC optimization; Thread configuration; Parallel processing; Oracle ASM tuning\n\nAWS: AWS DMS Oracle endpoint parallelAsmReadThreads for ASM CDC performance optimization\n\nValidation: Must be integer between 2-8 if provided; used with readAheadBlocks for ASM performance tuning",
|
|
7010
6893
|
"stability": "experimental",
|
|
7011
|
-
"summary": "
|
|
6894
|
+
"summary": "Number of parallel ASM read threads for Oracle change data capture performance optimization."
|
|
7012
6895
|
},
|
|
7013
6896
|
"immutable": true,
|
|
7014
6897
|
"locationInModule": {
|
|
7015
6898
|
"filename": "lib/endpoint.ts",
|
|
7016
|
-
"line":
|
|
6899
|
+
"line": 62
|
|
7017
6900
|
},
|
|
7018
6901
|
"name": "parallelAsmReadThreads",
|
|
7019
6902
|
"optional": true,
|
|
@@ -7024,14 +6907,13 @@
|
|
|
7024
6907
|
{
|
|
7025
6908
|
"abstract": true,
|
|
7026
6909
|
"docs": {
|
|
7027
|
-
"remarks": "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.\n\nUse cases: ASM performance; CDC optimization; Block configuration; Read-ahead tuning; Oracle ASM optimization\n\nAWS: AWS DMS Oracle endpoint readAheadBlocks for ASM CDC read-ahead performance optimization\n\nValidation: Must be integer between 1000-200000 if provided; used with parallelAsmReadThreads for ASM performance tuning",
|
|
7028
6910
|
"stability": "experimental",
|
|
7029
|
-
"summary": "
|
|
6911
|
+
"summary": "Number of read-ahead blocks for Oracle ASM change data capture performance optimization."
|
|
7030
6912
|
},
|
|
7031
6913
|
"immutable": true,
|
|
7032
6914
|
"locationInModule": {
|
|
7033
6915
|
"filename": "lib/endpoint.ts",
|
|
7034
|
-
"line":
|
|
6916
|
+
"line": 64
|
|
7035
6917
|
},
|
|
7036
6918
|
"name": "readAheadBlocks",
|
|
7037
6919
|
"optional": true,
|
|
@@ -7042,14 +6924,13 @@
|
|
|
7042
6924
|
{
|
|
7043
6925
|
"abstract": true,
|
|
7044
6926
|
"docs": {
|
|
7045
|
-
"remarks": "Enables DMS to read and replicate tablespace information during Oracle database migration, supporting tablespace-aware migration and maintaining Oracle storage organization on target databases.\n\nUse cases: Tablespace replication; Storage organization; Oracle structure preservation; Tablespace awareness; Migration fidelity\n\nAWS: AWS DMS Oracle endpoint readTableSpaceName for tablespace replication and organization support\n\nValidation: Must be boolean value if provided; enables tablespace name reading and replication during Oracle migration",
|
|
7046
6927
|
"stability": "experimental",
|
|
7047
|
-
"summary": "
|
|
6928
|
+
"summary": "Flag to enable tablespace name reading for Oracle tablespace replication support."
|
|
7048
6929
|
},
|
|
7049
6930
|
"immutable": true,
|
|
7050
6931
|
"locationInModule": {
|
|
7051
6932
|
"filename": "lib/endpoint.ts",
|
|
7052
|
-
"line":
|
|
6933
|
+
"line": 66
|
|
7053
6934
|
},
|
|
7054
6935
|
"name": "readTableSpaceName",
|
|
7055
6936
|
"optional": true,
|
|
@@ -7060,14 +6941,13 @@
|
|
|
7060
6941
|
{
|
|
7061
6942
|
"abstract": true,
|
|
7062
6943
|
"docs": {
|
|
7063
|
-
"remarks": "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.\n\nUse cases: Path replacement; Binary Reader configuration; RDS Oracle access; Redo log path management; Change data capture setup\n\nAWS: AWS DMS Oracle endpoint replacePathPrefix for Binary Reader path replacement configuration\n\nValidation: Must be boolean value if provided; enables path prefix replacement for Binary Reader redo log access",
|
|
7064
6944
|
"stability": "experimental",
|
|
7065
|
-
"summary": "
|
|
6945
|
+
"summary": "Flag to enable path prefix replacement for Binary Reader redo log access."
|
|
7066
6946
|
},
|
|
7067
6947
|
"immutable": true,
|
|
7068
6948
|
"locationInModule": {
|
|
7069
6949
|
"filename": "lib/endpoint.ts",
|
|
7070
|
-
"line":
|
|
6950
|
+
"line": 68
|
|
7071
6951
|
},
|
|
7072
6952
|
"name": "replacePathPrefix",
|
|
7073
6953
|
"optional": true,
|
|
@@ -7078,14 +6958,13 @@
|
|
|
7078
6958
|
{
|
|
7079
6959
|
"abstract": true,
|
|
7080
6960
|
"docs": {
|
|
7081
|
-
"remarks": "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.\n\nUse cases: Connection resilience; Error recovery; Query retry; Oracle connectivity; Network reliability\n\nAWS: AWS DMS Oracle endpoint retryInterval for query retry timing and connection resilience\n\nValidation: Must be positive integer in seconds if provided; controls query retry timing for Oracle connection resilience",
|
|
7082
6961
|
"stability": "experimental",
|
|
7083
|
-
"summary": "
|
|
6962
|
+
"summary": "Retry interval in seconds for Oracle connection query retry operations."
|
|
7084
6963
|
},
|
|
7085
6964
|
"immutable": true,
|
|
7086
6965
|
"locationInModule": {
|
|
7087
6966
|
"filename": "lib/endpoint.ts",
|
|
7088
|
-
"line":
|
|
6967
|
+
"line": 70
|
|
7089
6968
|
},
|
|
7090
6969
|
"name": "retryInterval",
|
|
7091
6970
|
"optional": true,
|
|
@@ -7096,14 +6975,13 @@
|
|
|
7096
6975
|
{
|
|
7097
6976
|
"abstract": true,
|
|
7098
6977
|
"docs": {
|
|
7099
|
-
"remarks": "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.\n\nUse cases: Credential management; Secrets Manager integration; Secure access; IAM role configuration; Oracle authentication\n\nAWS: AWS IAM role ARN for Secrets Manager access to Oracle endpoint credentials and authentication\n\nValidation: Must be valid IAM role ARN if provided; requires iam:PassRole action and Secrets Manager access permissions",
|
|
7100
6978
|
"stability": "experimental",
|
|
7101
|
-
"summary": "
|
|
6979
|
+
"summary": "IAM role ARN for AWS Secrets Manager access to Oracle endpoint credentials."
|
|
7102
6980
|
},
|
|
7103
6981
|
"immutable": true,
|
|
7104
6982
|
"locationInModule": {
|
|
7105
6983
|
"filename": "lib/endpoint.ts",
|
|
7106
|
-
"line":
|
|
6984
|
+
"line": 72
|
|
7107
6985
|
},
|
|
7108
6986
|
"name": "secretsManagerAccessRoleArn",
|
|
7109
6987
|
"optional": true,
|
|
@@ -7114,14 +6992,13 @@
|
|
|
7114
6992
|
{
|
|
7115
6993
|
"abstract": true,
|
|
7116
6994
|
"docs": {
|
|
7117
|
-
"remarks": "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.\n\nUse cases: ASM credential management; Secrets Manager integration; Oracle ASM access; Secure ASM authentication; Advanced storage configuration\n\nAWS: AWS IAM role ARN for Secrets Manager access to Oracle ASM credentials and authentication\n\nValidation: Must be valid IAM role ARN if provided; required for Oracle endpoints using ASM; mutually exclusive with clear-text ASM credentials",
|
|
7118
6995
|
"stability": "experimental",
|
|
7119
|
-
"summary": "
|
|
6996
|
+
"summary": "IAM role ARN for AWS Secrets Manager access to Oracle ASM credentials when using Advanced Storage Manager."
|
|
7120
6997
|
},
|
|
7121
6998
|
"immutable": true,
|
|
7122
6999
|
"locationInModule": {
|
|
7123
7000
|
"filename": "lib/endpoint.ts",
|
|
7124
|
-
"line":
|
|
7001
|
+
"line": 74
|
|
7125
7002
|
},
|
|
7126
7003
|
"name": "secretsManagerOracleAsmAccessRoleArn",
|
|
7127
7004
|
"optional": true,
|
|
@@ -7132,14 +7009,13 @@
|
|
|
7132
7009
|
{
|
|
7133
7010
|
"abstract": true,
|
|
7134
7011
|
"docs": {
|
|
7135
|
-
"remarks": "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.\n\nUse cases: ASM secret storage; Secure ASM credentials; Oracle ASM configuration; Advanced storage authentication; Secret management\n\nAWS: AWS Secrets Manager secret ARN containing Oracle ASM connection details and credentials\n\nValidation: Must be valid Secrets Manager secret ARN if provided; required for Oracle endpoints using ASM with Secrets Manager",
|
|
7136
7012
|
"stability": "experimental",
|
|
7137
|
-
"summary": "
|
|
7013
|
+
"summary": "Secrets Manager secret ARN containing Oracle ASM connection details for Advanced Storage Manager endpoints."
|
|
7138
7014
|
},
|
|
7139
7015
|
"immutable": true,
|
|
7140
7016
|
"locationInModule": {
|
|
7141
7017
|
"filename": "lib/endpoint.ts",
|
|
7142
|
-
"line":
|
|
7018
|
+
"line": 76
|
|
7143
7019
|
},
|
|
7144
7020
|
"name": "secretsManagerOracleAsmSecretArn",
|
|
7145
7021
|
"optional": true,
|
|
@@ -7150,14 +7026,13 @@
|
|
|
7150
7026
|
{
|
|
7151
7027
|
"abstract": true,
|
|
7152
7028
|
"docs": {
|
|
7153
|
-
"remarks": "Specifies the KMS key used to encrypt the credentials secret, providing additional encryption layer for Oracle endpoint authentication information stored in AWS Secrets Manager.\n\nUse cases: Credential encryption; KMS integration; Enhanced security; Secret encryption; Oracle credential protection\n\nAWS: AWS KMS key ARN for encrypting Secrets Manager secret containing Oracle endpoint credentials\n\nValidation: Must be valid KMS key ARN if provided; provides additional encryption for Oracle credentials in Secrets Manager",
|
|
7154
7029
|
"stability": "experimental",
|
|
7155
|
-
"summary": "
|
|
7030
|
+
"summary": "KMS key ARN for encrypting Oracle endpoint credentials secret in Secrets Manager."
|
|
7156
7031
|
},
|
|
7157
7032
|
"immutable": true,
|
|
7158
7033
|
"locationInModule": {
|
|
7159
7034
|
"filename": "lib/endpoint.ts",
|
|
7160
|
-
"line":
|
|
7035
|
+
"line": 80
|
|
7161
7036
|
},
|
|
7162
7037
|
"name": "secretsManagerSecretKMSArn",
|
|
7163
7038
|
"optional": true,
|
|
@@ -7168,14 +7043,13 @@
|
|
|
7168
7043
|
{
|
|
7169
7044
|
"abstract": true,
|
|
7170
7045
|
"docs": {
|
|
7171
|
-
"remarks": "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.\n\nUse cases: Spatial data conversion; GEOJSON transformation; Oracle spatial types; Custom function usage; Spatial data migration\n\nAWS: AWS DMS Oracle endpoint spatial data conversion function for SDO_GEOMETRY to GEOJSON transformation\n\nValidation: Must be valid Oracle function name if provided; function must be accessible and mimic SDO2GEOJSON operation",
|
|
7172
7046
|
"stability": "experimental",
|
|
7173
|
-
"summary": "
|
|
7047
|
+
"summary": "Custom function name for converting Oracle SDO_GEOMETRY to GEOJSON format during spatial data migration."
|
|
7174
7048
|
},
|
|
7175
7049
|
"immutable": true,
|
|
7176
7050
|
"locationInModule": {
|
|
7177
7051
|
"filename": "lib/endpoint.ts",
|
|
7178
|
-
"line":
|
|
7052
|
+
"line": 82
|
|
7179
7053
|
},
|
|
7180
7054
|
"name": "spatialDataOptionToGeoJsonFunctionName",
|
|
7181
7055
|
"optional": true,
|
|
@@ -7186,14 +7060,13 @@
|
|
|
7186
7060
|
{
|
|
7187
7061
|
"abstract": true,
|
|
7188
7062
|
"docs": {
|
|
7189
|
-
"remarks": "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.\n\nUse cases: Active Data Guard; Standby replication; Production isolation; CDC from standby; Database synchronization delay\n\nAWS: AWS DMS Oracle endpoint standby delay configuration for Active Data Guard standby database replication\n\nValidation: Must be positive integer in minutes if provided; controls synchronization delay for Active Data Guard standby sources",
|
|
7190
7063
|
"stability": "experimental",
|
|
7191
|
-
"summary": "
|
|
7064
|
+
"summary": "Standby delay time in minutes for Oracle Active Data Guard standby database synchronization."
|
|
7192
7065
|
},
|
|
7193
7066
|
"immutable": true,
|
|
7194
7067
|
"locationInModule": {
|
|
7195
7068
|
"filename": "lib/endpoint.ts",
|
|
7196
|
-
"line":
|
|
7069
|
+
"line": 84
|
|
7197
7070
|
},
|
|
7198
7071
|
"name": "standbyDelayTime",
|
|
7199
7072
|
"optional": true,
|
|
@@ -7204,14 +7077,13 @@
|
|
|
7204
7077
|
{
|
|
7205
7078
|
"abstract": true,
|
|
7206
7079
|
"docs": {
|
|
7207
|
-
"remarks": "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.\n\nUse cases: Binary Reader configuration; Online redo log access; RDS Oracle sources; Prefix replacement; Change data capture optimization\n\nAWS: AWS DMS Oracle endpoint useAlternateFolderForOnline for Binary Reader online redo log access configuration\n\nValidation: Must be boolean value if provided; enables alternate folder usage for Binary Reader online redo log access",
|
|
7208
7080
|
"stability": "experimental",
|
|
7209
|
-
"summary": "
|
|
7081
|
+
"summary": "Flag to enable alternate folder usage for online redo logs with Binary Reader for Oracle RDS sources."
|
|
7210
7082
|
},
|
|
7211
7083
|
"immutable": true,
|
|
7212
7084
|
"locationInModule": {
|
|
7213
7085
|
"filename": "lib/endpoint.ts",
|
|
7214
|
-
"line":
|
|
7086
|
+
"line": 86
|
|
7215
7087
|
},
|
|
7216
7088
|
"name": "useAlternateFolderForOnline",
|
|
7217
7089
|
"optional": true,
|
|
@@ -7222,14 +7094,13 @@
|
|
|
7222
7094
|
{
|
|
7223
7095
|
"abstract": true,
|
|
7224
7096
|
"docs": {
|
|
7225
|
-
"remarks": "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.\n\nUse cases: Binary Reader CDC; Alternative log access; Oracle ASM support; RDS Oracle configuration; Change data capture method selection\n\nAWS: AWS DMS Oracle endpoint useBFile for Binary Reader utility change data capture configuration\n\nValidation: Must be boolean value if provided; requires UseLogminerReader set to false; additional attributes needed for RDS Oracle",
|
|
7226
7097
|
"stability": "experimental",
|
|
7227
|
-
"summary": "
|
|
7098
|
+
"summary": "Flag to enable Binary Reader utility for Oracle change data capture operations."
|
|
7228
7099
|
},
|
|
7229
7100
|
"immutable": true,
|
|
7230
7101
|
"locationInModule": {
|
|
7231
7102
|
"filename": "lib/endpoint.ts",
|
|
7232
|
-
"line":
|
|
7103
|
+
"line": 88
|
|
7233
7104
|
},
|
|
7234
7105
|
"name": "useBFile",
|
|
7235
7106
|
"optional": true,
|
|
@@ -7240,14 +7111,13 @@
|
|
|
7240
7111
|
{
|
|
7241
7112
|
"abstract": true,
|
|
7242
7113
|
"docs": {
|
|
7243
|
-
"remarks": "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.\n\nUse cases: Performance optimization; Bulk loading; Full load acceleration; Oracle target optimization; Large data migration\n\nAWS: AWS DMS Oracle endpoint useDirectPathFullLoad for direct path protocol bulk loading optimization\n\nValidation: Must be boolean value if provided; enables OCI direct path protocol for bulk-loading Oracle target tables",
|
|
7244
7114
|
"stability": "experimental",
|
|
7245
|
-
"summary": "
|
|
7115
|
+
"summary": "Flag to enable direct path full load for Oracle target database performance optimization."
|
|
7246
7116
|
},
|
|
7247
7117
|
"immutable": true,
|
|
7248
7118
|
"locationInModule": {
|
|
7249
7119
|
"filename": "lib/endpoint.ts",
|
|
7250
|
-
"line":
|
|
7120
|
+
"line": 90
|
|
7251
7121
|
},
|
|
7252
7122
|
"name": "useDirectPathFullLoad",
|
|
7253
7123
|
"optional": true,
|
|
@@ -7258,14 +7128,13 @@
|
|
|
7258
7128
|
{
|
|
7259
7129
|
"abstract": true,
|
|
7260
7130
|
"docs": {
|
|
7261
|
-
"remarks": "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.\n\nUse cases: LogMiner CDC; Standard log access; Change data capture method; Oracle replication; Log access method selection\n\nAWS: AWS DMS Oracle endpoint useLogminerReader for LogMiner utility change data capture configuration\n\nValidation: Must be boolean value if provided; default true for LogMiner; set false to enable Binary Reader with useBFile",
|
|
7262
7131
|
"stability": "experimental",
|
|
7263
|
-
"summary": "
|
|
7132
|
+
"summary": "Flag to enable Oracle LogMiner utility for change data capture operations (default method)."
|
|
7264
7133
|
},
|
|
7265
7134
|
"immutable": true,
|
|
7266
7135
|
"locationInModule": {
|
|
7267
7136
|
"filename": "lib/endpoint.ts",
|
|
7268
|
-
"line":
|
|
7137
|
+
"line": 92
|
|
7269
7138
|
},
|
|
7270
7139
|
"name": "useLogminerReader",
|
|
7271
7140
|
"optional": true,
|
|
@@ -7276,14 +7145,13 @@
|
|
|
7276
7145
|
{
|
|
7277
7146
|
"abstract": true,
|
|
7278
7147
|
"docs": {
|
|
7279
|
-
"remarks": "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.\n\nUse cases: Binary Reader configuration; Path replacement; RDS Oracle access; Redo log path management; Custom path configuration\n\nAWS: AWS DMS Oracle endpoint usePathPrefix for Binary Reader path prefix replacement configuration\n\nValidation: Must be valid path prefix string if provided; used with Binary Reader for RDS Oracle redo log access replacement",
|
|
7280
7148
|
"stability": "experimental",
|
|
7281
|
-
"summary": "
|
|
7149
|
+
"summary": "Path prefix for Binary Reader redo log access replacement in Oracle RDS sources."
|
|
7282
7150
|
},
|
|
7283
7151
|
"immutable": true,
|
|
7284
7152
|
"locationInModule": {
|
|
7285
7153
|
"filename": "lib/endpoint.ts",
|
|
7286
|
-
"line":
|
|
7154
|
+
"line": 94
|
|
7287
7155
|
},
|
|
7288
7156
|
"name": "usePathPrefix",
|
|
7289
7157
|
"optional": true,
|
|
@@ -7298,15 +7166,15 @@
|
|
|
7298
7166
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
7299
7167
|
"datatype": true,
|
|
7300
7168
|
"docs": {
|
|
7301
|
-
"remarks": "
|
|
7169
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
7302
7170
|
"stability": "experimental",
|
|
7303
|
-
"summary": "
|
|
7171
|
+
"summary": "Provides information that defines a PostgreSQL endpoint."
|
|
7304
7172
|
},
|
|
7305
7173
|
"fqn": "@aws-mdaa/dms-constructs.PostgreSqlSettingsProperty",
|
|
7306
7174
|
"kind": "interface",
|
|
7307
7175
|
"locationInModule": {
|
|
7308
7176
|
"filename": "lib/endpoint.ts",
|
|
7309
|
-
"line":
|
|
7177
|
+
"line": 554
|
|
7310
7178
|
},
|
|
7311
7179
|
"name": "PostgreSqlSettingsProperty",
|
|
7312
7180
|
"properties": [
|
|
@@ -7320,7 +7188,7 @@
|
|
|
7320
7188
|
"immutable": true,
|
|
7321
7189
|
"locationInModule": {
|
|
7322
7190
|
"filename": "lib/endpoint.ts",
|
|
7323
|
-
"line":
|
|
7191
|
+
"line": 617
|
|
7324
7192
|
},
|
|
7325
7193
|
"name": "secretsManagerSecretArn",
|
|
7326
7194
|
"type": {
|
|
@@ -7330,14 +7198,13 @@
|
|
|
7330
7198
|
{
|
|
7331
7199
|
"abstract": true,
|
|
7332
7200
|
"docs": {
|
|
7333
|
-
"remarks": "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.\n\nUse cases: CDC performance optimization; Constraint bypassing; Custom connection setup; Migration performance tuning; Bulk load optimization\n\nAWS: AWS DMS PostgreSQL after-connect script for CDC optimization and custom connection configuration\n\nValidation: Must be valid SQL script if provided; commonly used for session configuration; optional for connection customization",
|
|
7334
7201
|
"stability": "experimental",
|
|
7335
|
-
"summary": "
|
|
7202
|
+
"summary": "SQL script executed after connecting to PostgreSQL source for change data capture (CDC)."
|
|
7336
7203
|
},
|
|
7337
7204
|
"immutable": true,
|
|
7338
7205
|
"locationInModule": {
|
|
7339
7206
|
"filename": "lib/endpoint.ts",
|
|
7340
|
-
"line":
|
|
7207
|
+
"line": 556
|
|
7341
7208
|
},
|
|
7342
7209
|
"name": "afterConnectScript",
|
|
7343
7210
|
"optional": true,
|
|
@@ -7348,14 +7215,13 @@
|
|
|
7348
7215
|
{
|
|
7349
7216
|
"abstract": true,
|
|
7350
7217
|
"docs": {
|
|
7351
|
-
"remarks": "Specifies the database name when using Babelfish for Aurora PostgreSQL, which provides SQL Server compatibility on top of PostgreSQL for cross-database migration scenarios.\n\nUse cases: Babelfish database access; SQL Server compatibility; Aurora PostgreSQL with Babelfish; Cross-database migration; SQL Server to PostgreSQL migration\n\nAWS: AWS DMS Babelfish for Aurora PostgreSQL database name for SQL Server compatibility layer access\n\nValidation: Must be valid database name if provided; used with Babelfish-enabled Aurora PostgreSQL; optional for Babelfish configuration",
|
|
7352
7218
|
"stability": "experimental",
|
|
7353
|
-
"summary": "
|
|
7219
|
+
"summary": "Babelfish for Aurora PostgreSQL database name for DMS endpoint configuration enabling SQL."
|
|
7354
7220
|
},
|
|
7355
7221
|
"immutable": true,
|
|
7356
7222
|
"locationInModule": {
|
|
7357
7223
|
"filename": "lib/endpoint.ts",
|
|
7358
|
-
"line":
|
|
7224
|
+
"line": 558
|
|
7359
7225
|
},
|
|
7360
7226
|
"name": "babelfishDatabaseName",
|
|
7361
7227
|
"optional": true,
|
|
@@ -7366,14 +7232,13 @@
|
|
|
7366
7232
|
{
|
|
7367
7233
|
"abstract": true,
|
|
7368
7234
|
"docs": {
|
|
7369
|
-
"remarks": "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.\n\nUse cases: DDL event capture; Schema change tracking; DDL replication; Database schema migration; Change data capture\n\nAWS: AWS DMS PostgreSQL DDL capture for schema change tracking and DDL event replication\n\nValidation: Must be boolean value if provided; optional for DDL capture control",
|
|
7370
7235
|
"stability": "experimental",
|
|
7371
|
-
"summary": "
|
|
7236
|
+
"summary": "Boolean flag to enable DDL event capture for PostgreSQL DMS migration enabling schema."
|
|
7372
7237
|
},
|
|
7373
7238
|
"immutable": true,
|
|
7374
7239
|
"locationInModule": {
|
|
7375
7240
|
"filename": "lib/endpoint.ts",
|
|
7376
|
-
"line":
|
|
7241
|
+
"line": 560
|
|
7377
7242
|
},
|
|
7378
7243
|
"name": "captureDdls",
|
|
7379
7244
|
"optional": true,
|
|
@@ -7384,14 +7249,13 @@
|
|
|
7384
7249
|
{
|
|
7385
7250
|
"abstract": true,
|
|
7386
7251
|
"docs": {
|
|
7387
|
-
"remarks": "Defines the default behavior for handling PostgreSQL-compatible endpoints such as Babelfish endpoints that require specific configuration and compatibility settings.\n\nUse cases: PostgreSQL-compatible endpoint handling; Babelfish endpoint configuration; Specialized database modes; Endpoint compatibility; Database-specific settings\n\nAWS: AWS DMS PostgreSQL database mode for PostgreSQL-compatible endpoint handling and specialized configuration\n\nValidation: Must be valid database mode string if provided; optional for specialized endpoint configuration",
|
|
7388
7252
|
"stability": "experimental",
|
|
7389
|
-
"summary": "
|
|
7253
|
+
"summary": "Database mode specification for PostgreSQL-compatible endpoints requiring additional."
|
|
7390
7254
|
},
|
|
7391
7255
|
"immutable": true,
|
|
7392
7256
|
"locationInModule": {
|
|
7393
7257
|
"filename": "lib/endpoint.ts",
|
|
7394
|
-
"line":
|
|
7258
|
+
"line": 562
|
|
7395
7259
|
},
|
|
7396
7260
|
"name": "databaseMode",
|
|
7397
7261
|
"optional": true,
|
|
@@ -7409,7 +7273,7 @@
|
|
|
7409
7273
|
"immutable": true,
|
|
7410
7274
|
"locationInModule": {
|
|
7411
7275
|
"filename": "lib/endpoint.ts",
|
|
7412
|
-
"line":
|
|
7276
|
+
"line": 568
|
|
7413
7277
|
},
|
|
7414
7278
|
"name": "ddlArtifactsSchema",
|
|
7415
7279
|
"optional": true,
|
|
@@ -7427,7 +7291,7 @@
|
|
|
7427
7291
|
"immutable": true,
|
|
7428
7292
|
"locationInModule": {
|
|
7429
7293
|
"filename": "lib/endpoint.ts",
|
|
7430
|
-
"line":
|
|
7294
|
+
"line": 574
|
|
7431
7295
|
},
|
|
7432
7296
|
"name": "executeTimeout",
|
|
7433
7297
|
"optional": true,
|
|
@@ -7445,7 +7309,7 @@
|
|
|
7445
7309
|
"immutable": true,
|
|
7446
7310
|
"locationInModule": {
|
|
7447
7311
|
"filename": "lib/endpoint.ts",
|
|
7448
|
-
"line":
|
|
7312
|
+
"line": 580
|
|
7449
7313
|
},
|
|
7450
7314
|
"name": "failTasksOnLobTruncation",
|
|
7451
7315
|
"optional": true,
|
|
@@ -7456,14 +7320,13 @@
|
|
|
7456
7320
|
{
|
|
7457
7321
|
"abstract": true,
|
|
7458
7322
|
"docs": {
|
|
7459
|
-
"remarks": "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.\n\nUse cases: WAL heartbeat management; Storage full prevention; Replication slot maintenance; Logical replication optimization; WAL log management\n\nAWS: AWS DMS PostgreSQL WAL heartbeat for replication slot maintenance and storage optimization\n\nValidation: Must be boolean value if provided; optional for WAL heartbeat control",
|
|
7460
7323
|
"stability": "experimental",
|
|
7461
|
-
"summary": "
|
|
7324
|
+
"summary": "Boolean flag to enable WAL heartbeat feature for PostgreSQL DMS migration preventing."
|
|
7462
7325
|
},
|
|
7463
7326
|
"immutable": true,
|
|
7464
7327
|
"locationInModule": {
|
|
7465
7328
|
"filename": "lib/endpoint.ts",
|
|
7466
|
-
"line":
|
|
7329
|
+
"line": 582
|
|
7467
7330
|
},
|
|
7468
7331
|
"name": "heartbeatEnable",
|
|
7469
7332
|
"optional": true,
|
|
@@ -7474,14 +7337,13 @@
|
|
|
7474
7337
|
{
|
|
7475
7338
|
"abstract": true,
|
|
7476
7339
|
"docs": {
|
|
7477
|
-
"remarks": "Defines how frequently the WAL heartbeat feature will execute dummy transactions to maintain replication slot health and prevent storage issues.\n\nUse cases: Heartbeat frequency control; Replication optimization; WAL management timing; Storage optimization; Performance tuning\n\nAWS: AWS DMS PostgreSQL WAL heartbeat frequency for configurable replication slot maintenance timing\n\nValidation: Must be positive number in minutes if provided; optional for heartbeat frequency control",
|
|
7478
7340
|
"stability": "experimental",
|
|
7479
|
-
"summary": "
|
|
7341
|
+
"summary": "WAL heartbeat frequency in minutes for PostgreSQL DMS migration enabling configurable."
|
|
7480
7342
|
},
|
|
7481
7343
|
"immutable": true,
|
|
7482
7344
|
"locationInModule": {
|
|
7483
7345
|
"filename": "lib/endpoint.ts",
|
|
7484
|
-
"line":
|
|
7346
|
+
"line": 584
|
|
7485
7347
|
},
|
|
7486
7348
|
"name": "heartbeatFrequency",
|
|
7487
7349
|
"optional": true,
|
|
@@ -7499,7 +7361,7 @@
|
|
|
7499
7361
|
"immutable": true,
|
|
7500
7362
|
"locationInModule": {
|
|
7501
7363
|
"filename": "lib/endpoint.ts",
|
|
7502
|
-
"line":
|
|
7364
|
+
"line": 589
|
|
7503
7365
|
},
|
|
7504
7366
|
"name": "heartbeatSchema",
|
|
7505
7367
|
"optional": true,
|
|
@@ -7517,7 +7379,7 @@
|
|
|
7517
7379
|
"immutable": true,
|
|
7518
7380
|
"locationInModule": {
|
|
7519
7381
|
"filename": "lib/endpoint.ts",
|
|
7520
|
-
"line":
|
|
7382
|
+
"line": 595
|
|
7521
7383
|
},
|
|
7522
7384
|
"name": "mapBooleanAsBoolean",
|
|
7523
7385
|
"optional": true,
|
|
@@ -7534,7 +7396,7 @@
|
|
|
7534
7396
|
"immutable": true,
|
|
7535
7397
|
"locationInModule": {
|
|
7536
7398
|
"filename": "lib/endpoint.ts",
|
|
7537
|
-
"line":
|
|
7399
|
+
"line": 601
|
|
7538
7400
|
},
|
|
7539
7401
|
"name": "maxFileSize",
|
|
7540
7402
|
"optional": true,
|
|
@@ -7552,7 +7414,7 @@
|
|
|
7552
7414
|
"immutable": true,
|
|
7553
7415
|
"locationInModule": {
|
|
7554
7416
|
"filename": "lib/endpoint.ts",
|
|
7555
|
-
"line":
|
|
7417
|
+
"line": 606
|
|
7556
7418
|
},
|
|
7557
7419
|
"name": "pluginName",
|
|
7558
7420
|
"optional": true,
|
|
@@ -7570,7 +7432,7 @@
|
|
|
7570
7432
|
"immutable": true,
|
|
7571
7433
|
"locationInModule": {
|
|
7572
7434
|
"filename": "lib/endpoint.ts",
|
|
7573
|
-
"line":
|
|
7435
|
+
"line": 612
|
|
7574
7436
|
},
|
|
7575
7437
|
"name": "secretsManagerAccessRoleArn",
|
|
7576
7438
|
"optional": true,
|
|
@@ -7587,7 +7449,7 @@
|
|
|
7587
7449
|
"immutable": true,
|
|
7588
7450
|
"locationInModule": {
|
|
7589
7451
|
"filename": "lib/endpoint.ts",
|
|
7590
|
-
"line":
|
|
7452
|
+
"line": 621
|
|
7591
7453
|
},
|
|
7592
7454
|
"name": "secretsManagerSecretKMSArn",
|
|
7593
7455
|
"optional": true,
|
|
@@ -7605,7 +7467,7 @@
|
|
|
7605
7467
|
"immutable": true,
|
|
7606
7468
|
"locationInModule": {
|
|
7607
7469
|
"filename": "lib/endpoint.ts",
|
|
7608
|
-
"line":
|
|
7470
|
+
"line": 628
|
|
7609
7471
|
},
|
|
7610
7472
|
"name": "slotName",
|
|
7611
7473
|
"optional": true,
|
|
@@ -7620,29 +7482,28 @@
|
|
|
7620
7482
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
7621
7483
|
"datatype": true,
|
|
7622
7484
|
"docs": {
|
|
7623
|
-
"remarks": "
|
|
7485
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
7624
7486
|
"stability": "experimental",
|
|
7625
|
-
"summary": "
|
|
7487
|
+
"summary": "Provides information that defines an Amazon Redshift endpoint."
|
|
7626
7488
|
},
|
|
7627
7489
|
"fqn": "@aws-mdaa/dms-constructs.RedshiftSettingsProperty",
|
|
7628
7490
|
"kind": "interface",
|
|
7629
7491
|
"locationInModule": {
|
|
7630
7492
|
"filename": "lib/endpoint.ts",
|
|
7631
|
-
"line":
|
|
7493
|
+
"line": 241
|
|
7632
7494
|
},
|
|
7633
7495
|
"name": "RedshiftSettingsProperty",
|
|
7634
7496
|
"properties": [
|
|
7635
7497
|
{
|
|
7636
7498
|
"abstract": true,
|
|
7637
7499
|
"docs": {
|
|
7638
|
-
"remarks": "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.\n\nUse cases: Data staging; S3 storage; CSV intermediate storage; Redshift loading; Data warehouse staging\n\nAWS: AWS S3 bucket name for DMS Redshift CSV file staging and data warehouse loading operations\n\nValidation: Must be valid S3 bucket name; required for Redshift endpoint configuration and CSV staging operations",
|
|
7639
7500
|
"stability": "experimental",
|
|
7640
|
-
"summary": "
|
|
7501
|
+
"summary": "S3 bucket name for intermediate CSV file storage before Redshift data loading operations."
|
|
7641
7502
|
},
|
|
7642
7503
|
"immutable": true,
|
|
7643
7504
|
"locationInModule": {
|
|
7644
7505
|
"filename": "lib/endpoint.ts",
|
|
7645
|
-
"line":
|
|
7506
|
+
"line": 249
|
|
7646
7507
|
},
|
|
7647
7508
|
"name": "bucketName",
|
|
7648
7509
|
"type": {
|
|
@@ -7652,14 +7513,13 @@
|
|
|
7652
7513
|
{
|
|
7653
7514
|
"abstract": true,
|
|
7654
7515
|
"docs": {
|
|
7655
|
-
"remarks": "Specifies the full ARN of the secret containing Redshift database connection information including credentials, enabling secure storage and access of Redshift endpoint authentication details.\n\nUse cases: Secure credential storage; Redshift authentication; Secrets Manager integration; Database connection security; Credential management\n\nAWS: AWS Secrets Manager secret ARN containing Redshift endpoint connection details and credentials\n\nValidation: Must be valid Secrets Manager secret ARN; required for secure Redshift endpoint credential management and authentication",
|
|
7656
7516
|
"stability": "experimental",
|
|
7657
|
-
"summary": "
|
|
7517
|
+
"summary": "Secrets Manager secret ARN containing Redshift endpoint connection details for secure credential management."
|
|
7658
7518
|
},
|
|
7659
7519
|
"immutable": true,
|
|
7660
7520
|
"locationInModule": {
|
|
7661
7521
|
"filename": "lib/endpoint.ts",
|
|
7662
|
-
"line":
|
|
7522
|
+
"line": 279
|
|
7663
7523
|
},
|
|
7664
7524
|
"name": "secretsManagerSecretArn",
|
|
7665
7525
|
"type": {
|
|
@@ -7669,14 +7529,13 @@
|
|
|
7669
7529
|
{
|
|
7670
7530
|
"abstract": true,
|
|
7671
7531
|
"docs": {
|
|
7672
|
-
"remarks": "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.\n\nUse cases: Data encryption; KMS integration; S3 security; Compliance requirements; Data protection\n\nAWS: AWS KMS key ID for S3 server-side encryption with customer-managed keys in Redshift staging\n\nValidation: Must be valid KMS key ID; required when EncryptionMode is SSE_KMS; requires proper IAM permissions and key policy",
|
|
7673
7532
|
"stability": "experimental",
|
|
7674
|
-
"summary": "
|
|
7533
|
+
"summary": "KMS key ID for server-side encryption when using SSE_KMS encryption mode for Redshift S3 staging security."
|
|
7675
7534
|
},
|
|
7676
7535
|
"immutable": true,
|
|
7677
7536
|
"locationInModule": {
|
|
7678
7537
|
"filename": "lib/endpoint.ts",
|
|
7679
|
-
"line":
|
|
7538
|
+
"line": 283
|
|
7680
7539
|
},
|
|
7681
7540
|
"name": "serverSideEncryptionKmsKeyId",
|
|
7682
7541
|
"type": {
|
|
@@ -7686,14 +7545,13 @@
|
|
|
7686
7545
|
{
|
|
7687
7546
|
"abstract": true,
|
|
7688
7547
|
"docs": {
|
|
7689
|
-
"remarks": "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.\n\nUse cases: Flexible date handling; Invalid date processing; Date format tolerance; Data warehouse loading; TIMESTAMP/DATE columns\n\nAWS: AWS DMS Redshift endpoint acceptAnyDate for flexible date format handling in data warehouse loading\n\nValidation: Must be boolean if provided; default false; applies only to TIMESTAMP and DATE columns; requires DATEFORMAT parameter",
|
|
7690
7548
|
"stability": "experimental",
|
|
7691
|
-
"summary": "
|
|
7549
|
+
"summary": "Flag to allow any date format including invalid formats for flexible date handling in Redshift data warehouse."
|
|
7692
7550
|
},
|
|
7693
7551
|
"immutable": true,
|
|
7694
7552
|
"locationInModule": {
|
|
7695
7553
|
"filename": "lib/endpoint.ts",
|
|
7696
|
-
"line":
|
|
7554
|
+
"line": 243
|
|
7697
7555
|
},
|
|
7698
7556
|
"name": "acceptAnyDate",
|
|
7699
7557
|
"optional": true,
|
|
@@ -7704,14 +7562,13 @@
|
|
|
7704
7562
|
{
|
|
7705
7563
|
"abstract": true,
|
|
7706
7564
|
"docs": {
|
|
7707
|
-
"remarks": "Provides custom initialization logic that runs after connection establishment to Redshift data warehouse, enabling database-specific setup and configuration for data warehouse operations.\n\nUse cases: Database initialization; Connection setup; Custom configuration; Post-connection tasks; Data warehouse preparation\n\nAWS: AWS DMS Redshift endpoint afterConnectScript for post-connection initialization and setup\n\nValidation: Must be valid SQL script code if provided; script content not filename; enables custom Redshift initialization",
|
|
7708
7565
|
"stability": "experimental",
|
|
7709
|
-
"summary": "
|
|
7566
|
+
"summary": "SQL script to execute after connecting to Redshift endpoint for initialization and setup tasks."
|
|
7710
7567
|
},
|
|
7711
7568
|
"immutable": true,
|
|
7712
7569
|
"locationInModule": {
|
|
7713
7570
|
"filename": "lib/endpoint.ts",
|
|
7714
|
-
"line":
|
|
7571
|
+
"line": 245
|
|
7715
7572
|
},
|
|
7716
7573
|
"name": "afterConnectScript",
|
|
7717
7574
|
"optional": true,
|
|
@@ -7722,14 +7579,13 @@
|
|
|
7722
7579
|
{
|
|
7723
7580
|
"abstract": true,
|
|
7724
7581
|
"docs": {
|
|
7725
|
-
"remarks": "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.\n\nUse cases: Data staging; S3 organization; CSV storage; Redshift COPY operations; Staged loading\n\nAWS: AWS S3 folder path for DMS Redshift CSV file staging and COPY operation organization\n\nValidation: Must be valid S3 folder path if provided; used for CSV staging before Redshift COPY operations",
|
|
7726
7582
|
"stability": "experimental",
|
|
7727
|
-
"summary": "
|
|
7583
|
+
"summary": "S3 folder for storing CSV files before uploading to Redshift cluster for staged data loading."
|
|
7728
7584
|
},
|
|
7729
7585
|
"immutable": true,
|
|
7730
7586
|
"locationInModule": {
|
|
7731
7587
|
"filename": "lib/endpoint.ts",
|
|
7732
|
-
"line":
|
|
7588
|
+
"line": 247
|
|
7733
7589
|
},
|
|
7734
7590
|
"name": "bucketFolder",
|
|
7735
7591
|
"optional": true,
|
|
@@ -7740,14 +7596,13 @@
|
|
|
7740
7596
|
{
|
|
7741
7597
|
"abstract": true,
|
|
7742
7598
|
"docs": {
|
|
7743
|
-
"remarks": "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.\n\nUse cases: Case-sensitive schemas; Schema name precision; Data organization; Redshift configuration; Schema handling\n\nAWS: AWS DMS Redshift endpoint caseSensitiveNames for case-sensitive schema name handling\n\nValidation: Must be boolean if provided; default false; requires Redshift configured for case-sensitive schema names",
|
|
7744
7599
|
"stability": "experimental",
|
|
7745
|
-
"summary": "
|
|
7600
|
+
"summary": "Flag to enable case-sensitive schema names in Redshift data warehouse for precise schema handling."
|
|
7746
7601
|
},
|
|
7747
7602
|
"immutable": true,
|
|
7748
7603
|
"locationInModule": {
|
|
7749
7604
|
"filename": "lib/endpoint.ts",
|
|
7750
|
-
"line":
|
|
7605
|
+
"line": 251
|
|
7751
7606
|
},
|
|
7752
7607
|
"name": "caseSensitiveNames",
|
|
7753
7608
|
"optional": true,
|
|
@@ -7758,14 +7613,13 @@
|
|
|
7758
7613
|
{
|
|
7759
7614
|
"abstract": true,
|
|
7760
7615
|
"docs": {
|
|
7761
|
-
"remarks": "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.\n\nUse cases: Storage optimization; Compression management; Performance tuning; Data warehouse optimization; Automatic encoding\n\nAWS: AWS DMS Redshift endpoint compUpdate for automatic compression and storage optimization\n\nValidation: Must be boolean if provided; default true; applies automatic compression to empty tables regardless of existing encodings",
|
|
7762
7616
|
"stability": "experimental",
|
|
7763
|
-
"summary": "
|
|
7617
|
+
"summary": "Flag to enable automatic compression for empty Redshift tables for storage optimization."
|
|
7764
7618
|
},
|
|
7765
7619
|
"immutable": true,
|
|
7766
7620
|
"locationInModule": {
|
|
7767
7621
|
"filename": "lib/endpoint.ts",
|
|
7768
|
-
"line":
|
|
7622
|
+
"line": 253
|
|
7769
7623
|
},
|
|
7770
7624
|
"name": "compUpdate",
|
|
7771
7625
|
"optional": true,
|
|
@@ -7776,14 +7630,13 @@
|
|
|
7776
7630
|
{
|
|
7777
7631
|
"abstract": true,
|
|
7778
7632
|
"docs": {
|
|
7779
|
-
"remarks": "Specifies the maximum time to wait for initial connection establishment to Redshift data warehouse, controlling connection reliability and timeout behavior for data warehouse connectivity.\n\nUse cases: Connection reliability; Timeout control; Network configuration; Connection management; Data warehouse connectivity\n\nAWS: AWS DMS Redshift endpoint connectionTimeout for connection establishment timeout control\n\nValidation: Must be positive integer in milliseconds if provided; controls initial connection timeout for Redshift endpoint",
|
|
7780
7633
|
"stability": "experimental",
|
|
7781
|
-
"summary": "
|
|
7634
|
+
"summary": "Connection timeout in milliseconds for Redshift endpoint connection establishment."
|
|
7782
7635
|
},
|
|
7783
7636
|
"immutable": true,
|
|
7784
7637
|
"locationInModule": {
|
|
7785
7638
|
"filename": "lib/endpoint.ts",
|
|
7786
|
-
"line":
|
|
7639
|
+
"line": 255
|
|
7787
7640
|
},
|
|
7788
7641
|
"name": "connectionTimeout",
|
|
7789
7642
|
"optional": true,
|
|
@@ -7794,14 +7647,13 @@
|
|
|
7794
7647
|
{
|
|
7795
7648
|
"abstract": true,
|
|
7796
7649
|
"docs": {
|
|
7797
|
-
"remarks": "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.\n\nUse cases: Date format specification; Flexible date parsing; Data warehouse loading; Date handling; Format recognition\n\nAWS: AWS DMS Redshift endpoint dateFormat for date format specification and parsing control\n\nValidation: Must be 'auto', quoted format string, or NULL if provided; default YYYY-MM-DD; use 'auto' for mixed formats",
|
|
7798
7650
|
"stability": "experimental",
|
|
7799
|
-
"summary": "
|
|
7651
|
+
"summary": "Date format specification for Redshift data loading and date handling."
|
|
7800
7652
|
},
|
|
7801
7653
|
"immutable": true,
|
|
7802
7654
|
"locationInModule": {
|
|
7803
7655
|
"filename": "lib/endpoint.ts",
|
|
7804
|
-
"line":
|
|
7656
|
+
"line": 257
|
|
7805
7657
|
},
|
|
7806
7658
|
"name": "dateFormat",
|
|
7807
7659
|
"optional": true,
|
|
@@ -7812,14 +7664,13 @@
|
|
|
7812
7664
|
{
|
|
7813
7665
|
"abstract": true,
|
|
7814
7666
|
"docs": {
|
|
7815
|
-
"remarks": "Enables migration of empty string fields as NULL values with true setting and false default, ensuring consistent null representation in Redshift data warehouse operations.\n\nUse cases: NULL handling; Empty string processing; Data consistency; Redshift migration; Field representation\n\nAWS: AWS DMS Redshift endpoint emptyAsNull for empty field NULL conversion and consistent data representation\n\nValidation: Must be boolean if provided; default false; converts empty CHAR/VARCHAR fields to NULL when true",
|
|
7816
7667
|
"stability": "experimental",
|
|
7817
|
-
"summary": "
|
|
7668
|
+
"summary": "Flag to migrate empty CHAR and VARCHAR fields as NULL for consistent null handling."
|
|
7818
7669
|
},
|
|
7819
7670
|
"immutable": true,
|
|
7820
7671
|
"locationInModule": {
|
|
7821
7672
|
"filename": "lib/endpoint.ts",
|
|
7822
|
-
"line":
|
|
7673
|
+
"line": 259
|
|
7823
7674
|
},
|
|
7824
7675
|
"name": "emptyAsNull",
|
|
7825
7676
|
"optional": true,
|
|
@@ -7830,14 +7681,13 @@
|
|
|
7830
7681
|
{
|
|
7831
7682
|
"abstract": true,
|
|
7832
7683
|
"docs": {
|
|
7833
|
-
"remarks": "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.\n\nUse cases: IDENTITY column handling; Explicit value loading; Full-load migration; Source value preservation; Identity management\n\nAWS: AWS DMS Redshift endpoint explicitIds for IDENTITY column value override in full-load migration\n\nValidation: Must be boolean if provided; default false; applies only to full-load migration tasks with IDENTITY columns",
|
|
7834
7684
|
"stability": "experimental",
|
|
7835
|
-
"summary": "
|
|
7685
|
+
"summary": "Flag to override auto-generated IDENTITY column values with explicit source values for full-load migration."
|
|
7836
7686
|
},
|
|
7837
7687
|
"immutable": true,
|
|
7838
7688
|
"locationInModule": {
|
|
7839
7689
|
"filename": "lib/endpoint.ts",
|
|
7840
|
-
"line":
|
|
7690
|
+
"line": 261
|
|
7841
7691
|
},
|
|
7842
7692
|
"name": "explicitIds",
|
|
7843
7693
|
"optional": true,
|
|
@@ -7848,14 +7698,13 @@
|
|
|
7848
7698
|
{
|
|
7849
7699
|
"abstract": true,
|
|
7850
7700
|
"docs": {
|
|
7851
|
-
"remarks": "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.\n\nUse cases: Upload optimization; Parallel processing; S3 multipart upload; Performance tuning; File transfer optimization\n\nAWS: AWS S3 multipart upload thread configuration for DMS Redshift CSV file upload optimization\n\nValidation: Must be integer between 1-64 if provided; default 10; controls parallel streams for S3 multipart upload",
|
|
7852
7701
|
"stability": "experimental",
|
|
7853
|
-
"summary": "
|
|
7702
|
+
"summary": "Number of parallel threads for single file upload to optimize S3 multipart upload performance."
|
|
7854
7703
|
},
|
|
7855
7704
|
"immutable": true,
|
|
7856
7705
|
"locationInModule": {
|
|
7857
7706
|
"filename": "lib/endpoint.ts",
|
|
7858
|
-
"line":
|
|
7707
|
+
"line": 263
|
|
7859
7708
|
},
|
|
7860
7709
|
"name": "fileTransferUploadStreams",
|
|
7861
7710
|
"optional": true,
|
|
@@ -7866,14 +7715,13 @@
|
|
|
7866
7715
|
{
|
|
7867
7716
|
"abstract": true,
|
|
7868
7717
|
"docs": {
|
|
7869
|
-
"remarks": "Specifies maximum wait time for DMS operations on Redshift cluster, controlling operation timeout behavior and preventing hung operations in data warehouse loading.\n\nUse cases: Operation timeout; Performance control; Redshift operations; Timeout management; Data warehouse loading\n\nAWS: AWS DMS Redshift endpoint loadTimeout for cluster operation timeout control and performance management\n\nValidation: Must be positive integer in milliseconds if provided; controls timeout for Redshift COPY/INSERT/DELETE/UPDATE operations",
|
|
7870
7718
|
"stability": "experimental",
|
|
7871
|
-
"summary": "
|
|
7719
|
+
"summary": "Timeout in milliseconds for Redshift cluster operations including COPY, INSERT, DELETE, and UPDATE."
|
|
7872
7720
|
},
|
|
7873
7721
|
"immutable": true,
|
|
7874
7722
|
"locationInModule": {
|
|
7875
7723
|
"filename": "lib/endpoint.ts",
|
|
7876
|
-
"line":
|
|
7724
|
+
"line": 265
|
|
7877
7725
|
},
|
|
7878
7726
|
"name": "loadTimeout",
|
|
7879
7727
|
"optional": true,
|
|
@@ -7884,14 +7732,13 @@
|
|
|
7884
7732
|
{
|
|
7885
7733
|
"abstract": true,
|
|
7886
7734
|
"docs": {
|
|
7887
|
-
"remarks": "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.\n\nUse cases: Boolean type preservation; Data type accuracy; Redshift native types; Type mapping; Data warehouse optimization\n\nAWS: AWS DMS Redshift endpoint mapBooleanAsBoolean for native boolean type migration and data type preservation\n\nValidation: Must be boolean if provided; must be set on both source and target endpoints; preserves boolean data type in Redshift",
|
|
7888
7735
|
"stability": "experimental",
|
|
7889
|
-
"summary": "
|
|
7736
|
+
"summary": "Flag to migrate boolean type as native boolean in Redshift for proper data type representation."
|
|
7890
7737
|
},
|
|
7891
7738
|
"immutable": true,
|
|
7892
7739
|
"locationInModule": {
|
|
7893
7740
|
"filename": "lib/endpoint.ts",
|
|
7894
|
-
"line":
|
|
7741
|
+
"line": 267
|
|
7895
7742
|
},
|
|
7896
7743
|
"name": "mapBooleanAsBoolean",
|
|
7897
7744
|
"optional": true,
|
|
@@ -7902,14 +7749,13 @@
|
|
|
7902
7749
|
{
|
|
7903
7750
|
"abstract": true,
|
|
7904
7751
|
"docs": {
|
|
7905
|
-
"remarks": "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.\n\nUse cases: File size control; S3 staging optimization; Transfer performance; Data warehouse loading; Storage management\n\nAWS: AWS DMS Redshift endpoint maxFileSize for CSV file size limits in S3 staging and data transfer\n\nValidation: Must be positive integer in KB if provided; default 1 GB; controls CSV file size for S3 staging and Redshift transfer",
|
|
7906
7752
|
"stability": "experimental",
|
|
7907
|
-
"summary": "
|
|
7753
|
+
"summary": "Maximum CSV file size in KB for S3 staging and Redshift data transfer optimization."
|
|
7908
7754
|
},
|
|
7909
7755
|
"immutable": true,
|
|
7910
7756
|
"locationInModule": {
|
|
7911
7757
|
"filename": "lib/endpoint.ts",
|
|
7912
|
-
"line":
|
|
7758
|
+
"line": 269
|
|
7913
7759
|
},
|
|
7914
7760
|
"name": "maxFileSize",
|
|
7915
7761
|
"optional": true,
|
|
@@ -7920,14 +7766,13 @@
|
|
|
7920
7766
|
{
|
|
7921
7767
|
"abstract": true,
|
|
7922
7768
|
"docs": {
|
|
7923
|
-
"remarks": "Enables removal of quotation marks while retaining all characters within quotes including delimiters, with false default, affecting string data processing in Redshift migration.\n\nUse cases: String processing; Quotation handling; Data cleaning; Character processing; String formatting\n\nAWS: AWS DMS Redshift endpoint removeQuotes for quotation mark removal and string data processing\n\nValidation: Must be boolean if provided; default false; removes surrounding quotation marks while preserving internal content",
|
|
7924
7769
|
"stability": "experimental",
|
|
7925
|
-
"summary": "
|
|
7770
|
+
"summary": "Flag to remove surrounding quotation marks from strings in incoming data for cleaner data processing."
|
|
7926
7771
|
},
|
|
7927
7772
|
"immutable": true,
|
|
7928
7773
|
"locationInModule": {
|
|
7929
7774
|
"filename": "lib/endpoint.ts",
|
|
7930
|
-
"line":
|
|
7775
|
+
"line": 271
|
|
7931
7776
|
},
|
|
7932
7777
|
"name": "removeQuotes",
|
|
7933
7778
|
"optional": true,
|
|
@@ -7938,14 +7783,13 @@
|
|
|
7938
7783
|
{
|
|
7939
7784
|
"abstract": true,
|
|
7940
7785
|
"docs": {
|
|
7941
|
-
"remarks": "Specifies the substitution character for invalid characters during data migration with default \"?\" character, working with ReplaceInvalidChars for character replacement and data cleaning.\n\nUse cases: Character replacement; Data cleaning; Invalid character handling; String processing; Data sanitization\n\nAWS: AWS DMS Redshift endpoint replaceChars for invalid character replacement and data cleaning\n\nValidation: Must be valid replacement character if provided; default \"?\"; works with ReplaceInvalidChars for character substitution",
|
|
7942
7786
|
"stability": "experimental",
|
|
7943
|
-
"summary": "
|
|
7787
|
+
"summary": "Replacement character for invalid characters specified in ReplaceInvalidChars for data cleaning."
|
|
7944
7788
|
},
|
|
7945
7789
|
"immutable": true,
|
|
7946
7790
|
"locationInModule": {
|
|
7947
7791
|
"filename": "lib/endpoint.ts",
|
|
7948
|
-
"line":
|
|
7792
|
+
"line": 273
|
|
7949
7793
|
},
|
|
7950
7794
|
"name": "replaceChars",
|
|
7951
7795
|
"optional": true,
|
|
@@ -7956,14 +7800,13 @@
|
|
|
7956
7800
|
{
|
|
7957
7801
|
"abstract": true,
|
|
7958
7802
|
"docs": {
|
|
7959
|
-
"remarks": "Specifies characters that should be replaced using ReplaceChars substitution, enabling data sanitization and character normalization during Redshift data warehouse migration operations.\n\nUse cases: Character filtering; Data sanitization; Invalid character removal; String normalization; Data cleaning\n\nAWS: AWS DMS Redshift endpoint replaceInvalidChars for character filtering and data sanitization\n\nValidation: Must be valid character list if provided; works with ReplaceChars for character replacement and data cleaning",
|
|
7960
7803
|
"stability": "experimental",
|
|
7961
|
-
"summary": "
|
|
7804
|
+
"summary": "List of characters to replace during data migration for data cleaning."
|
|
7962
7805
|
},
|
|
7963
7806
|
"immutable": true,
|
|
7964
7807
|
"locationInModule": {
|
|
7965
7808
|
"filename": "lib/endpoint.ts",
|
|
7966
|
-
"line":
|
|
7809
|
+
"line": 275
|
|
7967
7810
|
},
|
|
7968
7811
|
"name": "replaceInvalidChars",
|
|
7969
7812
|
"optional": true,
|
|
@@ -7974,14 +7817,13 @@
|
|
|
7974
7817
|
{
|
|
7975
7818
|
"abstract": true,
|
|
7976
7819
|
"docs": {
|
|
7977
|
-
"remarks": "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.\n\nUse cases: Credential management; Secrets Manager integration; Secure access; IAM role configuration; Redshift authentication\n\nAWS: AWS IAM role ARN for Secrets Manager access to Redshift endpoint credentials and authentication\n\nValidation: Must be valid IAM role ARN if provided; requires iam:PassRole action and Secrets Manager access permissions",
|
|
7978
7820
|
"stability": "experimental",
|
|
7979
|
-
"summary": "
|
|
7821
|
+
"summary": "IAM role ARN for AWS Secrets Manager access to Redshift endpoint credentials."
|
|
7980
7822
|
},
|
|
7981
7823
|
"immutable": true,
|
|
7982
7824
|
"locationInModule": {
|
|
7983
7825
|
"filename": "lib/endpoint.ts",
|
|
7984
|
-
"line":
|
|
7826
|
+
"line": 277
|
|
7985
7827
|
},
|
|
7986
7828
|
"name": "secretsManagerAccessRoleArn",
|
|
7987
7829
|
"optional": true,
|
|
@@ -7992,14 +7834,13 @@
|
|
|
7992
7834
|
{
|
|
7993
7835
|
"abstract": true,
|
|
7994
7836
|
"docs": {
|
|
7995
|
-
"remarks": "Specifies the KMS key used to encrypt the credentials secret, providing additional encryption layer for Redshift endpoint authentication information stored in AWS Secrets Manager.\n\nUse cases: Credential encryption; KMS integration; Enhanced security; Secret encryption; Redshift credential protection\n\nAWS: AWS KMS key ARN for encrypting Secrets Manager secret containing Redshift endpoint credentials\n\nValidation: Must be valid KMS key ARN if provided; provides additional encryption for Redshift credentials in Secrets Manager",
|
|
7996
7837
|
"stability": "experimental",
|
|
7997
|
-
"summary": "
|
|
7838
|
+
"summary": "KMS key ARN for encrypting Redshift endpoint credentials secret in Secrets Manager."
|
|
7998
7839
|
},
|
|
7999
7840
|
"immutable": true,
|
|
8000
7841
|
"locationInModule": {
|
|
8001
7842
|
"filename": "lib/endpoint.ts",
|
|
8002
|
-
"line":
|
|
7843
|
+
"line": 281
|
|
8003
7844
|
},
|
|
8004
7845
|
"name": "secretsManagerSecretKMSArn",
|
|
8005
7846
|
"optional": true,
|
|
@@ -8010,14 +7851,13 @@
|
|
|
8010
7851
|
{
|
|
8011
7852
|
"abstract": true,
|
|
8012
7853
|
"docs": {
|
|
8013
|
-
"remarks": "Specifies the service role enabling DMS to access Redshift service, requiring iam:PassRole action for secure Redshift access and data warehouse migration operations.\n\nUse cases: Service access; IAM role configuration; Redshift permissions; Secure access; Data warehouse authorization\n\nAWS: AWS IAM role ARN for DMS service access to Redshift service operations and data warehouse integration\n\nValidation: Must be valid IAM role ARN if provided; requires iam:PassRole action; enables Redshift service access operations",
|
|
8014
7854
|
"stability": "experimental",
|
|
8015
|
-
"summary": "
|
|
7855
|
+
"summary": "IAM role ARN for DMS service access to Redshift service operations for data warehouse integration."
|
|
8016
7856
|
},
|
|
8017
7857
|
"immutable": true,
|
|
8018
7858
|
"locationInModule": {
|
|
8019
7859
|
"filename": "lib/endpoint.ts",
|
|
8020
|
-
"line":
|
|
7860
|
+
"line": 285
|
|
8021
7861
|
},
|
|
8022
7862
|
"name": "serviceAccessRoleArn",
|
|
8023
7863
|
"optional": true,
|
|
@@ -8028,14 +7868,13 @@
|
|
|
8028
7868
|
{
|
|
8029
7869
|
"abstract": true,
|
|
8030
7870
|
"docs": {
|
|
8031
|
-
"remarks": "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.\n\nUse cases: Time format specification; Flexible time parsing; Data warehouse loading; Time handling; Format recognition\n\nAWS: AWS DMS Redshift endpoint timeFormat for time format specification and parsing control\n\nValidation: Must be 'auto', timeformat_string, 'epochsecs', or 'epochmillisecs' if provided; default 10; use 'auto' for mixed formats",
|
|
8032
7871
|
"stability": "experimental",
|
|
8033
|
-
"summary": "
|
|
7872
|
+
"summary": "Time format specification for Redshift data loading and time handling."
|
|
8034
7873
|
},
|
|
8035
7874
|
"immutable": true,
|
|
8036
7875
|
"locationInModule": {
|
|
8037
7876
|
"filename": "lib/endpoint.ts",
|
|
8038
|
-
"line":
|
|
7877
|
+
"line": 287
|
|
8039
7878
|
},
|
|
8040
7879
|
"name": "timeFormat",
|
|
8041
7880
|
"optional": true,
|
|
@@ -8046,14 +7885,13 @@
|
|
|
8046
7885
|
{
|
|
8047
7886
|
"abstract": true,
|
|
8048
7887
|
"docs": {
|
|
8049
|
-
"remarks": "Enables removal of trailing whitespace from VARCHAR columns with true setting and false default, improving data quality and consistency in Redshift data warehouse operations.\n\nUse cases: Data cleaning; Whitespace removal; VARCHAR processing; Data quality; String normalization\n\nAWS: AWS DMS Redshift endpoint trimBlanks for trailing whitespace removal from VARCHAR columns\n\nValidation: Must be boolean if provided; default false; applies only to VARCHAR data type columns; removes trailing whitespace",
|
|
8050
7888
|
"stability": "experimental",
|
|
8051
|
-
"summary": "
|
|
7889
|
+
"summary": "Flag to remove trailing white space characters from VARCHAR strings for cleaner data processing."
|
|
8052
7890
|
},
|
|
8053
7891
|
"immutable": true,
|
|
8054
7892
|
"locationInModule": {
|
|
8055
7893
|
"filename": "lib/endpoint.ts",
|
|
8056
|
-
"line":
|
|
7894
|
+
"line": 289
|
|
8057
7895
|
},
|
|
8058
7896
|
"name": "trimBlanks",
|
|
8059
7897
|
"optional": true,
|
|
@@ -8064,14 +7902,13 @@
|
|
|
8064
7902
|
{
|
|
8065
7903
|
"abstract": true,
|
|
8066
7904
|
"docs": {
|
|
8067
|
-
"remarks": "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.\n\nUse cases: Data truncation; Column size compliance; Data integrity; VARCHAR/CHAR handling; Size constraint management\n\nAWS: AWS DMS Redshift endpoint truncateColumns for data truncation and column size compliance\n\nValidation: Must be boolean if provided; default false; applies only to VARCHAR/CHAR columns with rows ≤4MB; ensures data fits columns",
|
|
8068
7905
|
"stability": "experimental",
|
|
8069
|
-
"summary": "
|
|
7906
|
+
"summary": "Flag to truncate data in columns to fit column size limits for data integrity in Redshift."
|
|
8070
7907
|
},
|
|
8071
7908
|
"immutable": true,
|
|
8072
7909
|
"locationInModule": {
|
|
8073
7910
|
"filename": "lib/endpoint.ts",
|
|
8074
|
-
"line":
|
|
7911
|
+
"line": 291
|
|
8075
7912
|
},
|
|
8076
7913
|
"name": "truncateColumns",
|
|
8077
7914
|
"optional": true,
|
|
@@ -8082,14 +7919,13 @@
|
|
|
8082
7919
|
{
|
|
8083
7920
|
"abstract": true,
|
|
8084
7921
|
"docs": {
|
|
8085
|
-
"remarks": "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.\n\nUse cases: Performance optimization; Buffer management; CSV generation; Memory optimization; File write performance\n\nAWS: AWS DMS Redshift endpoint writeBufferSize for CSV file generation buffer optimization and performance tuning\n\nValidation: Must be positive integer in KB if provided; default 1000KB; controls in-memory buffer size for CSV file generation",
|
|
8086
7922
|
"stability": "experimental",
|
|
8087
|
-
"summary": "
|
|
7923
|
+
"summary": "In-memory file write buffer size in KB for CSV file generation performance optimization."
|
|
8088
7924
|
},
|
|
8089
7925
|
"immutable": true,
|
|
8090
7926
|
"locationInModule": {
|
|
8091
7927
|
"filename": "lib/endpoint.ts",
|
|
8092
|
-
"line":
|
|
7928
|
+
"line": 293
|
|
8093
7929
|
},
|
|
8094
7930
|
"name": "writeBufferSize",
|
|
8095
7931
|
"optional": true,
|
|
@@ -8104,29 +7940,28 @@
|
|
|
8104
7940
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
8105
7941
|
"datatype": true,
|
|
8106
7942
|
"docs": {
|
|
8107
|
-
"remarks": "
|
|
7943
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
8108
7944
|
"stability": "experimental",
|
|
8109
|
-
"summary": "
|
|
7945
|
+
"summary": "Provides information that defines an Amazon S3 endpoint."
|
|
8110
7946
|
},
|
|
8111
7947
|
"fqn": "@aws-mdaa/dms-constructs.S3SettingsProperty",
|
|
8112
7948
|
"kind": "interface",
|
|
8113
7949
|
"locationInModule": {
|
|
8114
7950
|
"filename": "lib/endpoint.ts",
|
|
8115
|
-
"line":
|
|
7951
|
+
"line": 131
|
|
8116
7952
|
},
|
|
8117
7953
|
"name": "S3SettingsProperty",
|
|
8118
7954
|
"properties": [
|
|
8119
7955
|
{
|
|
8120
7956
|
"abstract": true,
|
|
8121
7957
|
"docs": {
|
|
8122
|
-
"remarks": "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.\n\nUse cases: Data lake destination; S3 storage; Migration target; Data repository; Database migration endpoint\n\nAWS: AWS S3 bucket name for DMS data migration destination and data lake storage\n\nValidation: Must be valid S3 bucket name; required for S3 endpoint configuration and data migration destination",
|
|
8123
7958
|
"stability": "experimental",
|
|
8124
|
-
"summary": "
|
|
7959
|
+
"summary": "S3 bucket name for DMS data migration destination in data lake architecture."
|
|
8125
7960
|
},
|
|
8126
7961
|
"immutable": true,
|
|
8127
7962
|
"locationInModule": {
|
|
8128
7963
|
"filename": "lib/endpoint.ts",
|
|
8129
|
-
"line":
|
|
7964
|
+
"line": 137
|
|
8130
7965
|
},
|
|
8131
7966
|
"name": "bucketName",
|
|
8132
7967
|
"type": {
|
|
@@ -8136,14 +7971,13 @@
|
|
|
8136
7971
|
{
|
|
8137
7972
|
"abstract": true,
|
|
8138
7973
|
"docs": {
|
|
8139
|
-
"remarks": "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.\n\nUse cases: Data encryption; KMS integration; S3 security; Compliance requirements; Data protection\n\nAWS: AWS KMS key ID for S3 server-side encryption with customer-managed keys\n\nValidation: Must be valid KMS key ID; required when EncryptionMode is SSE_KMS; requires proper IAM permissions and key policy",
|
|
8140
7974
|
"stability": "experimental",
|
|
8141
|
-
"summary": "
|
|
7975
|
+
"summary": "KMS key ID for server-side encryption when using SSE_KMS encryption mode for S3 data lake security."
|
|
8142
7976
|
},
|
|
8143
7977
|
"immutable": true,
|
|
8144
7978
|
"locationInModule": {
|
|
8145
7979
|
"filename": "lib/endpoint.ts",
|
|
8146
|
-
"line":
|
|
7980
|
+
"line": 197
|
|
8147
7981
|
},
|
|
8148
7982
|
"name": "serverSideEncryptionKmsKeyId",
|
|
8149
7983
|
"type": {
|
|
@@ -8153,14 +7987,13 @@
|
|
|
8153
7987
|
{
|
|
8154
7988
|
"abstract": true,
|
|
8155
7989
|
"docs": {
|
|
8156
|
-
"remarks": "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.\n\nUse cases: CSV headers; Data documentation; Data lake usability; Self-describing data; CSV format enhancement\n\nAWS: AWS DMS S3 endpoint addColumnName for CSV column header inclusion in data lake files\n\nValidation: Must be boolean, 'y', or 'n' if provided; default false; improves CSV data usability in S3 data lake",
|
|
8157
7990
|
"stability": "experimental",
|
|
8158
|
-
"summary": "
|
|
7991
|
+
"summary": "Flag to add column name information to CSV output files for S3 data lake integration."
|
|
8159
7992
|
},
|
|
8160
7993
|
"immutable": true,
|
|
8161
7994
|
"locationInModule": {
|
|
8162
7995
|
"filename": "lib/endpoint.ts",
|
|
8163
|
-
"line":
|
|
7996
|
+
"line": 133
|
|
8164
7997
|
},
|
|
8165
7998
|
"name": "addColumnName",
|
|
8166
7999
|
"optional": true,
|
|
@@ -8171,14 +8004,13 @@
|
|
|
8171
8004
|
{
|
|
8172
8005
|
"abstract": true,
|
|
8173
8006
|
"docs": {
|
|
8174
|
-
"remarks": "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.\n\nUse cases: Data organization; Folder structure; S3 hierarchy; Data lake organization; Path management\n\nAWS: AWS DMS S3 endpoint bucketFolder for hierarchical data organization in S3 bucket structure\n\nValidation: Must be valid S3 folder name if provided; creates bucketFolder/schema_name/table_name/ path structure",
|
|
8175
8007
|
"stability": "experimental",
|
|
8176
|
-
"summary": "
|
|
8008
|
+
"summary": "S3 bucket folder name for organizing migrated data with hierarchical structure."
|
|
8177
8009
|
},
|
|
8178
8010
|
"immutable": true,
|
|
8179
8011
|
"locationInModule": {
|
|
8180
8012
|
"filename": "lib/endpoint.ts",
|
|
8181
|
-
"line":
|
|
8013
|
+
"line": 135
|
|
8182
8014
|
},
|
|
8183
8015
|
"name": "bucketFolder",
|
|
8184
8016
|
"optional": true,
|
|
@@ -8189,14 +8021,13 @@
|
|
|
8189
8021
|
{
|
|
8190
8022
|
"abstract": true,
|
|
8191
8023
|
"docs": {
|
|
8192
|
-
"remarks": "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.\n\nUse cases: Access control; S3 permissions; Object security; Data lake security; File permissions\n\nAWS: AWS S3 canned ACL for objects created by DMS during data migration to S3 bucket\n\nValidation: Must be valid S3 canned ACL if provided; default NONE; controls object-level permissions in S3 bucket",
|
|
8193
8024
|
"stability": "experimental",
|
|
8194
|
-
"summary": "
|
|
8025
|
+
"summary": "Predefined access control list (ACL) for S3 objects created during data migration."
|
|
8195
8026
|
},
|
|
8196
8027
|
"immutable": true,
|
|
8197
8028
|
"locationInModule": {
|
|
8198
8029
|
"filename": "lib/endpoint.ts",
|
|
8199
|
-
"line":
|
|
8030
|
+
"line": 139
|
|
8200
8031
|
},
|
|
8201
8032
|
"name": "cannedAclForObjects",
|
|
8202
8033
|
"optional": true,
|
|
@@ -8207,14 +8038,13 @@
|
|
|
8207
8038
|
{
|
|
8208
8039
|
"abstract": true,
|
|
8209
8040
|
"docs": {
|
|
8210
|
-
"remarks": "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.\n\nUse cases: Change data capture; INSERT/UPDATE tracking; Data lake CDC; Operation logging; change tracking\n\nAWS: AWS DMS S3 endpoint cdcInsertsAndUpdates for CDC INSERT and UPDATE operations capture\n\nValidation: Must be boolean or 'y' if provided; mutually exclusive with CdcInsertsOnly; requires DMS version 3.3.1+",
|
|
8211
8041
|
"stability": "experimental",
|
|
8212
|
-
"summary": "
|
|
8042
|
+
"summary": "Flag to enable CDC INSERT and UPDATE operations capture to S3 files for change tracking."
|
|
8213
8043
|
},
|
|
8214
8044
|
"immutable": true,
|
|
8215
8045
|
"locationInModule": {
|
|
8216
8046
|
"filename": "lib/endpoint.ts",
|
|
8217
|
-
"line":
|
|
8047
|
+
"line": 141
|
|
8218
8048
|
},
|
|
8219
8049
|
"name": "cdcInsertsAndUpdates",
|
|
8220
8050
|
"optional": true,
|
|
@@ -8225,14 +8055,13 @@
|
|
|
8225
8055
|
{
|
|
8226
8056
|
"abstract": true,
|
|
8227
8057
|
"docs": {
|
|
8228
|
-
"remarks": "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.\n\nUse cases: Insert-only CDC; Append-only data lakes; INSERT tracking; Simplified change capture; Insert-focused replication\n\nAWS: AWS DMS S3 endpoint cdcInsertsOnly for CDC INSERT-only operations capture\n\nValidation: Must be boolean or 'y' if provided; mutually exclusive with CdcInsertsAndUpdates; requires DMS version 3.1.4+",
|
|
8229
8058
|
"stability": "experimental",
|
|
8230
|
-
"summary": "
|
|
8059
|
+
"summary": "Flag to enable CDC INSERT-only operations capture to S3 files for insert-focused change tracking."
|
|
8231
8060
|
},
|
|
8232
8061
|
"immutable": true,
|
|
8233
8062
|
"locationInModule": {
|
|
8234
8063
|
"filename": "lib/endpoint.ts",
|
|
8235
|
-
"line":
|
|
8064
|
+
"line": 143
|
|
8236
8065
|
},
|
|
8237
8066
|
"name": "cdcInsertsOnly",
|
|
8238
8067
|
"optional": true,
|
|
@@ -8243,14 +8072,13 @@
|
|
|
8243
8072
|
{
|
|
8244
8073
|
"abstract": true,
|
|
8245
8074
|
"docs": {
|
|
8246
|
-
"remarks": "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.\n\nUse cases: File timing control; CDC batching; Time-based triggers; File output scheduling; Batch interval management\n\nAWS: AWS DMS S3 endpoint cdcMaxBatchInterval for time-based CDC file output triggering\n\nValidation: Must be positive integer in seconds if provided; default 60; works with CdcMinFileSize for file output triggering",
|
|
8247
8075
|
"stability": "experimental",
|
|
8248
|
-
"summary": "
|
|
8076
|
+
"summary": "Maximum batch interval in seconds for CDC file output to S3 for time-based file creation."
|
|
8249
8077
|
},
|
|
8250
8078
|
"immutable": true,
|
|
8251
8079
|
"locationInModule": {
|
|
8252
8080
|
"filename": "lib/endpoint.ts",
|
|
8253
|
-
"line":
|
|
8081
|
+
"line": 145
|
|
8254
8082
|
},
|
|
8255
8083
|
"name": "cdcMaxBatchInterval",
|
|
8256
8084
|
"optional": true,
|
|
@@ -8261,14 +8089,13 @@
|
|
|
8261
8089
|
{
|
|
8262
8090
|
"abstract": true,
|
|
8263
8091
|
"docs": {
|
|
8264
|
-
"remarks": "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.\n\nUse cases: File size control; CDC batching; Size-based triggers; File output optimization; Batch size management\n\nAWS: AWS DMS S3 endpoint cdcMinFileSize for size-based CDC file output triggering\n\nValidation: Must be positive integer in KB if provided; default 32 MB; works with CdcMaxBatchInterval for file output triggering",
|
|
8265
8092
|
"stability": "experimental",
|
|
8266
|
-
"summary": "
|
|
8093
|
+
"summary": "Minimum file size in kilobytes for CDC file output to S3 for size-based file creation."
|
|
8267
8094
|
},
|
|
8268
8095
|
"immutable": true,
|
|
8269
8096
|
"locationInModule": {
|
|
8270
8097
|
"filename": "lib/endpoint.ts",
|
|
8271
|
-
"line":
|
|
8098
|
+
"line": 147
|
|
8272
8099
|
},
|
|
8273
8100
|
"name": "cdcMinFileSize",
|
|
8274
8101
|
"optional": true,
|
|
@@ -8279,14 +8106,13 @@
|
|
|
8279
8106
|
{
|
|
8280
8107
|
"abstract": true,
|
|
8281
8108
|
"docs": {
|
|
8282
|
-
"remarks": "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.\n\nUse cases: CDC organization; Transaction order; File path management; S3 CDC structure; Change data organization\n\nAWS: AWS DMS S3 endpoint cdcPath for CDC file organization and transaction order preservation\n\nValidation: Must be valid S3 folder path if provided; required for S3 sources with CDC; supports DMS version 3.4.2+",
|
|
8283
8109
|
"stability": "experimental",
|
|
8284
|
-
"summary": "
|
|
8110
|
+
"summary": "CDC folder path specification for change data capture file organization in S3."
|
|
8285
8111
|
},
|
|
8286
8112
|
"immutable": true,
|
|
8287
8113
|
"locationInModule": {
|
|
8288
8114
|
"filename": "lib/endpoint.ts",
|
|
8289
|
-
"line":
|
|
8115
|
+
"line": 149
|
|
8290
8116
|
},
|
|
8291
8117
|
"name": "cdcPath",
|
|
8292
8118
|
"optional": true,
|
|
@@ -8297,14 +8123,13 @@
|
|
|
8297
8123
|
{
|
|
8298
8124
|
"abstract": true,
|
|
8299
8125
|
"docs": {
|
|
8300
|
-
"remarks": "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.\n\nUse cases: Storage optimization; Compression; Performance tuning; Cost optimization; File size reduction\n\nAWS: AWS DMS S3 endpoint compressionType for target file compression and storage optimization\n\nValidation: Must be GZIP or NONE if provided; default NONE; applies to both CSV and Parquet file formats",
|
|
8301
8126
|
"stability": "experimental",
|
|
8302
|
-
"summary": "
|
|
8127
|
+
"summary": "Compression type for S3 target files to optimize storage and transfer performance."
|
|
8303
8128
|
},
|
|
8304
8129
|
"immutable": true,
|
|
8305
8130
|
"locationInModule": {
|
|
8306
8131
|
"filename": "lib/endpoint.ts",
|
|
8307
|
-
"line":
|
|
8132
|
+
"line": 151
|
|
8308
8133
|
},
|
|
8309
8134
|
"name": "compressionType",
|
|
8310
8135
|
"optional": true,
|
|
@@ -8315,14 +8140,13 @@
|
|
|
8315
8140
|
{
|
|
8316
8141
|
"abstract": true,
|
|
8317
8142
|
"docs": {
|
|
8318
|
-
"remarks": "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.\n\nUse cases: CSV formatting; Column separation; Data parsing; File structure; CSV customization\n\nAWS: AWS DMS S3 endpoint csvDelimiter for CSV column separation and file formatting\n\nValidation: Must be valid delimiter character if provided; default comma; affects CSV file structure and parsing",
|
|
8319
8143
|
"stability": "experimental",
|
|
8320
|
-
"summary": "
|
|
8144
|
+
"summary": "Column delimiter for CSV file format in S3 data lake integration."
|
|
8321
8145
|
},
|
|
8322
8146
|
"immutable": true,
|
|
8323
8147
|
"locationInModule": {
|
|
8324
8148
|
"filename": "lib/endpoint.ts",
|
|
8325
|
-
"line":
|
|
8149
|
+
"line": 153
|
|
8326
8150
|
},
|
|
8327
8151
|
"name": "csvDelimiter",
|
|
8328
8152
|
"optional": true,
|
|
@@ -8333,14 +8157,13 @@
|
|
|
8333
8157
|
{
|
|
8334
8158
|
"abstract": true,
|
|
8335
8159
|
"docs": {
|
|
8336
|
-
"remarks": "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.\n\nUse cases: Supplemental log handling; CDC data completeness; Missing column values; CSV CDC operations; Data consistency\n\nAWS: AWS DMS S3 endpoint csvNoSupValue for supplemental log column handling in CDC CSV operations\n\nValidation: Must be valid string value if provided; used when UseCsvNoSupValue is true; supports DMS version 3.4.1+",
|
|
8337
8160
|
"stability": "experimental",
|
|
8338
|
-
"summary": "
|
|
8161
|
+
"summary": "String value for columns not included in supplemental log during CDC CSV operations."
|
|
8339
8162
|
},
|
|
8340
8163
|
"immutable": true,
|
|
8341
8164
|
"locationInModule": {
|
|
8342
8165
|
"filename": "lib/endpoint.ts",
|
|
8343
|
-
"line":
|
|
8166
|
+
"line": 155
|
|
8344
8167
|
},
|
|
8345
8168
|
"name": "csvNoSupValue",
|
|
8346
8169
|
"optional": true,
|
|
@@ -8351,14 +8174,13 @@
|
|
|
8351
8174
|
{
|
|
8352
8175
|
"abstract": true,
|
|
8353
8176
|
"docs": {
|
|
8354
|
-
"remarks": "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.\n\nUse cases: Null value handling; CSV formatting; Data representation; Empty string differentiation; Target compatibility\n\nAWS: AWS DMS S3 endpoint csvNullValue for null value representation in CSV files\n\nValidation: Must be valid string if provided; default NULL; differentiates empty strings from null values in CSV format",
|
|
8355
8177
|
"stability": "experimental",
|
|
8356
|
-
"summary": "
|
|
8178
|
+
"summary": "Null value representation for CSV files in S3 data lake operations."
|
|
8357
8179
|
},
|
|
8358
8180
|
"immutable": true,
|
|
8359
8181
|
"locationInModule": {
|
|
8360
8182
|
"filename": "lib/endpoint.ts",
|
|
8361
|
-
"line":
|
|
8183
|
+
"line": 157
|
|
8362
8184
|
},
|
|
8363
8185
|
"name": "csvNullValue",
|
|
8364
8186
|
"optional": true,
|
|
@@ -8369,14 +8191,13 @@
|
|
|
8369
8191
|
{
|
|
8370
8192
|
"abstract": true,
|
|
8371
8193
|
"docs": {
|
|
8372
|
-
"remarks": "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.\n\nUse cases: CSV formatting; Row separation; Data parsing; File structure; CSV customization\n\nAWS: AWS DMS S3 endpoint csvRowDelimiter for CSV row separation and file formatting\n\nValidation: Must be valid delimiter character if provided; default carriage return (\\n); affects CSV file structure and parsing",
|
|
8373
8194
|
"stability": "experimental",
|
|
8374
|
-
"summary": "
|
|
8195
|
+
"summary": "Row delimiter for CSV files in S3 data lake integration."
|
|
8375
8196
|
},
|
|
8376
8197
|
"immutable": true,
|
|
8377
8198
|
"locationInModule": {
|
|
8378
8199
|
"filename": "lib/endpoint.ts",
|
|
8379
|
-
"line":
|
|
8200
|
+
"line": 159
|
|
8380
8201
|
},
|
|
8381
8202
|
"name": "csvRowDelimiter",
|
|
8382
8203
|
"optional": true,
|
|
@@ -8387,14 +8208,13 @@
|
|
|
8387
8208
|
{
|
|
8388
8209
|
"abstract": true,
|
|
8389
8210
|
"docs": {
|
|
8390
|
-
"remarks": "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.\n\nUse cases: Data format selection; Storage optimization; Query performance; Compression efficiency; Data lake architecture\n\nAWS: AWS DMS S3 endpoint dataFormat for output file format selection and data lake optimization\n\nValidation: Must be 'csv' or 'parquet' if provided; affects storage efficiency and query performance in data lake",
|
|
8391
8211
|
"stability": "experimental",
|
|
8392
|
-
"summary": "
|
|
8212
|
+
"summary": "Data format specification for S3 output files in data lake architecture."
|
|
8393
8213
|
},
|
|
8394
8214
|
"immutable": true,
|
|
8395
8215
|
"locationInModule": {
|
|
8396
8216
|
"filename": "lib/endpoint.ts",
|
|
8397
|
-
"line":
|
|
8217
|
+
"line": 161
|
|
8398
8218
|
},
|
|
8399
8219
|
"name": "dataFormat",
|
|
8400
8220
|
"optional": true,
|
|
@@ -8405,14 +8225,13 @@
|
|
|
8405
8225
|
{
|
|
8406
8226
|
"abstract": true,
|
|
8407
8227
|
"docs": {
|
|
8408
|
-
"remarks": "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.\n\nUse cases: Parquet optimization; Page size tuning; Compression efficiency; Query performance; Columnar storage optimization\n\nAWS: AWS DMS S3 endpoint dataPageSize for Parquet file page size optimization and performance tuning\n\nValidation: Must be positive integer in bytes if provided; default 1 MiB; applies only to Parquet file format",
|
|
8409
8228
|
"stability": "experimental",
|
|
8410
|
-
"summary": "
|
|
8229
|
+
"summary": "Data page size in bytes for Parquet file format optimization."
|
|
8411
8230
|
},
|
|
8412
8231
|
"immutable": true,
|
|
8413
8232
|
"locationInModule": {
|
|
8414
8233
|
"filename": "lib/endpoint.ts",
|
|
8415
|
-
"line":
|
|
8234
|
+
"line": 163
|
|
8416
8235
|
},
|
|
8417
8236
|
"name": "dataPageSize",
|
|
8418
8237
|
"optional": true,
|
|
@@ -8423,14 +8242,13 @@
|
|
|
8423
8242
|
{
|
|
8424
8243
|
"abstract": true,
|
|
8425
8244
|
"docs": {
|
|
8426
|
-
"remarks": "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.\n\nUse cases: Date partitioning; Folder organization; Data lake structure; Time-based organization; Partition delimiter\n\nAWS: AWS DMS S3 endpoint datePartitionDelimiter for date-based folder partitioning organization\n\nValidation: Must be valid delimiter if provided; default SLASH; used when DatePartitionedEnabled is true",
|
|
8427
8245
|
"stability": "experimental",
|
|
8428
|
-
"summary": "
|
|
8246
|
+
"summary": "Date partition delimiter for S3 folder partitioning organization."
|
|
8429
8247
|
},
|
|
8430
8248
|
"immutable": true,
|
|
8431
8249
|
"locationInModule": {
|
|
8432
8250
|
"filename": "lib/endpoint.ts",
|
|
8433
|
-
"line":
|
|
8251
|
+
"line": 165
|
|
8434
8252
|
},
|
|
8435
8253
|
"name": "datePartitionDelimiter",
|
|
8436
8254
|
"optional": true,
|
|
@@ -8441,14 +8259,13 @@
|
|
|
8441
8259
|
{
|
|
8442
8260
|
"abstract": true,
|
|
8443
8261
|
"docs": {
|
|
8444
|
-
"remarks": "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.\n\nUse cases: Date-based partitioning; Data organization; Query optimization; Time-based structure; Data lake management\n\nAWS: AWS DMS S3 endpoint datePartitionEnabled for date-based folder partitioning and data organization\n\nValidation: Must be boolean if provided; default false; enables date-based folder partitioning for data lake organization",
|
|
8445
8262
|
"stability": "experimental",
|
|
8446
|
-
"summary": "
|
|
8263
|
+
"summary": "Flag to enable date-based folder partitioning for S3 bucket organization."
|
|
8447
8264
|
},
|
|
8448
8265
|
"immutable": true,
|
|
8449
8266
|
"locationInModule": {
|
|
8450
8267
|
"filename": "lib/endpoint.ts",
|
|
8451
|
-
"line":
|
|
8268
|
+
"line": 167
|
|
8452
8269
|
},
|
|
8453
8270
|
"name": "datePartitionEnabled",
|
|
8454
8271
|
"optional": true,
|
|
@@ -8459,14 +8276,13 @@
|
|
|
8459
8276
|
{
|
|
8460
8277
|
"abstract": true,
|
|
8461
8278
|
"docs": {
|
|
8462
|
-
"remarks": "Specifies the date format sequence for folder partitioning with default YYYYMMDD, used when DatePartitionedEnabled is true for consistent date-based folder naming and organization.\n\nUse cases: Date format specification; Folder naming; Partition sequence; Date organization; Consistent naming\n\nAWS: AWS DMS S3 endpoint datePartitionSequence for date format specification in folder partitioning\n\nValidation: Must be valid date format if provided; default YYYYMMDD; used when DatePartitionedEnabled is true",
|
|
8463
8279
|
"stability": "experimental",
|
|
8464
|
-
"summary": "
|
|
8280
|
+
"summary": "Date format sequence for folder partitioning organization in S3 data lake."
|
|
8465
8281
|
},
|
|
8466
8282
|
"immutable": true,
|
|
8467
8283
|
"locationInModule": {
|
|
8468
8284
|
"filename": "lib/endpoint.ts",
|
|
8469
|
-
"line":
|
|
8285
|
+
"line": 169
|
|
8470
8286
|
},
|
|
8471
8287
|
"name": "datePartitionSequence",
|
|
8472
8288
|
"optional": true,
|
|
@@ -8477,14 +8293,13 @@
|
|
|
8477
8293
|
{
|
|
8478
8294
|
"abstract": true,
|
|
8479
8295
|
"docs": {
|
|
8480
|
-
"remarks": "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.\n\nUse cases: Time zone conversion; Date partition timing; CDC file naming; Time zone consistency; Global data management\n\nAWS: AWS DMS S3 endpoint datePartitionTimezone for time zone conversion in date partitioning\n\nValidation: Must be valid Area/Location time zone format if provided; used when DatePartitionedEnabled is true",
|
|
8481
8296
|
"stability": "experimental",
|
|
8482
|
-
"summary": "
|
|
8297
|
+
"summary": "Time zone specification for date partition folder creation and CDC file naming."
|
|
8483
8298
|
},
|
|
8484
8299
|
"immutable": true,
|
|
8485
8300
|
"locationInModule": {
|
|
8486
8301
|
"filename": "lib/endpoint.ts",
|
|
8487
|
-
"line":
|
|
8302
|
+
"line": 171
|
|
8488
8303
|
},
|
|
8489
8304
|
"name": "datePartitionTimezone",
|
|
8490
8305
|
"optional": true,
|
|
@@ -8495,14 +8310,13 @@
|
|
|
8495
8310
|
{
|
|
8496
8311
|
"abstract": true,
|
|
8497
8312
|
"docs": {
|
|
8498
|
-
"remarks": "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.\n\nUse cases: Parquet optimization; Dictionary encoding; Compression efficiency; Column storage optimization; Encoding performance\n\nAWS: AWS DMS S3 endpoint dictPageSizeLimit for Parquet dictionary page size optimization and encoding control\n\nValidation: Must be positive integer in bytes if provided; default 1 MiB; applies only to Parquet file format",
|
|
8499
8313
|
"stability": "experimental",
|
|
8500
|
-
"summary": "
|
|
8314
|
+
"summary": "Maximum dictionary page size limit for Parquet column encoding optimization."
|
|
8501
8315
|
},
|
|
8502
8316
|
"immutable": true,
|
|
8503
8317
|
"locationInModule": {
|
|
8504
8318
|
"filename": "lib/endpoint.ts",
|
|
8505
|
-
"line":
|
|
8319
|
+
"line": 173
|
|
8506
8320
|
},
|
|
8507
8321
|
"name": "dictPageSizeLimit",
|
|
8508
8322
|
"optional": true,
|
|
@@ -8513,14 +8327,13 @@
|
|
|
8513
8327
|
{
|
|
8514
8328
|
"abstract": true,
|
|
8515
8329
|
"docs": {
|
|
8516
|
-
"remarks": "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.\n\nUse cases: Query optimization; Statistics collection; Parquet performance; Data analysis; Query planning\n\nAWS: AWS DMS S3 endpoint enableStatistics for Parquet statistics collection and query optimization\n\nValidation: Must be boolean if provided; default true; applies only to Parquet file format; improves query performance",
|
|
8517
8330
|
"stability": "experimental",
|
|
8518
|
-
"summary": "
|
|
8331
|
+
"summary": "Flag to enable statistics collection for Parquet pages and row groups for query optimization."
|
|
8519
8332
|
},
|
|
8520
8333
|
"immutable": true,
|
|
8521
8334
|
"locationInModule": {
|
|
8522
8335
|
"filename": "lib/endpoint.ts",
|
|
8523
|
-
"line":
|
|
8336
|
+
"line": 175
|
|
8524
8337
|
},
|
|
8525
8338
|
"name": "enableStatistics",
|
|
8526
8339
|
"optional": true,
|
|
@@ -8531,14 +8344,13 @@
|
|
|
8531
8344
|
{
|
|
8532
8345
|
"abstract": true,
|
|
8533
8346
|
"docs": {
|
|
8534
|
-
"remarks": "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.\n\nUse cases: Compression optimization; Encoding selection; Storage efficiency; Parquet performance; Data compression\n\nAWS: AWS DMS S3 endpoint encodingType for Parquet encoding method selection and compression optimization\n\nValidation: Must be RLE_DICTIONARY, PLAIN, or PLAIN_DICTIONARY if provided; default RLE_DICTIONARY; affects Parquet compression",
|
|
8535
8347
|
"stability": "experimental",
|
|
8536
|
-
"summary": "
|
|
8348
|
+
"summary": "Encoding type specification for Parquet file compression and storage optimization."
|
|
8537
8349
|
},
|
|
8538
8350
|
"immutable": true,
|
|
8539
8351
|
"locationInModule": {
|
|
8540
8352
|
"filename": "lib/endpoint.ts",
|
|
8541
|
-
"line":
|
|
8353
|
+
"line": 177
|
|
8542
8354
|
},
|
|
8543
8355
|
"name": "encodingType",
|
|
8544
8356
|
"optional": true,
|
|
@@ -8549,14 +8361,13 @@
|
|
|
8549
8361
|
{
|
|
8550
8362
|
"abstract": true,
|
|
8551
8363
|
"docs": {
|
|
8552
|
-
"remarks": "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.\n\nUse cases: S3 source configuration; Table definition; Schema specification; Data structure; Source table mapping\n\nAWS: AWS DMS S3 endpoint externalTableDefinition for S3 source table structure and schema definition\n\nValidation: Must be valid table definition if provided; required when S3 is used as source; defines table structure and schema",
|
|
8553
8364
|
"stability": "experimental",
|
|
8554
|
-
"summary": "
|
|
8365
|
+
"summary": "External table definition for S3 source configuration in data lake integration."
|
|
8555
8366
|
},
|
|
8556
8367
|
"immutable": true,
|
|
8557
8368
|
"locationInModule": {
|
|
8558
8369
|
"filename": "lib/endpoint.ts",
|
|
8559
|
-
"line":
|
|
8370
|
+
"line": 179
|
|
8560
8371
|
},
|
|
8561
8372
|
"name": "externalTableDefinition",
|
|
8562
8373
|
"optional": true,
|
|
@@ -8567,14 +8378,13 @@
|
|
|
8567
8378
|
{
|
|
8568
8379
|
"abstract": true,
|
|
8569
8380
|
"docs": {
|
|
8570
|
-
"remarks": "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.\n\nUse cases: CSV header handling; File parsing; Data processing; Header row management; CSV source configuration\n\nAWS: AWS DMS S3 endpoint ignoreHeaderRows for CSV header row handling in S3 source processing\n\nValidation: Must be 0 or 1 if provided; default 0; controls CSV header row processing in S3 source operations",
|
|
8571
8381
|
"stability": "experimental",
|
|
8572
|
-
"summary": "
|
|
8382
|
+
"summary": "Number of header rows to ignore in CSV files for S3 source processing."
|
|
8573
8383
|
},
|
|
8574
8384
|
"immutable": true,
|
|
8575
8385
|
"locationInModule": {
|
|
8576
8386
|
"filename": "lib/endpoint.ts",
|
|
8577
|
-
"line":
|
|
8387
|
+
"line": 181
|
|
8578
8388
|
},
|
|
8579
8389
|
"name": "ignoreHeaderRows",
|
|
8580
8390
|
"optional": true,
|
|
@@ -8585,14 +8395,13 @@
|
|
|
8585
8395
|
{
|
|
8586
8396
|
"abstract": true,
|
|
8587
8397
|
"docs": {
|
|
8588
|
-
"remarks": "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.\n\nUse cases: Operation tracking; Full load consistency; CDC compatibility; INSERT indication; Data lineage\n\nAWS: AWS DMS S3 endpoint includeOpForFullLoad for INSERT operation indication in full load CSV output\n\nValidation: Must be boolean or 'y' if provided; requires DMS version 3.1.4+; works with CdcInsertsOnly and CdcInsertsAndUpdates",
|
|
8589
8398
|
"stability": "experimental",
|
|
8590
|
-
"summary": "
|
|
8399
|
+
"summary": "Flag to include INSERT operation indicators in full load CSV output for consistency with CDC operations."
|
|
8591
8400
|
},
|
|
8592
8401
|
"immutable": true,
|
|
8593
8402
|
"locationInModule": {
|
|
8594
8403
|
"filename": "lib/endpoint.ts",
|
|
8595
|
-
"line":
|
|
8404
|
+
"line": 183
|
|
8596
8405
|
},
|
|
8597
8406
|
"name": "includeOpForFullLoad",
|
|
8598
8407
|
"optional": true,
|
|
@@ -8603,14 +8412,13 @@
|
|
|
8603
8412
|
{
|
|
8604
8413
|
"abstract": true,
|
|
8605
8414
|
"docs": {
|
|
8606
|
-
"remarks": "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.\n\nUse cases: File size control; Full load optimization; Storage management; File organization; Performance tuning\n\nAWS: AWS DMS S3 endpoint maxFileSize for CSV file size limits during full load migration\n\nValidation: Must be integer between 1-1,048,576 KB if provided; default 1 GB; controls CSV file size during full load",
|
|
8607
8415
|
"stability": "experimental",
|
|
8608
|
-
"summary": "
|
|
8416
|
+
"summary": "Maximum CSV file size in KB for S3 target during full load migration operations."
|
|
8609
8417
|
},
|
|
8610
8418
|
"immutable": true,
|
|
8611
8419
|
"locationInModule": {
|
|
8612
8420
|
"filename": "lib/endpoint.ts",
|
|
8613
|
-
"line":
|
|
8421
|
+
"line": 185
|
|
8614
8422
|
},
|
|
8615
8423
|
"name": "maxFileSize",
|
|
8616
8424
|
"optional": true,
|
|
@@ -8621,14 +8429,13 @@
|
|
|
8621
8429
|
{
|
|
8622
8430
|
"abstract": true,
|
|
8623
8431
|
"docs": {
|
|
8624
|
-
"remarks": "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.\n\nUse cases: Athena compatibility; Glue integration; Timestamp precision; Parquet optimization; Query engine compatibility\n\nAWS: AWS DMS S3 endpoint parquetTimestampInMillisecond for TIMESTAMP precision in Parquet files\n\nValidation: Must be boolean or 'y' if provided; requires DMS version 3.1.4+; applies only to Parquet format; CSV always uses microsecond",
|
|
8625
8432
|
"stability": "experimental",
|
|
8626
|
-
"summary": "
|
|
8433
|
+
"summary": "Flag to set TIMESTAMP column precision to milliseconds in Parquet files for Athena and Glue compatibility."
|
|
8627
8434
|
},
|
|
8628
8435
|
"immutable": true,
|
|
8629
8436
|
"locationInModule": {
|
|
8630
8437
|
"filename": "lib/endpoint.ts",
|
|
8631
|
-
"line":
|
|
8438
|
+
"line": 187
|
|
8632
8439
|
},
|
|
8633
8440
|
"name": "parquetTimestampInMillisecond",
|
|
8634
8441
|
"optional": true,
|
|
@@ -8639,14 +8446,13 @@
|
|
|
8639
8446
|
{
|
|
8640
8447
|
"abstract": true,
|
|
8641
8448
|
"docs": {
|
|
8642
|
-
"remarks": "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.\n\nUse cases: Parquet version selection; Format compatibility; Feature availability; Performance optimization; Columnar storage\n\nAWS: AWS DMS S3 endpoint parquetVersion for Apache Parquet format version specification\n\nValidation: Must be 'parquet_1_0' or 'parquet_2_0' if provided; default parquet_1_0; affects Parquet file compatibility and features",
|
|
8643
8449
|
"stability": "experimental",
|
|
8644
|
-
"summary": "
|
|
8450
|
+
"summary": "Apache Parquet format version specification for S3 data lake columnar storage."
|
|
8645
8451
|
},
|
|
8646
8452
|
"immutable": true,
|
|
8647
8453
|
"locationInModule": {
|
|
8648
8454
|
"filename": "lib/endpoint.ts",
|
|
8649
|
-
"line":
|
|
8455
|
+
"line": 189
|
|
8650
8456
|
},
|
|
8651
8457
|
"name": "parquetVersion",
|
|
8652
8458
|
"optional": true,
|
|
@@ -8657,14 +8463,13 @@
|
|
|
8657
8463
|
{
|
|
8658
8464
|
"abstract": true,
|
|
8659
8465
|
"docs": {
|
|
8660
|
-
"remarks": "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.\n\nUse cases: Transaction consistency; CDC ordering; Data integrity; Transaction preservation; Change data consistency\n\nAWS: AWS DMS S3 endpoint preserveTransactions for CDC transaction order preservation in S3 target\n\nValidation: Must be boolean if provided; requires CdcPath setting; supports DMS version 3.4.2+; ensures transaction order consistency",
|
|
8661
8466
|
"stability": "experimental",
|
|
8662
|
-
"summary": "
|
|
8467
|
+
"summary": "Flag to preserve transaction order for CDC loads in S3 target for data consistency."
|
|
8663
8468
|
},
|
|
8664
8469
|
"immutable": true,
|
|
8665
8470
|
"locationInModule": {
|
|
8666
8471
|
"filename": "lib/endpoint.ts",
|
|
8667
|
-
"line":
|
|
8472
|
+
"line": 191
|
|
8668
8473
|
},
|
|
8669
8474
|
"name": "preserveTransactions",
|
|
8670
8475
|
"optional": true,
|
|
@@ -8675,14 +8480,13 @@
|
|
|
8675
8480
|
{
|
|
8676
8481
|
"abstract": true,
|
|
8677
8482
|
"docs": {
|
|
8678
|
-
"remarks": "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.\n\nUse cases: CSV compliance; Quotation handling; RFC 4180 standard; Data parsing; CSV formatting\n\nAWS: AWS DMS S3 endpoint rfc4180 for CSV quotation mark handling and RFC 4180 compliance\n\nValidation: Must be boolean, 'y', or 'n' if provided; default true; affects CSV quotation mark handling and delimiter behavior",
|
|
8679
8483
|
"stability": "experimental",
|
|
8680
|
-
"summary": "
|
|
8484
|
+
"summary": "Flag to enable RFC 4180 compliance for CSV quotation mark handling in S3 operations."
|
|
8681
8485
|
},
|
|
8682
8486
|
"immutable": true,
|
|
8683
8487
|
"locationInModule": {
|
|
8684
8488
|
"filename": "lib/endpoint.ts",
|
|
8685
|
-
"line":
|
|
8489
|
+
"line": 193
|
|
8686
8490
|
},
|
|
8687
8491
|
"name": "rfc4180",
|
|
8688
8492
|
"optional": true,
|
|
@@ -8693,14 +8497,13 @@
|
|
|
8693
8497
|
{
|
|
8694
8498
|
"abstract": true,
|
|
8695
8499
|
"docs": {
|
|
8696
|
-
"remarks": "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.\n\nUse cases: Parquet optimization; Read performance; Write performance; Row group tuning; Columnar storage optimization\n\nAWS: AWS DMS S3 endpoint rowGroupLength for Parquet row group size optimization and performance tuning\n\nValidation: Must be positive integer if provided; default 10,000; maximum 64MB (64*1024*1024 bytes); applies only to Parquet format",
|
|
8697
8500
|
"stability": "experimental",
|
|
8698
|
-
"summary": "
|
|
8501
|
+
"summary": "Number of rows in Parquet row group for read/write performance optimization."
|
|
8699
8502
|
},
|
|
8700
8503
|
"immutable": true,
|
|
8701
8504
|
"locationInModule": {
|
|
8702
8505
|
"filename": "lib/endpoint.ts",
|
|
8703
|
-
"line":
|
|
8506
|
+
"line": 195
|
|
8704
8507
|
},
|
|
8705
8508
|
"name": "rowGroupLength",
|
|
8706
8509
|
"optional": true,
|
|
@@ -8711,14 +8514,13 @@
|
|
|
8711
8514
|
{
|
|
8712
8515
|
"abstract": true,
|
|
8713
8516
|
"docs": {
|
|
8714
|
-
"remarks": "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.\n\nUse cases: Service access; IAM role configuration; S3 permissions; Secure access; Data migration authorization\n\nAWS: AWS IAM role ARN for DMS service access to S3 bucket operations and data lake integration\n\nValidation: Must be valid IAM role ARN if provided; requires iam:PassRole action; enables S3 read/write operations",
|
|
8715
8517
|
"stability": "experimental",
|
|
8716
|
-
"summary": "
|
|
8518
|
+
"summary": "IAM role ARN for DMS service access to S3 bucket operations for data lake integration."
|
|
8717
8519
|
},
|
|
8718
8520
|
"immutable": true,
|
|
8719
8521
|
"locationInModule": {
|
|
8720
8522
|
"filename": "lib/endpoint.ts",
|
|
8721
|
-
"line":
|
|
8523
|
+
"line": 199
|
|
8722
8524
|
},
|
|
8723
8525
|
"name": "serviceAccessRoleArn",
|
|
8724
8526
|
"optional": true,
|
|
@@ -8729,14 +8531,13 @@
|
|
|
8729
8531
|
{
|
|
8730
8532
|
"abstract": true,
|
|
8731
8533
|
"docs": {
|
|
8732
|
-
"remarks": "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.\n\nUse cases: Data lineage; Migration tracking; Timestamp information; Data auditing; Change tracking\n\nAWS: AWS DMS S3 endpoint timestampColumnName for migration timestamp tracking in data lake files\n\nValidation: Must be valid column name if provided; requires DMS version 3.1.4+; adds timestamp column to output files",
|
|
8733
8534
|
"stability": "experimental",
|
|
8734
|
-
"summary": "
|
|
8535
|
+
"summary": "Timestamp column name for adding migration timing information to S3 data lake files."
|
|
8735
8536
|
},
|
|
8736
8537
|
"immutable": true,
|
|
8737
8538
|
"locationInModule": {
|
|
8738
8539
|
"filename": "lib/endpoint.ts",
|
|
8739
|
-
"line":
|
|
8540
|
+
"line": 201
|
|
8740
8541
|
},
|
|
8741
8542
|
"name": "timestampColumnName",
|
|
8742
8543
|
"optional": true,
|
|
@@ -8747,14 +8548,13 @@
|
|
|
8747
8548
|
{
|
|
8748
8549
|
"abstract": true,
|
|
8749
8550
|
"docs": {
|
|
8750
|
-
"remarks": "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.\n\nUse cases: Supplemental log handling; CDC data completeness; Missing column values; CSV CDC operations; Data consistency\n\nAWS: AWS DMS S3 endpoint useCsvNoSupValue for supplemental log column handling in CDC CSV operations\n\nValidation: Must be boolean if provided; works with CsvNoSupValue setting; applies only to CDC loads in CSV format",
|
|
8751
8551
|
"stability": "experimental",
|
|
8752
|
-
"summary": "
|
|
8552
|
+
"summary": "Flag to use CsvNoSupValue for columns not in supplemental log during CDC CSV operations."
|
|
8753
8553
|
},
|
|
8754
8554
|
"immutable": true,
|
|
8755
8555
|
"locationInModule": {
|
|
8756
8556
|
"filename": "lib/endpoint.ts",
|
|
8757
|
-
"line":
|
|
8557
|
+
"line": 205
|
|
8758
8558
|
},
|
|
8759
8559
|
"name": "useCsvNoSupValue",
|
|
8760
8560
|
"optional": true,
|
|
@@ -8765,14 +8565,13 @@
|
|
|
8765
8565
|
{
|
|
8766
8566
|
"abstract": true,
|
|
8767
8567
|
"docs": {
|
|
8768
|
-
"remarks": "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.\n\nUse cases: Timestamp consistency; Task timing; Full load timing; Timestamp behavior; Data lineage\n\nAWS: AWS DMS S3 endpoint useTaskStartTimeForFullLoadTimestamp for timestamp column behavior control\n\nValidation: Must be boolean if provided; affects timestamp column behavior for full load operations; CDC always uses commit time",
|
|
8769
8568
|
"stability": "experimental",
|
|
8770
|
-
"summary": "
|
|
8569
|
+
"summary": "Flag to use task start time for full load timestamp column instead of data arrival time."
|
|
8771
8570
|
},
|
|
8772
8571
|
"immutable": true,
|
|
8773
8572
|
"locationInModule": {
|
|
8774
8573
|
"filename": "lib/endpoint.ts",
|
|
8775
|
-
"line":
|
|
8574
|
+
"line": 203
|
|
8776
8575
|
},
|
|
8777
8576
|
"name": "useTaskStartTimeForFullLoadTimestamp",
|
|
8778
8577
|
"optional": true,
|
|
@@ -8787,29 +8586,27 @@
|
|
|
8787
8586
|
"assembly": "@aws-mdaa/dms-constructs",
|
|
8788
8587
|
"datatype": true,
|
|
8789
8588
|
"docs": {
|
|
8790
|
-
"remarks": "
|
|
8589
|
+
"remarks": "Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption.\nThis 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* .",
|
|
8791
8590
|
"stability": "experimental",
|
|
8792
|
-
"summary": "
|
|
8591
|
+
"summary": "Provides information that defines a SAP ASE endpoint."
|
|
8793
8592
|
},
|
|
8794
8593
|
"fqn": "@aws-mdaa/dms-constructs.SybaseSettingsProperty",
|
|
8795
8594
|
"kind": "interface",
|
|
8796
8595
|
"locationInModule": {
|
|
8797
8596
|
"filename": "lib/endpoint.ts",
|
|
8798
|
-
"line":
|
|
8597
|
+
"line": 17
|
|
8799
8598
|
},
|
|
8800
8599
|
"name": "SybaseSettingsProperty",
|
|
8801
8600
|
"properties": [
|
|
8802
8601
|
{
|
|
8803
8602
|
"abstract": true,
|
|
8804
8603
|
"docs": {
|
|
8805
|
-
"
|
|
8806
|
-
"stability": "experimental",
|
|
8807
|
-
"summary": "Q-ENHANCED-PROPERTY Required Secrets Manager secret ARN containing Sybase endpoint connection details enabling secure credential storage for SAP ASE database connectivity."
|
|
8604
|
+
"stability": "experimental"
|
|
8808
8605
|
},
|
|
8809
8606
|
"immutable": true,
|
|
8810
8607
|
"locationInModule": {
|
|
8811
8608
|
"filename": "lib/endpoint.ts",
|
|
8812
|
-
"line":
|
|
8609
|
+
"line": 20
|
|
8813
8610
|
},
|
|
8814
8611
|
"name": "secretsManagerSecretArn",
|
|
8815
8612
|
"type": {
|
|
@@ -8819,14 +8616,13 @@
|
|
|
8819
8616
|
{
|
|
8820
8617
|
"abstract": true,
|
|
8821
8618
|
"docs": {
|
|
8822
|
-
"remarks": "Defines the IAM role that DMS assumes to retrieve database credentials from Secrets Manager for SAP ASE endpoint connectivity with role-based security.\n\nUse cases: Secure credential access; IAM role-based security; Secrets Manager integration; DMS authentication\n\nAWS: DMS Sybase endpoint secretsManagerAccessRoleArn setting for IAM role-based credential access\n\nValidation: Must be valid IAM role ARN if provided; role must have iam:PassRole and Secrets Manager access permissions\nSee: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanageraccessrolearn",
|
|
8823
8619
|
"stability": "experimental",
|
|
8824
|
-
"summary": "
|
|
8620
|
+
"summary": "IAM role ARN for DMS to access Secrets Manager secret containing Sybase endpoint."
|
|
8825
8621
|
},
|
|
8826
8622
|
"immutable": true,
|
|
8827
8623
|
"locationInModule": {
|
|
8828
8624
|
"filename": "lib/endpoint.ts",
|
|
8829
|
-
"line":
|
|
8625
|
+
"line": 19
|
|
8830
8626
|
},
|
|
8831
8627
|
"name": "secretsManagerAccessRoleArn",
|
|
8832
8628
|
"optional": true,
|
|
@@ -8837,14 +8633,13 @@
|
|
|
8837
8633
|
{
|
|
8838
8634
|
"abstract": true,
|
|
8839
8635
|
"docs": {
|
|
8840
|
-
"remarks": "Defines the KMS key used to encrypt the Secrets Manager secret that stores Sybase endpoint credentials for additional security layer.\n\nUse cases: Credential encryption; Enhanced security; KMS integration; Secrets Manager encryption\n\nAWS: DMS Sybase endpoint secretsManagerSecretKMSArn setting for KMS encryption of credentials\n\nValidation: Must be valid KMS key ARN if provided; enables encryption of Secrets Manager secret containing credentials",
|
|
8841
8636
|
"stability": "experimental",
|
|
8842
|
-
"summary": "
|
|
8637
|
+
"summary": "KMS key ARN for encrypting Secrets Manager secret containing Sybase credentials enabling."
|
|
8843
8638
|
},
|
|
8844
8639
|
"immutable": true,
|
|
8845
8640
|
"locationInModule": {
|
|
8846
8641
|
"filename": "lib/endpoint.ts",
|
|
8847
|
-
"line":
|
|
8642
|
+
"line": 22
|
|
8848
8643
|
},
|
|
8849
8644
|
"name": "secretsManagerSecretKMSArn",
|
|
8850
8645
|
"optional": true,
|
|
@@ -8856,6 +8651,6 @@
|
|
|
8856
8651
|
"symbolId": "lib/endpoint:SybaseSettingsProperty"
|
|
8857
8652
|
}
|
|
8858
8653
|
},
|
|
8859
|
-
"version": "1.
|
|
8860
|
-
"fingerprint": "
|
|
8654
|
+
"version": "1.5.0",
|
|
8655
|
+
"fingerprint": "LHv686Ek0CNECmB6mhzkQy57mmmqoqI8mtuKgsMdHhQ="
|
|
8861
8656
|
}
|