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