@aws-mdaa/dataops-dms 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +131 -0
  2. package/SCHEMA.md +3747 -0
  3. package/bin/dms.d.ts +6 -0
  4. package/bin/dms.js +10 -0
  5. package/cdk.json +7 -0
  6. package/lib/config-schema.json +1618 -0
  7. package/lib/dms-config.d.ts +25 -0
  8. package/lib/dms-config.js +19 -0
  9. package/lib/dms.d.ts +11 -0
  10. package/lib/dms.js +28 -0
  11. package/mdaa.config.json +3 -0
  12. package/package.json +55 -0
package/SCHEMA.md ADDED
@@ -0,0 +1,3747 @@
1
+ # Schema Docs
2
+
3
+ | | |
4
+ | ------------------------- | ------------------------------------------------------- |
5
+ | **Type** | `object` |
6
+ | **Required** | No |
7
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
8
+
9
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
10
+ | -------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | + [deploymentRole](#deploymentRole ) | No | string | No | - | - |
12
+ | + [dms](#dms ) | No | object | No | In #/definitions/DMSProps | - |
13
+ | + [kmsArn](#kmsArn ) | No | string | No | - | - |
14
+ | - [nag_suppressions](#nag_suppressions ) | No | object | No | In #/definitions/MdaaNagSuppressions | Nag suppressions |
15
+ | + [projectBucket](#projectBucket ) | No | string | No | - | - |
16
+ | + [projectName](#projectName ) | No | string | No | - | - |
17
+ | + [projectTopicArn](#projectTopicArn ) | No | string | No | - | - |
18
+ | + [securityConfigurationName](#securityConfigurationName ) | No | string | No | - | - |
19
+ | - [service_catalog_product_config](#service_catalog_product_config ) | No | object | No | In #/definitions/MdaaServiceCatalogProductConfig | Service Catalog Config<br />If specified, the configured module will be deployed as a Service Catalog product instead of directly to the environment |
20
+
21
+ ## <a name="deploymentRole"></a>1. Property `root > deploymentRole`
22
+
23
+ | | |
24
+ | ------------ | -------- |
25
+ | **Type** | `string` |
26
+ | **Required** | Yes |
27
+
28
+ ## <a name="dms"></a>2. Property `root > dms`
29
+
30
+ | | |
31
+ | ------------------------- | ------------------------------------------------------- |
32
+ | **Type** | `object` |
33
+ | **Required** | Yes |
34
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
35
+ | **Defined in** | #/definitions/DMSProps |
36
+
37
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
38
+ | ---------------------------------------------------- | ------- | ------ | ---------- | ---------------------------------------------- | ----------------- |
39
+ | - [dmsRoleArn](#dms_dmsRoleArn ) | No | string | No | - | - |
40
+ | - [endpoints](#dms_endpoints ) | No | object | No | In #/definitions/NamedEndpointProps | - |
41
+ | - [replicationInstances](#dms_replicationInstances ) | No | object | No | In #/definitions/NamedReplicationInstanceProps | - |
42
+ | - [replicationTasks](#dms_replicationTasks ) | No | object | No | In #/definitions/NamedReplicationTaskProps | - |
43
+
44
+ ### <a name="dms_dmsRoleArn"></a>2.1. Property `root > dms > dmsRoleArn`
45
+
46
+ | | |
47
+ | ------------ | -------- |
48
+ | **Type** | `string` |
49
+ | **Required** | No |
50
+
51
+ ### <a name="dms_endpoints"></a>2.2. Property `root > dms > endpoints`
52
+
53
+ | | |
54
+ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
55
+ | **Type** | `object` |
56
+ | **Required** | No |
57
+ | **Additional properties** | [[Should-conform]](#dms_endpoints_additionalProperties "Each additional property must conform to the following schema") |
58
+ | **Defined in** | #/definitions/NamedEndpointProps |
59
+
60
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
61
+ | ------------------------------------------ | ------- | ------ | ---------- | ------------------------------ | ----------------- |
62
+ | - [](#dms_endpoints_additionalProperties ) | No | object | No | In #/definitions/EndpointProps | - |
63
+
64
+ #### <a name="dms_endpoints_additionalProperties"></a>2.2.1. Property `root > dms > endpoints > EndpointProps`
65
+
66
+ | | |
67
+ | ------------------------- | ------------------------------------------------------- |
68
+ | **Type** | `object` |
69
+ | **Required** | No |
70
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
71
+ | **Defined in** | #/definitions/EndpointProps |
72
+
73
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
74
+ | ----------------------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
75
+ | - [databaseName](#dms_endpoints_additionalProperties_databaseName ) | No | string | No | - | The optional name of the endpoint database. Required for certain endpoint types. |
76
+ | - [docDbSettings](#dms_endpoints_additionalProperties_docDbSettings ) | No | object | No | In #/definitions/DocDbSettingsProperty | Settings in JSON format for the source and target DocumentDB endpoint.<br /><br />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* . |
77
+ | - [dynamoDbSettings](#dms_endpoints_additionalProperties_dynamoDbSettings ) | No | object | No | In #/definitions/DynamoDbSettingsProperty | Settings in JSON format for the target Amazon DynamoDB endpoint.<br /><br />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* . |
78
+ | - [elasticsearchSettings](#dms_endpoints_additionalProperties_elasticsearchSettings ) | No | object | No | In #/definitions/ElasticsearchSettingsProperty | Settings in JSON format for the target OpenSearch endpoint.<br /><br />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* . |
79
+ | + [endpointType](#dms_endpoints_additionalProperties_endpointType ) | No | enum (of string) | No | In #/definitions/MdaaEndpointType | The type of Endpoint ("source" or "target") |
80
+ | + [engineName](#dms_endpoints_additionalProperties_engineName ) | No | enum (of string) | No | In #/definitions/MdaaEndpointEngine | The name of the endpoint engine |
81
+ | - [ibmDb2Settings](#dms_endpoints_additionalProperties_ibmDb2Settings ) | No | object | No | In #/definitions/IbmDb2SettingsProperty | Settings in JSON format for the source IBM Db2 LUW endpoint.<br /><br />For 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* . |
82
+ | - [kinesisSettings](#dms_endpoints_additionalProperties_kinesisSettings ) | No | object | No | In #/definitions/KinesisSettingsProperty | Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.<br /><br />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* . |
83
+ | - [microsoftSqlServerSettings](#dms_endpoints_additionalProperties_microsoftSqlServerSettings ) | No | object | No | In #/definitions/MicrosoftSqlServerSettingsProperty | Settings in JSON format for the source and target Microsoft SQL Server endpoint.<br /><br />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* . |
84
+ | - [mongoDbSettings](#dms_endpoints_additionalProperties_mongoDbSettings ) | No | object | No | In #/definitions/MongoDbSettingsProperty | Settings in JSON format for the source MongoDB endpoint.<br /><br />For more information about the available settings, see [Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide* . |
85
+ | - [mySqlSettings](#dms_endpoints_additionalProperties_mySqlSettings ) | No | object | No | In #/definitions/MySqlSettingsProperty | Settings in JSON format for the source and target MySQL endpoint.<br /><br />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* . |
86
+ | - [neptuneSettings](#dms_endpoints_additionalProperties_neptuneSettings ) | No | object | No | In #/definitions/NeptuneSettingsProperty | Settings in JSON format for the target Amazon Neptune endpoint.<br /><br />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* . |
87
+ | - [oracleSettings](#dms_endpoints_additionalProperties_oracleSettings ) | No | object | No | In #/definitions/OracleSettingsProperty | Settings in JSON format for the source and target Oracle endpoint.<br /><br />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* . |
88
+ | - [postgreSqlSettings](#dms_endpoints_additionalProperties_postgreSqlSettings ) | No | object | No | In #/definitions/PostgreSqlSettingsProperty | Settings in JSON format for the source and target PostgreSQL endpoint.<br /><br />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* . |
89
+ | - [redshiftSettings](#dms_endpoints_additionalProperties_redshiftSettings ) | No | object | No | In #/definitions/RedshiftSettingsProperty | Settings in JSON format for the Amazon Redshift endpoint.<br /><br />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* . |
90
+ | - [s3Settings](#dms_endpoints_additionalProperties_s3Settings ) | No | object | No | In #/definitions/S3SettingsProperty | Settings in JSON format for the source and target Amazon S3 endpoint.<br /><br />For more information about other 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* . |
91
+ | - [sybaseSettings](#dms_endpoints_additionalProperties_sybaseSettings ) | No | object | No | In #/definitions/SybaseSettingsProperty | Settings in JSON format for the source and target SAP ASE endpoint.<br /><br />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* . |
92
+
93
+ ##### <a name="dms_endpoints_additionalProperties_databaseName"></a>2.2.1.1. Property `root > dms > endpoints > additionalProperties > databaseName`
94
+
95
+ | | |
96
+ | ------------ | -------- |
97
+ | **Type** | `string` |
98
+ | **Required** | No |
99
+
100
+ **Description:** The optional name of the endpoint database. Required for certain endpoint types.
101
+
102
+ ##### <a name="dms_endpoints_additionalProperties_docDbSettings"></a>2.2.1.2. Property `root > dms > endpoints > additionalProperties > docDbSettings`
103
+
104
+ | | |
105
+ | ------------------------- | ------------------------------------------------------- |
106
+ | **Type** | `object` |
107
+ | **Required** | No |
108
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
109
+ | **Defined in** | #/definitions/DocDbSettingsProperty |
110
+
111
+ **Description:** Settings in JSON format for the source and target DocumentDB endpoint.
112
+
113
+ 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* .
114
+
115
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
116
+ | --------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
117
+ | - [docsToInvestigate](#dms_endpoints_additionalProperties_docDbSettings_docsToInvestigate ) | No | number | No | - | Indicates the number of documents to preview to determine the document organization.<br /><br />Use this setting when \`NestingLevel\` is set to \`"one"\` .<br /><br />Must be a positive value greater than \`0\` . Default value is \`1000\` . |
118
+ | - [extractDocId](#dms_endpoints_additionalProperties_docDbSettings_extractDocId ) | No | boolean | No | - | Specifies the document ID. Use this setting when \`NestingLevel\` is set to \`"none"\` .<br /><br />Default value is \`"false"\` . |
119
+ | - [nestingLevel](#dms_endpoints_additionalProperties_docDbSettings_nestingLevel ) | No | string | No | - | Specifies either document or table mode.<br /><br />Default value is \`"none"\` . Specify \`"none"\` to use document mode. Specify \`"one"\` to use table mode. |
120
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_docDbSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint. |
121
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_docDbSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the DocumentDB endpoint connection details. |
122
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_docDbSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
123
+
124
+ ###### <a name="dms_endpoints_additionalProperties_docDbSettings_docsToInvestigate"></a>2.2.1.2.1. Property `root > dms > endpoints > additionalProperties > docDbSettings > docsToInvestigate`
125
+
126
+ | | |
127
+ | ------------ | -------- |
128
+ | **Type** | `number` |
129
+ | **Required** | No |
130
+
131
+ **Description:** Indicates the number of documents to preview to determine the document organization.
132
+
133
+ Use this setting when `NestingLevel` is set to `"one"` .
134
+
135
+ Must be a positive value greater than `0` . Default value is `1000` .
136
+
137
+ ###### <a name="dms_endpoints_additionalProperties_docDbSettings_extractDocId"></a>2.2.1.2.2. Property `root > dms > endpoints > additionalProperties > docDbSettings > extractDocId`
138
+
139
+ | | |
140
+ | ------------ | --------- |
141
+ | **Type** | `boolean` |
142
+ | **Required** | No |
143
+
144
+ **Description:** Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"` .
145
+
146
+ Default value is `"false"` .
147
+
148
+ ###### <a name="dms_endpoints_additionalProperties_docDbSettings_nestingLevel"></a>2.2.1.2.3. Property `root > dms > endpoints > additionalProperties > docDbSettings > nestingLevel`
149
+
150
+ | | |
151
+ | ------------ | -------- |
152
+ | **Type** | `string` |
153
+ | **Required** | No |
154
+
155
+ **Description:** Specifies either document or table mode.
156
+
157
+ Default value is `"none"` . Specify `"none"` to use document mode. Specify `"one"` to use table mode.
158
+
159
+ ###### <a name="dms_endpoints_additionalProperties_docDbSettings_secretsManagerAccessRoleArn"></a>2.2.1.2.4. Property `root > dms > endpoints > additionalProperties > docDbSettings > secretsManagerAccessRoleArn`
160
+
161
+ | | |
162
+ | ------------ | -------- |
163
+ | **Type** | `string` |
164
+ | **Required** | No |
165
+
166
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
167
+
168
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
169
+
170
+ ###### <a name="dms_endpoints_additionalProperties_docDbSettings_secretsManagerSecretArn"></a>2.2.1.2.5. Property `root > dms > endpoints > additionalProperties > docDbSettings > secretsManagerSecretArn`
171
+
172
+ | | |
173
+ | ------------ | -------- |
174
+ | **Type** | `string` |
175
+ | **Required** | Yes |
176
+
177
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details.
178
+
179
+ ###### <a name="dms_endpoints_additionalProperties_docDbSettings_secretsManagerSecretKMSArn"></a>2.2.1.2.6. Property `root > dms > endpoints > additionalProperties > docDbSettings > secretsManagerSecretKMSArn`
180
+
181
+ | | |
182
+ | ------------ | -------- |
183
+ | **Type** | `string` |
184
+ | **Required** | No |
185
+
186
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
187
+
188
+ ##### <a name="dms_endpoints_additionalProperties_dynamoDbSettings"></a>2.2.1.3. Property `root > dms > endpoints > additionalProperties > dynamoDbSettings`
189
+
190
+ | | |
191
+ | ------------------------- | ------------------------------------------------------- |
192
+ | **Type** | `object` |
193
+ | **Required** | No |
194
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
195
+ | **Defined in** | #/definitions/DynamoDbSettingsProperty |
196
+
197
+ **Description:** Settings in JSON format for the target Amazon DynamoDB endpoint.
198
+
199
+ 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* .
200
+
201
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
202
+ | ---------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- |
203
+ | - [serviceAccessRoleArn](#dms_endpoints_additionalProperties_dynamoDbSettings_serviceAccessRoleArn ) | No | string | No | - | The Amazon Resource Name (ARN) used by the service to access the IAM role.<br /><br />The role must allow the \`iam:PassRole\` action. |
204
+
205
+ ###### <a name="dms_endpoints_additionalProperties_dynamoDbSettings_serviceAccessRoleArn"></a>2.2.1.3.1. Property `root > dms > endpoints > additionalProperties > dynamoDbSettings > serviceAccessRoleArn`
206
+
207
+ | | |
208
+ | ------------ | -------- |
209
+ | **Type** | `string` |
210
+ | **Required** | No |
211
+
212
+ **Description:** The Amazon Resource Name (ARN) used by the service to access the IAM role.
213
+
214
+ The role must allow the `iam:PassRole` action.
215
+
216
+ ##### <a name="dms_endpoints_additionalProperties_elasticsearchSettings"></a>2.2.1.4. Property `root > dms > endpoints > additionalProperties > elasticsearchSettings`
217
+
218
+ | | |
219
+ | ------------------------- | ------------------------------------------------------- |
220
+ | **Type** | `object` |
221
+ | **Required** | No |
222
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
223
+ | **Defined in** | #/definitions/ElasticsearchSettingsProperty |
224
+
225
+ **Description:** Settings in JSON format for the target OpenSearch endpoint.
226
+
227
+ 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* .
228
+
229
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
230
+ | --------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
231
+ | - [endpointUri](#dms_endpoints_additionalProperties_elasticsearchSettings_endpointUri ) | No | string | No | - | The endpoint for the OpenSearch cluster.<br /><br />AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified. |
232
+ | - [errorRetryDuration](#dms_endpoints_additionalProperties_elasticsearchSettings_errorRetryDuration ) | No | number | No | - | The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. |
233
+ | - [fullLoadErrorPercentage](#dms_endpoints_additionalProperties_elasticsearchSettings_fullLoadErrorPercentage ) | No | number | No | - | The maximum percentage of records that can fail to be written before a full load operation stops.<br /><br />To avoid early failure, this counter is only effective after 1,000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops. |
234
+ | - [serviceAccessRoleArn](#dms_endpoints_additionalProperties_elasticsearchSettings_serviceAccessRoleArn ) | No | string | No | - | The Amazon Resource Name (ARN) used by the service to access the IAM role.<br /><br />The role must allow the \`iam:PassRole\` action. |
235
+
236
+ ###### <a name="dms_endpoints_additionalProperties_elasticsearchSettings_endpointUri"></a>2.2.1.4.1. Property `root > dms > endpoints > additionalProperties > elasticsearchSettings > endpointUri`
237
+
238
+ | | |
239
+ | ------------ | -------- |
240
+ | **Type** | `string` |
241
+ | **Required** | No |
242
+
243
+ **Description:** The endpoint for the OpenSearch cluster.
244
+
245
+ AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
246
+
247
+ ###### <a name="dms_endpoints_additionalProperties_elasticsearchSettings_errorRetryDuration"></a>2.2.1.4.2. Property `root > dms > endpoints > additionalProperties > elasticsearchSettings > errorRetryDuration`
248
+
249
+ | | |
250
+ | ------------ | -------- |
251
+ | **Type** | `number` |
252
+ | **Required** | No |
253
+
254
+ **Description:** The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
255
+
256
+ ###### <a name="dms_endpoints_additionalProperties_elasticsearchSettings_fullLoadErrorPercentage"></a>2.2.1.4.3. Property `root > dms > endpoints > additionalProperties > elasticsearchSettings > fullLoadErrorPercentage`
257
+
258
+ | | |
259
+ | ------------ | -------- |
260
+ | **Type** | `number` |
261
+ | **Required** | No |
262
+
263
+ **Description:** The maximum percentage of records that can fail to be written before a full load operation stops.
264
+
265
+ To avoid early failure, this counter is only effective after 1,000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.
266
+
267
+ ###### <a name="dms_endpoints_additionalProperties_elasticsearchSettings_serviceAccessRoleArn"></a>2.2.1.4.4. Property `root > dms > endpoints > additionalProperties > elasticsearchSettings > serviceAccessRoleArn`
268
+
269
+ | | |
270
+ | ------------ | -------- |
271
+ | **Type** | `string` |
272
+ | **Required** | No |
273
+
274
+ **Description:** The Amazon Resource Name (ARN) used by the service to access the IAM role.
275
+
276
+ The role must allow the `iam:PassRole` action.
277
+
278
+ ##### <a name="dms_endpoints_additionalProperties_endpointType"></a>2.2.1.5. Property `root > dms > endpoints > additionalProperties > endpointType`
279
+
280
+ | | |
281
+ | -------------- | ------------------------------ |
282
+ | **Type** | `enum (of string)` |
283
+ | **Required** | Yes |
284
+ | **Defined in** | #/definitions/MdaaEndpointType |
285
+
286
+ **Description:** The type of Endpoint ("source" or "target")
287
+
288
+ Must be one of:
289
+ * "source"
290
+ * "target"
291
+
292
+ ##### <a name="dms_endpoints_additionalProperties_engineName"></a>2.2.1.6. Property `root > dms > endpoints > additionalProperties > engineName`
293
+
294
+ | | |
295
+ | -------------- | -------------------------------- |
296
+ | **Type** | `enum (of string)` |
297
+ | **Required** | Yes |
298
+ | **Defined in** | #/definitions/MdaaEndpointEngine |
299
+
300
+ **Description:** The name of the endpoint engine
301
+
302
+ Must be one of:
303
+ * "aurora"
304
+ * "aurora-postgresql"
305
+ * "azuredb"
306
+ * "db2"
307
+ * "docdb"
308
+ * "dynamodb"
309
+ * "elasticsearch"
310
+ * "kafka"
311
+ * "kinesis"
312
+ * "mariadb"
313
+ * "mongodb"
314
+ * "mysql"
315
+ * "neptune"
316
+ * "opensearch"
317
+ * "oracle"
318
+ * "postgres"
319
+ * "redshift"
320
+ * "redshift-serverless"
321
+ * "s3"
322
+ * "sqlserver"
323
+ * "sybase"
324
+
325
+ ##### <a name="dms_endpoints_additionalProperties_ibmDb2Settings"></a>2.2.1.7. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings`
326
+
327
+ | | |
328
+ | ------------------------- | ------------------------------------------------------- |
329
+ | **Type** | `object` |
330
+ | **Required** | No |
331
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
332
+ | **Defined in** | #/definitions/IbmDb2SettingsProperty |
333
+
334
+ **Description:** Settings in JSON format for the source IBM Db2 LUW endpoint.
335
+
336
+ For 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* .
337
+
338
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
339
+ | ---------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
340
+ | - [currentLsn](#dms_endpoints_additionalProperties_ibmDb2Settings_currentLsn ) | No | string | No | - | For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start. |
341
+ | - [maxKBytesPerRead](#dms_endpoints_additionalProperties_ibmDb2Settings_maxKBytesPerRead ) | No | number | No | - | Maximum number of bytes per read, as a NUMBER value.<br /><br />The default is 64 KB. |
342
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_ibmDb2Settings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint. |
343
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_ibmDb2Settings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the IBMDB2 endpoint connection details. |
344
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_ibmDb2Settings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
345
+ | - [setDataCaptureChanges](#dms_endpoints_additionalProperties_ibmDb2Settings_setDataCaptureChanges ) | No | boolean | No | - | Enables ongoing replication (CDC) as a BOOLEAN value.<br /><br />The default is true. |
346
+
347
+ ###### <a name="dms_endpoints_additionalProperties_ibmDb2Settings_currentLsn"></a>2.2.1.7.1. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings > currentLsn`
348
+
349
+ | | |
350
+ | ------------ | -------- |
351
+ | **Type** | `string` |
352
+ | **Required** | No |
353
+
354
+ **Description:** For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
355
+
356
+ ###### <a name="dms_endpoints_additionalProperties_ibmDb2Settings_maxKBytesPerRead"></a>2.2.1.7.2. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings > maxKBytesPerRead`
357
+
358
+ | | |
359
+ | ------------ | -------- |
360
+ | **Type** | `number` |
361
+ | **Required** | No |
362
+
363
+ **Description:** Maximum number of bytes per read, as a NUMBER value.
364
+
365
+ The default is 64 KB.
366
+
367
+ ###### <a name="dms_endpoints_additionalProperties_ibmDb2Settings_secretsManagerAccessRoleArn"></a>2.2.1.7.3. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings > secretsManagerAccessRoleArn`
368
+
369
+ | | |
370
+ | ------------ | -------- |
371
+ | **Type** | `string` |
372
+ | **Required** | No |
373
+
374
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
375
+
376
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
377
+
378
+ ###### <a name="dms_endpoints_additionalProperties_ibmDb2Settings_secretsManagerSecretArn"></a>2.2.1.7.4. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings > secretsManagerSecretArn`
379
+
380
+ | | |
381
+ | ------------ | -------- |
382
+ | **Type** | `string` |
383
+ | **Required** | Yes |
384
+
385
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details.
386
+
387
+ ###### <a name="dms_endpoints_additionalProperties_ibmDb2Settings_secretsManagerSecretKMSArn"></a>2.2.1.7.5. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings > secretsManagerSecretKMSArn`
388
+
389
+ | | |
390
+ | ------------ | -------- |
391
+ | **Type** | `string` |
392
+ | **Required** | No |
393
+
394
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
395
+
396
+ ###### <a name="dms_endpoints_additionalProperties_ibmDb2Settings_setDataCaptureChanges"></a>2.2.1.7.6. Property `root > dms > endpoints > additionalProperties > ibmDb2Settings > setDataCaptureChanges`
397
+
398
+ | | |
399
+ | ------------ | --------- |
400
+ | **Type** | `boolean` |
401
+ | **Required** | No |
402
+
403
+ **Description:** Enables ongoing replication (CDC) as a BOOLEAN value.
404
+
405
+ The default is true.
406
+
407
+ ##### <a name="dms_endpoints_additionalProperties_kinesisSettings"></a>2.2.1.8. Property `root > dms > endpoints > additionalProperties > kinesisSettings`
408
+
409
+ | | |
410
+ | ------------------------- | ------------------------------------------------------- |
411
+ | **Type** | `object` |
412
+ | **Required** | No |
413
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
414
+ | **Defined in** | #/definitions/KinesisSettingsProperty |
415
+
416
+ **Description:** Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
417
+
418
+ 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* .
419
+
420
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
421
+ | ----------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
422
+ | - [includeControlDetails](#dms_endpoints_additionalProperties_kinesisSettings_includeControlDetails ) | No | boolean | No | - | Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.<br /><br />The default is \`false\` . |
423
+ | - [includeNullAndEmpty](#dms_endpoints_additionalProperties_kinesisSettings_includeNullAndEmpty ) | No | boolean | No | - | Include NULL and empty columns for records migrated to the endpoint.<br /><br />The default is \`false\` . |
424
+ | - [includePartitionValue](#dms_endpoints_additionalProperties_kinesisSettings_includePartitionValue ) | No | boolean | No | - | Shows the partition value within the Kinesis message output, unless the partition type is \`schema-table-type\` .<br /><br />The default is \`false\` . |
425
+ | - [includeTableAlterOperations](#dms_endpoints_additionalProperties_kinesisSettings_includeTableAlterOperations ) | No | boolean | No | - | Includes any data definition language (DDL) operations that change the table in the control data, such as \`rename-table\` , \`drop-table\` , \`add-column\` , \`drop-column\` , and \`rename-column\` .<br /><br />The default is \`false\` . |
426
+ | - [includeTransactionDetails](#dms_endpoints_additionalProperties_kinesisSettings_includeTransactionDetails ) | No | boolean | No | - | Provides detailed transaction information from the source database.<br /><br />This information includes a commit timestamp, a log position, and values for \`transaction_id\` , previous \`transaction_id\` , and \`transaction_record_id\` (the record offset within a transaction). The default is \`false\` . |
427
+ | - [messageFormat](#dms_endpoints_additionalProperties_kinesisSettings_messageFormat ) | No | string | No | - | The output format for the records created on the endpoint.<br /><br />The message format is \`JSON\` (default) or \`JSON_UNFORMATTED\` (a single line with no tab). |
428
+ | - [noHexPrefix](#dms_endpoints_additionalProperties_kinesisSettings_noHexPrefix ) | No | boolean | No | - | Set this optional parameter to \`true\` to avoid adding a '0x' prefix to raw data in hexadecimal format.<br /><br />For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the \`NoHexPrefix\` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix. |
429
+ | - [partitionIncludeSchemaTable](#dms_endpoints_additionalProperties_kinesisSettings_partitionIncludeSchemaTable ) | No | boolean | No | - | Prefixes schema and table names to partition values, when the partition type is \`primary-key-type\` .<br /><br />Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is \`false\` . |
430
+ | - [serviceAccessRoleArn](#dms_endpoints_additionalProperties_kinesisSettings_serviceAccessRoleArn ) | No | string | No | - | The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream.<br /><br />The role must allow the \`iam:PassRole\` action. |
431
+ | + [streamArn](#dms_endpoints_additionalProperties_kinesisSettings_streamArn ) | No | string | No | - | The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint. |
432
+
433
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_includeControlDetails"></a>2.2.1.8.1. Property `root > dms > endpoints > additionalProperties > kinesisSettings > includeControlDetails`
434
+
435
+ | | |
436
+ | ------------ | --------- |
437
+ | **Type** | `boolean` |
438
+ | **Required** | No |
439
+
440
+ **Description:** Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.
441
+
442
+ The default is `false` .
443
+
444
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_includeNullAndEmpty"></a>2.2.1.8.2. Property `root > dms > endpoints > additionalProperties > kinesisSettings > includeNullAndEmpty`
445
+
446
+ | | |
447
+ | ------------ | --------- |
448
+ | **Type** | `boolean` |
449
+ | **Required** | No |
450
+
451
+ **Description:** Include NULL and empty columns for records migrated to the endpoint.
452
+
453
+ The default is `false` .
454
+
455
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_includePartitionValue"></a>2.2.1.8.3. Property `root > dms > endpoints > additionalProperties > kinesisSettings > includePartitionValue`
456
+
457
+ | | |
458
+ | ------------ | --------- |
459
+ | **Type** | `boolean` |
460
+ | **Required** | No |
461
+
462
+ **Description:** Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type` .
463
+
464
+ The default is `false` .
465
+
466
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_includeTableAlterOperations"></a>2.2.1.8.4. Property `root > dms > endpoints > additionalProperties > kinesisSettings > includeTableAlterOperations`
467
+
468
+ | | |
469
+ | ------------ | --------- |
470
+ | **Type** | `boolean` |
471
+ | **Required** | No |
472
+
473
+ **Description:** Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table` , `drop-table` , `add-column` , `drop-column` , and `rename-column` .
474
+
475
+ The default is `false` .
476
+
477
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_includeTransactionDetails"></a>2.2.1.8.5. Property `root > dms > endpoints > additionalProperties > kinesisSettings > includeTransactionDetails`
478
+
479
+ | | |
480
+ | ------------ | --------- |
481
+ | **Type** | `boolean` |
482
+ | **Required** | No |
483
+
484
+ **Description:** Provides detailed transaction information from the source database.
485
+
486
+ This information includes a commit timestamp, a log position, and values for `transaction_id` , previous `transaction_id` , and `transaction_record_id` (the record offset within a transaction). The default is `false` .
487
+
488
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_messageFormat"></a>2.2.1.8.6. Property `root > dms > endpoints > additionalProperties > kinesisSettings > messageFormat`
489
+
490
+ | | |
491
+ | ------------ | -------- |
492
+ | **Type** | `string` |
493
+ | **Required** | No |
494
+
495
+ **Description:** The output format for the records created on the endpoint.
496
+
497
+ The message format is `JSON` (default) or `JSON_UNFORMATTED` (a single line with no tab).
498
+
499
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_noHexPrefix"></a>2.2.1.8.7. Property `root > dms > endpoints > additionalProperties > kinesisSettings > noHexPrefix`
500
+
501
+ | | |
502
+ | ------------ | --------- |
503
+ | **Type** | `boolean` |
504
+ | **Required** | No |
505
+
506
+ **Description:** Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
507
+
508
+ For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
509
+
510
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_partitionIncludeSchemaTable"></a>2.2.1.8.8. Property `root > dms > endpoints > additionalProperties > kinesisSettings > partitionIncludeSchemaTable`
511
+
512
+ | | |
513
+ | ------------ | --------- |
514
+ | **Type** | `boolean` |
515
+ | **Required** | No |
516
+
517
+ **Description:** Prefixes schema and table names to partition values, when the partition type is `primary-key-type` .
518
+
519
+ Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is `false` .
520
+
521
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_serviceAccessRoleArn"></a>2.2.1.8.9. Property `root > dms > endpoints > additionalProperties > kinesisSettings > serviceAccessRoleArn`
522
+
523
+ | | |
524
+ | ------------ | -------- |
525
+ | **Type** | `string` |
526
+ | **Required** | No |
527
+
528
+ **Description:** The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream.
529
+
530
+ The role must allow the `iam:PassRole` action.
531
+
532
+ ###### <a name="dms_endpoints_additionalProperties_kinesisSettings_streamArn"></a>2.2.1.8.10. Property `root > dms > endpoints > additionalProperties > kinesisSettings > streamArn`
533
+
534
+ | | |
535
+ | ------------ | -------- |
536
+ | **Type** | `string` |
537
+ | **Required** | Yes |
538
+
539
+ **Description:** The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
540
+
541
+ ##### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings"></a>2.2.1.9. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings`
542
+
543
+ | | |
544
+ | ------------------------- | ------------------------------------------------------- |
545
+ | **Type** | `object` |
546
+ | **Required** | No |
547
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
548
+ | **Defined in** | #/definitions/MicrosoftSqlServerSettingsProperty |
549
+
550
+ **Description:** Settings in JSON format for the source and target Microsoft SQL Server endpoint.
551
+
552
+ 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* .
553
+
554
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
555
+ | ---------------------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
556
+ | - [bcpPacketSize](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_bcpPacketSize ) | No | number | No | - | The maximum size of the packets (in bytes) used to transfer data using BCP. |
557
+ | - [controlTablesFileGroup](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_controlTablesFileGroup ) | No | string | No | - | Specifies a file group for the AWS DMS internal tables.<br /><br />When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group. |
558
+ | - [databaseName](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_databaseName ) | No | string | No | - | Database name for the endpoint. |
559
+ | - [forceLobLookup](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_forceLobLookup ) | No | boolean | No | - | Forces LOB lookup on inline LOB. |
560
+ | - [port](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_port ) | No | number | No | - | Endpoint TCP port. |
561
+ | - [querySingleAlwaysOnNode](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_querySingleAlwaysOnNode ) | No | boolean | No | - | Cleans and recreates table metadata information on the replication instance when a mismatch occurs.<br /><br />An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance. |
562
+ | - [readBackupOnly](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_readBackupOnly ) | No | boolean | No | - | When this attribute is set to \`Y\` , AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.<br /><br />Setting this parameter to \`Y\` enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication. |
563
+ | - [safeguardPolicy](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_safeguardPolicy ) | No | string | No | - | Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.<br /><br />*Start transactions in the database:* This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.<br /><br />*Exclusively use sp_repldone within a single task* : When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method. |
564
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint. |
565
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the MicrosoftSQLServer endpoint connection details. |
566
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
567
+ | - [serverName](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_serverName ) | No | string | No | - | Fully qualified domain name of the endpoint.<br /><br />For an Amazon RDS SQL Server instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) , in the \`[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address\` field. |
568
+ | - [tlogAccessMode](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_tlogAccessMode ) | No | string | No | - | Indicates the mode used to fetch CDC data. |
569
+ | - [trimSpaceInChar](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_trimSpaceInChar ) | No | boolean | No | - | Use the \`TrimSpaceInChar\` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.<br /><br />Setting \`TrimSpaceInChar\` does not left-trim data. The default value is \`true\` . |
570
+ | - [useBcpFullLoad](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_useBcpFullLoad ) | No | boolean | No | - | Use this to attribute to transfer data for full-load operations using BCP.<br /><br />When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option. |
571
+ | - [useThirdPartyBackupDevice](#dms_endpoints_additionalProperties_microsoftSqlServerSettings_useThirdPartyBackupDevice ) | No | boolean | No | - | When this attribute is set to \`Y\` , DMS processes third-party transaction log backups if they are created in native format. |
572
+
573
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_bcpPacketSize"></a>2.2.1.9.1. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > bcpPacketSize`
574
+
575
+ | | |
576
+ | ------------ | -------- |
577
+ | **Type** | `number` |
578
+ | **Required** | No |
579
+
580
+ **Description:** The maximum size of the packets (in bytes) used to transfer data using BCP.
581
+
582
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_controlTablesFileGroup"></a>2.2.1.9.2. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > controlTablesFileGroup`
583
+
584
+ | | |
585
+ | ------------ | -------- |
586
+ | **Type** | `string` |
587
+ | **Required** | No |
588
+
589
+ **Description:** Specifies a file group for the AWS DMS internal tables.
590
+
591
+ When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
592
+
593
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_databaseName"></a>2.2.1.9.3. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > databaseName`
594
+
595
+ | | |
596
+ | ------------ | -------- |
597
+ | **Type** | `string` |
598
+ | **Required** | No |
599
+
600
+ **Description:** Database name for the endpoint.
601
+
602
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_forceLobLookup"></a>2.2.1.9.4. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > forceLobLookup`
603
+
604
+ | | |
605
+ | ------------ | --------- |
606
+ | **Type** | `boolean` |
607
+ | **Required** | No |
608
+
609
+ **Description:** Forces LOB lookup on inline LOB.
610
+
611
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_port"></a>2.2.1.9.5. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > port`
612
+
613
+ | | |
614
+ | ------------ | -------- |
615
+ | **Type** | `number` |
616
+ | **Required** | No |
617
+
618
+ **Description:** Endpoint TCP port.
619
+
620
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_querySingleAlwaysOnNode"></a>2.2.1.9.6. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > querySingleAlwaysOnNode`
621
+
622
+ | | |
623
+ | ------------ | --------- |
624
+ | **Type** | `boolean` |
625
+ | **Required** | No |
626
+
627
+ **Description:** Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
628
+
629
+ An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.
630
+
631
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_readBackupOnly"></a>2.2.1.9.7. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > readBackupOnly`
632
+
633
+ | | |
634
+ | ------------ | --------- |
635
+ | **Type** | `boolean` |
636
+ | **Required** | No |
637
+
638
+ **Description:** When this attribute is set to `Y` , AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication.
639
+
640
+ Setting this parameter to `Y` enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
641
+
642
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_safeguardPolicy"></a>2.2.1.9.8. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > safeguardPolicy`
643
+
644
+ | | |
645
+ | ------------ | -------- |
646
+ | **Type** | `string` |
647
+ | **Required** | No |
648
+
649
+ **Description:** Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
650
+
651
+ *Start transactions in the database:* This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
652
+
653
+ *Exclusively use sp_repldone within a single task* : When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
654
+
655
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_secretsManagerAccessRoleArn"></a>2.2.1.9.9. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > secretsManagerAccessRoleArn`
656
+
657
+ | | |
658
+ | ------------ | -------- |
659
+ | **Type** | `string` |
660
+ | **Required** | No |
661
+
662
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
663
+
664
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.
665
+
666
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_secretsManagerSecretArn"></a>2.2.1.9.10. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > secretsManagerSecretArn`
667
+
668
+ | | |
669
+ | ------------ | -------- |
670
+ | **Type** | `string` |
671
+ | **Required** | Yes |
672
+
673
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the MicrosoftSQLServer endpoint connection details.
674
+
675
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_secretsManagerSecretKMSArn"></a>2.2.1.9.11. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > secretsManagerSecretKMSArn`
676
+
677
+ | | |
678
+ | ------------ | -------- |
679
+ | **Type** | `string` |
680
+ | **Required** | No |
681
+
682
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
683
+
684
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_serverName"></a>2.2.1.9.12. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > serverName`
685
+
686
+ | | |
687
+ | ------------ | -------- |
688
+ | **Type** | `string` |
689
+ | **Required** | No |
690
+
691
+ **Description:** Fully qualified domain name of the endpoint.
692
+
693
+ For an Amazon RDS SQL Server instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) , in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address` field.
694
+
695
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_tlogAccessMode"></a>2.2.1.9.13. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > tlogAccessMode`
696
+
697
+ | | |
698
+ | ------------ | -------- |
699
+ | **Type** | `string` |
700
+ | **Required** | No |
701
+
702
+ **Description:** Indicates the mode used to fetch CDC data.
703
+
704
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_trimSpaceInChar"></a>2.2.1.9.14. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > trimSpaceInChar`
705
+
706
+ | | |
707
+ | ------------ | --------- |
708
+ | **Type** | `boolean` |
709
+ | **Required** | No |
710
+
711
+ **Description:** Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration.
712
+
713
+ Setting `TrimSpaceInChar` does not left-trim data. The default value is `true` .
714
+
715
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_useBcpFullLoad"></a>2.2.1.9.15. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > useBcpFullLoad`
716
+
717
+ | | |
718
+ | ------------ | --------- |
719
+ | **Type** | `boolean` |
720
+ | **Required** | No |
721
+
722
+ **Description:** Use this to attribute to transfer data for full-load operations using BCP.
723
+
724
+ When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
725
+
726
+ ###### <a name="dms_endpoints_additionalProperties_microsoftSqlServerSettings_useThirdPartyBackupDevice"></a>2.2.1.9.16. Property `root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > useThirdPartyBackupDevice`
727
+
728
+ | | |
729
+ | ------------ | --------- |
730
+ | **Type** | `boolean` |
731
+ | **Required** | No |
732
+
733
+ **Description:** When this attribute is set to `Y` , DMS processes third-party transaction log backups if they are created in native format.
734
+
735
+ ##### <a name="dms_endpoints_additionalProperties_mongoDbSettings"></a>2.2.1.10. Property `root > dms > endpoints > additionalProperties > mongoDbSettings`
736
+
737
+ | | |
738
+ | ------------------------- | ------------------------------------------------------- |
739
+ | **Type** | `object` |
740
+ | **Required** | No |
741
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
742
+ | **Defined in** | #/definitions/MongoDbSettingsProperty |
743
+
744
+ **Description:** Settings in JSON format for the source MongoDB endpoint.
745
+
746
+ For more information about the available settings, see [Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide* .
747
+
748
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
749
+ | ----------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
750
+ | - [authMechanism](#dms_endpoints_additionalProperties_mongoDbSettings_authMechanism ) | No | string | No | - | The authentication mechanism you use to access the MongoDB source endpoint.<br /><br />For the default value, in MongoDB version 2.x, \`"default"\` is \`"mongodb_cr"\` . For MongoDB version 3.x or later, \`"default"\` is \`"scram_sha_1"\` . This setting isn't used when \`AuthType\` is set to \`"no"\` . |
751
+ | - [authSource](#dms_endpoints_additionalProperties_mongoDbSettings_authSource ) | No | string | No | - | The MongoDB database name. This setting isn't used when \`AuthType\` is set to \`"no"\` .<br /><br />The default is \`"admin"\` . |
752
+ | - [authType](#dms_endpoints_additionalProperties_mongoDbSettings_authType ) | No | string | No | - | The authentication type you use to access the MongoDB source endpoint.<br /><br />When set to \`"no"\` , user name and password parameters are not used and can be empty. |
753
+ | - [databaseName](#dms_endpoints_additionalProperties_mongoDbSettings_databaseName ) | No | string | No | - | The database name on the MongoDB source endpoint. |
754
+ | - [docsToInvestigate](#dms_endpoints_additionalProperties_mongoDbSettings_docsToInvestigate ) | No | string | No | - | Indicates the number of documents to preview to determine the document organization.<br /><br />Use this setting when \`NestingLevel\` is set to \`"one"\` .<br /><br />Must be a positive value greater than \`0\` . Default value is \`1000\` . |
755
+ | - [extractDocId](#dms_endpoints_additionalProperties_mongoDbSettings_extractDocId ) | No | string | No | - | Specifies the document ID. Use this setting when \`NestingLevel\` is set to \`"none"\` .<br /><br />Default value is \`"false"\` . |
756
+ | - [nestingLevel](#dms_endpoints_additionalProperties_mongoDbSettings_nestingLevel ) | No | string | No | - | Specifies either document or table mode.<br /><br />Default value is \`"none"\` . Specify \`"none"\` to use document mode. Specify \`"one"\` to use table mode. |
757
+ | - [port](#dms_endpoints_additionalProperties_mongoDbSettings_port ) | No | number | No | - | The port value for the MongoDB source endpoint. |
758
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_mongoDbSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint. |
759
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_mongoDbSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the MongoDB endpoint connection details. |
760
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_mongoDbSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
761
+ | - [serverName](#dms_endpoints_additionalProperties_mongoDbSettings_serverName ) | No | string | No | - | The name of the server on the MongoDB source endpoint. |
762
+
763
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_authMechanism"></a>2.2.1.10.1. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > authMechanism`
764
+
765
+ | | |
766
+ | ------------ | -------- |
767
+ | **Type** | `string` |
768
+ | **Required** | No |
769
+
770
+ **Description:** The authentication mechanism you use to access the MongoDB source endpoint.
771
+
772
+ For the default value, in MongoDB version 2.x, `"default"` is `"mongodb_cr"` . For MongoDB version 3.x or later, `"default"` is `"scram_sha_1"` . This setting isn't used when `AuthType` is set to `"no"` .
773
+
774
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_authSource"></a>2.2.1.10.2. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > authSource`
775
+
776
+ | | |
777
+ | ------------ | -------- |
778
+ | **Type** | `string` |
779
+ | **Required** | No |
780
+
781
+ **Description:** The MongoDB database name. This setting isn't used when `AuthType` is set to `"no"` .
782
+
783
+ The default is `"admin"` .
784
+
785
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_authType"></a>2.2.1.10.3. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > authType`
786
+
787
+ | | |
788
+ | ------------ | -------- |
789
+ | **Type** | `string` |
790
+ | **Required** | No |
791
+
792
+ **Description:** The authentication type you use to access the MongoDB source endpoint.
793
+
794
+ When set to `"no"` , user name and password parameters are not used and can be empty.
795
+
796
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_databaseName"></a>2.2.1.10.4. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > databaseName`
797
+
798
+ | | |
799
+ | ------------ | -------- |
800
+ | **Type** | `string` |
801
+ | **Required** | No |
802
+
803
+ **Description:** The database name on the MongoDB source endpoint.
804
+
805
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_docsToInvestigate"></a>2.2.1.10.5. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > docsToInvestigate`
806
+
807
+ | | |
808
+ | ------------ | -------- |
809
+ | **Type** | `string` |
810
+ | **Required** | No |
811
+
812
+ **Description:** Indicates the number of documents to preview to determine the document organization.
813
+
814
+ Use this setting when `NestingLevel` is set to `"one"` .
815
+
816
+ Must be a positive value greater than `0` . Default value is `1000` .
817
+
818
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_extractDocId"></a>2.2.1.10.6. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > extractDocId`
819
+
820
+ | | |
821
+ | ------------ | -------- |
822
+ | **Type** | `string` |
823
+ | **Required** | No |
824
+
825
+ **Description:** Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"` .
826
+
827
+ Default value is `"false"` .
828
+
829
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_nestingLevel"></a>2.2.1.10.7. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > nestingLevel`
830
+
831
+ | | |
832
+ | ------------ | -------- |
833
+ | **Type** | `string` |
834
+ | **Required** | No |
835
+
836
+ **Description:** Specifies either document or table mode.
837
+
838
+ Default value is `"none"` . Specify `"none"` to use document mode. Specify `"one"` to use table mode.
839
+
840
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_port"></a>2.2.1.10.8. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > port`
841
+
842
+ | | |
843
+ | ------------ | -------- |
844
+ | **Type** | `number` |
845
+ | **Required** | No |
846
+
847
+ **Description:** The port value for the MongoDB source endpoint.
848
+
849
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_secretsManagerAccessRoleArn"></a>2.2.1.10.9. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > secretsManagerAccessRoleArn`
850
+
851
+ | | |
852
+ | ------------ | -------- |
853
+ | **Type** | `string` |
854
+ | **Required** | No |
855
+
856
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
857
+
858
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
859
+
860
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_secretsManagerSecretArn"></a>2.2.1.10.10. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > secretsManagerSecretArn`
861
+
862
+ | | |
863
+ | ------------ | -------- |
864
+ | **Type** | `string` |
865
+ | **Required** | Yes |
866
+
867
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details.
868
+
869
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_secretsManagerSecretKMSArn"></a>2.2.1.10.11. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > secretsManagerSecretKMSArn`
870
+
871
+ | | |
872
+ | ------------ | -------- |
873
+ | **Type** | `string` |
874
+ | **Required** | No |
875
+
876
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
877
+
878
+ ###### <a name="dms_endpoints_additionalProperties_mongoDbSettings_serverName"></a>2.2.1.10.12. Property `root > dms > endpoints > additionalProperties > mongoDbSettings > serverName`
879
+
880
+ | | |
881
+ | ------------ | -------- |
882
+ | **Type** | `string` |
883
+ | **Required** | No |
884
+
885
+ **Description:** The name of the server on the MongoDB source endpoint.
886
+
887
+ ##### <a name="dms_endpoints_additionalProperties_mySqlSettings"></a>2.2.1.11. Property `root > dms > endpoints > additionalProperties > mySqlSettings`
888
+
889
+ | | |
890
+ | ------------------------- | ------------------------------------------------------- |
891
+ | **Type** | `object` |
892
+ | **Required** | No |
893
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
894
+ | **Defined in** | #/definitions/MySqlSettingsProperty |
895
+
896
+ **Description:** Settings in JSON format for the source and target MySQL endpoint.
897
+
898
+ 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* .
899
+
900
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
901
+ | ------------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
902
+ | - [afterConnectScript](#dms_endpoints_additionalProperties_mySqlSettings_afterConnectScript ) | No | string | No | - | Specifies a script to run immediately after AWS DMS connects to the endpoint.<br /><br />The migration task continues running regardless if the SQL statement succeeds or fails.<br /><br />For this parameter, provide the code of the script itself, not the name of a file containing the script. |
903
+ | - [cleanSourceMetadataOnMismatch](#dms_endpoints_additionalProperties_mySqlSettings_cleanSourceMetadataOnMismatch ) | No | boolean | No | - | Cleans and recreates table metadata information on the replication instance when a mismatch occurs.<br /><br />For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. |
904
+ | - [eventsPollInterval](#dms_endpoints_additionalProperties_mySqlSettings_eventsPollInterval ) | No | number | No | - | Specifies how often to check the binary log for new changes/events when the database is idle.<br /><br />The default is five seconds.<br /><br />Example: \`eventsPollInterval=5;\`<br /><br />In the example, AWS DMS checks for changes in the binary logs every five seconds. |
905
+ | - [maxFileSize](#dms_endpoints_additionalProperties_mySqlSettings_maxFileSize ) | No | number | No | - | Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.<br /><br />Example: \`maxFileSize=512\` |
906
+ | - [parallelLoadThreads](#dms_endpoints_additionalProperties_mySqlSettings_parallelLoadThreads ) | No | number | No | - | Improves performance when loading data into the MySQL-compatible target database.<br /><br />Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.<br /><br />Example: \`parallelLoadThreads=1\` |
907
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_mySqlSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint. |
908
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_mySqlSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the MySQL endpoint connection details. |
909
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_mySqlSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
910
+ | - [serverTimezone](#dms_endpoints_additionalProperties_mySqlSettings_serverTimezone ) | No | string | No | - | Specifies the time zone for the source MySQL database.<br /><br />Example: \`serverTimezone=US/Pacific;\`<br /><br />Note: Do not enclose time zones in single quotes. |
911
+ | - [targetDbType](#dms_endpoints_additionalProperties_mySqlSettings_targetDbType ) | No | string | No | - | Specifies where to migrate source tables on the target, either to a single database or multiple databases.<br /><br />If you specify \`SPECIFIC_DATABASE\` , specify the database name using the \`DatabaseName\` parameter of the \`Endpoint\` object.<br /><br />Example: \`targetDbType=MULTIPLE_DATABASES\` |
912
+
913
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_afterConnectScript"></a>2.2.1.11.1. Property `root > dms > endpoints > additionalProperties > mySqlSettings > afterConnectScript`
914
+
915
+ | | |
916
+ | ------------ | -------- |
917
+ | **Type** | `string` |
918
+ | **Required** | No |
919
+
920
+ **Description:** Specifies a script to run immediately after AWS DMS connects to the endpoint.
921
+
922
+ The migration task continues running regardless if the SQL statement succeeds or fails.
923
+
924
+ For this parameter, provide the code of the script itself, not the name of a file containing the script.
925
+
926
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_cleanSourceMetadataOnMismatch"></a>2.2.1.11.2. Property `root > dms > endpoints > additionalProperties > mySqlSettings > cleanSourceMetadataOnMismatch`
927
+
928
+ | | |
929
+ | ------------ | --------- |
930
+ | **Type** | `boolean` |
931
+ | **Required** | No |
932
+
933
+ **Description:** Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
934
+
935
+ For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance.
936
+
937
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_eventsPollInterval"></a>2.2.1.11.3. Property `root > dms > endpoints > additionalProperties > mySqlSettings > eventsPollInterval`
938
+
939
+ | | |
940
+ | ------------ | -------- |
941
+ | **Type** | `number` |
942
+ | **Required** | No |
943
+
944
+ **Description:** Specifies how often to check the binary log for new changes/events when the database is idle.
945
+
946
+ The default is five seconds.
947
+
948
+ Example: `eventsPollInterval=5;`
949
+
950
+ In the example, AWS DMS checks for changes in the binary logs every five seconds.
951
+
952
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_maxFileSize"></a>2.2.1.11.4. Property `root > dms > endpoints > additionalProperties > mySqlSettings > maxFileSize`
953
+
954
+ | | |
955
+ | ------------ | -------- |
956
+ | **Type** | `number` |
957
+ | **Required** | No |
958
+
959
+ **Description:** Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
960
+
961
+ Example: `maxFileSize=512`
962
+
963
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_parallelLoadThreads"></a>2.2.1.11.5. Property `root > dms > endpoints > additionalProperties > mySqlSettings > parallelLoadThreads`
964
+
965
+ | | |
966
+ | ------------ | -------- |
967
+ | **Type** | `number` |
968
+ | **Required** | No |
969
+
970
+ **Description:** Improves performance when loading data into the MySQL-compatible target database.
971
+
972
+ Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.
973
+
974
+ Example: `parallelLoadThreads=1`
975
+
976
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_secretsManagerAccessRoleArn"></a>2.2.1.11.6. Property `root > dms > endpoints > additionalProperties > mySqlSettings > secretsManagerAccessRoleArn`
977
+
978
+ | | |
979
+ | ------------ | -------- |
980
+ | **Type** | `string` |
981
+ | **Required** | No |
982
+
983
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
984
+
985
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.
986
+
987
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_secretsManagerSecretArn"></a>2.2.1.11.7. Property `root > dms > endpoints > additionalProperties > mySqlSettings > secretsManagerSecretArn`
988
+
989
+ | | |
990
+ | ------------ | -------- |
991
+ | **Type** | `string` |
992
+ | **Required** | Yes |
993
+
994
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
995
+
996
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_secretsManagerSecretKMSArn"></a>2.2.1.11.8. Property `root > dms > endpoints > additionalProperties > mySqlSettings > secretsManagerSecretKMSArn`
997
+
998
+ | | |
999
+ | ------------ | -------- |
1000
+ | **Type** | `string` |
1001
+ | **Required** | No |
1002
+
1003
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
1004
+
1005
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_serverTimezone"></a>2.2.1.11.9. Property `root > dms > endpoints > additionalProperties > mySqlSettings > serverTimezone`
1006
+
1007
+ | | |
1008
+ | ------------ | -------- |
1009
+ | **Type** | `string` |
1010
+ | **Required** | No |
1011
+
1012
+ **Description:** Specifies the time zone for the source MySQL database.
1013
+
1014
+ Example: `serverTimezone=US/Pacific;`
1015
+
1016
+ Note: Do not enclose time zones in single quotes.
1017
+
1018
+ ###### <a name="dms_endpoints_additionalProperties_mySqlSettings_targetDbType"></a>2.2.1.11.10. Property `root > dms > endpoints > additionalProperties > mySqlSettings > targetDbType`
1019
+
1020
+ | | |
1021
+ | ------------ | -------- |
1022
+ | **Type** | `string` |
1023
+ | **Required** | No |
1024
+
1025
+ **Description:** Specifies where to migrate source tables on the target, either to a single database or multiple databases.
1026
+
1027
+ If you specify `SPECIFIC_DATABASE` , specify the database name using the `DatabaseName` parameter of the `Endpoint` object.
1028
+
1029
+ Example: `targetDbType=MULTIPLE_DATABASES`
1030
+
1031
+ ##### <a name="dms_endpoints_additionalProperties_neptuneSettings"></a>2.2.1.12. Property `root > dms > endpoints > additionalProperties > neptuneSettings`
1032
+
1033
+ | | |
1034
+ | ------------------------- | ------------------------------------------------------- |
1035
+ | **Type** | `object` |
1036
+ | **Required** | No |
1037
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
1038
+ | **Defined in** | #/definitions/NeptuneSettingsProperty |
1039
+
1040
+ **Description:** Settings in JSON format for the target Amazon Neptune endpoint.
1041
+
1042
+ 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* .
1043
+
1044
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
1045
+ | --------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1046
+ | - [errorRetryDuration](#dms_endpoints_additionalProperties_neptuneSettings_errorRetryDuration ) | No | number | No | - | The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error.<br /><br />The default is 250. |
1047
+ | - [maxFileSize](#dms_endpoints_additionalProperties_neptuneSettings_maxFileSize ) | No | number | No | - | The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data. |
1048
+ | - [maxRetryCount](#dms_endpoints_additionalProperties_neptuneSettings_maxRetryCount ) | No | number | No | - | The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.<br /><br />The default is 5. |
1049
+ | - [s3BucketFolder](#dms_endpoints_additionalProperties_neptuneSettings_s3BucketFolder ) | No | string | No | - | A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by \`S3BucketName\`. |
1050
+ | + [s3BucketName](#dms_endpoints_additionalProperties_neptuneSettings_s3BucketName ) | No | string | No | - | The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files. |
1051
+ | - [serviceAccessRoleArn](#dms_endpoints_additionalProperties_neptuneSettings_serviceAccessRoleArn ) | No | string | No | - | The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.<br /><br />The role must allow the \`iam:PassRole\` action.<br /><br />For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide* . |
1052
+
1053
+ ###### <a name="dms_endpoints_additionalProperties_neptuneSettings_errorRetryDuration"></a>2.2.1.12.1. Property `root > dms > endpoints > additionalProperties > neptuneSettings > errorRetryDuration`
1054
+
1055
+ | | |
1056
+ | ------------ | -------- |
1057
+ | **Type** | `number` |
1058
+ | **Required** | No |
1059
+
1060
+ **Description:** The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error.
1061
+
1062
+ The default is 250.
1063
+
1064
+ ###### <a name="dms_endpoints_additionalProperties_neptuneSettings_maxFileSize"></a>2.2.1.12.2. Property `root > dms > endpoints > additionalProperties > neptuneSettings > maxFileSize`
1065
+
1066
+ | | |
1067
+ | ------------ | -------- |
1068
+ | **Type** | `number` |
1069
+ | **Required** | No |
1070
+
1071
+ **Description:** The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
1072
+
1073
+ ###### <a name="dms_endpoints_additionalProperties_neptuneSettings_maxRetryCount"></a>2.2.1.12.3. Property `root > dms > endpoints > additionalProperties > neptuneSettings > maxRetryCount`
1074
+
1075
+ | | |
1076
+ | ------------ | -------- |
1077
+ | **Type** | `number` |
1078
+ | **Required** | No |
1079
+
1080
+ **Description:** The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.
1081
+
1082
+ The default is 5.
1083
+
1084
+ ###### <a name="dms_endpoints_additionalProperties_neptuneSettings_s3BucketFolder"></a>2.2.1.12.4. Property `root > dms > endpoints > additionalProperties > neptuneSettings > s3BucketFolder`
1085
+
1086
+ | | |
1087
+ | ------------ | -------- |
1088
+ | **Type** | `string` |
1089
+ | **Required** | No |
1090
+
1091
+ **Description:** A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by `S3BucketName`.
1092
+
1093
+ ###### <a name="dms_endpoints_additionalProperties_neptuneSettings_s3BucketName"></a>2.2.1.12.5. Property `root > dms > endpoints > additionalProperties > neptuneSettings > s3BucketName`
1094
+
1095
+ | | |
1096
+ | ------------ | -------- |
1097
+ | **Type** | `string` |
1098
+ | **Required** | Yes |
1099
+
1100
+ **Description:** The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
1101
+
1102
+ ###### <a name="dms_endpoints_additionalProperties_neptuneSettings_serviceAccessRoleArn"></a>2.2.1.12.6. Property `root > dms > endpoints > additionalProperties > neptuneSettings > serviceAccessRoleArn`
1103
+
1104
+ | | |
1105
+ | ------------ | -------- |
1106
+ | **Type** | `string` |
1107
+ | **Required** | No |
1108
+
1109
+ **Description:** The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.
1110
+
1111
+ The role must allow the `iam:PassRole` action.
1112
+
1113
+ For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide* .
1114
+
1115
+ ##### <a name="dms_endpoints_additionalProperties_oracleSettings"></a>2.2.1.13. Property `root > dms > endpoints > additionalProperties > oracleSettings`
1116
+
1117
+ | | |
1118
+ | ------------------------- | ------------------------------------------------------- |
1119
+ | **Type** | `object` |
1120
+ | **Required** | No |
1121
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
1122
+ | **Defined in** | #/definitions/OracleSettingsProperty |
1123
+
1124
+ **Description:** Settings in JSON format for the source and target Oracle endpoint.
1125
+
1126
+ 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* .
1127
+
1128
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
1129
+ | -------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1130
+ | - [accessAlternateDirectly](#dms_endpoints_additionalProperties_oracleSettings_accessAlternateDirectly ) | No | boolean | No | - | Set this attribute to \`false\` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.<br /><br />This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access. |
1131
+ | - [addSupplementalLogging](#dms_endpoints_additionalProperties_oracleSettings_addSupplementalLogging ) | No | boolean | No | - | Set this attribute to set up table-level supplemental logging for the Oracle database.<br /><br />This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.<br /><br />If you use this option, you still need to enable database-level supplemental logging. |
1132
+ | - [additionalArchivedLogDestId](#dms_endpoints_additionalProperties_oracleSettings_additionalArchivedLogDestId ) | No | number | No | - | Set this attribute with \`ArchivedLogDestId\` in a primary/ standby setup.<br /><br />This attribute is useful in the case of a switchover. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.<br /><br />Although AWS DMS supports the use of the Oracle \`RESETLOGS\` option to open the database, never use \`RESETLOGS\` unless necessary. For additional information about \`RESETLOGS\` , see [RMAN Data Repair Concepts](https://docs.aws.amazon.com/https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide* . |
1133
+ | - [allowSelectNestedTables](#dms_endpoints_additionalProperties_oracleSettings_allowSelectNestedTables ) | No | boolean | No | - | Set this attribute to \`true\` to enable replication of Oracle tables containing columns that are nested tables or defined types. |
1134
+ | - [archivedLogDestId](#dms_endpoints_additionalProperties_oracleSettings_archivedLogDestId ) | No | number | No | - | Specifies the ID of the destination for the archived redo logs.<br /><br />This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the \`AdditionalArchivedLogDestId\` option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset. |
1135
+ | - [archivedLogsOnly](#dms_endpoints_additionalProperties_oracleSettings_archivedLogsOnly ) | No | boolean | No | - | When this field is set to \`Y\` , AWS DMS only accesses the archived redo logs.<br /><br />If the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS user account needs to be granted ASM privileges. |
1136
+ | - [asmServer](#dms_endpoints_additionalProperties_oracleSettings_asmServer ) | No | string | No | - | For an Oracle source endpoint, your ASM server address.<br /><br />You can set this value from the \`asm_server\` value. You set \`asm_server\` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) . |
1137
+ | - [charLengthSemantics](#dms_endpoints_additionalProperties_oracleSettings_charLengthSemantics ) | No | string | No | - | Specifies whether the length of a character column is in bytes or in characters.<br /><br />To indicate that the character column length is in characters, set this attribute to \`CHAR\` . Otherwise, the character column length is in bytes.<br /><br />Example: \`charLengthSemantics=CHAR;\` |
1138
+ | - [directPathNoLog](#dms_endpoints_additionalProperties_oracleSettings_directPathNoLog ) | No | boolean | No | - | When set to \`true\` , this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs. |
1139
+ | - [directPathParallelLoad](#dms_endpoints_additionalProperties_oracleSettings_directPathParallelLoad ) | No | boolean | No | - | When set to \`true\` , this attribute specifies a parallel load when \`useDirectPathFullLoad\` is set to \`Y\` .<br /><br />This attribute also only applies when you use the AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes. |
1140
+ | - [enableHomogenousTablespace](#dms_endpoints_additionalProperties_oracleSettings_enableHomogenousTablespace ) | No | boolean | No | - | Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target. |
1141
+ | - [extraArchivedLogDestIds](#dms_endpoints_additionalProperties_oracleSettings_extraArchivedLogDestIds ) | No | array of number | No | - | Specifies the IDs of one more destinations for one or more archived redo logs.<br /><br />These IDs are the values of the \`dest_id\` column in the \`v$archived_log\` view. Use this setting with the \`archivedLogDestId\` extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.<br /><br />This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, AWS DMS needs information about what destination to get archive redo logs from to read changes. AWS DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.<br /><br />\`archivedLogDestId=1; ExtraArchivedLogDestIds=[2]\`<br /><br />In a primary-to-multiple-standby setup, you might apply the following settings.<br /><br />\`archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]\`<br /><br />Although AWS DMS supports the use of the Oracle \`RESETLOGS\` option to open the database, never use \`RESETLOGS\` unless it's necessary. For more information about \`RESETLOGS\` , see [RMAN Data Repair Concepts](https://docs.aws.amazon.com/https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide* . |
1142
+ | - [failTasksOnLobTruncation](#dms_endpoints_additionalProperties_oracleSettings_failTasksOnLobTruncation ) | No | boolean | No | - | When set to \`true\` , this attribute causes a task to fail if the actual size of an LOB column is greater than the specified \`LobMaxSize\` .<br /><br />If a task is set to limited LOB mode and this option is set to \`true\` , the task fails instead of truncating the LOB data. |
1143
+ | - [numberDatatypeScale](#dms_endpoints_additionalProperties_oracleSettings_numberDatatypeScale ) | No | number | No | - | Specifies the number scale.<br /><br />You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.<br /><br />Example: \`numberDataTypeScale=12\` |
1144
+ | - [oraclePathPrefix](#dms_endpoints_additionalProperties_oracleSettings_oraclePathPrefix ) | No | string | No | - | Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.<br /><br />This value specifies the default Oracle root used to access the redo logs. |
1145
+ | - [parallelAsmReadThreads](#dms_endpoints_additionalProperties_oracleSettings_parallelAsmReadThreads ) | No | number | No | - | Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).<br /><br />You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the \`readAheadBlocks\` attribute. |
1146
+ | - [readAheadBlocks](#dms_endpoints_additionalProperties_oracleSettings_readAheadBlocks ) | No | number | No | - | Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).<br /><br />You can specify an integer value between 1000 (the default) and 200,000 (the maximum). |
1147
+ | - [readTableSpaceName](#dms_endpoints_additionalProperties_oracleSettings_readTableSpaceName ) | No | boolean | No | - | When set to \`true\` , this attribute supports tablespace replication. |
1148
+ | - [replacePathPrefix](#dms_endpoints_additionalProperties_oracleSettings_replacePathPrefix ) | No | boolean | No | - | Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.<br /><br />This setting tells DMS instance to replace the default Oracle root with the specified \`usePathPrefix\` setting to access the redo logs. |
1149
+ | - [retryInterval](#dms_endpoints_additionalProperties_oracleSettings_retryInterval ) | No | number | No | - | Specifies the number of seconds that the system waits before resending a query.<br /><br />Example: \`retryInterval=6;\` |
1150
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_oracleSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint. |
1151
+ | - [secretsManagerOracleAsmAccessRoleArn](#dms_endpoints_additionalProperties_oracleSettings_secretsManagerOracleAsmAccessRoleArn ) | No | string | No | - | Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).<br /><br />The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the \`SecretsManagerOracleAsmSecret\` . This \`SecretsManagerOracleAsmSecret\` has the secret value that allows access to the Oracle ASM of the endpoint.<br /><br />> You can specify one of two sets of values for these permissions. You can specify the values for this setting and \`SecretsManagerOracleAsmSecretId\` . Or you can specify clear-text values for \`AsmUser\` , \`AsmPassword\` , and \`AsmServerName\` . You can't specify both.<br />><br />> For more information on creating this \`SecretsManagerOracleAsmSecret\` , the corresponding \`SecretsManagerOracleAsmAccessRoleArn\` , and the \`SecretsManagerOracleAsmSecretId\` that is required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide* . |
1152
+ | - [secretsManagerOracleAsmSecretArn](#dms_endpoints_additionalProperties_oracleSettings_secretsManagerOracleAsmSecretArn ) | No | string | No | - | Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).<br /><br />The full ARN of the \`SecretsManagerOracleAsmSecret\` that contains the Oracle ASM connection details for the Oracle endpoint. |
1153
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_oracleSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the Oracle endpoint connection details. |
1154
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_oracleSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
1155
+ | - [spatialDataOptionToGeoJsonFunctionName](#dms_endpoints_additionalProperties_oracleSettings_spatialDataOptionToGeoJsonFunctionName ) | No | string | No | - | Use this attribute to convert \`SDO_GEOMETRY\` to \`GEOJSON\` format.<br /><br />By default, DMS calls the \`SDO2GEOJSON\` custom function if present and accessible. Or you can create your own custom function that mimics the operation of \`SDOGEOJSON\` and set \`SpatialDataOptionToGeoJsonFunctionName\` to call it instead. |
1156
+ | - [standbyDelayTime](#dms_endpoints_additionalProperties_oracleSettings_standbyDelayTime ) | No | number | No | - | Use this attribute to specify a time in minutes for the delay in standby sync.<br /><br />If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.<br /><br />In AWS DMS , you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production. |
1157
+ | - [useAlternateFolderForOnline](#dms_endpoints_additionalProperties_oracleSettings_useAlternateFolderForOnline ) | No | boolean | No | - | Set this attribute to \`true\` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.<br /><br />This tells the DMS instance to use any specified prefix replacement to access all online redo logs. |
1158
+ | - [useBFile](#dms_endpoints_additionalProperties_oracleSettings_useBFile ) | No | boolean | No | - | Set this attribute to Y to capture change data using the Binary Reader utility.<br /><br />Set \`UseLogminerReader\` to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see [Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) . |
1159
+ | - [useDirectPathFullLoad](#dms_endpoints_additionalProperties_oracleSettings_useDirectPathFullLoad ) | No | boolean | No | - | Set this attribute to Y to have AWS DMS use a direct path full load.<br /><br />Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load. |
1160
+ | - [useLogminerReader](#dms_endpoints_additionalProperties_oracleSettings_useLogminerReader ) | No | boolean | No | - | Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default).<br /><br />Set this attribute to N if you want to access the redo logs as a binary file. When you set \`UseLogminerReader\` to N, also set \`UseBfile\` to Y. For more information on this setting and using Oracle ASM, see [Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the *AWS DMS User Guide* . |
1161
+ | - [usePathPrefix](#dms_endpoints_additionalProperties_oracleSettings_usePathPrefix ) | No | string | No | - | Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.<br /><br />This value specifies the path prefix used to replace the default Oracle root to access the redo logs. |
1162
+
1163
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_accessAlternateDirectly"></a>2.2.1.13.1. Property `root > dms > endpoints > additionalProperties > oracleSettings > accessAlternateDirectly`
1164
+
1165
+ | | |
1166
+ | ------------ | --------- |
1167
+ | **Type** | `boolean` |
1168
+ | **Required** | No |
1169
+
1170
+ **Description:** Set this attribute to `false` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
1171
+
1172
+ This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.
1173
+
1174
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_addSupplementalLogging"></a>2.2.1.13.2. Property `root > dms > endpoints > additionalProperties > oracleSettings > addSupplementalLogging`
1175
+
1176
+ | | |
1177
+ | ------------ | --------- |
1178
+ | **Type** | `boolean` |
1179
+ | **Required** | No |
1180
+
1181
+ **Description:** Set this attribute to set up table-level supplemental logging for the Oracle database.
1182
+
1183
+ This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.
1184
+
1185
+ If you use this option, you still need to enable database-level supplemental logging.
1186
+
1187
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_additionalArchivedLogDestId"></a>2.2.1.13.3. Property `root > dms > endpoints > additionalProperties > oracleSettings > additionalArchivedLogDestId`
1188
+
1189
+ | | |
1190
+ | ------------ | -------- |
1191
+ | **Type** | `number` |
1192
+ | **Required** | No |
1193
+
1194
+ **Description:** Set this attribute with `ArchivedLogDestId` in a primary/ standby setup.
1195
+
1196
+ This attribute is useful in the case of a switchover. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.
1197
+
1198
+ Although AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless necessary. For additional information about `RESETLOGS` , see [RMAN Data Repair Concepts](https://docs.aws.amazon.com/https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide* .
1199
+
1200
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_allowSelectNestedTables"></a>2.2.1.13.4. Property `root > dms > endpoints > additionalProperties > oracleSettings > allowSelectNestedTables`
1201
+
1202
+ | | |
1203
+ | ------------ | --------- |
1204
+ | **Type** | `boolean` |
1205
+ | **Required** | No |
1206
+
1207
+ **Description:** Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types.
1208
+
1209
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_archivedLogDestId"></a>2.2.1.13.5. Property `root > dms > endpoints > additionalProperties > oracleSettings > archivedLogDestId`
1210
+
1211
+ | | |
1212
+ | ------------ | -------- |
1213
+ | **Type** | `number` |
1214
+ | **Required** | No |
1215
+
1216
+ **Description:** Specifies the ID of the destination for the archived redo logs.
1217
+
1218
+ This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the `AdditionalArchivedLogDestId` option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
1219
+
1220
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_archivedLogsOnly"></a>2.2.1.13.6. Property `root > dms > endpoints > additionalProperties > oracleSettings > archivedLogsOnly`
1221
+
1222
+ | | |
1223
+ | ------------ | --------- |
1224
+ | **Type** | `boolean` |
1225
+ | **Required** | No |
1226
+
1227
+ **Description:** When this field is set to `Y` , AWS DMS only accesses the archived redo logs.
1228
+
1229
+ If the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS user account needs to be granted ASM privileges.
1230
+
1231
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_asmServer"></a>2.2.1.13.7. Property `root > dms > endpoints > additionalProperties > oracleSettings > asmServer`
1232
+
1233
+ | | |
1234
+ | ------------ | -------- |
1235
+ | **Type** | `string` |
1236
+ | **Required** | No |
1237
+
1238
+ **Description:** For an Oracle source endpoint, your ASM server address.
1239
+
1240
+ You can set this value from the `asm_server` value. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) .
1241
+
1242
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_charLengthSemantics"></a>2.2.1.13.8. Property `root > dms > endpoints > additionalProperties > oracleSettings > charLengthSemantics`
1243
+
1244
+ | | |
1245
+ | ------------ | -------- |
1246
+ | **Type** | `string` |
1247
+ | **Required** | No |
1248
+
1249
+ **Description:** Specifies whether the length of a character column is in bytes or in characters.
1250
+
1251
+ To indicate that the character column length is in characters, set this attribute to `CHAR` . Otherwise, the character column length is in bytes.
1252
+
1253
+ Example: `charLengthSemantics=CHAR;`
1254
+
1255
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_directPathNoLog"></a>2.2.1.13.9. Property `root > dms > endpoints > additionalProperties > oracleSettings > directPathNoLog`
1256
+
1257
+ | | |
1258
+ | ------------ | --------- |
1259
+ | **Type** | `boolean` |
1260
+ | **Required** | No |
1261
+
1262
+ **Description:** When set to `true` , this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.
1263
+
1264
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_directPathParallelLoad"></a>2.2.1.13.10. Property `root > dms > endpoints > additionalProperties > oracleSettings > directPathParallelLoad`
1265
+
1266
+ | | |
1267
+ | ------------ | --------- |
1268
+ | **Type** | `boolean` |
1269
+ | **Required** | No |
1270
+
1271
+ **Description:** When set to `true` , this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y` .
1272
+
1273
+ This attribute also only applies when you use the AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
1274
+
1275
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_enableHomogenousTablespace"></a>2.2.1.13.11. Property `root > dms > endpoints > additionalProperties > oracleSettings > enableHomogenousTablespace`
1276
+
1277
+ | | |
1278
+ | ------------ | --------- |
1279
+ | **Type** | `boolean` |
1280
+ | **Required** | No |
1281
+
1282
+ **Description:** Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
1283
+
1284
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_extraArchivedLogDestIds"></a>2.2.1.13.12. Property `root > dms > endpoints > additionalProperties > oracleSettings > extraArchivedLogDestIds`
1285
+
1286
+ | | |
1287
+ | ------------ | ----------------- |
1288
+ | **Type** | `array of number` |
1289
+ | **Required** | No |
1290
+
1291
+ **Description:** Specifies the IDs of one more destinations for one or more archived redo logs.
1292
+
1293
+ These IDs are the values of the `dest_id` column in the `v$archived_log` view. Use this setting with the `archivedLogDestId` extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.
1294
+
1295
+ This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, AWS DMS needs information about what destination to get archive redo logs from to read changes. AWS DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.
1296
+
1297
+ `archivedLogDestId=1; ExtraArchivedLogDestIds=[2]`
1298
+
1299
+ In a primary-to-multiple-standby setup, you might apply the following settings.
1300
+
1301
+ `archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]`
1302
+
1303
+ Although AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless it's necessary. For more information about `RESETLOGS` , see [RMAN Data Repair Concepts](https://docs.aws.amazon.com/https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide* .
1304
+
1305
+ | | Array restrictions |
1306
+ | -------------------- | ------------------ |
1307
+ | **Min items** | N/A |
1308
+ | **Max items** | N/A |
1309
+ | **Items unicity** | False |
1310
+ | **Additional items** | False |
1311
+ | **Tuple validation** | See below |
1312
+
1313
+ | Each item of this array must be | Description |
1314
+ | ----------------------------------------------------------------------------------------------------------------- | ----------- |
1315
+ | [extraArchivedLogDestIds items](#dms_endpoints_additionalProperties_oracleSettings_extraArchivedLogDestIds_items) | - |
1316
+
1317
+ ###### <a name="autogenerated_heading_2"></a>2.2.1.13.12.1. root > dms > endpoints > additionalProperties > oracleSettings > extraArchivedLogDestIds > extraArchivedLogDestIds items
1318
+
1319
+ | | |
1320
+ | ------------ | -------- |
1321
+ | **Type** | `number` |
1322
+ | **Required** | No |
1323
+
1324
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_failTasksOnLobTruncation"></a>2.2.1.13.13. Property `root > dms > endpoints > additionalProperties > oracleSettings > failTasksOnLobTruncation`
1325
+
1326
+ | | |
1327
+ | ------------ | --------- |
1328
+ | **Type** | `boolean` |
1329
+ | **Required** | No |
1330
+
1331
+ **Description:** When set to `true` , this attribute causes a task to fail if the actual size of an LOB column is greater than the specified `LobMaxSize` .
1332
+
1333
+ If a task is set to limited LOB mode and this option is set to `true` , the task fails instead of truncating the LOB data.
1334
+
1335
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_numberDatatypeScale"></a>2.2.1.13.14. Property `root > dms > endpoints > additionalProperties > oracleSettings > numberDatatypeScale`
1336
+
1337
+ | | |
1338
+ | ------------ | -------- |
1339
+ | **Type** | `number` |
1340
+ | **Required** | No |
1341
+
1342
+ **Description:** Specifies the number scale.
1343
+
1344
+ You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.
1345
+
1346
+ Example: `numberDataTypeScale=12`
1347
+
1348
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_oraclePathPrefix"></a>2.2.1.13.15. Property `root > dms > endpoints > additionalProperties > oracleSettings > oraclePathPrefix`
1349
+
1350
+ | | |
1351
+ | ------------ | -------- |
1352
+ | **Type** | `string` |
1353
+ | **Required** | No |
1354
+
1355
+ **Description:** Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
1356
+
1357
+ This value specifies the default Oracle root used to access the redo logs.
1358
+
1359
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_parallelAsmReadThreads"></a>2.2.1.13.16. Property `root > dms > endpoints > additionalProperties > oracleSettings > parallelAsmReadThreads`
1360
+
1361
+ | | |
1362
+ | ------------ | -------- |
1363
+ | **Type** | `number` |
1364
+ | **Required** | No |
1365
+
1366
+ **Description:** Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).
1367
+
1368
+ You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the `readAheadBlocks` attribute.
1369
+
1370
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_readAheadBlocks"></a>2.2.1.13.17. Property `root > dms > endpoints > additionalProperties > oracleSettings > readAheadBlocks`
1371
+
1372
+ | | |
1373
+ | ------------ | -------- |
1374
+ | **Type** | `number` |
1375
+ | **Required** | No |
1376
+
1377
+ **Description:** Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM).
1378
+
1379
+ You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
1380
+
1381
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_readTableSpaceName"></a>2.2.1.13.18. Property `root > dms > endpoints > additionalProperties > oracleSettings > readTableSpaceName`
1382
+
1383
+ | | |
1384
+ | ------------ | --------- |
1385
+ | **Type** | `boolean` |
1386
+ | **Required** | No |
1387
+
1388
+ **Description:** When set to `true` , this attribute supports tablespace replication.
1389
+
1390
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_replacePathPrefix"></a>2.2.1.13.19. Property `root > dms > endpoints > additionalProperties > oracleSettings > replacePathPrefix`
1391
+
1392
+ | | |
1393
+ | ------------ | --------- |
1394
+ | **Type** | `boolean` |
1395
+ | **Required** | No |
1396
+
1397
+ **Description:** Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
1398
+
1399
+ This setting tells DMS instance to replace the default Oracle root with the specified `usePathPrefix` setting to access the redo logs.
1400
+
1401
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_retryInterval"></a>2.2.1.13.20. Property `root > dms > endpoints > additionalProperties > oracleSettings > retryInterval`
1402
+
1403
+ | | |
1404
+ | ------------ | -------- |
1405
+ | **Type** | `number` |
1406
+ | **Required** | No |
1407
+
1408
+ **Description:** Specifies the number of seconds that the system waits before resending a query.
1409
+
1410
+ Example: `retryInterval=6;`
1411
+
1412
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_secretsManagerAccessRoleArn"></a>2.2.1.13.21. Property `root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerAccessRoleArn`
1413
+
1414
+ | | |
1415
+ | ------------ | -------- |
1416
+ | **Type** | `string` |
1417
+ | **Required** | No |
1418
+
1419
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
1420
+
1421
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.
1422
+
1423
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_secretsManagerOracleAsmAccessRoleArn"></a>2.2.1.13.22. Property `root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerOracleAsmAccessRoleArn`
1424
+
1425
+ | | |
1426
+ | ------------ | -------- |
1427
+ | **Type** | `string` |
1428
+ | **Required** | No |
1429
+
1430
+ **Description:** Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
1431
+
1432
+ The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret` . This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint.
1433
+
1434
+ > You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId` . Or you can specify clear-text values for `AsmUser` , `AsmPassword` , and `AsmServerName` . You can't specify both.
1435
+ >
1436
+ > For more information on creating this `SecretsManagerOracleAsmSecret` , the corresponding `SecretsManagerOracleAsmAccessRoleArn` , and the `SecretsManagerOracleAsmSecretId` that is required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide* .
1437
+
1438
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_secretsManagerOracleAsmSecretArn"></a>2.2.1.13.23. Property `root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerOracleAsmSecretArn`
1439
+
1440
+ | | |
1441
+ | ------------ | -------- |
1442
+ | **Type** | `string` |
1443
+ | **Required** | No |
1444
+
1445
+ **Description:** Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
1446
+
1447
+ The full ARN of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint.
1448
+
1449
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_secretsManagerSecretArn"></a>2.2.1.13.24. Property `root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerSecretArn`
1450
+
1451
+ | | |
1452
+ | ------------ | -------- |
1453
+ | **Type** | `string` |
1454
+ | **Required** | Yes |
1455
+
1456
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the Oracle endpoint connection details.
1457
+
1458
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_secretsManagerSecretKMSArn"></a>2.2.1.13.25. Property `root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerSecretKMSArn`
1459
+
1460
+ | | |
1461
+ | ------------ | -------- |
1462
+ | **Type** | `string` |
1463
+ | **Required** | No |
1464
+
1465
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
1466
+
1467
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_spatialDataOptionToGeoJsonFunctionName"></a>2.2.1.13.26. Property `root > dms > endpoints > additionalProperties > oracleSettings > spatialDataOptionToGeoJsonFunctionName`
1468
+
1469
+ | | |
1470
+ | ------------ | -------- |
1471
+ | **Type** | `string` |
1472
+ | **Required** | No |
1473
+
1474
+ **Description:** Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format.
1475
+
1476
+ By default, DMS calls the `SDO2GEOJSON` custom function if present and accessible. Or you can create your own custom function that mimics the operation of `SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to call it instead.
1477
+
1478
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_standbyDelayTime"></a>2.2.1.13.27. Property `root > dms > endpoints > additionalProperties > oracleSettings > standbyDelayTime`
1479
+
1480
+ | | |
1481
+ | ------------ | -------- |
1482
+ | **Type** | `number` |
1483
+ | **Required** | No |
1484
+
1485
+ **Description:** Use this attribute to specify a time in minutes for the delay in standby sync.
1486
+
1487
+ If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.
1488
+
1489
+ In AWS DMS , you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.
1490
+
1491
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_useAlternateFolderForOnline"></a>2.2.1.13.28. Property `root > dms > endpoints > additionalProperties > oracleSettings > useAlternateFolderForOnline`
1492
+
1493
+ | | |
1494
+ | ------------ | --------- |
1495
+ | **Type** | `boolean` |
1496
+ | **Required** | No |
1497
+
1498
+ **Description:** Set this attribute to `true` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
1499
+
1500
+ This tells the DMS instance to use any specified prefix replacement to access all online redo logs.
1501
+
1502
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_useBFile"></a>2.2.1.13.29. Property `root > dms > endpoints > additionalProperties > oracleSettings > useBFile`
1503
+
1504
+ | | |
1505
+ | ------------ | --------- |
1506
+ | **Type** | `boolean` |
1507
+ | **Required** | No |
1508
+
1509
+ **Description:** Set this attribute to Y to capture change data using the Binary Reader utility.
1510
+
1511
+ Set `UseLogminerReader` to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see [Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) .
1512
+
1513
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_useDirectPathFullLoad"></a>2.2.1.13.30. Property `root > dms > endpoints > additionalProperties > oracleSettings > useDirectPathFullLoad`
1514
+
1515
+ | | |
1516
+ | ------------ | --------- |
1517
+ | **Type** | `boolean` |
1518
+ | **Required** | No |
1519
+
1520
+ **Description:** Set this attribute to Y to have AWS DMS use a direct path full load.
1521
+
1522
+ Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
1523
+
1524
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_useLogminerReader"></a>2.2.1.13.31. Property `root > dms > endpoints > additionalProperties > oracleSettings > useLogminerReader`
1525
+
1526
+ | | |
1527
+ | ------------ | --------- |
1528
+ | **Type** | `boolean` |
1529
+ | **Required** | No |
1530
+
1531
+ **Description:** Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default).
1532
+
1533
+ Set this attribute to N if you want to access the redo logs as a binary file. When you set `UseLogminerReader` to N, also set `UseBfile` to Y. For more information on this setting and using Oracle ASM, see [Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the *AWS DMS User Guide* .
1534
+
1535
+ ###### <a name="dms_endpoints_additionalProperties_oracleSettings_usePathPrefix"></a>2.2.1.13.32. Property `root > dms > endpoints > additionalProperties > oracleSettings > usePathPrefix`
1536
+
1537
+ | | |
1538
+ | ------------ | -------- |
1539
+ | **Type** | `string` |
1540
+ | **Required** | No |
1541
+
1542
+ **Description:** Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
1543
+
1544
+ This value specifies the path prefix used to replace the default Oracle root to access the redo logs.
1545
+
1546
+ ##### <a name="dms_endpoints_additionalProperties_postgreSqlSettings"></a>2.2.1.14. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings`
1547
+
1548
+ | | |
1549
+ | ------------------------- | ------------------------------------------------------- |
1550
+ | **Type** | `object` |
1551
+ | **Required** | No |
1552
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
1553
+ | **Defined in** | #/definitions/PostgreSqlSettingsProperty |
1554
+
1555
+ **Description:** Settings in JSON format for the source and target PostgreSQL endpoint.
1556
+
1557
+ 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* .
1558
+
1559
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
1560
+ | -------------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1561
+ | - [afterConnectScript](#dms_endpoints_additionalProperties_postgreSqlSettings_afterConnectScript ) | No | string | No | - | For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.<br /><br />Example: \`afterConnectScript=SET session_replication_role='replica'\` |
1562
+ | - [babelfishDatabaseName](#dms_endpoints_additionalProperties_postgreSqlSettings_babelfishDatabaseName ) | No | string | No | - | The Babelfish for Aurora PostgreSQL database name for the endpoint. |
1563
+ | - [captureDdls](#dms_endpoints_additionalProperties_postgreSqlSettings_captureDdls ) | No | boolean | No | - | To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.<br /><br />You can later remove these artifacts.<br /><br />If this value is set to \`N\` , you don't have to create tables or triggers on the source database. |
1564
+ | - [databaseMode](#dms_endpoints_additionalProperties_postgreSqlSettings_databaseMode ) | No | string | No | - | Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. |
1565
+ | - [ddlArtifactsSchema](#dms_endpoints_additionalProperties_postgreSqlSettings_ddlArtifactsSchema ) | No | string | No | - | The schema in which the operational DDL database artifacts are created.<br /><br />Example: \`ddlArtifactsSchema=xyzddlschema;\` |
1566
+ | - [executeTimeout](#dms_endpoints_additionalProperties_postgreSqlSettings_executeTimeout ) | No | number | No | - | Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.<br /><br />Example: \`executeTimeout=100;\` |
1567
+ | - [failTasksOnLobTruncation](#dms_endpoints_additionalProperties_postgreSqlSettings_failTasksOnLobTruncation ) | No | boolean | No | - | When set to \`true\` , this value causes a task to fail if the actual size of a LOB column is greater than the specified \`LobMaxSize\` .<br /><br />If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data. |
1568
+ | - [heartbeatEnable](#dms_endpoints_additionalProperties_postgreSqlSettings_heartbeatEnable ) | No | boolean | No | - | The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.<br /><br />By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps \`restart_lsn\` moving and prevents storage full scenarios. |
1569
+ | - [heartbeatFrequency](#dms_endpoints_additionalProperties_postgreSqlSettings_heartbeatFrequency ) | No | number | No | - | Sets the WAL heartbeat frequency (in minutes). |
1570
+ | - [heartbeatSchema](#dms_endpoints_additionalProperties_postgreSqlSettings_heartbeatSchema ) | No | string | No | - | Sets the schema in which the heartbeat artifacts are created. |
1571
+ | - [mapBooleanAsBoolean](#dms_endpoints_additionalProperties_postgreSqlSettings_mapBooleanAsBoolean ) | No | boolean | No | - | When true, lets PostgreSQL migrate the boolean type as boolean.<br /><br />By default, PostgreSQL migrates booleans as \`varchar(5)\` . You must set this setting on both the source and target endpoints for it to take effect. |
1572
+ | - [maxFileSize](#dms_endpoints_additionalProperties_postgreSqlSettings_maxFileSize ) | No | number | No | - | Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.<br /><br />Example: \`maxFileSize=512\` |
1573
+ | - [pluginName](#dms_endpoints_additionalProperties_postgreSqlSettings_pluginName ) | No | string | No | - | Specifies the plugin to use to create a replication slot. |
1574
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_postgreSqlSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint. |
1575
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_postgreSqlSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the PostgreSQL endpoint connection details. |
1576
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_postgreSqlSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
1577
+ | - [slotName](#dms_endpoints_additionalProperties_postgreSqlSettings_slotName ) | No | string | No | - | Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.<br /><br />When used with the \`CdcStartPosition\` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of \`CdcStartPosition\` . If the specified slot doesn't exist or the task doesn't have a valid \`CdcStartPosition\` setting, DMS raises an error.<br /><br />For more information about setting the \`CdcStartPosition\` request parameter, see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the *AWS Database Migration Service User Guide* . For more information about using \`CdcStartPosition\` , see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) , [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) , and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) . |
1578
+
1579
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_afterConnectScript"></a>2.2.1.14.1. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > afterConnectScript`
1580
+
1581
+ | | |
1582
+ | ------------ | -------- |
1583
+ | **Type** | `string` |
1584
+ | **Required** | No |
1585
+
1586
+ **Description:** For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
1587
+
1588
+ Example: `afterConnectScript=SET session_replication_role='replica'`
1589
+
1590
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_babelfishDatabaseName"></a>2.2.1.14.2. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > babelfishDatabaseName`
1591
+
1592
+ | | |
1593
+ | ------------ | -------- |
1594
+ | **Type** | `string` |
1595
+ | **Required** | No |
1596
+
1597
+ **Description:** The Babelfish for Aurora PostgreSQL database name for the endpoint.
1598
+
1599
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_captureDdls"></a>2.2.1.14.3. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > captureDdls`
1600
+
1601
+ | | |
1602
+ | ------------ | --------- |
1603
+ | **Type** | `boolean` |
1604
+ | **Required** | No |
1605
+
1606
+ **Description:** To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
1607
+
1608
+ You can later remove these artifacts.
1609
+
1610
+ If this value is set to `N` , you don't have to create tables or triggers on the source database.
1611
+
1612
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_databaseMode"></a>2.2.1.14.4. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > databaseMode`
1613
+
1614
+ | | |
1615
+ | ------------ | -------- |
1616
+ | **Type** | `string` |
1617
+ | **Required** | No |
1618
+
1619
+ **Description:** Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
1620
+
1621
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_ddlArtifactsSchema"></a>2.2.1.14.5. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > ddlArtifactsSchema`
1622
+
1623
+ | | |
1624
+ | ------------ | -------- |
1625
+ | **Type** | `string` |
1626
+ | **Required** | No |
1627
+
1628
+ **Description:** The schema in which the operational DDL database artifacts are created.
1629
+
1630
+ Example: `ddlArtifactsSchema=xyzddlschema;`
1631
+
1632
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_executeTimeout"></a>2.2.1.14.6. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > executeTimeout`
1633
+
1634
+ | | |
1635
+ | ------------ | -------- |
1636
+ | **Type** | `number` |
1637
+ | **Required** | No |
1638
+
1639
+ **Description:** Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
1640
+
1641
+ Example: `executeTimeout=100;`
1642
+
1643
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_failTasksOnLobTruncation"></a>2.2.1.14.7. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > failTasksOnLobTruncation`
1644
+
1645
+ | | |
1646
+ | ------------ | --------- |
1647
+ | **Type** | `boolean` |
1648
+ | **Required** | No |
1649
+
1650
+ **Description:** When set to `true` , this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize` .
1651
+
1652
+ If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
1653
+
1654
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_heartbeatEnable"></a>2.2.1.14.8. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > heartbeatEnable`
1655
+
1656
+ | | |
1657
+ | ------------ | --------- |
1658
+ | **Type** | `boolean` |
1659
+ | **Required** | No |
1660
+
1661
+ **Description:** The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
1662
+
1663
+ By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps `restart_lsn` moving and prevents storage full scenarios.
1664
+
1665
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_heartbeatFrequency"></a>2.2.1.14.9. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > heartbeatFrequency`
1666
+
1667
+ | | |
1668
+ | ------------ | -------- |
1669
+ | **Type** | `number` |
1670
+ | **Required** | No |
1671
+
1672
+ **Description:** Sets the WAL heartbeat frequency (in minutes).
1673
+
1674
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_heartbeatSchema"></a>2.2.1.14.10. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > heartbeatSchema`
1675
+
1676
+ | | |
1677
+ | ------------ | -------- |
1678
+ | **Type** | `string` |
1679
+ | **Required** | No |
1680
+
1681
+ **Description:** Sets the schema in which the heartbeat artifacts are created.
1682
+
1683
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_mapBooleanAsBoolean"></a>2.2.1.14.11. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > mapBooleanAsBoolean`
1684
+
1685
+ | | |
1686
+ | ------------ | --------- |
1687
+ | **Type** | `boolean` |
1688
+ | **Required** | No |
1689
+
1690
+ **Description:** When true, lets PostgreSQL migrate the boolean type as boolean.
1691
+
1692
+ By default, PostgreSQL migrates booleans as `varchar(5)` . You must set this setting on both the source and target endpoints for it to take effect.
1693
+
1694
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_maxFileSize"></a>2.2.1.14.12. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > maxFileSize`
1695
+
1696
+ | | |
1697
+ | ------------ | -------- |
1698
+ | **Type** | `number` |
1699
+ | **Required** | No |
1700
+
1701
+ **Description:** Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
1702
+
1703
+ Example: `maxFileSize=512`
1704
+
1705
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_pluginName"></a>2.2.1.14.13. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > pluginName`
1706
+
1707
+ | | |
1708
+ | ------------ | -------- |
1709
+ | **Type** | `string` |
1710
+ | **Required** | No |
1711
+
1712
+ **Description:** Specifies the plugin to use to create a replication slot.
1713
+
1714
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_secretsManagerAccessRoleArn"></a>2.2.1.14.14. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > secretsManagerAccessRoleArn`
1715
+
1716
+ | | |
1717
+ | ------------ | -------- |
1718
+ | **Type** | `string` |
1719
+ | **Required** | No |
1720
+
1721
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
1722
+
1723
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
1724
+
1725
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_secretsManagerSecretArn"></a>2.2.1.14.15. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > secretsManagerSecretArn`
1726
+
1727
+ | | |
1728
+ | ------------ | -------- |
1729
+ | **Type** | `string` |
1730
+ | **Required** | Yes |
1731
+
1732
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details.
1733
+
1734
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_secretsManagerSecretKMSArn"></a>2.2.1.14.16. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > secretsManagerSecretKMSArn`
1735
+
1736
+ | | |
1737
+ | ------------ | -------- |
1738
+ | **Type** | `string` |
1739
+ | **Required** | No |
1740
+
1741
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
1742
+
1743
+ ###### <a name="dms_endpoints_additionalProperties_postgreSqlSettings_slotName"></a>2.2.1.14.17. Property `root > dms > endpoints > additionalProperties > postgreSqlSettings > slotName`
1744
+
1745
+ | | |
1746
+ | ------------ | -------- |
1747
+ | **Type** | `string` |
1748
+ | **Required** | No |
1749
+
1750
+ **Description:** Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
1751
+
1752
+ When used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of `CdcStartPosition` . If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error.
1753
+
1754
+ For more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the *AWS Database Migration Service User Guide* . For more information about using `CdcStartPosition` , see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) , [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) , and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) .
1755
+
1756
+ ##### <a name="dms_endpoints_additionalProperties_redshiftSettings"></a>2.2.1.15. Property `root > dms > endpoints > additionalProperties > redshiftSettings`
1757
+
1758
+ | | |
1759
+ | ------------------------- | ------------------------------------------------------- |
1760
+ | **Type** | `object` |
1761
+ | **Required** | No |
1762
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
1763
+ | **Defined in** | #/definitions/RedshiftSettingsProperty |
1764
+
1765
+ **Description:** Settings in JSON format for the Amazon Redshift endpoint.
1766
+
1767
+ 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* .
1768
+
1769
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
1770
+ | -------------------------------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1771
+ | - [acceptAnyDate](#dms_endpoints_additionalProperties_redshiftSettings_acceptAnyDate ) | No | boolean | No | - | A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.<br /><br />You can choose \`true\` or \`false\` (the default).<br /><br />This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. |
1772
+ | - [afterConnectScript](#dms_endpoints_additionalProperties_redshiftSettings_afterConnectScript ) | No | string | No | - | Code to run after connecting.<br /><br />This parameter should contain the code itself, not the name of a file containing the code. |
1773
+ | - [bucketFolder](#dms_endpoints_additionalProperties_redshiftSettings_bucketFolder ) | No | string | No | - | An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.<br /><br />For full load mode, AWS DMS converts source records into .csv files and loads them to the *BucketFolder/TableID* path. AWS DMS uses the Redshift \`COPY\` command to upload the .csv files to the target table. The files are deleted once the \`COPY\` operation has finished. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the *Amazon Redshift Database Developer Guide* .<br /><br />For change-data-capture (CDC) mode, AWS DMS creates a *NetChanges* table, and loads the .csv files to this *BucketFolder/NetChangesTableID* path. |
1774
+ | + [bucketName](#dms_endpoints_additionalProperties_redshiftSettings_bucketName ) | No | string | No | - | The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift. |
1775
+ | - [caseSensitiveNames](#dms_endpoints_additionalProperties_redshiftSettings_caseSensitiveNames ) | No | boolean | No | - | If Amazon Redshift is configured to support case sensitive schema names, set \`CaseSensitiveNames\` to \`true\` .<br /><br />The default is \`false\` . |
1776
+ | - [compUpdate](#dms_endpoints_additionalProperties_redshiftSettings_compUpdate ) | No | boolean | No | - | If you set \`CompUpdate\` to \`true\` Amazon Redshift applies automatic compression if the table is empty.<br /><br />This applies even if the table columns already have encodings other than \`RAW\` . If you set \`CompUpdate\` to \`false\` , automatic compression is disabled and existing column encodings aren't changed. The default is \`true\` . |
1777
+ | - [connectionTimeout](#dms_endpoints_additionalProperties_redshiftSettings_connectionTimeout ) | No | number | No | - | A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection. |
1778
+ | - [dateFormat](#dms_endpoints_additionalProperties_redshiftSettings_dateFormat ) | No | string | No | - | The date format that you are using.<br /><br />Valid values are \`auto\` (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using \`auto\` recognizes most strings, even some that aren't supported when you use a date format string.<br /><br />If your date and time values use formats different from each other, set this to \`auto\` . |
1779
+ | - [emptyAsNull](#dms_endpoints_additionalProperties_redshiftSettings_emptyAsNull ) | No | boolean | No | - | A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.<br /><br />A value of \`true\` sets empty CHAR and VARCHAR fields to null. The default is \`false\` . |
1780
+ | - [explicitIds](#dms_endpoints_additionalProperties_redshiftSettings_explicitIds ) | No | boolean | No | - | This setting is only valid for a full-load migration task.<br /><br />Set \`ExplicitIds\` to \`true\` to have tables with \`IDENTITY\` columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is \`false\` . |
1781
+ | - [fileTransferUploadStreams](#dms_endpoints_additionalProperties_redshiftSettings_fileTransferUploadStreams ) | No | number | No | - | The number of threads used to upload a single file.<br /><br />This parameter accepts a value from 1 through 64. It defaults to 10.<br /><br />The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) .<br /><br />\`FileTransferUploadStreams\` accepts a value from 1 through 64. It defaults to 10. |
1782
+ | - [loadTimeout](#dms_endpoints_additionalProperties_redshiftSettings_loadTimeout ) | No | number | No | - | The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE. |
1783
+ | - [mapBooleanAsBoolean](#dms_endpoints_additionalProperties_redshiftSettings_mapBooleanAsBoolean ) | No | boolean | No | - | When true, lets Redshift migrate the boolean type as boolean.<br /><br />By default, Redshift migrates booleans as \`varchar(1)\` . You must set this setting on both the source and target endpoints for it to take effect. |
1784
+ | - [maxFileSize](#dms_endpoints_additionalProperties_redshiftSettings_maxFileSize ) | No | number | No | - | The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB). |
1785
+ | - [removeQuotes](#dms_endpoints_additionalProperties_redshiftSettings_removeQuotes ) | No | boolean | No | - | A value that specifies to remove surrounding quotation marks from strings in the incoming data.<br /><br />All characters within the quotation marks, including delimiters, are retained. Choose \`true\` to remove quotation marks. The default is \`false\` . |
1786
+ | - [replaceChars](#dms_endpoints_additionalProperties_redshiftSettings_replaceChars ) | No | string | No | - | A value that specifies to replaces the invalid characters specified in \`ReplaceInvalidChars\` , substituting the specified characters instead.<br /><br />The default is \`"?"\` . |
1787
+ | - [replaceInvalidChars](#dms_endpoints_additionalProperties_redshiftSettings_replaceInvalidChars ) | No | string | No | - | A list of characters that you want to replace.<br /><br />Use with \`ReplaceChars\` . |
1788
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_redshiftSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint. |
1789
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_redshiftSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the Amazon Redshift endpoint connection details. |
1790
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_redshiftSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
1791
+ | + [serverSideEncryptionKmsKeyId](#dms_endpoints_additionalProperties_redshiftSettings_serverSideEncryptionKmsKeyId ) | No | string | No | - | The AWS KMS key ID.<br /><br />If you are using \`SSE_KMS\` for the \`EncryptionMode\` , provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key. |
1792
+ | - [serviceAccessRoleArn](#dms_endpoints_additionalProperties_redshiftSettings_serviceAccessRoleArn ) | No | string | No | - | The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.<br /><br />The role must allow the \`iam:PassRole\` action. |
1793
+ | - [timeFormat](#dms_endpoints_additionalProperties_redshiftSettings_timeFormat ) | No | string | No | - | The time format that you want to use.<br /><br />Valid values are \`auto\` (case-sensitive), \`'timeformat_string'\` , \`'epochsecs'\` , or \`'epochmillisecs'\` . It defaults to 10. Using \`auto\` recognizes most strings, even some that aren't supported when you use a time format string.<br /><br />If your date and time values use formats different from each other, set this parameter to \`auto\` . |
1794
+ | - [trimBlanks](#dms_endpoints_additionalProperties_redshiftSettings_trimBlanks ) | No | boolean | No | - | A value that specifies to remove the trailing white space characters from a VARCHAR string.<br /><br />This parameter applies only to columns with a VARCHAR data type. Choose \`true\` to remove unneeded white space. The default is \`false\` . |
1795
+ | - [truncateColumns](#dms_endpoints_additionalProperties_redshiftSettings_truncateColumns ) | No | boolean | No | - | A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.<br /><br />This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose \`true\` to truncate data. The default is \`false\` . |
1796
+ | - [writeBufferSize](#dms_endpoints_additionalProperties_redshiftSettings_writeBufferSize ) | No | number | No | - | The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB). |
1797
+
1798
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_acceptAnyDate"></a>2.2.1.15.1. Property `root > dms > endpoints > additionalProperties > redshiftSettings > acceptAnyDate`
1799
+
1800
+ | | |
1801
+ | ------------ | --------- |
1802
+ | **Type** | `boolean` |
1803
+ | **Required** | No |
1804
+
1805
+ **Description:** A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.
1806
+
1807
+ You can choose `true` or `false` (the default).
1808
+
1809
+ This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
1810
+
1811
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_afterConnectScript"></a>2.2.1.15.2. Property `root > dms > endpoints > additionalProperties > redshiftSettings > afterConnectScript`
1812
+
1813
+ | | |
1814
+ | ------------ | -------- |
1815
+ | **Type** | `string` |
1816
+ | **Required** | No |
1817
+
1818
+ **Description:** Code to run after connecting.
1819
+
1820
+ This parameter should contain the code itself, not the name of a file containing the code.
1821
+
1822
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_bucketFolder"></a>2.2.1.15.3. Property `root > dms > endpoints > additionalProperties > redshiftSettings > bucketFolder`
1823
+
1824
+ | | |
1825
+ | ------------ | -------- |
1826
+ | **Type** | `string` |
1827
+ | **Required** | No |
1828
+
1829
+ **Description:** An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
1830
+
1831
+ For full load mode, AWS DMS converts source records into .csv files and loads them to the *BucketFolder/TableID* path. AWS DMS uses the Redshift `COPY` command to upload the .csv files to the target table. The files are deleted once the `COPY` operation has finished. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the *Amazon Redshift Database Developer Guide* .
1832
+
1833
+ For change-data-capture (CDC) mode, AWS DMS creates a *NetChanges* table, and loads the .csv files to this *BucketFolder/NetChangesTableID* path.
1834
+
1835
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_bucketName"></a>2.2.1.15.4. Property `root > dms > endpoints > additionalProperties > redshiftSettings > bucketName`
1836
+
1837
+ | | |
1838
+ | ------------ | -------- |
1839
+ | **Type** | `string` |
1840
+ | **Required** | Yes |
1841
+
1842
+ **Description:** The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
1843
+
1844
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_caseSensitiveNames"></a>2.2.1.15.5. Property `root > dms > endpoints > additionalProperties > redshiftSettings > caseSensitiveNames`
1845
+
1846
+ | | |
1847
+ | ------------ | --------- |
1848
+ | **Type** | `boolean` |
1849
+ | **Required** | No |
1850
+
1851
+ **Description:** If Amazon Redshift is configured to support case sensitive schema names, set `CaseSensitiveNames` to `true` .
1852
+
1853
+ The default is `false` .
1854
+
1855
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_compUpdate"></a>2.2.1.15.6. Property `root > dms > endpoints > additionalProperties > redshiftSettings > compUpdate`
1856
+
1857
+ | | |
1858
+ | ------------ | --------- |
1859
+ | **Type** | `boolean` |
1860
+ | **Required** | No |
1861
+
1862
+ **Description:** If you set `CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty.
1863
+
1864
+ This applies even if the table columns already have encodings other than `RAW` . If you set `CompUpdate` to `false` , automatic compression is disabled and existing column encodings aren't changed. The default is `true` .
1865
+
1866
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_connectionTimeout"></a>2.2.1.15.7. Property `root > dms > endpoints > additionalProperties > redshiftSettings > connectionTimeout`
1867
+
1868
+ | | |
1869
+ | ------------ | -------- |
1870
+ | **Type** | `number` |
1871
+ | **Required** | No |
1872
+
1873
+ **Description:** A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
1874
+
1875
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_dateFormat"></a>2.2.1.15.8. Property `root > dms > endpoints > additionalProperties > redshiftSettings > dateFormat`
1876
+
1877
+ | | |
1878
+ | ------------ | -------- |
1879
+ | **Type** | `string` |
1880
+ | **Required** | No |
1881
+
1882
+ **Description:** The date format that you are using.
1883
+
1884
+ Valid values are `auto` (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using `auto` recognizes most strings, even some that aren't supported when you use a date format string.
1885
+
1886
+ If your date and time values use formats different from each other, set this to `auto` .
1887
+
1888
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_emptyAsNull"></a>2.2.1.15.9. Property `root > dms > endpoints > additionalProperties > redshiftSettings > emptyAsNull`
1889
+
1890
+ | | |
1891
+ | ------------ | --------- |
1892
+ | **Type** | `boolean` |
1893
+ | **Required** | No |
1894
+
1895
+ **Description:** A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
1896
+
1897
+ A value of `true` sets empty CHAR and VARCHAR fields to null. The default is `false` .
1898
+
1899
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_explicitIds"></a>2.2.1.15.10. Property `root > dms > endpoints > additionalProperties > redshiftSettings > explicitIds`
1900
+
1901
+ | | |
1902
+ | ------------ | --------- |
1903
+ | **Type** | `boolean` |
1904
+ | **Required** | No |
1905
+
1906
+ **Description:** This setting is only valid for a full-load migration task.
1907
+
1908
+ Set `ExplicitIds` to `true` to have tables with `IDENTITY` columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is `false` .
1909
+
1910
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_fileTransferUploadStreams"></a>2.2.1.15.11. Property `root > dms > endpoints > additionalProperties > redshiftSettings > fileTransferUploadStreams`
1911
+
1912
+ | | |
1913
+ | ------------ | -------- |
1914
+ | **Type** | `number` |
1915
+ | **Required** | No |
1916
+
1917
+ **Description:** The number of threads used to upload a single file.
1918
+
1919
+ This parameter accepts a value from 1 through 64. It defaults to 10.
1920
+
1921
+ The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) .
1922
+
1923
+ `FileTransferUploadStreams` accepts a value from 1 through 64. It defaults to 10.
1924
+
1925
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_loadTimeout"></a>2.2.1.15.12. Property `root > dms > endpoints > additionalProperties > redshiftSettings > loadTimeout`
1926
+
1927
+ | | |
1928
+ | ------------ | -------- |
1929
+ | **Type** | `number` |
1930
+ | **Required** | No |
1931
+
1932
+ **Description:** The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
1933
+
1934
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_mapBooleanAsBoolean"></a>2.2.1.15.13. Property `root > dms > endpoints > additionalProperties > redshiftSettings > mapBooleanAsBoolean`
1935
+
1936
+ | | |
1937
+ | ------------ | --------- |
1938
+ | **Type** | `boolean` |
1939
+ | **Required** | No |
1940
+
1941
+ **Description:** When true, lets Redshift migrate the boolean type as boolean.
1942
+
1943
+ By default, Redshift migrates booleans as `varchar(1)` . You must set this setting on both the source and target endpoints for it to take effect.
1944
+
1945
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_maxFileSize"></a>2.2.1.15.14. Property `root > dms > endpoints > additionalProperties > redshiftSettings > maxFileSize`
1946
+
1947
+ | | |
1948
+ | ------------ | -------- |
1949
+ | **Type** | `number` |
1950
+ | **Required** | No |
1951
+
1952
+ **Description:** The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).
1953
+
1954
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_removeQuotes"></a>2.2.1.15.15. Property `root > dms > endpoints > additionalProperties > redshiftSettings > removeQuotes`
1955
+
1956
+ | | |
1957
+ | ------------ | --------- |
1958
+ | **Type** | `boolean` |
1959
+ | **Required** | No |
1960
+
1961
+ **Description:** A value that specifies to remove surrounding quotation marks from strings in the incoming data.
1962
+
1963
+ All characters within the quotation marks, including delimiters, are retained. Choose `true` to remove quotation marks. The default is `false` .
1964
+
1965
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_replaceChars"></a>2.2.1.15.16. Property `root > dms > endpoints > additionalProperties > redshiftSettings > replaceChars`
1966
+
1967
+ | | |
1968
+ | ------------ | -------- |
1969
+ | **Type** | `string` |
1970
+ | **Required** | No |
1971
+
1972
+ **Description:** A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars` , substituting the specified characters instead.
1973
+
1974
+ The default is `"?"` .
1975
+
1976
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_replaceInvalidChars"></a>2.2.1.15.17. Property `root > dms > endpoints > additionalProperties > redshiftSettings > replaceInvalidChars`
1977
+
1978
+ | | |
1979
+ | ------------ | -------- |
1980
+ | **Type** | `string` |
1981
+ | **Required** | No |
1982
+
1983
+ **Description:** A list of characters that you want to replace.
1984
+
1985
+ Use with `ReplaceChars` .
1986
+
1987
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_secretsManagerAccessRoleArn"></a>2.2.1.15.18. Property `root > dms > endpoints > additionalProperties > redshiftSettings > secretsManagerAccessRoleArn`
1988
+
1989
+ | | |
1990
+ | ------------ | -------- |
1991
+ | **Type** | `string` |
1992
+ | **Required** | No |
1993
+
1994
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
1995
+
1996
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.
1997
+
1998
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_secretsManagerSecretArn"></a>2.2.1.15.19. Property `root > dms > endpoints > additionalProperties > redshiftSettings > secretsManagerSecretArn`
1999
+
2000
+ | | |
2001
+ | ------------ | -------- |
2002
+ | **Type** | `string` |
2003
+ | **Required** | Yes |
2004
+
2005
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details.
2006
+
2007
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_secretsManagerSecretKMSArn"></a>2.2.1.15.20. Property `root > dms > endpoints > additionalProperties > redshiftSettings > secretsManagerSecretKMSArn`
2008
+
2009
+ | | |
2010
+ | ------------ | -------- |
2011
+ | **Type** | `string` |
2012
+ | **Required** | No |
2013
+
2014
+ **Description:** The ID of the KMS key used to encrypt the credentials secret.
2015
+
2016
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_serverSideEncryptionKmsKeyId"></a>2.2.1.15.21. Property `root > dms > endpoints > additionalProperties > redshiftSettings > serverSideEncryptionKmsKeyId`
2017
+
2018
+ | | |
2019
+ | ------------ | -------- |
2020
+ | **Type** | `string` |
2021
+ | **Required** | Yes |
2022
+
2023
+ **Description:** The AWS KMS key ID.
2024
+
2025
+ If you are using `SSE_KMS` for the `EncryptionMode` , provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
2026
+
2027
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_serviceAccessRoleArn"></a>2.2.1.15.22. Property `root > dms > endpoints > additionalProperties > redshiftSettings > serviceAccessRoleArn`
2028
+
2029
+ | | |
2030
+ | ------------ | -------- |
2031
+ | **Type** | `string` |
2032
+ | **Required** | No |
2033
+
2034
+ **Description:** The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
2035
+
2036
+ The role must allow the `iam:PassRole` action.
2037
+
2038
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_timeFormat"></a>2.2.1.15.23. Property `root > dms > endpoints > additionalProperties > redshiftSettings > timeFormat`
2039
+
2040
+ | | |
2041
+ | ------------ | -------- |
2042
+ | **Type** | `string` |
2043
+ | **Required** | No |
2044
+
2045
+ **Description:** The time format that you want to use.
2046
+
2047
+ Valid values are `auto` (case-sensitive), `'timeformat_string'` , `'epochsecs'` , or `'epochmillisecs'` . It defaults to 10. Using `auto` recognizes most strings, even some that aren't supported when you use a time format string.
2048
+
2049
+ If your date and time values use formats different from each other, set this parameter to `auto` .
2050
+
2051
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_trimBlanks"></a>2.2.1.15.24. Property `root > dms > endpoints > additionalProperties > redshiftSettings > trimBlanks`
2052
+
2053
+ | | |
2054
+ | ------------ | --------- |
2055
+ | **Type** | `boolean` |
2056
+ | **Required** | No |
2057
+
2058
+ **Description:** A value that specifies to remove the trailing white space characters from a VARCHAR string.
2059
+
2060
+ This parameter applies only to columns with a VARCHAR data type. Choose `true` to remove unneeded white space. The default is `false` .
2061
+
2062
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_truncateColumns"></a>2.2.1.15.25. Property `root > dms > endpoints > additionalProperties > redshiftSettings > truncateColumns`
2063
+
2064
+ | | |
2065
+ | ------------ | --------- |
2066
+ | **Type** | `boolean` |
2067
+ | **Required** | No |
2068
+
2069
+ **Description:** A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
2070
+
2071
+ This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose `true` to truncate data. The default is `false` .
2072
+
2073
+ ###### <a name="dms_endpoints_additionalProperties_redshiftSettings_writeBufferSize"></a>2.2.1.15.26. Property `root > dms > endpoints > additionalProperties > redshiftSettings > writeBufferSize`
2074
+
2075
+ | | |
2076
+ | ------------ | -------- |
2077
+ | **Type** | `number` |
2078
+ | **Required** | No |
2079
+
2080
+ **Description:** The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).
2081
+
2082
+ ##### <a name="dms_endpoints_additionalProperties_s3Settings"></a>2.2.1.16. Property `root > dms > endpoints > additionalProperties > s3Settings`
2083
+
2084
+ | | |
2085
+ | ------------------------- | ------------------------------------------------------- |
2086
+ | **Type** | `object` |
2087
+ | **Required** | No |
2088
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2089
+ | **Defined in** | #/definitions/S3SettingsProperty |
2090
+
2091
+ **Description:** Settings in JSON format for the source and target Amazon S3 endpoint.
2092
+
2093
+ For more information about other 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* .
2094
+
2095
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2096
+ | ------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2097
+ | - [addColumnName](#dms_endpoints_additionalProperties_s3Settings_addColumnName ) | No | boolean | No | - | An optional parameter that, when set to \`true\` or \`y\` , you can use to add column name information to the .csv output file.<br /><br />The default value is \`false\` . Valid values are \`true\` , \`false\` , \`y\` , and \`n\` . |
2098
+ | - [bucketFolder](#dms_endpoints_additionalProperties_s3Settings_bucketFolder ) | No | string | No | - | An optional parameter to set a folder name in the S3 bucket.<br /><br />If provided, tables are created in the path \`*bucketFolder* / *schema_name* / *table_name* /\` . If this parameter isn't specified, the path used is \`*schema_name* / *table_name* /\` . |
2099
+ | + [bucketName](#dms_endpoints_additionalProperties_s3Settings_bucketName ) | No | string | No | - | The name of the S3 bucket. |
2100
+ | - [cannedAclForObjects](#dms_endpoints_additionalProperties_s3Settings_cannedAclForObjects ) | No | string | No | - | A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide* .<br /><br />The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL. |
2101
+ | - [cdcInsertsAndUpdates](#dms_endpoints_additionalProperties_s3Settings_cdcInsertsAndUpdates ) | No | boolean | No | - | A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is \`false\` , but when \`CdcInsertsAndUpdates\` is set to \`true\` or \`y\` , only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.<br /><br />For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the \`IncludeOpForFullLoad\` parameter. If \`IncludeOpForFullLoad\` is set to \`true\` , the first field of every CDC record is set to either \`I\` or \`U\` to indicate INSERT and UPDATE operations at the source. But if \`IncludeOpForFullLoad\` is set to \`false\` , CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide* .<br /><br />> AWS DMS supports the use of the \`CdcInsertsAndUpdates\` parameter in versions 3.3.1 and later.<br />><br />> \`CdcInsertsOnly\` and \`CdcInsertsAndUpdates\` can't both be set to \`true\` for the same endpoint. Set either \`CdcInsertsOnly\` or \`CdcInsertsAndUpdates\` to \`true\` for the same endpoint, but not both. |
2102
+ | - [cdcInsertsOnly](#dms_endpoints_additionalProperties_s3Settings_cdcInsertsOnly ) | No | boolean | No | - | A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the \`false\` setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.<br /><br />If \`CdcInsertsOnly\` is set to \`true\` or \`y\` , only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of \`IncludeOpForFullLoad\` . If \`IncludeOpForFullLoad\` is set to \`true\` , the first field of every CDC record is set to I to indicate the INSERT operation at the source. If \`IncludeOpForFullLoad\` is set to \`false\` , every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide* .<br /><br />> AWS DMS supports the interaction described preceding between the \`CdcInsertsOnly\` and \`IncludeOpForFullLoad\` parameters in versions 3.1.4 and later.<br />><br />> \`CdcInsertsOnly\` and \`CdcInsertsAndUpdates\` can't both be set to \`true\` for the same endpoint. Set either \`CdcInsertsOnly\` or \`CdcInsertsAndUpdates\` to \`true\` for the same endpoint, but not both. |
2103
+ | - [cdcMaxBatchInterval](#dms_endpoints_additionalProperties_s3Settings_cdcMaxBatchInterval ) | No | number | No | - | Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.<br /><br />When \`CdcMaxBatchInterval\` and \`CdcMinFileSize\` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.<br /><br />The default value is 60 seconds. |
2104
+ | - [cdcMinFileSize](#dms_endpoints_additionalProperties_s3Settings_cdcMinFileSize ) | No | number | No | - | Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.<br /><br />When \`CdcMinFileSize\` and \`CdcMaxBatchInterval\` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.<br /><br />The default value is 32 MB. |
2105
+ | - [cdcPath](#dms_endpoints_additionalProperties_s3Settings_cdcPath ) | No | string | No | - | Specifies the folder path of CDC files.<br /><br />For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If \`CdcPath\` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set [\`PreserveTransactions\`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to \`true\` , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [\`BucketFolder\`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [\`BucketName\`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName) .<br /><br />For example, if you specify \`CdcPath\` as \`MyChangedData\` , and you specify \`BucketName\` as \`MyTargetBucket\` but do not specify \`BucketFolder\` , AWS DMS creates the CDC folder path following: \`MyTargetBucket/MyChangedData\` .<br /><br />If you specify the same \`CdcPath\` , and you specify \`BucketName\` as \`MyTargetBucket\` and \`BucketFolder\` as \`MyTargetData\` , AWS DMS creates the CDC folder path following: \`MyTargetBucket/MyTargetData/MyChangedData\` .<br /><br />For more information on CDC including transaction order on an S3 target, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) .<br /><br />> This setting is supported in AWS DMS versions 3.4.2 and later. |
2106
+ | - [compressionType](#dms_endpoints_additionalProperties_s3Settings_compressionType ) | No | string | No | - | An optional parameter.<br /><br />When set to GZIP it enables the service to compress the target files. To allow the service to write the target files uncompressed, either set this parameter to NONE (the default) or don't specify the parameter at all. This parameter applies to both .csv and .parquet file formats. |
2107
+ | - [csvDelimiter](#dms_endpoints_additionalProperties_s3Settings_csvDelimiter ) | No | string | No | - | The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. |
2108
+ | - [csvNoSupValue](#dms_endpoints_additionalProperties_s3Settings_csvNoSupValue ) | No | string | No | - | This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If [\`UseCsvNoSupValue\`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the \`UseCsvNoSupValue\` setting.<br /><br />> This setting is supported in AWS DMS versions 3.4.1 and later. |
2109
+ | - [csvNullValue](#dms_endpoints_additionalProperties_s3Settings_csvNullValue ) | No | string | No | - | An optional parameter that specifies how AWS DMS treats null values.<br /><br />While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), AWS DMS treats the empty string as the null value instead of \`NULL\` .<br /><br />The default value is \`NULL\` . Valid values include any valid string. |
2110
+ | - [csvRowDelimiter](#dms_endpoints_additionalProperties_s3Settings_csvRowDelimiter ) | No | string | No | - | The delimiter used to separate rows in the .csv file for both source and target.<br /><br />The default is a carriage return ( \`\n\` ). |
2111
+ | - [dataFormat](#dms_endpoints_additionalProperties_s3Settings_dataFormat ) | No | string | No | - | The format of the data that you want to use for output. You can choose one of the following:.<br /><br />- \`csv\` : This is a row-based file format with comma-separated values (.csv).<br />- \`parquet\` : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response. |
2112
+ | - [dataPageSize](#dms_endpoints_additionalProperties_s3Settings_dataPageSize ) | No | number | No | - | The size of one data page in bytes.<br /><br />This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only. |
2113
+ | - [datePartitionDelimiter](#dms_endpoints_additionalProperties_s3Settings_datePartitionDelimiter ) | No | string | No | - | Specifies a date separating delimiter to use during folder partitioning.<br /><br />The default value is \`SLASH\` . Use this parameter when \`DatePartitionedEnabled\` is set to \`true\` . |
2114
+ | - [datePartitionEnabled](#dms_endpoints_additionalProperties_s3Settings_datePartitionEnabled ) | No | boolean | No | - | When set to \`true\` , this parameter partitions S3 bucket folders based on transaction commit dates.<br /><br />The default value is \`false\` . For more information about date-based folder partitioning, see [Using date-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning) . |
2115
+ | - [datePartitionSequence](#dms_endpoints_additionalProperties_s3Settings_datePartitionSequence ) | No | string | No | - | Identifies the sequence of the date format to use during folder partitioning.<br /><br />The default value is \`YYYYMMDD\` . Use this parameter when \`DatePartitionedEnabled\` is set to \`true\` . |
2116
+ | - [datePartitionTimezone](#dms_endpoints_additionalProperties_s3Settings_datePartitionTimezone ) | No | string | No | - | When creating an S3 target endpoint, set \`DatePartitionTimezone\` to convert the current UTC time into a specified time zone.<br /><br />The conversion occurs when a date partition folder is created and a change data capture (CDC) file name is generated. The time zone format is Area/Location. Use this parameter when \`DatePartitionedEnabled\` is set to \`true\` , as shown in the following example.<br /><br />\`s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":" *Asia/Seoul* ", "BucketName": "dms-nattarat-test"}'\` |
2117
+ | - [dictPageSizeLimit](#dms_endpoints_additionalProperties_s3Settings_dictPageSizeLimit ) | No | number | No | - | The maximum size of an encoded dictionary page of a column.<br /><br />If the dictionary page exceeds this, this column is stored using an encoding type of \`PLAIN\` . This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to \`PLAIN\` encoding. This size is used for .parquet file format only. |
2118
+ | - [enableStatistics](#dms_endpoints_additionalProperties_s3Settings_enableStatistics ) | No | boolean | No | - | A value that enables statistics for Parquet pages and row groups.<br /><br />Choose \`true\` to enable statistics, \`false\` to disable. Statistics include \`NULL\` , \`DISTINCT\` , \`MAX\` , and \`MIN\` values. This parameter defaults to \`true\` . This value is used for .parquet file format only. |
2119
+ | - [encodingType](#dms_endpoints_additionalProperties_s3Settings_encodingType ) | No | string | No | - | The type of encoding that you're using:.<br /><br />- \`RLE_DICTIONARY\` uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.<br />- \`PLAIN\` doesn't use encoding at all. Values are stored as they are.<br />- \`PLAIN_DICTIONARY\` builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk. |
2120
+ | - [externalTableDefinition](#dms_endpoints_additionalProperties_s3Settings_externalTableDefinition ) | No | string | No | - | The external table definition.<br /><br />Conditional: If \`S3\` is used as a source then \`ExternalTableDefinition\` is required. |
2121
+ | - [ignoreHeaderRows](#dms_endpoints_additionalProperties_s3Settings_ignoreHeaderRows ) | No | number | No | - | When this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.<br /><br />The default is 0. |
2122
+ | - [includeOpForFullLoad](#dms_endpoints_additionalProperties_s3Settings_includeOpForFullLoad ) | No | boolean | No | - | A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.<br /><br />> AWS DMS supports the \`IncludeOpForFullLoad\` parameter in versions 3.1.4 and later.<br /><br />For full load, records can only be inserted. By default (the \`false\` setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If \`IncludeOpForFullLoad\` is set to \`true\` or \`y\` , the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.<br /><br />> This setting works together with the \`CdcInsertsOnly\` and the \`CdcInsertsAndUpdates\` parameters for output to .csv files only. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide* . |
2123
+ | - [maxFileSize](#dms_endpoints_additionalProperties_s3Settings_maxFileSize ) | No | number | No | - | A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.<br /><br />The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576. |
2124
+ | - [parquetTimestampInMillisecond](#dms_endpoints_additionalProperties_s3Settings_parquetTimestampInMillisecond ) | No | boolean | No | - | A value that specifies the precision of any \`TIMESTAMP\` column values that are written to an Amazon S3 object file in .parquet format.<br /><br />> AWS DMS supports the \`ParquetTimestampInMillisecond\` parameter in versions 3.1.4 and later.<br /><br />When \`ParquetTimestampInMillisecond\` is set to \`true\` or \`y\` , AWS DMS writes all \`TIMESTAMP\` columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.<br /><br />Currently, Amazon Athena and AWS Glue can handle only millisecond precision for \`TIMESTAMP\` values. Set this parameter to \`true\` for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue .<br /><br />> AWS DMS writes any \`TIMESTAMP\` column values written to an S3 file in .csv format with microsecond precision.<br />><br />> Setting \`ParquetTimestampInMillisecond\` has no effect on the string format of the timestamp column value that is inserted by setting the \`TimestampColumnName\` parameter. |
2125
+ | - [parquetVersion](#dms_endpoints_additionalProperties_s3Settings_parquetVersion ) | No | string | No | - | The version of the Apache Parquet format that you want to use: \`parquet_1_0\` (the default) or \`parquet_2_0\` . |
2126
+ | - [preserveTransactions](#dms_endpoints_additionalProperties_s3Settings_preserveTransactions ) | No | boolean | No | - | If this setting is set to \`true\` , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by [\`CdcPath\`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath) . For more information, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) .<br /><br />> This setting is supported in AWS DMS versions 3.4.2 and later. |
2127
+ | - [rfc4180](#dms_endpoints_additionalProperties_s3Settings_rfc4180 ) | No | boolean | No | - | For an S3 source, when this value is set to \`true\` or \`y\` , each leading double quotation mark has to be followed by an ending double quotation mark.<br /><br />This formatting complies with RFC 4180. When this value is set to \`false\` or \`n\` , string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.<br /><br />For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to \`true\` or \`y\` using Amazon S3 as a target, if the data has quotation marks or newline characters in it, AWS DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.<br /><br />The default value is \`true\` . Valid values include \`true\` , \`false\` , \`y\` , and \`n\` . |
2128
+ | - [rowGroupLength](#dms_endpoints_additionalProperties_s3Settings_rowGroupLength ) | No | number | No | - | The number of rows in a row group.<br /><br />A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.<br /><br />If you choose a value larger than the maximum, \`RowGroupLength\` is set to the max row group length in bytes (64 * 1024 * 1024). |
2129
+ | + [serverSideEncryptionKmsKeyId](#dms_endpoints_additionalProperties_s3Settings_serverSideEncryptionKmsKeyId ) | No | string | No | - | If you are using \`SSE_KMS\` for the \`EncryptionMode\` , provide the AWS KMS key ID.<br /><br />The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.<br /><br />Here is a CLI example: \`aws dms create-endpoint --endpoint-identifier *value* --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn= *value* ,BucketFolder= *value* ,BucketName= *value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId= *value*\` |
2130
+ | - [serviceAccessRoleArn](#dms_endpoints_additionalProperties_s3Settings_serviceAccessRoleArn ) | No | string | No | - | A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.<br /><br />The role must allow the \`iam:PassRole\` action. It enables AWS DMS to read and write objects from an S3 bucket. |
2131
+ | - [timestampColumnName](#dms_endpoints_additionalProperties_s3Settings_timestampColumnName ) | No | string | No | - | A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.<br /><br />> AWS DMS supports the \`TimestampColumnName\` parameter in versions 3.1.4 and later.<br /><br />AWS DMS includes an additional \`STRING\` column in the .csv or .parquet object files of your migrated data when you set \`TimestampColumnName\` to a nonblank value.<br /><br />For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.<br /><br />For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.<br /><br />The string format for this timestamp column value is \`yyyy-MM-dd HH:mm:ss.SSSSSS\` . By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.<br /><br />When the \`AddColumnName\` parameter is set to \`true\` , DMS also includes a name for the timestamp column that you set with \`TimestampColumnName\` . |
2132
+ | - [useCsvNoSupValue](#dms_endpoints_additionalProperties_s3Settings_useCsvNoSupValue ) | No | boolean | No | - | This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to \`true\` for columns not included in the supplemental log, AWS DMS uses the value specified by [\`CsvNoSupValue\`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue) . If this setting isn't set or is set to \`false\` , AWS DMS uses the null value for these columns.<br /><br />> This setting is supported in AWS DMS versions 3.4.1 and later. |
2133
+ | - [useTaskStartTimeForFullLoadTimestamp](#dms_endpoints_additionalProperties_s3Settings_useTaskStartTimeForFullLoadTimestamp ) | No | boolean | No | - | When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target.<br /><br />For full load, when \`useTaskStartTimeForFullLoadTimestamp\` is set to \`true\` , each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.<br /><br />When \`useTaskStartTimeForFullLoadTimestamp\` is set to \`false\` , the full load timestamp in the timestamp column increments with the time data arrives at the target. |
2134
+
2135
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_addColumnName"></a>2.2.1.16.1. Property `root > dms > endpoints > additionalProperties > s3Settings > addColumnName`
2136
+
2137
+ | | |
2138
+ | ------------ | --------- |
2139
+ | **Type** | `boolean` |
2140
+ | **Required** | No |
2141
+
2142
+ **Description:** An optional parameter that, when set to `true` or `y` , you can use to add column name information to the .csv output file.
2143
+
2144
+ The default value is `false` . Valid values are `true` , `false` , `y` , and `n` .
2145
+
2146
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_bucketFolder"></a>2.2.1.16.2. Property `root > dms > endpoints > additionalProperties > s3Settings > bucketFolder`
2147
+
2148
+ | | |
2149
+ | ------------ | -------- |
2150
+ | **Type** | `string` |
2151
+ | **Required** | No |
2152
+
2153
+ **Description:** An optional parameter to set a folder name in the S3 bucket.
2154
+
2155
+ If provided, tables are created in the path `*bucketFolder* / *schema_name* / *table_name* /` . If this parameter isn't specified, the path used is `*schema_name* / *table_name* /` .
2156
+
2157
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_bucketName"></a>2.2.1.16.3. Property `root > dms > endpoints > additionalProperties > s3Settings > bucketName`
2158
+
2159
+ | | |
2160
+ | ------------ | -------- |
2161
+ | **Type** | `string` |
2162
+ | **Required** | Yes |
2163
+
2164
+ **Description:** The name of the S3 bucket.
2165
+
2166
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_cannedAclForObjects"></a>2.2.1.16.4. Property `root > dms > endpoints > additionalProperties > s3Settings > cannedAclForObjects`
2167
+
2168
+ | | |
2169
+ | ------------ | -------- |
2170
+ | **Type** | `string` |
2171
+ | **Required** | No |
2172
+
2173
+ **Description:** A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide* .
2174
+
2175
+ The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.
2176
+
2177
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_cdcInsertsAndUpdates"></a>2.2.1.16.5. Property `root > dms > endpoints > additionalProperties > s3Settings > cdcInsertsAndUpdates`
2178
+
2179
+ | | |
2180
+ | ------------ | --------- |
2181
+ | **Type** | `boolean` |
2182
+ | **Required** | No |
2183
+
2184
+ **Description:** A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is `false` , but when `CdcInsertsAndUpdates` is set to `true` or `y` , only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.
2185
+
2186
+ For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter. If `IncludeOpForFullLoad` is set to `true` , the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source. But if `IncludeOpForFullLoad` is set to `false` , CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide* .
2187
+
2188
+ > AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3.3.1 and later.
2189
+ >
2190
+ > `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both.
2191
+
2192
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_cdcInsertsOnly"></a>2.2.1.16.6. Property `root > dms > endpoints > additionalProperties > s3Settings > cdcInsertsOnly`
2193
+
2194
+ | | |
2195
+ | ------------ | --------- |
2196
+ | **Type** | `boolean` |
2197
+ | **Required** | No |
2198
+
2199
+ **Description:** A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the `false` setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.
2200
+
2201
+ If `CdcInsertsOnly` is set to `true` or `y` , only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad` . If `IncludeOpForFullLoad` is set to `true` , the first field of every CDC record is set to I to indicate the INSERT operation at the source. If `IncludeOpForFullLoad` is set to `false` , every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide* .
2202
+
2203
+ > AWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3.1.4 and later.
2204
+ >
2205
+ > `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both.
2206
+
2207
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_cdcMaxBatchInterval"></a>2.2.1.16.7. Property `root > dms > endpoints > additionalProperties > s3Settings > cdcMaxBatchInterval`
2208
+
2209
+ | | |
2210
+ | ------------ | -------- |
2211
+ | **Type** | `number` |
2212
+ | **Required** | No |
2213
+
2214
+ **Description:** Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
2215
+
2216
+ When `CdcMaxBatchInterval` and `CdcMinFileSize` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.
2217
+
2218
+ The default value is 60 seconds.
2219
+
2220
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_cdcMinFileSize"></a>2.2.1.16.8. Property `root > dms > endpoints > additionalProperties > s3Settings > cdcMinFileSize`
2221
+
2222
+ | | |
2223
+ | ------------ | -------- |
2224
+ | **Type** | `number` |
2225
+ | **Required** | No |
2226
+
2227
+ **Description:** Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
2228
+
2229
+ When `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.
2230
+
2231
+ The default value is 32 MB.
2232
+
2233
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_cdcPath"></a>2.2.1.16.9. Property `root > dms > endpoints > additionalProperties > s3Settings > cdcPath`
2234
+
2235
+ | | |
2236
+ | ------------ | -------- |
2237
+ | **Type** | `string` |
2238
+ | **Required** | No |
2239
+
2240
+ **Description:** Specifies the folder path of CDC files.
2241
+
2242
+ For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set [`PreserveTransactions`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true` , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [`BucketFolder`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [`BucketName`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName) .
2243
+
2244
+ For example, if you specify `CdcPath` as `MyChangedData` , and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder` , AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData` .
2245
+
2246
+ If you specify the same `CdcPath` , and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData` , AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData` .
2247
+
2248
+ For more information on CDC including transaction order on an S3 target, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) .
2249
+
2250
+ > This setting is supported in AWS DMS versions 3.4.2 and later.
2251
+
2252
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_compressionType"></a>2.2.1.16.10. Property `root > dms > endpoints > additionalProperties > s3Settings > compressionType`
2253
+
2254
+ | | |
2255
+ | ------------ | -------- |
2256
+ | **Type** | `string` |
2257
+ | **Required** | No |
2258
+
2259
+ **Description:** An optional parameter.
2260
+
2261
+ When set to GZIP it enables the service to compress the target files. To allow the service to write the target files uncompressed, either set this parameter to NONE (the default) or don't specify the parameter at all. This parameter applies to both .csv and .parquet file formats.
2262
+
2263
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_csvDelimiter"></a>2.2.1.16.11. Property `root > dms > endpoints > additionalProperties > s3Settings > csvDelimiter`
2264
+
2265
+ | | |
2266
+ | ------------ | -------- |
2267
+ | **Type** | `string` |
2268
+ | **Required** | No |
2269
+
2270
+ **Description:** The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
2271
+
2272
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_csvNoSupValue"></a>2.2.1.16.12. Property `root > dms > endpoints > additionalProperties > s3Settings > csvNoSupValue`
2273
+
2274
+ | | |
2275
+ | ------------ | -------- |
2276
+ | **Type** | `string` |
2277
+ | **Required** | No |
2278
+
2279
+ **Description:** This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If [`UseCsvNoSupValue`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the `UseCsvNoSupValue` setting.
2280
+
2281
+ > This setting is supported in AWS DMS versions 3.4.1 and later.
2282
+
2283
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_csvNullValue"></a>2.2.1.16.13. Property `root > dms > endpoints > additionalProperties > s3Settings > csvNullValue`
2284
+
2285
+ | | |
2286
+ | ------------ | -------- |
2287
+ | **Type** | `string` |
2288
+ | **Required** | No |
2289
+
2290
+ **Description:** An optional parameter that specifies how AWS DMS treats null values.
2291
+
2292
+ While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), AWS DMS treats the empty string as the null value instead of `NULL` .
2293
+
2294
+ The default value is `NULL` . Valid values include any valid string.
2295
+
2296
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_csvRowDelimiter"></a>2.2.1.16.14. Property `root > dms > endpoints > additionalProperties > s3Settings > csvRowDelimiter`
2297
+
2298
+ | | |
2299
+ | ------------ | -------- |
2300
+ | **Type** | `string` |
2301
+ | **Required** | No |
2302
+
2303
+ **Description:** The delimiter used to separate rows in the .csv file for both source and target.
2304
+
2305
+ The default is a carriage return ( `\n` ).
2306
+
2307
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_dataFormat"></a>2.2.1.16.15. Property `root > dms > endpoints > additionalProperties > s3Settings > dataFormat`
2308
+
2309
+ | | |
2310
+ | ------------ | -------- |
2311
+ | **Type** | `string` |
2312
+ | **Required** | No |
2313
+
2314
+ **Description:** The format of the data that you want to use for output. You can choose one of the following:.
2315
+
2316
+ - `csv` : This is a row-based file format with comma-separated values (.csv).
2317
+ - `parquet` : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.
2318
+
2319
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_dataPageSize"></a>2.2.1.16.16. Property `root > dms > endpoints > additionalProperties > s3Settings > dataPageSize`
2320
+
2321
+ | | |
2322
+ | ------------ | -------- |
2323
+ | **Type** | `number` |
2324
+ | **Required** | No |
2325
+
2326
+ **Description:** The size of one data page in bytes.
2327
+
2328
+ This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.
2329
+
2330
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_datePartitionDelimiter"></a>2.2.1.16.17. Property `root > dms > endpoints > additionalProperties > s3Settings > datePartitionDelimiter`
2331
+
2332
+ | | |
2333
+ | ------------ | -------- |
2334
+ | **Type** | `string` |
2335
+ | **Required** | No |
2336
+
2337
+ **Description:** Specifies a date separating delimiter to use during folder partitioning.
2338
+
2339
+ The default value is `SLASH` . Use this parameter when `DatePartitionedEnabled` is set to `true` .
2340
+
2341
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_datePartitionEnabled"></a>2.2.1.16.18. Property `root > dms > endpoints > additionalProperties > s3Settings > datePartitionEnabled`
2342
+
2343
+ | | |
2344
+ | ------------ | --------- |
2345
+ | **Type** | `boolean` |
2346
+ | **Required** | No |
2347
+
2348
+ **Description:** When set to `true` , this parameter partitions S3 bucket folders based on transaction commit dates.
2349
+
2350
+ The default value is `false` . For more information about date-based folder partitioning, see [Using date-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning) .
2351
+
2352
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_datePartitionSequence"></a>2.2.1.16.19. Property `root > dms > endpoints > additionalProperties > s3Settings > datePartitionSequence`
2353
+
2354
+ | | |
2355
+ | ------------ | -------- |
2356
+ | **Type** | `string` |
2357
+ | **Required** | No |
2358
+
2359
+ **Description:** Identifies the sequence of the date format to use during folder partitioning.
2360
+
2361
+ The default value is `YYYYMMDD` . Use this parameter when `DatePartitionedEnabled` is set to `true` .
2362
+
2363
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_datePartitionTimezone"></a>2.2.1.16.20. Property `root > dms > endpoints > additionalProperties > s3Settings > datePartitionTimezone`
2364
+
2365
+ | | |
2366
+ | ------------ | -------- |
2367
+ | **Type** | `string` |
2368
+ | **Required** | No |
2369
+
2370
+ **Description:** When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone.
2371
+
2372
+ The conversion occurs when a date partition folder is created and a change data capture (CDC) file name is generated. The time zone format is Area/Location. Use this parameter when `DatePartitionedEnabled` is set to `true` , as shown in the following example.
2373
+
2374
+ `s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":" *Asia/Seoul* ", "BucketName": "dms-nattarat-test"}'`
2375
+
2376
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_dictPageSizeLimit"></a>2.2.1.16.21. Property `root > dms > endpoints > additionalProperties > s3Settings > dictPageSizeLimit`
2377
+
2378
+ | | |
2379
+ | ------------ | -------- |
2380
+ | **Type** | `number` |
2381
+ | **Required** | No |
2382
+
2383
+ **Description:** The maximum size of an encoded dictionary page of a column.
2384
+
2385
+ If the dictionary page exceeds this, this column is stored using an encoding type of `PLAIN` . This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to `PLAIN` encoding. This size is used for .parquet file format only.
2386
+
2387
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_enableStatistics"></a>2.2.1.16.22. Property `root > dms > endpoints > additionalProperties > s3Settings > enableStatistics`
2388
+
2389
+ | | |
2390
+ | ------------ | --------- |
2391
+ | **Type** | `boolean` |
2392
+ | **Required** | No |
2393
+
2394
+ **Description:** A value that enables statistics for Parquet pages and row groups.
2395
+
2396
+ Choose `true` to enable statistics, `false` to disable. Statistics include `NULL` , `DISTINCT` , `MAX` , and `MIN` values. This parameter defaults to `true` . This value is used for .parquet file format only.
2397
+
2398
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_encodingType"></a>2.2.1.16.23. Property `root > dms > endpoints > additionalProperties > s3Settings > encodingType`
2399
+
2400
+ | | |
2401
+ | ------------ | -------- |
2402
+ | **Type** | `string` |
2403
+ | **Required** | No |
2404
+
2405
+ **Description:** The type of encoding that you're using:.
2406
+
2407
+ - `RLE_DICTIONARY` uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.
2408
+ - `PLAIN` doesn't use encoding at all. Values are stored as they are.
2409
+ - `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
2410
+
2411
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_externalTableDefinition"></a>2.2.1.16.24. Property `root > dms > endpoints > additionalProperties > s3Settings > externalTableDefinition`
2412
+
2413
+ | | |
2414
+ | ------------ | -------- |
2415
+ | **Type** | `string` |
2416
+ | **Required** | No |
2417
+
2418
+ **Description:** The external table definition.
2419
+
2420
+ Conditional: If `S3` is used as a source then `ExternalTableDefinition` is required.
2421
+
2422
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_ignoreHeaderRows"></a>2.2.1.16.25. Property `root > dms > endpoints > additionalProperties > s3Settings > ignoreHeaderRows`
2423
+
2424
+ | | |
2425
+ | ------------ | -------- |
2426
+ | **Type** | `number` |
2427
+ | **Required** | No |
2428
+
2429
+ **Description:** When this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.
2430
+
2431
+ The default is 0.
2432
+
2433
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_includeOpForFullLoad"></a>2.2.1.16.26. Property `root > dms > endpoints > additionalProperties > s3Settings > includeOpForFullLoad`
2434
+
2435
+ | | |
2436
+ | ------------ | --------- |
2437
+ | **Type** | `boolean` |
2438
+ | **Required** | No |
2439
+
2440
+ **Description:** A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
2441
+
2442
+ > AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3.1.4 and later.
2443
+
2444
+ For full load, records can only be inserted. By default (the `false` setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If `IncludeOpForFullLoad` is set to `true` or `y` , the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.
2445
+
2446
+ > This setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to .csv files only. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide* .
2447
+
2448
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_maxFileSize"></a>2.2.1.16.27. Property `root > dms > endpoints > additionalProperties > s3Settings > maxFileSize`
2449
+
2450
+ | | |
2451
+ | ------------ | -------- |
2452
+ | **Type** | `number` |
2453
+ | **Required** | No |
2454
+
2455
+ **Description:** A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.
2456
+
2457
+ The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.
2458
+
2459
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_parquetTimestampInMillisecond"></a>2.2.1.16.28. Property `root > dms > endpoints > additionalProperties > s3Settings > parquetTimestampInMillisecond`
2460
+
2461
+ | | |
2462
+ | ------------ | --------- |
2463
+ | **Type** | `boolean` |
2464
+ | **Required** | No |
2465
+
2466
+ **Description:** A value that specifies the precision of any `TIMESTAMP` column values that are written to an Amazon S3 object file in .parquet format.
2467
+
2468
+ > AWS DMS supports the `ParquetTimestampInMillisecond` parameter in versions 3.1.4 and later.
2469
+
2470
+ When `ParquetTimestampInMillisecond` is set to `true` or `y` , AWS DMS writes all `TIMESTAMP` columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.
2471
+
2472
+ Currently, Amazon Athena and AWS Glue can handle only millisecond precision for `TIMESTAMP` values. Set this parameter to `true` for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue .
2473
+
2474
+ > AWS DMS writes any `TIMESTAMP` column values written to an S3 file in .csv format with microsecond precision.
2475
+ >
2476
+ > Setting `ParquetTimestampInMillisecond` has no effect on the string format of the timestamp column value that is inserted by setting the `TimestampColumnName` parameter.
2477
+
2478
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_parquetVersion"></a>2.2.1.16.29. Property `root > dms > endpoints > additionalProperties > s3Settings > parquetVersion`
2479
+
2480
+ | | |
2481
+ | ------------ | -------- |
2482
+ | **Type** | `string` |
2483
+ | **Required** | No |
2484
+
2485
+ **Description:** The version of the Apache Parquet format that you want to use: `parquet_1_0` (the default) or `parquet_2_0` .
2486
+
2487
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_preserveTransactions"></a>2.2.1.16.30. Property `root > dms > endpoints > additionalProperties > s3Settings > preserveTransactions`
2488
+
2489
+ | | |
2490
+ | ------------ | --------- |
2491
+ | **Type** | `boolean` |
2492
+ | **Required** | No |
2493
+
2494
+ **Description:** If this setting is set to `true` , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by [`CdcPath`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath) . For more information, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) .
2495
+
2496
+ > This setting is supported in AWS DMS versions 3.4.2 and later.
2497
+
2498
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_rfc4180"></a>2.2.1.16.31. Property `root > dms > endpoints > additionalProperties > s3Settings > rfc4180`
2499
+
2500
+ | | |
2501
+ | ------------ | --------- |
2502
+ | **Type** | `boolean` |
2503
+ | **Required** | No |
2504
+
2505
+ **Description:** For an S3 source, when this value is set to `true` or `y` , each leading double quotation mark has to be followed by an ending double quotation mark.
2506
+
2507
+ This formatting complies with RFC 4180. When this value is set to `false` or `n` , string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.
2508
+
2509
+ For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to `true` or `y` using Amazon S3 as a target, if the data has quotation marks or newline characters in it, AWS DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.
2510
+
2511
+ The default value is `true` . Valid values include `true` , `false` , `y` , and `n` .
2512
+
2513
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_rowGroupLength"></a>2.2.1.16.32. Property `root > dms > endpoints > additionalProperties > s3Settings > rowGroupLength`
2514
+
2515
+ | | |
2516
+ | ------------ | -------- |
2517
+ | **Type** | `number` |
2518
+ | **Required** | No |
2519
+
2520
+ **Description:** The number of rows in a row group.
2521
+
2522
+ A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.
2523
+
2524
+ If you choose a value larger than the maximum, `RowGroupLength` is set to the max row group length in bytes (64 * 1024 * 1024).
2525
+
2526
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_serverSideEncryptionKmsKeyId"></a>2.2.1.16.33. Property `root > dms > endpoints > additionalProperties > s3Settings > serverSideEncryptionKmsKeyId`
2527
+
2528
+ | | |
2529
+ | ------------ | -------- |
2530
+ | **Type** | `string` |
2531
+ | **Required** | Yes |
2532
+
2533
+ **Description:** If you are using `SSE_KMS` for the `EncryptionMode` , provide the AWS KMS key ID.
2534
+
2535
+ The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
2536
+
2537
+ Here is a CLI example: `aws dms create-endpoint --endpoint-identifier *value* --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn= *value* ,BucketFolder= *value* ,BucketName= *value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId= *value*`
2538
+
2539
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_serviceAccessRoleArn"></a>2.2.1.16.34. Property `root > dms > endpoints > additionalProperties > s3Settings > serviceAccessRoleArn`
2540
+
2541
+ | | |
2542
+ | ------------ | -------- |
2543
+ | **Type** | `string` |
2544
+ | **Required** | No |
2545
+
2546
+ **Description:** A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
2547
+
2548
+ The role must allow the `iam:PassRole` action. It enables AWS DMS to read and write objects from an S3 bucket.
2549
+
2550
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_timestampColumnName"></a>2.2.1.16.35. Property `root > dms > endpoints > additionalProperties > s3Settings > timestampColumnName`
2551
+
2552
+ | | |
2553
+ | ------------ | -------- |
2554
+ | **Type** | `string` |
2555
+ | **Required** | No |
2556
+
2557
+ **Description:** A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
2558
+
2559
+ > AWS DMS supports the `TimestampColumnName` parameter in versions 3.1.4 and later.
2560
+
2561
+ AWS DMS includes an additional `STRING` column in the .csv or .parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value.
2562
+
2563
+ For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.
2564
+
2565
+ For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.
2566
+
2567
+ The string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS` . By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.
2568
+
2569
+ When the `AddColumnName` parameter is set to `true` , DMS also includes a name for the timestamp column that you set with `TimestampColumnName` .
2570
+
2571
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_useCsvNoSupValue"></a>2.2.1.16.36. Property `root > dms > endpoints > additionalProperties > s3Settings > useCsvNoSupValue`
2572
+
2573
+ | | |
2574
+ | ------------ | --------- |
2575
+ | **Type** | `boolean` |
2576
+ | **Required** | No |
2577
+
2578
+ **Description:** This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [`CsvNoSupValue`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue) . If this setting isn't set or is set to `false` , AWS DMS uses the null value for these columns.
2579
+
2580
+ > This setting is supported in AWS DMS versions 3.4.1 and later.
2581
+
2582
+ ###### <a name="dms_endpoints_additionalProperties_s3Settings_useTaskStartTimeForFullLoadTimestamp"></a>2.2.1.16.37. Property `root > dms > endpoints > additionalProperties > s3Settings > useTaskStartTimeForFullLoadTimestamp`
2583
+
2584
+ | | |
2585
+ | ------------ | --------- |
2586
+ | **Type** | `boolean` |
2587
+ | **Required** | No |
2588
+
2589
+ **Description:** When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target.
2590
+
2591
+ For full load, when `useTaskStartTimeForFullLoadTimestamp` is set to `true` , each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.
2592
+
2593
+ When `useTaskStartTimeForFullLoadTimestamp` is set to `false` , the full load timestamp in the timestamp column increments with the time data arrives at the target.
2594
+
2595
+ ##### <a name="dms_endpoints_additionalProperties_sybaseSettings"></a>2.2.1.17. Property `root > dms > endpoints > additionalProperties > sybaseSettings`
2596
+
2597
+ | | |
2598
+ | ------------------------- | ------------------------------------------------------- |
2599
+ | **Type** | `object` |
2600
+ | **Required** | No |
2601
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2602
+ | **Defined in** | #/definitions/SybaseSettingsProperty |
2603
+
2604
+ **Description:** Settings in JSON format for the source and target SAP ASE endpoint.
2605
+
2606
+ 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* .
2607
+
2608
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2609
+ | ---------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2610
+ | - [secretsManagerAccessRoleArn](#dms_endpoints_additionalProperties_sybaseSettings_secretsManagerAccessRoleArn ) | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in \`SecretsManagerSecret\` .<br /><br />The role must allow the \`iam:PassRole\` action. \`SecretsManagerSecret\` has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint. |
2611
+ | + [secretsManagerSecretArn](#dms_endpoints_additionalProperties_sybaseSettings_secretsManagerSecretArn ) | No | string | No | - | The full ARN of the \`SecretsManagerSecret\` that contains the SAP SAE endpoint connection details. |
2612
+ | - [secretsManagerSecretKMSArn](#dms_endpoints_additionalProperties_sybaseSettings_secretsManagerSecretKMSArn ) | No | string | No | - | The Arn of the KMS key used to encrypt the credentials secret. |
2613
+
2614
+ ###### <a name="dms_endpoints_additionalProperties_sybaseSettings_secretsManagerAccessRoleArn"></a>2.2.1.17.1. Property `root > dms > endpoints > additionalProperties > sybaseSettings > secretsManagerAccessRoleArn`
2615
+
2616
+ | | |
2617
+ | ------------ | -------- |
2618
+ | **Type** | `string` |
2619
+ | **Required** | No |
2620
+
2621
+ **Description:** The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
2622
+
2623
+ The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.
2624
+
2625
+ ###### <a name="dms_endpoints_additionalProperties_sybaseSettings_secretsManagerSecretArn"></a>2.2.1.17.2. Property `root > dms > endpoints > additionalProperties > sybaseSettings > secretsManagerSecretArn`
2626
+
2627
+ | | |
2628
+ | ------------ | -------- |
2629
+ | **Type** | `string` |
2630
+ | **Required** | Yes |
2631
+
2632
+ **Description:** The full ARN of the `SecretsManagerSecret` that contains the SAP SAE endpoint connection details.
2633
+
2634
+ ###### <a name="dms_endpoints_additionalProperties_sybaseSettings_secretsManagerSecretKMSArn"></a>2.2.1.17.3. Property `root > dms > endpoints > additionalProperties > sybaseSettings > secretsManagerSecretKMSArn`
2635
+
2636
+ | | |
2637
+ | ------------ | -------- |
2638
+ | **Type** | `string` |
2639
+ | **Required** | No |
2640
+
2641
+ **Description:** The Arn of the KMS key used to encrypt the credentials secret.
2642
+
2643
+ ### <a name="dms_replicationInstances"></a>2.3. Property `root > dms > replicationInstances`
2644
+
2645
+ | | |
2646
+ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
2647
+ | **Type** | `object` |
2648
+ | **Required** | No |
2649
+ | **Additional properties** | [[Should-conform]](#dms_replicationInstances_additionalProperties "Each additional property must conform to the following schema") |
2650
+ | **Defined in** | #/definitions/NamedReplicationInstanceProps |
2651
+
2652
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2653
+ | ----------------------------------------------------- | ------- | ------ | ---------- | ----------------------------------------- | ----------------- |
2654
+ | - [](#dms_replicationInstances_additionalProperties ) | No | object | No | In #/definitions/ReplicationInstanceProps | - |
2655
+
2656
+ #### <a name="dms_replicationInstances_additionalProperties"></a>2.3.1. Property `root > dms > replicationInstances > ReplicationInstanceProps`
2657
+
2658
+ | | |
2659
+ | ------------------------- | ------------------------------------------------------- |
2660
+ | **Type** | `object` |
2661
+ | **Required** | No |
2662
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2663
+ | **Defined in** | #/definitions/ReplicationInstanceProps |
2664
+
2665
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2666
+ | ---------------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2667
+ | - [addSelfReferenceRule](#dms_replicationInstances_additionalProperties_addSelfReferenceRule ) | No | boolean | No | - | If true, the SG will allow traffic to and from itself |
2668
+ | - [egressRules](#dms_replicationInstances_additionalProperties_egressRules ) | No | object | No | In #/definitions/MdaaSecurityGroupRuleProps | List of egress rules to be added to the function SG |
2669
+ | - [ingressRules](#dms_replicationInstances_additionalProperties_ingressRules ) | No | object | No | Same as [egressRules](#dms_replicationInstances_additionalProperties_egressRules ) | List of ingress rules to be added to the function SG |
2670
+ | + [instanceClass](#dms_replicationInstances_additionalProperties_instanceClass ) | No | string | No | - | The compute class of the replication instance. <br />For supported types, see https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html |
2671
+ | + [subnetIds](#dms_replicationInstances_additionalProperties_subnetIds ) | No | array of string | No | - | List of subnet ids on which the replication instance will be deployed.<br />This list must span at least two Azs |
2672
+ | + [vpcId](#dms_replicationInstances_additionalProperties_vpcId ) | No | string | No | - | The VPC on which the replication instance will be deployed. |
2673
+
2674
+ ##### <a name="dms_replicationInstances_additionalProperties_addSelfReferenceRule"></a>2.3.1.1. Property `root > dms > replicationInstances > additionalProperties > addSelfReferenceRule`
2675
+
2676
+ | | |
2677
+ | ------------ | --------- |
2678
+ | **Type** | `boolean` |
2679
+ | **Required** | No |
2680
+
2681
+ **Description:** If true, the SG will allow traffic to and from itself
2682
+
2683
+ ##### <a name="dms_replicationInstances_additionalProperties_egressRules"></a>2.3.1.2. Property `root > dms > replicationInstances > additionalProperties > egressRules`
2684
+
2685
+ | | |
2686
+ | ------------------------- | ------------------------------------------------------- |
2687
+ | **Type** | `object` |
2688
+ | **Required** | No |
2689
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2690
+ | **Defined in** | #/definitions/MdaaSecurityGroupRuleProps |
2691
+
2692
+ **Description:** List of egress rules to be added to the function SG
2693
+
2694
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2695
+ | -------------------------------------------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- |
2696
+ | - [ipv4](#dms_replicationInstances_additionalProperties_egressRules_ipv4 ) | No | array | No | - | - |
2697
+ | - [prefixList](#dms_replicationInstances_additionalProperties_egressRules_prefixList ) | No | array | No | - | - |
2698
+ | - [sg](#dms_replicationInstances_additionalProperties_egressRules_sg ) | No | array | No | - | - |
2699
+
2700
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4"></a>2.3.1.2.1. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4`
2701
+
2702
+ | | |
2703
+ | ------------ | ------- |
2704
+ | **Type** | `array` |
2705
+ | **Required** | No |
2706
+
2707
+ | | Array restrictions |
2708
+ | -------------------- | ------------------ |
2709
+ | **Min items** | N/A |
2710
+ | **Max items** | N/A |
2711
+ | **Items unicity** | False |
2712
+ | **Additional items** | False |
2713
+ | **Tuple validation** | See below |
2714
+
2715
+ | Each item of this array must be | Description |
2716
+ | ------------------------------------------------------------------------------------- | ----------- |
2717
+ | [MdaaCidrPeer](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items) | - |
2718
+
2719
+ ###### <a name="autogenerated_heading_3"></a>2.3.1.2.1.1. root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > MdaaCidrPeer
2720
+
2721
+ | | |
2722
+ | ------------------------- | ------------------------------------------------------- |
2723
+ | **Type** | `object` |
2724
+ | **Required** | No |
2725
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2726
+ | **Defined in** | #/definitions/MdaaCidrPeer |
2727
+
2728
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2729
+ | ----------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
2730
+ | + [cidr](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_cidr ) | No | string | No | - | - |
2731
+ | - [description](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_description ) | No | string | No | - | - |
2732
+ | - [port](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_port ) | No | number | No | - | - |
2733
+ | + [protocol](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_protocol ) | No | string | No | - | - |
2734
+ | - [suppressions](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions ) | No | array | No | - | - |
2735
+ | - [toPort](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_toPort ) | No | number | No | - | - |
2736
+
2737
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_cidr"></a>2.3.1.2.1.1.1. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > cidr`
2738
+
2739
+ | | |
2740
+ | ------------ | -------- |
2741
+ | **Type** | `string` |
2742
+ | **Required** | Yes |
2743
+
2744
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_description"></a>2.3.1.2.1.1.2. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > description`
2745
+
2746
+ | | |
2747
+ | ------------ | -------- |
2748
+ | **Type** | `string` |
2749
+ | **Required** | No |
2750
+
2751
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_port"></a>2.3.1.2.1.1.3. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > port`
2752
+
2753
+ | | |
2754
+ | ------------ | -------- |
2755
+ | **Type** | `number` |
2756
+ | **Required** | No |
2757
+
2758
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_protocol"></a>2.3.1.2.1.1.4. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > protocol`
2759
+
2760
+ | | |
2761
+ | ------------ | -------- |
2762
+ | **Type** | `string` |
2763
+ | **Required** | Yes |
2764
+
2765
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions"></a>2.3.1.2.1.1.5. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions`
2766
+
2767
+ | | |
2768
+ | ------------ | ------- |
2769
+ | **Type** | `array` |
2770
+ | **Required** | No |
2771
+
2772
+ | | Array restrictions |
2773
+ | -------------------- | ------------------ |
2774
+ | **Min items** | N/A |
2775
+ | **Max items** | N/A |
2776
+ | **Items unicity** | False |
2777
+ | **Additional items** | False |
2778
+ | **Tuple validation** | See below |
2779
+
2780
+ | Each item of this array must be | Description |
2781
+ | --------------------------------------------------------------------------------------------------------------- | ----------- |
2782
+ | [NagSuppressionProps](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items) | - |
2783
+
2784
+ ###### <a name="autogenerated_heading_4"></a>2.3.1.2.1.1.5.1. root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > NagSuppressionProps
2785
+
2786
+ | | |
2787
+ | ------------------------- | ------------------------------------------------------- |
2788
+ | **Type** | `object` |
2789
+ | **Required** | No |
2790
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2791
+ | **Defined in** | #/definitions/NagSuppressionProps |
2792
+
2793
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2794
+ | ------------------------------------------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- |
2795
+ | + [id](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items_id ) | No | string | No | - | - |
2796
+ | + [reason](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items_reason ) | No | string | No | - | - |
2797
+
2798
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items_id"></a>2.3.1.2.1.1.5.1.1. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > id`
2799
+
2800
+ | | |
2801
+ | ------------ | -------- |
2802
+ | **Type** | `string` |
2803
+ | **Required** | Yes |
2804
+
2805
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items_reason"></a>2.3.1.2.1.1.5.1.2. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > reason`
2806
+
2807
+ | | |
2808
+ | ------------ | -------- |
2809
+ | **Type** | `string` |
2810
+ | **Required** | Yes |
2811
+
2812
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_ipv4_items_toPort"></a>2.3.1.2.1.1.6. Property `root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > toPort`
2813
+
2814
+ | | |
2815
+ | ------------ | -------- |
2816
+ | **Type** | `number` |
2817
+ | **Required** | No |
2818
+
2819
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList"></a>2.3.1.2.2. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList`
2820
+
2821
+ | | |
2822
+ | ------------ | ------- |
2823
+ | **Type** | `array` |
2824
+ | **Required** | No |
2825
+
2826
+ | | Array restrictions |
2827
+ | -------------------- | ------------------ |
2828
+ | **Min items** | N/A |
2829
+ | **Max items** | N/A |
2830
+ | **Items unicity** | False |
2831
+ | **Additional items** | False |
2832
+ | **Tuple validation** | See below |
2833
+
2834
+ | Each item of this array must be | Description |
2835
+ | ------------------------------------------------------------------------------------------------- | ----------- |
2836
+ | [MdaaPrefixListPeer](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items) | - |
2837
+
2838
+ ###### <a name="autogenerated_heading_5"></a>2.3.1.2.2.1. root > dms > replicationInstances > additionalProperties > egressRules > prefixList > MdaaPrefixListPeer
2839
+
2840
+ | | |
2841
+ | ------------------------- | ------------------------------------------------------- |
2842
+ | **Type** | `object` |
2843
+ | **Required** | No |
2844
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2845
+ | **Defined in** | #/definitions/MdaaPrefixListPeer |
2846
+
2847
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2848
+ | ----------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
2849
+ | - [description](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_description ) | No | string | No | - | - |
2850
+ | - [port](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_port ) | No | number | No | - | - |
2851
+ | + [prefixList](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_prefixList ) | No | string | No | - | - |
2852
+ | + [protocol](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_protocol ) | No | string | No | - | - |
2853
+ | - [suppressions](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_suppressions ) | No | array | No | - | - |
2854
+ | - [toPort](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_toPort ) | No | number | No | - | - |
2855
+
2856
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList_items_description"></a>2.3.1.2.2.1.1. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > description`
2857
+
2858
+ | | |
2859
+ | ------------ | -------- |
2860
+ | **Type** | `string` |
2861
+ | **Required** | No |
2862
+
2863
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList_items_port"></a>2.3.1.2.2.1.2. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > port`
2864
+
2865
+ | | |
2866
+ | ------------ | -------- |
2867
+ | **Type** | `number` |
2868
+ | **Required** | No |
2869
+
2870
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList_items_prefixList"></a>2.3.1.2.2.1.3. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > prefixList`
2871
+
2872
+ | | |
2873
+ | ------------ | -------- |
2874
+ | **Type** | `string` |
2875
+ | **Required** | Yes |
2876
+
2877
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList_items_protocol"></a>2.3.1.2.2.1.4. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > protocol`
2878
+
2879
+ | | |
2880
+ | ------------ | -------- |
2881
+ | **Type** | `string` |
2882
+ | **Required** | Yes |
2883
+
2884
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList_items_suppressions"></a>2.3.1.2.2.1.5. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > suppressions`
2885
+
2886
+ | | |
2887
+ | ------------ | ------- |
2888
+ | **Type** | `array` |
2889
+ | **Required** | No |
2890
+
2891
+ | | Array restrictions |
2892
+ | -------------------- | ------------------ |
2893
+ | **Min items** | N/A |
2894
+ | **Max items** | N/A |
2895
+ | **Items unicity** | False |
2896
+ | **Additional items** | False |
2897
+ | **Tuple validation** | See below |
2898
+
2899
+ | Each item of this array must be | Description |
2900
+ | --------------------------------------------------------------------------------------------------------------------- | ----------- |
2901
+ | [NagSuppressionProps](#dms_replicationInstances_additionalProperties_egressRules_prefixList_items_suppressions_items) | - |
2902
+
2903
+ ###### <a name="autogenerated_heading_6"></a>2.3.1.2.2.1.5.1. root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > suppressions > NagSuppressionProps
2904
+
2905
+ | | |
2906
+ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2907
+ | **Type** | `object` |
2908
+ | **Required** | No |
2909
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2910
+ | **Same definition as** | [dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items) |
2911
+
2912
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_prefixList_items_toPort"></a>2.3.1.2.2.1.6. Property `root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > toPort`
2913
+
2914
+ | | |
2915
+ | ------------ | -------- |
2916
+ | **Type** | `number` |
2917
+ | **Required** | No |
2918
+
2919
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg"></a>2.3.1.2.3. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg`
2920
+
2921
+ | | |
2922
+ | ------------ | ------- |
2923
+ | **Type** | `array` |
2924
+ | **Required** | No |
2925
+
2926
+ | | Array restrictions |
2927
+ | -------------------- | ------------------ |
2928
+ | **Min items** | N/A |
2929
+ | **Max items** | N/A |
2930
+ | **Items unicity** | False |
2931
+ | **Additional items** | False |
2932
+ | **Tuple validation** | See below |
2933
+
2934
+ | Each item of this array must be | Description |
2935
+ | -------------------------------------------------------------------------------------------- | ----------- |
2936
+ | [MdaaSecurityGroupPeer](#dms_replicationInstances_additionalProperties_egressRules_sg_items) | - |
2937
+
2938
+ ###### <a name="autogenerated_heading_7"></a>2.3.1.2.3.1. root > dms > replicationInstances > additionalProperties > egressRules > sg > MdaaSecurityGroupPeer
2939
+
2940
+ | | |
2941
+ | ------------------------- | ------------------------------------------------------- |
2942
+ | **Type** | `object` |
2943
+ | **Required** | No |
2944
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
2945
+ | **Defined in** | #/definitions/MdaaSecurityGroupPeer |
2946
+
2947
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
2948
+ | --------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
2949
+ | - [description](#dms_replicationInstances_additionalProperties_egressRules_sg_items_description ) | No | string | No | - | - |
2950
+ | - [port](#dms_replicationInstances_additionalProperties_egressRules_sg_items_port ) | No | number | No | - | - |
2951
+ | + [protocol](#dms_replicationInstances_additionalProperties_egressRules_sg_items_protocol ) | No | string | No | - | - |
2952
+ | + [sgId](#dms_replicationInstances_additionalProperties_egressRules_sg_items_sgId ) | No | string | No | - | - |
2953
+ | - [suppressions](#dms_replicationInstances_additionalProperties_egressRules_sg_items_suppressions ) | No | array | No | - | - |
2954
+ | - [toPort](#dms_replicationInstances_additionalProperties_egressRules_sg_items_toPort ) | No | number | No | - | - |
2955
+
2956
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg_items_description"></a>2.3.1.2.3.1.1. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > description`
2957
+
2958
+ | | |
2959
+ | ------------ | -------- |
2960
+ | **Type** | `string` |
2961
+ | **Required** | No |
2962
+
2963
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg_items_port"></a>2.3.1.2.3.1.2. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > port`
2964
+
2965
+ | | |
2966
+ | ------------ | -------- |
2967
+ | **Type** | `number` |
2968
+ | **Required** | No |
2969
+
2970
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg_items_protocol"></a>2.3.1.2.3.1.3. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > protocol`
2971
+
2972
+ | | |
2973
+ | ------------ | -------- |
2974
+ | **Type** | `string` |
2975
+ | **Required** | Yes |
2976
+
2977
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg_items_sgId"></a>2.3.1.2.3.1.4. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > sgId`
2978
+
2979
+ | | |
2980
+ | ------------ | -------- |
2981
+ | **Type** | `string` |
2982
+ | **Required** | Yes |
2983
+
2984
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg_items_suppressions"></a>2.3.1.2.3.1.5. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > suppressions`
2985
+
2986
+ | | |
2987
+ | ------------ | ------- |
2988
+ | **Type** | `array` |
2989
+ | **Required** | No |
2990
+
2991
+ | | Array restrictions |
2992
+ | -------------------- | ------------------ |
2993
+ | **Min items** | N/A |
2994
+ | **Max items** | N/A |
2995
+ | **Items unicity** | False |
2996
+ | **Additional items** | False |
2997
+ | **Tuple validation** | See below |
2998
+
2999
+ | Each item of this array must be | Description |
3000
+ | ------------------------------------------------------------------------------------------------------------- | ----------- |
3001
+ | [NagSuppressionProps](#dms_replicationInstances_additionalProperties_egressRules_sg_items_suppressions_items) | - |
3002
+
3003
+ ###### <a name="autogenerated_heading_8"></a>2.3.1.2.3.1.5.1. root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > suppressions > NagSuppressionProps
3004
+
3005
+ | | |
3006
+ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3007
+ | **Type** | `object` |
3008
+ | **Required** | No |
3009
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3010
+ | **Same definition as** | [dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items](#dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items) |
3011
+
3012
+ ###### <a name="dms_replicationInstances_additionalProperties_egressRules_sg_items_toPort"></a>2.3.1.2.3.1.6. Property `root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > toPort`
3013
+
3014
+ | | |
3015
+ | ------------ | -------- |
3016
+ | **Type** | `number` |
3017
+ | **Required** | No |
3018
+
3019
+ ##### <a name="dms_replicationInstances_additionalProperties_ingressRules"></a>2.3.1.3. Property `root > dms > replicationInstances > additionalProperties > ingressRules`
3020
+
3021
+ | | |
3022
+ | ------------------------- | ------------------------------------------------------------------------- |
3023
+ | **Type** | `object` |
3024
+ | **Required** | No |
3025
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3026
+ | **Same definition as** | [egressRules](#dms_replicationInstances_additionalProperties_egressRules) |
3027
+
3028
+ **Description:** List of ingress rules to be added to the function SG
3029
+
3030
+ ##### <a name="dms_replicationInstances_additionalProperties_instanceClass"></a>2.3.1.4. Property `root > dms > replicationInstances > additionalProperties > instanceClass`
3031
+
3032
+ | | |
3033
+ | ------------ | -------- |
3034
+ | **Type** | `string` |
3035
+ | **Required** | Yes |
3036
+
3037
+ **Description:** The compute class of the replication instance.
3038
+ For supported types, see https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html
3039
+
3040
+ ##### <a name="dms_replicationInstances_additionalProperties_subnetIds"></a>2.3.1.5. Property `root > dms > replicationInstances > additionalProperties > subnetIds`
3041
+
3042
+ | | |
3043
+ | ------------ | ----------------- |
3044
+ | **Type** | `array of string` |
3045
+ | **Required** | Yes |
3046
+
3047
+ **Description:** List of subnet ids on which the replication instance will be deployed.
3048
+ This list must span at least two Azs
3049
+
3050
+ | | Array restrictions |
3051
+ | -------------------- | ------------------ |
3052
+ | **Min items** | N/A |
3053
+ | **Max items** | N/A |
3054
+ | **Items unicity** | False |
3055
+ | **Additional items** | False |
3056
+ | **Tuple validation** | See below |
3057
+
3058
+ | Each item of this array must be | Description |
3059
+ | --------------------------------------------------------------------------------- | ----------- |
3060
+ | [subnetIds items](#dms_replicationInstances_additionalProperties_subnetIds_items) | - |
3061
+
3062
+ ###### <a name="autogenerated_heading_9"></a>2.3.1.5.1. root > dms > replicationInstances > additionalProperties > subnetIds > subnetIds items
3063
+
3064
+ | | |
3065
+ | ------------ | -------- |
3066
+ | **Type** | `string` |
3067
+ | **Required** | No |
3068
+
3069
+ ##### <a name="dms_replicationInstances_additionalProperties_vpcId"></a>2.3.1.6. Property `root > dms > replicationInstances > additionalProperties > vpcId`
3070
+
3071
+ | | |
3072
+ | ------------ | -------- |
3073
+ | **Type** | `string` |
3074
+ | **Required** | Yes |
3075
+
3076
+ **Description:** The VPC on which the replication instance will be deployed.
3077
+
3078
+ ### <a name="dms_replicationTasks"></a>2.4. Property `root > dms > replicationTasks`
3079
+
3080
+ | | |
3081
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
3082
+ | **Type** | `object` |
3083
+ | **Required** | No |
3084
+ | **Additional properties** | [[Should-conform]](#dms_replicationTasks_additionalProperties "Each additional property must conform to the following schema") |
3085
+ | **Defined in** | #/definitions/NamedReplicationTaskProps |
3086
+
3087
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3088
+ | ------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------- | ----------------- |
3089
+ | - [](#dms_replicationTasks_additionalProperties ) | No | object | No | In #/definitions/ReplicationTaskProps | - |
3090
+
3091
+ #### <a name="dms_replicationTasks_additionalProperties"></a>2.4.1. Property `root > dms > replicationTasks > ReplicationTaskProps`
3092
+
3093
+ | | |
3094
+ | ------------------------- | ------------------------------------------------------- |
3095
+ | **Type** | `object` |
3096
+ | **Required** | No |
3097
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3098
+ | **Defined in** | #/definitions/ReplicationTaskProps |
3099
+
3100
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3101
+ | ------------------------------------------------------------------------------------------------ | ------- | ---------------- | ---------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3102
+ | - [cdcStartPosition](#dms_replicationTasks_additionalProperties_cdcStartPosition ) | No | string | No | - | Indicates when you want a change data capture (CDC) operation to start.<br /><br />Use either \`CdcStartPosition\` or \`CdcStartTime\` to specify when you want a CDC operation to start. Specifying both values results in an error.<br /><br />The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format.<br /><br />Here is a date example: \`--cdc-start-position "2018-03-08T12:12:12"\`<br /><br />Here is a checkpoint example: \`--cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"\`<br /><br />Here is an LSN example: \`--cdc-start-position “mysql-bin-changelog.000024:373”\`<br /><br />> When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the \`slotName\` extra connection attribute to the name of this logical replication slot. For more information, 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) in the *AWS Database Migration Service User Guide* . |
3103
+ | - [cdcStartTime](#dms_replicationTasks_additionalProperties_cdcStartTime ) | No | number | No | - | Indicates the start time for a change data capture (CDC) operation. |
3104
+ | - [cdcStopPosition](#dms_replicationTasks_additionalProperties_cdcStopPosition ) | No | string | No | - | Indicates when you want a change data capture (CDC) operation to stop.<br /><br />The value can be either server time or commit time.<br /><br />Here is a server time example: \`--cdc-stop-position "server_time:2018-02-09T12:12:12"\`<br /><br />Here is a commit time example: \`--cdc-stop-position "commit_time: 2018-02-09T12:12:12"\` |
3105
+ | + [migrationType](#dms_replicationTasks_additionalProperties_migrationType ) | No | enum (of string) | No | In #/definitions/DmsMigrationType | The migration type.<br /><br />Valid values: \`full-load\` \| \`cdc\` \| \`full-load-and-cdc\` |
3106
+ | + [replicationInstance](#dms_replicationTasks_additionalProperties_replicationInstance ) | No | string | No | - | The name of the replication instance from the 'replicationInstances' section. |
3107
+ | - [replicationTaskSettings](#dms_replicationTasks_additionalProperties_replicationTaskSettings ) | No | object | No | - | Overall settings for the task, in JSON format.<br /><br />For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide* . |
3108
+ | + [sourceEndpoint](#dms_replicationTasks_additionalProperties_sourceEndpoint ) | No | string | No | - | The name of the source endpoint from the 'endpoints' section of this config |
3109
+ | + [tableMappings](#dms_replicationTasks_additionalProperties_tableMappings ) | No | object | No | - | The table mappings for the task, in JSON format.<br /><br />For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide* . |
3110
+ | + [targetEndpoint](#dms_replicationTasks_additionalProperties_targetEndpoint ) | No | string | No | - | The name of the target endpoint from the 'endpoints' section of this config |
3111
+ | - [taskData](#dms_replicationTasks_additionalProperties_taskData ) | No | object | No | - | Supplemental information that the task requires to migrate the data for certain source and target endpoints.<br /><br />For more information, see [Specifying Supplemental Data for Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the *AWS Database Migration Service User Guide.* |
3112
+
3113
+ ##### <a name="dms_replicationTasks_additionalProperties_cdcStartPosition"></a>2.4.1.1. Property `root > dms > replicationTasks > additionalProperties > cdcStartPosition`
3114
+
3115
+ | | |
3116
+ | ------------ | -------- |
3117
+ | **Type** | `string` |
3118
+ | **Required** | No |
3119
+
3120
+ **Description:** Indicates when you want a change data capture (CDC) operation to start.
3121
+
3122
+ Use either `CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start. Specifying both values results in an error.
3123
+
3124
+ The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format.
3125
+
3126
+ Here is a date example: `--cdc-start-position "2018-03-08T12:12:12"`
3127
+
3128
+ Here is a checkpoint example: `--cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"`
3129
+
3130
+ Here is an LSN example: `--cdc-start-position “mysql-bin-changelog.000024:373”`
3131
+
3132
+ > When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot. For more information, 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) in the *AWS Database Migration Service User Guide* .
3133
+
3134
+ ##### <a name="dms_replicationTasks_additionalProperties_cdcStartTime"></a>2.4.1.2. Property `root > dms > replicationTasks > additionalProperties > cdcStartTime`
3135
+
3136
+ | | |
3137
+ | ------------ | -------- |
3138
+ | **Type** | `number` |
3139
+ | **Required** | No |
3140
+
3141
+ **Description:** Indicates the start time for a change data capture (CDC) operation.
3142
+
3143
+ ##### <a name="dms_replicationTasks_additionalProperties_cdcStopPosition"></a>2.4.1.3. Property `root > dms > replicationTasks > additionalProperties > cdcStopPosition`
3144
+
3145
+ | | |
3146
+ | ------------ | -------- |
3147
+ | **Type** | `string` |
3148
+ | **Required** | No |
3149
+
3150
+ **Description:** Indicates when you want a change data capture (CDC) operation to stop.
3151
+
3152
+ The value can be either server time or commit time.
3153
+
3154
+ Here is a server time example: `--cdc-stop-position "server_time:2018-02-09T12:12:12"`
3155
+
3156
+ Here is a commit time example: `--cdc-stop-position "commit_time: 2018-02-09T12:12:12"`
3157
+
3158
+ ##### <a name="dms_replicationTasks_additionalProperties_migrationType"></a>2.4.1.4. Property `root > dms > replicationTasks > additionalProperties > migrationType`
3159
+
3160
+ | | |
3161
+ | -------------- | ------------------------------ |
3162
+ | **Type** | `enum (of string)` |
3163
+ | **Required** | Yes |
3164
+ | **Defined in** | #/definitions/DmsMigrationType |
3165
+
3166
+ **Description:** The migration type.
3167
+
3168
+ Valid values: `full-load` | `cdc` | `full-load-and-cdc`
3169
+
3170
+ Must be one of:
3171
+ * "cdc"
3172
+ * "full-load"
3173
+ * "full-load-and-cdc"
3174
+
3175
+ ##### <a name="dms_replicationTasks_additionalProperties_replicationInstance"></a>2.4.1.5. Property `root > dms > replicationTasks > additionalProperties > replicationInstance`
3176
+
3177
+ | | |
3178
+ | ------------ | -------- |
3179
+ | **Type** | `string` |
3180
+ | **Required** | Yes |
3181
+
3182
+ **Description:** The name of the replication instance from the 'replicationInstances' section.
3183
+
3184
+ ##### <a name="dms_replicationTasks_additionalProperties_replicationTaskSettings"></a>2.4.1.6. Property `root > dms > replicationTasks > additionalProperties > replicationTaskSettings`
3185
+
3186
+ | | |
3187
+ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3188
+ | **Type** | `object` |
3189
+ | **Required** | No |
3190
+ | **Additional properties** | [[Should-conform]](#dms_replicationTasks_additionalProperties_replicationTaskSettings_additionalProperties "Each additional property must conform to the following schema") |
3191
+
3192
+ **Description:** Overall settings for the task, in JSON format.
3193
+
3194
+ For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide* .
3195
+
3196
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3197
+ | ---------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
3198
+ | - [](#dms_replicationTasks_additionalProperties_replicationTaskSettings_additionalProperties ) | No | object | No | - | - |
3199
+
3200
+ ###### <a name="dms_replicationTasks_additionalProperties_replicationTaskSettings_additionalProperties"></a>2.4.1.6.1. Property `root > dms > replicationTasks > additionalProperties > replicationTaskSettings > additionalProperties`
3201
+
3202
+ | | |
3203
+ | ------------------------- | ------------------------------------------------------------------------- |
3204
+ | **Type** | `object` |
3205
+ | **Required** | No |
3206
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
3207
+
3208
+ ##### <a name="dms_replicationTasks_additionalProperties_sourceEndpoint"></a>2.4.1.7. Property `root > dms > replicationTasks > additionalProperties > sourceEndpoint`
3209
+
3210
+ | | |
3211
+ | ------------ | -------- |
3212
+ | **Type** | `string` |
3213
+ | **Required** | Yes |
3214
+
3215
+ **Description:** The name of the source endpoint from the 'endpoints' section of this config
3216
+
3217
+ ##### <a name="dms_replicationTasks_additionalProperties_tableMappings"></a>2.4.1.8. Property `root > dms > replicationTasks > additionalProperties > tableMappings`
3218
+
3219
+ | | |
3220
+ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3221
+ | **Type** | `object` |
3222
+ | **Required** | Yes |
3223
+ | **Additional properties** | [[Should-conform]](#dms_replicationTasks_additionalProperties_tableMappings_additionalProperties "Each additional property must conform to the following schema") |
3224
+
3225
+ **Description:** The table mappings for the task, in JSON format.
3226
+
3227
+ For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide* .
3228
+
3229
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3230
+ | ------------------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- |
3231
+ | - [](#dms_replicationTasks_additionalProperties_tableMappings_additionalProperties ) | No | object | No | - | - |
3232
+
3233
+ ###### <a name="dms_replicationTasks_additionalProperties_tableMappings_additionalProperties"></a>2.4.1.8.1. Property `root > dms > replicationTasks > additionalProperties > tableMappings > additionalProperties`
3234
+
3235
+ | | |
3236
+ | ------------------------- | ------------------------------------------------------------------------- |
3237
+ | **Type** | `object` |
3238
+ | **Required** | No |
3239
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
3240
+
3241
+ ##### <a name="dms_replicationTasks_additionalProperties_targetEndpoint"></a>2.4.1.9. Property `root > dms > replicationTasks > additionalProperties > targetEndpoint`
3242
+
3243
+ | | |
3244
+ | ------------ | -------- |
3245
+ | **Type** | `string` |
3246
+ | **Required** | Yes |
3247
+
3248
+ **Description:** The name of the target endpoint from the 'endpoints' section of this config
3249
+
3250
+ ##### <a name="dms_replicationTasks_additionalProperties_taskData"></a>2.4.1.10. Property `root > dms > replicationTasks > additionalProperties > taskData`
3251
+
3252
+ | | |
3253
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3254
+ | **Type** | `object` |
3255
+ | **Required** | No |
3256
+ | **Additional properties** | [[Should-conform]](#dms_replicationTasks_additionalProperties_taskData_additionalProperties "Each additional property must conform to the following schema") |
3257
+
3258
+ **Description:** Supplemental information that the task requires to migrate the data for certain source and target endpoints.
3259
+
3260
+ For more information, see [Specifying Supplemental Data for Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the *AWS Database Migration Service User Guide.*
3261
+
3262
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3263
+ | ------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
3264
+ | - [](#dms_replicationTasks_additionalProperties_taskData_additionalProperties ) | No | object | No | - | - |
3265
+
3266
+ ###### <a name="dms_replicationTasks_additionalProperties_taskData_additionalProperties"></a>2.4.1.10.1. Property `root > dms > replicationTasks > additionalProperties > taskData > additionalProperties`
3267
+
3268
+ | | |
3269
+ | ------------------------- | ------------------------------------------------------------------------- |
3270
+ | **Type** | `object` |
3271
+ | **Required** | No |
3272
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
3273
+
3274
+ ## <a name="kmsArn"></a>3. Property `root > kmsArn`
3275
+
3276
+ | | |
3277
+ | ------------ | -------- |
3278
+ | **Type** | `string` |
3279
+ | **Required** | Yes |
3280
+
3281
+ ## <a name="nag_suppressions"></a>4. Property `root > nag_suppressions`
3282
+
3283
+ | | |
3284
+ | ------------------------- | ------------------------------------------------------- |
3285
+ | **Type** | `object` |
3286
+ | **Required** | No |
3287
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3288
+ | **Defined in** | #/definitions/MdaaNagSuppressions |
3289
+
3290
+ **Description:** Nag suppressions
3291
+
3292
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3293
+ | --------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- |
3294
+ | + [by_path](#nag_suppressions_by_path ) | No | array | No | - | - |
3295
+
3296
+ ### <a name="nag_suppressions_by_path"></a>4.1. Property `root > nag_suppressions > by_path`
3297
+
3298
+ | | |
3299
+ | ------------ | ------- |
3300
+ | **Type** | `array` |
3301
+ | **Required** | Yes |
3302
+
3303
+ | | Array restrictions |
3304
+ | -------------------- | ------------------ |
3305
+ | **Min items** | N/A |
3306
+ | **Max items** | N/A |
3307
+ | **Items unicity** | False |
3308
+ | **Additional items** | False |
3309
+ | **Tuple validation** | See below |
3310
+
3311
+ | Each item of this array must be | Description |
3312
+ | ----------------------------------------------------------- | ----------- |
3313
+ | [MdaaNagSuppressionByPath](#nag_suppressions_by_path_items) | - |
3314
+
3315
+ #### <a name="autogenerated_heading_10"></a>4.1.1. root > nag_suppressions > by_path > MdaaNagSuppressionByPath
3316
+
3317
+ | | |
3318
+ | ------------------------- | ------------------------------------------------------- |
3319
+ | **Type** | `object` |
3320
+ | **Required** | No |
3321
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3322
+ | **Defined in** | #/definitions/MdaaNagSuppressionByPath |
3323
+
3324
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3325
+ | --------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
3326
+ | + [path](#nag_suppressions_by_path_items_path ) | No | string | No | - | - |
3327
+ | + [suppressions](#nag_suppressions_by_path_items_suppressions ) | No | array of object | No | - | - |
3328
+
3329
+ ##### <a name="nag_suppressions_by_path_items_path"></a>4.1.1.1. Property `root > nag_suppressions > by_path > by_path items > path`
3330
+
3331
+ | | |
3332
+ | ------------ | -------- |
3333
+ | **Type** | `string` |
3334
+ | **Required** | Yes |
3335
+
3336
+ ##### <a name="nag_suppressions_by_path_items_suppressions"></a>4.1.1.2. Property `root > nag_suppressions > by_path > by_path items > suppressions`
3337
+
3338
+ | | |
3339
+ | ------------ | ----------------- |
3340
+ | **Type** | `array of object` |
3341
+ | **Required** | Yes |
3342
+
3343
+ | | Array restrictions |
3344
+ | -------------------- | ------------------ |
3345
+ | **Min items** | N/A |
3346
+ | **Max items** | N/A |
3347
+ | **Items unicity** | False |
3348
+ | **Additional items** | False |
3349
+ | **Tuple validation** | See below |
3350
+
3351
+ | Each item of this array must be | Description |
3352
+ | ------------------------------------------------------------------------ | ----------- |
3353
+ | [suppressions items](#nag_suppressions_by_path_items_suppressions_items) | - |
3354
+
3355
+ ###### <a name="autogenerated_heading_11"></a>4.1.1.2.1. root > nag_suppressions > by_path > by_path items > suppressions > suppressions items
3356
+
3357
+ | | |
3358
+ | ------------------------- | ------------------------------------------------------- |
3359
+ | **Type** | `object` |
3360
+ | **Required** | No |
3361
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3362
+
3363
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3364
+ | ---------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
3365
+ | + [id](#nag_suppressions_by_path_items_suppressions_items_id ) | No | string | No | - | - |
3366
+ | + [reason](#nag_suppressions_by_path_items_suppressions_items_reason ) | No | string | No | - | - |
3367
+
3368
+ ###### <a name="nag_suppressions_by_path_items_suppressions_items_id"></a>4.1.1.2.1.1. Property `root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > id`
3369
+
3370
+ | | |
3371
+ | ------------ | -------- |
3372
+ | **Type** | `string` |
3373
+ | **Required** | Yes |
3374
+
3375
+ ###### <a name="nag_suppressions_by_path_items_suppressions_items_reason"></a>4.1.1.2.1.2. Property `root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > reason`
3376
+
3377
+ | | |
3378
+ | ------------ | -------- |
3379
+ | **Type** | `string` |
3380
+ | **Required** | Yes |
3381
+
3382
+ ## <a name="projectBucket"></a>5. Property `root > projectBucket`
3383
+
3384
+ | | |
3385
+ | ------------ | -------- |
3386
+ | **Type** | `string` |
3387
+ | **Required** | Yes |
3388
+
3389
+ ## <a name="projectName"></a>6. Property `root > projectName`
3390
+
3391
+ | | |
3392
+ | ------------ | -------- |
3393
+ | **Type** | `string` |
3394
+ | **Required** | Yes |
3395
+
3396
+ ## <a name="projectTopicArn"></a>7. Property `root > projectTopicArn`
3397
+
3398
+ | | |
3399
+ | ------------ | -------- |
3400
+ | **Type** | `string` |
3401
+ | **Required** | Yes |
3402
+
3403
+ ## <a name="securityConfigurationName"></a>8. Property `root > securityConfigurationName`
3404
+
3405
+ | | |
3406
+ | ------------ | -------- |
3407
+ | **Type** | `string` |
3408
+ | **Required** | Yes |
3409
+
3410
+ ## <a name="service_catalog_product_config"></a>9. Property `root > service_catalog_product_config`
3411
+
3412
+ | | |
3413
+ | ------------------------- | ------------------------------------------------------- |
3414
+ | **Type** | `object` |
3415
+ | **Required** | No |
3416
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3417
+ | **Defined in** | #/definitions/MdaaServiceCatalogProductConfig |
3418
+
3419
+ **Description:** Service Catalog Config
3420
+ If specified, the configured module will be deployed as a Service Catalog product instead of directly to the environment
3421
+
3422
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3423
+ | ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
3424
+ | - [launch_role_name](#service_catalog_product_config_launch_role_name ) | No | string | No | - | - |
3425
+ | + [name](#service_catalog_product_config_name ) | No | string | No | - | - |
3426
+ | + [owner](#service_catalog_product_config_owner ) | No | string | No | - | - |
3427
+ | - [parameters](#service_catalog_product_config_parameters ) | No | object | No | - | - |
3428
+ | + [portfolio_arn](#service_catalog_product_config_portfolio_arn ) | No | string | No | - | - |
3429
+
3430
+ ### <a name="service_catalog_product_config_launch_role_name"></a>9.1. Property `root > service_catalog_product_config > launch_role_name`
3431
+
3432
+ | | |
3433
+ | ------------ | -------- |
3434
+ | **Type** | `string` |
3435
+ | **Required** | No |
3436
+
3437
+ ### <a name="service_catalog_product_config_name"></a>9.2. Property `root > service_catalog_product_config > name`
3438
+
3439
+ | | |
3440
+ | ------------ | -------- |
3441
+ | **Type** | `string` |
3442
+ | **Required** | Yes |
3443
+
3444
+ ### <a name="service_catalog_product_config_owner"></a>9.3. Property `root > service_catalog_product_config > owner`
3445
+
3446
+ | | |
3447
+ | ------------ | -------- |
3448
+ | **Type** | `string` |
3449
+ | **Required** | Yes |
3450
+
3451
+ ### <a name="service_catalog_product_config_parameters"></a>9.4. Property `root > service_catalog_product_config > parameters`
3452
+
3453
+ | | |
3454
+ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
3455
+ | **Type** | `object` |
3456
+ | **Required** | No |
3457
+ | **Additional properties** | [[Should-conform]](#service_catalog_product_config_parameters_additionalProperties "Each additional property must conform to the following schema") |
3458
+
3459
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3460
+ | ---------------------------------------------------------------------- | ------- | ------ | ---------- | -------------------------------------------------- | ----------------- |
3461
+ | - [](#service_catalog_product_config_parameters_additionalProperties ) | No | object | No | In #/definitions/MdaaServiceCatalogParameterConfig | - |
3462
+
3463
+ #### <a name="service_catalog_product_config_parameters_additionalProperties"></a>9.4.1. Property `root > service_catalog_product_config > parameters > MdaaServiceCatalogParameterConfig`
3464
+
3465
+ | | |
3466
+ | ------------------------- | ------------------------------------------------------- |
3467
+ | **Type** | `object` |
3468
+ | **Required** | No |
3469
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3470
+ | **Defined in** | #/definitions/MdaaServiceCatalogParameterConfig |
3471
+
3472
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3473
+ | --------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------------- | ----------------- |
3474
+ | - [constraints](#service_catalog_product_config_parameters_additionalProperties_constraints ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintConfig | - |
3475
+ | + [props](#service_catalog_product_config_parameters_additionalProperties_props ) | No | object | No | In #/definitions/CfnParameterProps | - |
3476
+
3477
+ ##### <a name="service_catalog_product_config_parameters_additionalProperties_constraints"></a>9.4.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints`
3478
+
3479
+ | | |
3480
+ | ------------------------- | ------------------------------------------------------- |
3481
+ | **Type** | `object` |
3482
+ | **Required** | No |
3483
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3484
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintConfig |
3485
+
3486
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3487
+ | --------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
3488
+ | + [description](#service_catalog_product_config_parameters_additionalProperties_constraints_description ) | No | string | No | - | - |
3489
+ | + [rules](#service_catalog_product_config_parameters_additionalProperties_constraints_rules ) | No | object | No | - | - |
3490
+
3491
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_description"></a>9.4.1.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > description`
3492
+
3493
+ | | |
3494
+ | ------------ | -------- |
3495
+ | **Type** | `string` |
3496
+ | **Required** | Yes |
3497
+
3498
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules"></a>9.4.1.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules`
3499
+
3500
+ | | |
3501
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3502
+ | **Type** | `object` |
3503
+ | **Required** | Yes |
3504
+ | **Additional properties** | [[Should-conform]](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties "Each additional property must conform to the following schema") |
3505
+
3506
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3507
+ | ------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------- | ----------------- |
3508
+ | - [](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleConfig | - |
3509
+
3510
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties"></a>9.4.1.1.2.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > MdaaServiceCatalogConstraintRuleConfig`
3511
+
3512
+ | | |
3513
+ | ------------------------- | ------------------------------------------------------- |
3514
+ | **Type** | `object` |
3515
+ | **Required** | No |
3516
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3517
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleConfig |
3518
+
3519
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3520
+ | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------ | ----------------- |
3521
+ | + [assertions](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions ) | No | array | No | - | - |
3522
+ | + [condition](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_condition ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig | - |
3523
+
3524
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions"></a>9.4.1.1.2.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions`
3525
+
3526
+ | | |
3527
+ | ------------ | ------- |
3528
+ | **Type** | `array` |
3529
+ | **Required** | Yes |
3530
+
3531
+ | | Array restrictions |
3532
+ | -------------------- | ------------------ |
3533
+ | **Min items** | N/A |
3534
+ | **Max items** | N/A |
3535
+ | **Items unicity** | False |
3536
+ | **Additional items** | False |
3537
+ | **Tuple validation** | See below |
3538
+
3539
+ | Each item of this array must be | Description |
3540
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
3541
+ | [MdaaServiceCatalogConstraintRuleAssertionConfig](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items) | - |
3542
+
3543
+ ###### <a name="autogenerated_heading_12"></a>9.4.1.1.2.1.1.1. root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > MdaaServiceCatalogConstraintRuleAssertionConfig
3544
+
3545
+ | | |
3546
+ | ------------------------- | ------------------------------------------------------------- |
3547
+ | **Type** | `object` |
3548
+ | **Required** | No |
3549
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3550
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleAssertionConfig |
3551
+
3552
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3553
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
3554
+ | + [assert](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_assert ) | No | string | No | - | - |
3555
+ | + [description](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_description ) | No | string | No | - | - |
3556
+
3557
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_assert"></a>9.4.1.1.2.1.1.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > assert`
3558
+
3559
+ | | |
3560
+ | ------------ | -------- |
3561
+ | **Type** | `string` |
3562
+ | **Required** | Yes |
3563
+
3564
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_description"></a>9.4.1.1.2.1.1.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > description`
3565
+
3566
+ | | |
3567
+ | ------------ | -------- |
3568
+ | **Type** | `string` |
3569
+ | **Required** | Yes |
3570
+
3571
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_condition"></a>9.4.1.1.2.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > condition`
3572
+
3573
+ | | |
3574
+ | ------------------------- | ------------------------------------------------------------------------- |
3575
+ | **Type** | `object` |
3576
+ | **Required** | Yes |
3577
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
3578
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig |
3579
+
3580
+ ##### <a name="service_catalog_product_config_parameters_additionalProperties_props"></a>9.4.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > props`
3581
+
3582
+ | | |
3583
+ | ------------------------- | ------------------------------------------------------- |
3584
+ | **Type** | `object` |
3585
+ | **Required** | Yes |
3586
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
3587
+ | **Defined in** | #/definitions/CfnParameterProps |
3588
+
3589
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
3590
+ | ----------------------------------------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3591
+ | - [allowedPattern](#service_catalog_product_config_parameters_additionalProperties_props_allowedPattern ) | No | string | No | - | A regular expression that represents the patterns to allow for String types. |
3592
+ | - [allowedValues](#service_catalog_product_config_parameters_additionalProperties_props_allowedValues ) | No | array of string | No | - | An array containing the list of values allowed for the parameter. |
3593
+ | - [constraintDescription](#service_catalog_product_config_parameters_additionalProperties_props_constraintDescription ) | No | string | No | - | A string that explains a constraint when the constraint is violated.<br />For example, without a constraint description, a parameter that has an allowed<br />pattern of [A-Za-z0-9]+ displays the following error message when the user specifies<br />an invalid value: |
3594
+ | - [default](#service_catalog_product_config_parameters_additionalProperties_props_default ) | No | object | No | - | A value of the appropriate type for the template to use if no value is specified<br />when a stack is created. If you define constraints for the parameter, you must specify<br />a value that adheres to those constraints. |
3595
+ | - [description](#service_catalog_product_config_parameters_additionalProperties_props_description ) | No | string | No | - | A string of up to 4000 characters that describes the parameter. |
3596
+ | - [maxLength](#service_catalog_product_config_parameters_additionalProperties_props_maxLength ) | No | number | No | - | An integer value that determines the largest number of characters you want to allow for String types. |
3597
+ | - [maxValue](#service_catalog_product_config_parameters_additionalProperties_props_maxValue ) | No | number | No | - | A numeric value that determines the largest numeric value you want to allow for Number types. |
3598
+ | - [minLength](#service_catalog_product_config_parameters_additionalProperties_props_minLength ) | No | number | No | - | An integer value that determines the smallest number of characters you want to allow for String types. |
3599
+ | - [minValue](#service_catalog_product_config_parameters_additionalProperties_props_minValue ) | No | number | No | - | A numeric value that determines the smallest numeric value you want to allow for Number types. |
3600
+ | - [noEcho](#service_catalog_product_config_parameters_additionalProperties_props_noEcho ) | No | boolean | No | - | Whether to mask the parameter value when anyone makes a call that describes the stack.<br />If you set the value to \`\`true\`\`, the parameter value is masked with asterisks (\`\`*****\`\`). |
3601
+ | - [type](#service_catalog_product_config_parameters_additionalProperties_props_type ) | No | string | No | - | The data type for the parameter (DataType). |
3602
+
3603
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_allowedPattern"></a>9.4.1.2.1. Property `root > service_catalog_product_config > parameters > additionalProperties > props > allowedPattern`
3604
+
3605
+ | | |
3606
+ | ------------ | ------------------------------------------------------- |
3607
+ | **Type** | `string` |
3608
+ | **Required** | No |
3609
+ | **Default** | `"- No constraints on patterns allowed for parameter."` |
3610
+
3611
+ **Description:** A regular expression that represents the patterns to allow for String types.
3612
+
3613
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_allowedValues"></a>9.4.1.2.2. Property `root > service_catalog_product_config > parameters > additionalProperties > props > allowedValues`
3614
+
3615
+ | | |
3616
+ | ------------ | ----------------------------------------------------- |
3617
+ | **Type** | `array of string` |
3618
+ | **Required** | No |
3619
+ | **Default** | `"- No constraints on values allowed for parameter."` |
3620
+
3621
+ **Description:** An array containing the list of values allowed for the parameter.
3622
+
3623
+ | | Array restrictions |
3624
+ | -------------------- | ------------------ |
3625
+ | **Min items** | N/A |
3626
+ | **Max items** | N/A |
3627
+ | **Items unicity** | False |
3628
+ | **Additional items** | False |
3629
+ | **Tuple validation** | See below |
3630
+
3631
+ | Each item of this array must be | Description |
3632
+ | ---------------------------------------------------------------------------------------------------------------- | ----------- |
3633
+ | [allowedValues items](#service_catalog_product_config_parameters_additionalProperties_props_allowedValues_items) | - |
3634
+
3635
+ ###### <a name="autogenerated_heading_13"></a>9.4.1.2.2.1. root > service_catalog_product_config > parameters > additionalProperties > props > allowedValues > allowedValues items
3636
+
3637
+ | | |
3638
+ | ------------ | -------- |
3639
+ | **Type** | `string` |
3640
+ | **Required** | No |
3641
+
3642
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_constraintDescription"></a>9.4.1.2.3. Property `root > service_catalog_product_config > parameters > additionalProperties > props > constraintDescription`
3643
+
3644
+ | | |
3645
+ | ------------ | -------------------------------------------------------------------------------------- |
3646
+ | **Type** | `string` |
3647
+ | **Required** | No |
3648
+ | **Default** | `"- No description with customized error message when user specifies invalid values."` |
3649
+
3650
+ **Description:** A string that explains a constraint when the constraint is violated.
3651
+ For example, without a constraint description, a parameter that has an allowed
3652
+ pattern of [A-Za-z0-9]+ displays the following error message when the user specifies
3653
+ an invalid value:
3654
+
3655
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_default"></a>9.4.1.2.4. Property `root > service_catalog_product_config > parameters > additionalProperties > props > default`
3656
+
3657
+ | | |
3658
+ | ------------------------- | ------------------------------------------------------------------------- |
3659
+ | **Type** | `object` |
3660
+ | **Required** | No |
3661
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
3662
+ | **Default** | `"- No default value for parameter."` |
3663
+
3664
+ **Description:** A value of the appropriate type for the template to use if no value is specified
3665
+ when a stack is created. If you define constraints for the parameter, you must specify
3666
+ a value that adheres to those constraints.
3667
+
3668
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_description"></a>9.4.1.2.5. Property `root > service_catalog_product_config > parameters > additionalProperties > props > description`
3669
+
3670
+ | | |
3671
+ | ------------ | --------------------------------------- |
3672
+ | **Type** | `string` |
3673
+ | **Required** | No |
3674
+ | **Default** | `"- No description for the parameter."` |
3675
+
3676
+ **Description:** A string of up to 4000 characters that describes the parameter.
3677
+
3678
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_maxLength"></a>9.4.1.2.6. Property `root > service_catalog_product_config > parameters > additionalProperties > props > maxLength`
3679
+
3680
+ | | |
3681
+ | ------------ | ----------- |
3682
+ | **Type** | `number` |
3683
+ | **Required** | No |
3684
+ | **Default** | `"- None."` |
3685
+
3686
+ **Description:** An integer value that determines the largest number of characters you want to allow for String types.
3687
+
3688
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_maxValue"></a>9.4.1.2.7. Property `root > service_catalog_product_config > parameters > additionalProperties > props > maxValue`
3689
+
3690
+ | | |
3691
+ | ------------ | ----------- |
3692
+ | **Type** | `number` |
3693
+ | **Required** | No |
3694
+ | **Default** | `"- None."` |
3695
+
3696
+ **Description:** A numeric value that determines the largest numeric value you want to allow for Number types.
3697
+
3698
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_minLength"></a>9.4.1.2.8. Property `root > service_catalog_product_config > parameters > additionalProperties > props > minLength`
3699
+
3700
+ | | |
3701
+ | ------------ | ----------- |
3702
+ | **Type** | `number` |
3703
+ | **Required** | No |
3704
+ | **Default** | `"- None."` |
3705
+
3706
+ **Description:** An integer value that determines the smallest number of characters you want to allow for String types.
3707
+
3708
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_minValue"></a>9.4.1.2.9. Property `root > service_catalog_product_config > parameters > additionalProperties > props > minValue`
3709
+
3710
+ | | |
3711
+ | ------------ | ----------- |
3712
+ | **Type** | `number` |
3713
+ | **Required** | No |
3714
+ | **Default** | `"- None."` |
3715
+
3716
+ **Description:** A numeric value that determines the smallest numeric value you want to allow for Number types.
3717
+
3718
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_noEcho"></a>9.4.1.2.10. Property `root > service_catalog_product_config > parameters > additionalProperties > props > noEcho`
3719
+
3720
+ | | |
3721
+ | ------------ | -------------------------------------- |
3722
+ | **Type** | `boolean` |
3723
+ | **Required** | No |
3724
+ | **Default** | `"- Parameter values are not masked."` |
3725
+
3726
+ **Description:** Whether to mask the parameter value when anyone makes a call that describes the stack.
3727
+ If you set the value to ``true``, the parameter value is masked with asterisks (``*****``).
3728
+
3729
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_type"></a>9.4.1.2.11. Property `root > service_catalog_product_config > parameters > additionalProperties > props > type`
3730
+
3731
+ | | |
3732
+ | ------------ | ---------- |
3733
+ | **Type** | `string` |
3734
+ | **Required** | No |
3735
+ | **Default** | `"String"` |
3736
+
3737
+ **Description:** The data type for the parameter (DataType).
3738
+
3739
+ ### <a name="service_catalog_product_config_portfolio_arn"></a>9.5. Property `root > service_catalog_product_config > portfolio_arn`
3740
+
3741
+ | | |
3742
+ | ------------ | -------- |
3743
+ | **Type** | `string` |
3744
+ | **Required** | Yes |
3745
+
3746
+ ----------------------------------------------------------------------------------------------------------------------------
3747
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-08-16 at 13:40:38 -0400