@aws-mdaa/dataops-dms 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +15 -8
  2. package/SCHEMA.md +9219 -1456
  3. package/lib/config-schema.json +2826 -303
  4. package/lib/dms-config.d.ts +5 -6
  5. package/lib/dms-config.js +1 -1
  6. package/package.json +13 -10
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  AWS Database Migration Service provides functionality to migrate data from source data stores (such as RDBMS) to destination data stores (such as RDBMS, or S3).
4
4
 
5
- ***
5
+ ---
6
6
 
7
7
  ## Deployed Resources and Compliance Details
8
8
 
@@ -14,7 +14,7 @@ AWS Database Migration Service provides functionality to migrate data from sourc
14
14
 
15
15
  **DMS Replication Task** - Tasks move data between DMS Endpoints, and are executed using Replication Instance compute.
16
16
 
17
- ***
17
+ ---
18
18
 
19
19
  ## Configuration
20
20
 
@@ -24,17 +24,19 @@ Add the following snippet to your mdaa.yaml under the `modules:` section of a do
24
24
 
25
25
  ```yaml
26
26
  dataops-dms: # Module Name can be customized
27
- module_path: "@aws-caef/dataops-dms" # Must match module NPM package name
27
+ module_path: "@aws-mdaa/dataops-dms" # Must match module NPM package name
28
28
  module_configs:
29
29
  - ./dataops-dms.yaml # Filename/path can be customized
30
30
  ```
31
31
 
32
32
  ### Requiring a VPC role
33
+
33
34
  DMS requires the existence of a `dms-vpc-role` role. If this role doesn't already exist, in the first DMS module configuration you need to add the following flag:
34
35
 
35
36
  ```yaml
36
37
  createDmsVpcRole: true
37
38
  ```
39
+
38
40
  See its use in the full example below.
39
41
 
40
42
  For more information about this requirement, see DMS [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DMS_migration-IAM.dms-vpc-role.html) for more details.
@@ -44,9 +46,14 @@ For more information about this requirement, see DMS [documentation](https://doc
44
46
  [Config Schema Docs](SCHEMA.md)
45
47
 
46
48
  ```yaml
47
- # Name of the DataOps Project
49
+ # (Optional) Name of the DataOps Project
50
+ # Other resources within the project can be referenced in the config using
51
+ # the "project:" prefix on the config value.
48
52
  projectName: test-project
49
53
 
54
+ # Alternatively, if projectName is not provided, you can supply the parameter directly:
55
+ # kmsArn: arn:aws:kms:region:account:key/key-id # KMS key for encrypting DMS replication instances and migration data
56
+
50
57
  # Contains all DMS related configuration
51
58
  dms:
52
59
  # do we need to create the one-per-account role of `dms-vpc-role` that is required before DMS is created
@@ -76,9 +83,9 @@ dms:
76
83
  test-source:
77
84
  # The type of endpoint--one of 'source' or 'target'
78
85
  endpointType: source
79
- # The endpoint engine name.
80
- # One of mysql | oracle | postgres | mariadb | aurora | aurora-postgresql |
81
- # opensearch | redshift | redshift-serverless |s3 | db2 | azuredb | sybase |
86
+ # The endpoint engine name.
87
+ # One of mysql | oracle | postgres | mariadb | aurora | aurora-postgresql |
88
+ # opensearch | redshift | redshift-serverless |s3 | db2 | azuredb | sybase |
82
89
  # dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptune
83
90
  engineName: sqlserver
84
91
  # The appropriate settings for the provided engine name.
@@ -119,7 +126,7 @@ dms:
119
126
  rule-name: '1'
120
127
  object-locator:
121
128
  schema-name: Test
122
- table-name: "%"
129
+ table-name: '%'
123
130
  rule-action: include
124
131
  - rule-type: selection
125
132
  rule-id: '2'