aws-sdk 2.945.0 → 2.949.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -1
- package/README.md +1 -1
- package/apis/chime-2018-05-01.min.json +259 -258
- package/apis/dms-2016-01-01.min.json +127 -97
- package/apis/ec2-2016-11-15.min.json +1236 -930
- package/apis/ec2-2016-11-15.paginators.json +6 -0
- package/apis/emr-containers-2020-10-01.min.json +25 -23
- package/apis/glue-2017-03-31.min.json +254 -220
- package/apis/health-2016-08-04.min.json +29 -29
- package/apis/healthlake-2017-07-01.min.json +258 -60
- package/apis/healthlake-2017-07-01.paginators.json +10 -0
- package/apis/iotsitewise-2019-12-02.min.json +46 -25
- package/apis/lightsail-2016-11-28.min.json +557 -192
- package/apis/location-2020-11-19.min.json +205 -0
- package/apis/robomaker-2018-06-29.min.json +6 -3
- package/apis/wellarchitected-2020-03-31.min.json +60 -19
- package/clients/acm.d.ts +16 -16
- package/clients/appintegrations.d.ts +22 -22
- package/clients/auditmanager.d.ts +138 -138
- package/clients/chime.d.ts +5 -0
- package/clients/cognitoidentityserviceprovider.d.ts +72 -72
- package/clients/directconnect.d.ts +11 -8
- package/clients/dms.d.ts +253 -204
- package/clients/ec2.d.ts +332 -6
- package/clients/ecs.d.ts +83 -83
- package/clients/emrcontainers.d.ts +12 -2
- package/clients/glue.d.ts +38 -3
- package/clients/health.d.ts +3 -2
- package/clients/healthlake.d.ts +220 -5
- package/clients/imagebuilder.d.ts +27 -27
- package/clients/lexmodelbuildingservice.d.ts +1 -1
- package/clients/lightsail.d.ts +610 -150
- package/clients/location.d.ts +227 -35
- package/clients/robomaker.d.ts +12 -0
- package/clients/wellarchitected.d.ts +76 -5
- package/dist/aws-sdk-core-react-native.js +6 -1
- package/dist/aws-sdk-react-native.js +20 -15
- package/dist/aws-sdk.js +1455 -933
- package/dist/aws-sdk.min.js +65 -65
- package/lib/core.d.ts +1 -0
- package/lib/core.js +1 -1
- package/lib/json/builder.js +3 -0
- package/lib/json/parser.js +1 -0
- package/lib/model/index.d.ts +4 -0
- package/lib/model/shape.js +1 -0
- package/package.json +1 -1
- package/scripts/lib/ts-generator.js +16 -0
package/clients/dms.d.ts
CHANGED
|
@@ -13,11 +13,11 @@ declare class DMS extends Service {
|
|
|
13
13
|
constructor(options?: DMS.Types.ClientConfiguration)
|
|
14
14
|
config: Config & DMS.Types.ClientConfiguration;
|
|
15
15
|
/**
|
|
16
|
-
* Adds metadata tags to an
|
|
16
|
+
* Adds metadata tags to an DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.
|
|
17
17
|
*/
|
|
18
18
|
addTagsToResource(params: DMS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
|
|
19
19
|
/**
|
|
20
|
-
* Adds metadata tags to an
|
|
20
|
+
* Adds metadata tags to an DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.
|
|
21
21
|
*/
|
|
22
22
|
addTagsToResource(callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
|
|
23
23
|
/**
|
|
@@ -37,27 +37,27 @@ declare class DMS extends Service {
|
|
|
37
37
|
*/
|
|
38
38
|
cancelReplicationTaskAssessmentRun(callback?: (err: AWSError, data: DMS.Types.CancelReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.CancelReplicationTaskAssessmentRunResponse, AWSError>;
|
|
39
39
|
/**
|
|
40
|
-
* Creates an endpoint using the provided settings.
|
|
40
|
+
* Creates an endpoint using the provided settings. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
|
|
41
41
|
*/
|
|
42
42
|
createEndpoint(params: DMS.Types.CreateEndpointMessage, callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
|
|
43
43
|
/**
|
|
44
|
-
* Creates an endpoint using the provided settings.
|
|
44
|
+
* Creates an endpoint using the provided settings. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
|
|
45
45
|
*/
|
|
46
46
|
createEndpoint(callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
|
|
47
47
|
/**
|
|
48
|
-
* Creates an
|
|
48
|
+
* Creates an DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account. For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
|
|
49
49
|
*/
|
|
50
50
|
createEventSubscription(params: DMS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request<DMS.Types.CreateEventSubscriptionResponse, AWSError>;
|
|
51
51
|
/**
|
|
52
|
-
* Creates an
|
|
52
|
+
* Creates an DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account. For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
|
|
53
53
|
*/
|
|
54
54
|
createEventSubscription(callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request<DMS.Types.CreateEventSubscriptionResponse, AWSError>;
|
|
55
55
|
/**
|
|
56
|
-
* Creates the replication instance using the specified parameters.
|
|
56
|
+
* Creates the replication instance using the specified parameters. DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
|
|
57
57
|
*/
|
|
58
58
|
createReplicationInstance(params: DMS.Types.CreateReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
|
|
59
59
|
/**
|
|
60
|
-
* Creates the replication instance using the specified parameters.
|
|
60
|
+
* Creates the replication instance using the specified parameters. DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
|
|
61
61
|
*/
|
|
62
62
|
createReplicationInstance(callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
|
|
63
63
|
/**
|
|
@@ -101,11 +101,11 @@ declare class DMS extends Service {
|
|
|
101
101
|
*/
|
|
102
102
|
deleteEndpoint(callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
|
|
103
103
|
/**
|
|
104
|
-
* Deletes an
|
|
104
|
+
* Deletes an DMS event subscription.
|
|
105
105
|
*/
|
|
106
106
|
deleteEventSubscription(params: DMS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request<DMS.Types.DeleteEventSubscriptionResponse, AWSError>;
|
|
107
107
|
/**
|
|
108
|
-
* Deletes an
|
|
108
|
+
* Deletes an DMS event subscription.
|
|
109
109
|
*/
|
|
110
110
|
deleteEventSubscription(callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request<DMS.Types.DeleteEventSubscriptionResponse, AWSError>;
|
|
111
111
|
/**
|
|
@@ -133,19 +133,19 @@ declare class DMS extends Service {
|
|
|
133
133
|
*/
|
|
134
134
|
deleteReplicationTask(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
|
|
135
135
|
/**
|
|
136
|
-
* Deletes the record of a single premigration assessment run. This operation removes all metadata that
|
|
136
|
+
* Deletes the record of a single premigration assessment run. This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
|
|
137
137
|
*/
|
|
138
138
|
deleteReplicationTaskAssessmentRun(params: DMS.Types.DeleteReplicationTaskAssessmentRunMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.DeleteReplicationTaskAssessmentRunResponse, AWSError>;
|
|
139
139
|
/**
|
|
140
|
-
* Deletes the record of a single premigration assessment run. This operation removes all metadata that
|
|
140
|
+
* Deletes the record of a single premigration assessment run. This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
|
|
141
141
|
*/
|
|
142
142
|
deleteReplicationTaskAssessmentRun(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.DeleteReplicationTaskAssessmentRunResponse, AWSError>;
|
|
143
143
|
/**
|
|
144
|
-
* Lists all of the
|
|
144
|
+
* Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region. This command does not take any parameters.
|
|
145
145
|
*/
|
|
146
146
|
describeAccountAttributes(params: DMS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
|
|
147
147
|
/**
|
|
148
|
-
* Lists all of the
|
|
148
|
+
* Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region. This command does not take any parameters.
|
|
149
149
|
*/
|
|
150
150
|
describeAccountAttributes(callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
|
|
151
151
|
/**
|
|
@@ -197,11 +197,11 @@ declare class DMS extends Service {
|
|
|
197
197
|
*/
|
|
198
198
|
describeEndpoints(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
|
|
199
199
|
/**
|
|
200
|
-
* Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the
|
|
200
|
+
* Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide.
|
|
201
201
|
*/
|
|
202
202
|
describeEventCategories(params: DMS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request<DMS.Types.DescribeEventCategoriesResponse, AWSError>;
|
|
203
203
|
/**
|
|
204
|
-
* Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the
|
|
204
|
+
* Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide.
|
|
205
205
|
*/
|
|
206
206
|
describeEventCategories(callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request<DMS.Types.DescribeEventCategoriesResponse, AWSError>;
|
|
207
207
|
/**
|
|
@@ -213,11 +213,11 @@ declare class DMS extends Service {
|
|
|
213
213
|
*/
|
|
214
214
|
describeEventSubscriptions(callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request<DMS.Types.DescribeEventSubscriptionsResponse, AWSError>;
|
|
215
215
|
/**
|
|
216
|
-
* Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on
|
|
216
|
+
* Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
|
|
217
217
|
*/
|
|
218
218
|
describeEvents(params: DMS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request<DMS.Types.DescribeEventsResponse, AWSError>;
|
|
219
219
|
/**
|
|
220
|
-
* Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on
|
|
220
|
+
* Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
|
|
221
221
|
*/
|
|
222
222
|
describeEvents(callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request<DMS.Types.DescribeEventsResponse, AWSError>;
|
|
223
223
|
/**
|
|
@@ -269,11 +269,11 @@ declare class DMS extends Service {
|
|
|
269
269
|
*/
|
|
270
270
|
describeReplicationSubnetGroups(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
|
|
271
271
|
/**
|
|
272
|
-
* Returns the task assessment results from Amazon S3. This action always returns the latest results.
|
|
272
|
+
* Returns the task assessment results from the Amazon S3 bucket that DMS creates in your account. This action always returns the latest results. For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
|
|
273
273
|
*/
|
|
274
274
|
describeReplicationTaskAssessmentResults(params: DMS.Types.DescribeReplicationTaskAssessmentResultsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentResultsResponse, AWSError>;
|
|
275
275
|
/**
|
|
276
|
-
* Returns the task assessment results from Amazon S3. This action always returns the latest results.
|
|
276
|
+
* Returns the task assessment results from the Amazon S3 bucket that DMS creates in your account. This action always returns the latest results. For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
|
|
277
277
|
*/
|
|
278
278
|
describeReplicationTaskAssessmentResults(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentResultsResponse, AWSError>;
|
|
279
279
|
/**
|
|
@@ -309,11 +309,11 @@ declare class DMS extends Service {
|
|
|
309
309
|
*/
|
|
310
310
|
describeSchemas(callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
|
|
311
311
|
/**
|
|
312
|
-
* Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that
|
|
312
|
+
* Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
|
|
313
313
|
*/
|
|
314
314
|
describeTableStatistics(params: DMS.Types.DescribeTableStatisticsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
|
|
315
315
|
/**
|
|
316
|
-
* Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that
|
|
316
|
+
* Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
|
|
317
317
|
*/
|
|
318
318
|
describeTableStatistics(callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
|
|
319
319
|
/**
|
|
@@ -325,27 +325,27 @@ declare class DMS extends Service {
|
|
|
325
325
|
*/
|
|
326
326
|
importCertificate(callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
|
|
327
327
|
/**
|
|
328
|
-
* Lists all metadata tags attached to an
|
|
328
|
+
* Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
|
|
329
329
|
*/
|
|
330
330
|
listTagsForResource(params: DMS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
|
|
331
331
|
/**
|
|
332
|
-
* Lists all metadata tags attached to an
|
|
332
|
+
* Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
|
|
333
333
|
*/
|
|
334
334
|
listTagsForResource(callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
|
|
335
335
|
/**
|
|
336
|
-
* Modifies the specified endpoint.
|
|
336
|
+
* Modifies the specified endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
|
|
337
337
|
*/
|
|
338
338
|
modifyEndpoint(params: DMS.Types.ModifyEndpointMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
|
|
339
339
|
/**
|
|
340
|
-
* Modifies the specified endpoint.
|
|
340
|
+
* Modifies the specified endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
|
|
341
341
|
*/
|
|
342
342
|
modifyEndpoint(callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
|
|
343
343
|
/**
|
|
344
|
-
* Modifies an existing
|
|
344
|
+
* Modifies an existing DMS event notification subscription.
|
|
345
345
|
*/
|
|
346
346
|
modifyEventSubscription(params: DMS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request<DMS.Types.ModifyEventSubscriptionResponse, AWSError>;
|
|
347
347
|
/**
|
|
348
|
-
* Modifies an existing
|
|
348
|
+
* Modifies an existing DMS event notification subscription.
|
|
349
349
|
*/
|
|
350
350
|
modifyEventSubscription(callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request<DMS.Types.ModifyEventSubscriptionResponse, AWSError>;
|
|
351
351
|
/**
|
|
@@ -365,19 +365,19 @@ declare class DMS extends Service {
|
|
|
365
365
|
*/
|
|
366
366
|
modifyReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
|
|
367
367
|
/**
|
|
368
|
-
* Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about
|
|
368
|
+
* Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
|
|
369
369
|
*/
|
|
370
370
|
modifyReplicationTask(params: DMS.Types.ModifyReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request<DMS.Types.ModifyReplicationTaskResponse, AWSError>;
|
|
371
371
|
/**
|
|
372
|
-
* Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about
|
|
372
|
+
* Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
|
|
373
373
|
*/
|
|
374
374
|
modifyReplicationTask(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request<DMS.Types.ModifyReplicationTaskResponse, AWSError>;
|
|
375
375
|
/**
|
|
376
|
-
* Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later
|
|
376
|
+
* Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.
|
|
377
377
|
*/
|
|
378
378
|
moveReplicationTask(params: DMS.Types.MoveReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.MoveReplicationTaskResponse) => void): Request<DMS.Types.MoveReplicationTaskResponse, AWSError>;
|
|
379
379
|
/**
|
|
380
|
-
* Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later
|
|
380
|
+
* Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.
|
|
381
381
|
*/
|
|
382
382
|
moveReplicationTask(callback?: (err: AWSError, data: DMS.Types.MoveReplicationTaskResponse) => void): Request<DMS.Types.MoveReplicationTaskResponse, AWSError>;
|
|
383
383
|
/**
|
|
@@ -405,19 +405,19 @@ declare class DMS extends Service {
|
|
|
405
405
|
*/
|
|
406
406
|
reloadTables(callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request<DMS.Types.ReloadTablesResponse, AWSError>;
|
|
407
407
|
/**
|
|
408
|
-
* Removes metadata tags from an
|
|
408
|
+
* Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
|
|
409
409
|
*/
|
|
410
410
|
removeTagsFromResource(params: DMS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
|
|
411
411
|
/**
|
|
412
|
-
* Removes metadata tags from an
|
|
412
|
+
* Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
|
|
413
413
|
*/
|
|
414
414
|
removeTagsFromResource(callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
|
|
415
415
|
/**
|
|
416
|
-
* Starts the replication task. For more information about
|
|
416
|
+
* Starts the replication task. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
|
|
417
417
|
*/
|
|
418
418
|
startReplicationTask(params: DMS.Types.StartReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
|
|
419
419
|
/**
|
|
420
|
-
* Starts the replication task. For more information about
|
|
420
|
+
* Starts the replication task. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
|
|
421
421
|
*/
|
|
422
422
|
startReplicationTask(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
|
|
423
423
|
/**
|
|
@@ -520,7 +520,7 @@ declare class DMS extends Service {
|
|
|
520
520
|
declare namespace DMS {
|
|
521
521
|
export interface AccountQuota {
|
|
522
522
|
/**
|
|
523
|
-
* The name of the
|
|
523
|
+
* The name of the DMS quota for this account.
|
|
524
524
|
*/
|
|
525
525
|
AccountQuotaName?: String;
|
|
526
526
|
/**
|
|
@@ -535,7 +535,7 @@ declare namespace DMS {
|
|
|
535
535
|
export type AccountQuotaList = AccountQuota[];
|
|
536
536
|
export interface AddTagsToResourceMessage {
|
|
537
537
|
/**
|
|
538
|
-
* Identifies the
|
|
538
|
+
* Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DMS, you can tag a replication instance, an endpoint, or a replication task.
|
|
539
539
|
*/
|
|
540
540
|
ResourceArn: String;
|
|
541
541
|
/**
|
|
@@ -547,7 +547,7 @@ declare namespace DMS {
|
|
|
547
547
|
}
|
|
548
548
|
export interface ApplyPendingMaintenanceActionMessage {
|
|
549
549
|
/**
|
|
550
|
-
* The Amazon Resource Name (ARN) of the
|
|
550
|
+
* The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to.
|
|
551
551
|
*/
|
|
552
552
|
ReplicationInstanceArn: String;
|
|
553
553
|
/**
|
|
@@ -561,7 +561,7 @@ declare namespace DMS {
|
|
|
561
561
|
}
|
|
562
562
|
export interface ApplyPendingMaintenanceActionResponse {
|
|
563
563
|
/**
|
|
564
|
-
* The
|
|
564
|
+
* The DMS resource that the pending maintenance action will be applied to.
|
|
565
565
|
*/
|
|
566
566
|
ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
|
|
567
567
|
}
|
|
@@ -691,15 +691,15 @@ declare namespace DMS {
|
|
|
691
691
|
*/
|
|
692
692
|
Port?: IntegerOptional;
|
|
693
693
|
/**
|
|
694
|
-
* The name of the endpoint database.
|
|
694
|
+
* The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
|
|
695
695
|
*/
|
|
696
696
|
DatabaseName?: String;
|
|
697
697
|
/**
|
|
698
|
-
* Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with
|
|
698
|
+
* Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.
|
|
699
699
|
*/
|
|
700
700
|
ExtraConnectionAttributes?: String;
|
|
701
701
|
/**
|
|
702
|
-
* An
|
|
702
|
+
* An KMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
|
|
703
703
|
*/
|
|
704
704
|
KmsKeyId?: String;
|
|
705
705
|
/**
|
|
@@ -715,7 +715,7 @@ declare namespace DMS {
|
|
|
715
715
|
*/
|
|
716
716
|
SslMode?: DmsSslModeValue;
|
|
717
717
|
/**
|
|
718
|
-
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
|
|
718
|
+
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.
|
|
719
719
|
*/
|
|
720
720
|
ServiceAccessRoleArn?: String;
|
|
721
721
|
/**
|
|
@@ -723,64 +723,64 @@ declare namespace DMS {
|
|
|
723
723
|
*/
|
|
724
724
|
ExternalTableDefinition?: String;
|
|
725
725
|
/**
|
|
726
|
-
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the
|
|
726
|
+
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
|
|
727
727
|
*/
|
|
728
728
|
DynamoDbSettings?: DynamoDbSettings;
|
|
729
729
|
/**
|
|
730
|
-
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for
|
|
730
|
+
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
|
|
731
731
|
*/
|
|
732
732
|
S3Settings?: S3Settings;
|
|
733
733
|
/**
|
|
734
|
-
* The settings in JSON format for the DMS transfer type of source endpoint. Possible settings include the following: ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
|
|
734
|
+
* The settings in JSON format for the DMS transfer type of source endpoint. Possible settings include the following: ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. The role must allow the iam:PassRole action. BucketName - The name of the S3 bucket to use. Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }
|
|
735
735
|
*/
|
|
736
736
|
DmsTransferSettings?: DmsTransferSettings;
|
|
737
737
|
/**
|
|
738
|
-
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
|
|
738
|
+
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
|
|
739
739
|
*/
|
|
740
740
|
MongoDbSettings?: MongoDbSettings;
|
|
741
741
|
/**
|
|
742
|
-
* Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using
|
|
742
|
+
* Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
|
|
743
743
|
*/
|
|
744
744
|
KinesisSettings?: KinesisSettings;
|
|
745
745
|
/**
|
|
746
|
-
* Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using
|
|
746
|
+
* Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
|
|
747
747
|
*/
|
|
748
748
|
KafkaSettings?: KafkaSettings;
|
|
749
749
|
/**
|
|
750
|
-
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for
|
|
750
|
+
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in the Database Migration Service User Guide.
|
|
751
751
|
*/
|
|
752
752
|
ElasticsearchSettings?: ElasticsearchSettings;
|
|
753
753
|
/**
|
|
754
|
-
* Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying
|
|
754
|
+
* Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
|
|
755
755
|
*/
|
|
756
756
|
NeptuneSettings?: NeptuneSettings;
|
|
757
757
|
RedshiftSettings?: RedshiftSettings;
|
|
758
758
|
/**
|
|
759
|
-
* Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for
|
|
759
|
+
* Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
|
|
760
760
|
*/
|
|
761
761
|
PostgreSQLSettings?: PostgreSQLSettings;
|
|
762
762
|
/**
|
|
763
|
-
* Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for
|
|
763
|
+
* Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
|
|
764
764
|
*/
|
|
765
765
|
MySQLSettings?: MySQLSettings;
|
|
766
766
|
/**
|
|
767
|
-
* Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for
|
|
767
|
+
* Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
|
|
768
768
|
*/
|
|
769
769
|
OracleSettings?: OracleSettings;
|
|
770
770
|
/**
|
|
771
|
-
* Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for
|
|
771
|
+
* Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
|
|
772
772
|
*/
|
|
773
773
|
SybaseSettings?: SybaseSettings;
|
|
774
774
|
/**
|
|
775
|
-
* Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for
|
|
775
|
+
* Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
|
|
776
776
|
*/
|
|
777
777
|
MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings;
|
|
778
778
|
/**
|
|
779
|
-
* Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for
|
|
779
|
+
* Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
|
|
780
780
|
*/
|
|
781
781
|
IBMDb2Settings?: IBMDb2Settings;
|
|
782
782
|
/**
|
|
783
|
-
* A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value,
|
|
783
|
+
* A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
|
|
784
784
|
*/
|
|
785
785
|
ResourceIdentifier?: String;
|
|
786
786
|
DocDbSettings?: DocDbSettings;
|
|
@@ -793,7 +793,7 @@ declare namespace DMS {
|
|
|
793
793
|
}
|
|
794
794
|
export interface CreateEventSubscriptionMessage {
|
|
795
795
|
/**
|
|
796
|
-
* The name of the
|
|
796
|
+
* The name of the DMS event notification subscription. This name must be less than 255 characters.
|
|
797
797
|
*/
|
|
798
798
|
SubscriptionName: String;
|
|
799
799
|
/**
|
|
@@ -801,15 +801,15 @@ declare namespace DMS {
|
|
|
801
801
|
*/
|
|
802
802
|
SnsTopicArn: String;
|
|
803
803
|
/**
|
|
804
|
-
* The type of
|
|
804
|
+
* The type of DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value isn't specified, all events are returned. Valid values: replication-instance | replication-task
|
|
805
805
|
*/
|
|
806
806
|
SourceType?: String;
|
|
807
807
|
/**
|
|
808
|
-
* A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the
|
|
808
|
+
* A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.
|
|
809
809
|
*/
|
|
810
810
|
EventCategories?: EventCategoriesList;
|
|
811
811
|
/**
|
|
812
|
-
* A list of identifiers for which
|
|
812
|
+
* A list of identifiers for which DMS provides notification events. If you don't specify a value, notifications are provided for all sources. If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
|
|
813
813
|
*/
|
|
814
814
|
SourceIds?: SourceIdsList;
|
|
815
815
|
/**
|
|
@@ -837,7 +837,7 @@ declare namespace DMS {
|
|
|
837
837
|
*/
|
|
838
838
|
AllocatedStorage?: IntegerOptional;
|
|
839
839
|
/**
|
|
840
|
-
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right
|
|
840
|
+
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
|
|
841
841
|
*/
|
|
842
842
|
ReplicationInstanceClass: String;
|
|
843
843
|
/**
|
|
@@ -845,7 +845,7 @@ declare namespace DMS {
|
|
|
845
845
|
*/
|
|
846
846
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
847
847
|
/**
|
|
848
|
-
* The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's
|
|
848
|
+
* The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Region, for example: us-east-1d
|
|
849
849
|
*/
|
|
850
850
|
AvailabilityZone?: String;
|
|
851
851
|
/**
|
|
@@ -853,7 +853,7 @@ declare namespace DMS {
|
|
|
853
853
|
*/
|
|
854
854
|
ReplicationSubnetGroupIdentifier?: String;
|
|
855
855
|
/**
|
|
856
|
-
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per
|
|
856
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
|
|
857
857
|
*/
|
|
858
858
|
PreferredMaintenanceWindow?: String;
|
|
859
859
|
/**
|
|
@@ -873,7 +873,7 @@ declare namespace DMS {
|
|
|
873
873
|
*/
|
|
874
874
|
Tags?: TagList;
|
|
875
875
|
/**
|
|
876
|
-
* An
|
|
876
|
+
* An KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
|
|
877
877
|
*/
|
|
878
878
|
KmsKeyId?: String;
|
|
879
879
|
/**
|
|
@@ -885,7 +885,7 @@ declare namespace DMS {
|
|
|
885
885
|
*/
|
|
886
886
|
DnsNameServers?: String;
|
|
887
887
|
/**
|
|
888
|
-
* A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value,
|
|
888
|
+
* A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
|
|
889
889
|
*/
|
|
890
890
|
ResourceIdentifier?: String;
|
|
891
891
|
}
|
|
@@ -941,11 +941,11 @@ declare namespace DMS {
|
|
|
941
941
|
*/
|
|
942
942
|
MigrationType: MigrationTypeValue;
|
|
943
943
|
/**
|
|
944
|
-
* The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the
|
|
944
|
+
* The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.
|
|
945
945
|
*/
|
|
946
946
|
TableMappings: String;
|
|
947
947
|
/**
|
|
948
|
-
* Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for
|
|
948
|
+
* Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.
|
|
949
949
|
*/
|
|
950
950
|
ReplicationTaskSettings?: String;
|
|
951
951
|
/**
|
|
@@ -953,7 +953,7 @@ declare namespace DMS {
|
|
|
953
953
|
*/
|
|
954
954
|
CdcStartTime?: TStamp;
|
|
955
955
|
/**
|
|
956
|
-
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” 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
|
|
956
|
+
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” 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 DMS.
|
|
957
957
|
*/
|
|
958
958
|
CdcStartPosition?: String;
|
|
959
959
|
/**
|
|
@@ -965,11 +965,11 @@ declare namespace DMS {
|
|
|
965
965
|
*/
|
|
966
966
|
Tags?: TagList;
|
|
967
967
|
/**
|
|
968
|
-
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the
|
|
968
|
+
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
|
|
969
969
|
*/
|
|
970
970
|
TaskData?: String;
|
|
971
971
|
/**
|
|
972
|
-
* A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value,
|
|
972
|
+
* A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
|
|
973
973
|
*/
|
|
974
974
|
ResourceIdentifier?: String;
|
|
975
975
|
}
|
|
@@ -1086,7 +1086,7 @@ declare namespace DMS {
|
|
|
1086
1086
|
*/
|
|
1087
1087
|
AccountQuotas?: AccountQuotaList;
|
|
1088
1088
|
/**
|
|
1089
|
-
* A unique
|
|
1089
|
+
* A unique DMS identifier for an account in a particular Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given Region. The format of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3 bucket: dms-111122223333-c44445555666. DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
|
|
1090
1090
|
*/
|
|
1091
1091
|
UniqueAccountIdentifier?: String;
|
|
1092
1092
|
}
|
|
@@ -1122,7 +1122,7 @@ declare namespace DMS {
|
|
|
1122
1122
|
}
|
|
1123
1123
|
export interface DescribeApplicableIndividualAssessmentsResponse {
|
|
1124
1124
|
/**
|
|
1125
|
-
* List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the
|
|
1125
|
+
* List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.
|
|
1126
1126
|
*/
|
|
1127
1127
|
IndividualAssessmentNames?: IndividualAssessmentNameList;
|
|
1128
1128
|
/**
|
|
@@ -1252,7 +1252,7 @@ declare namespace DMS {
|
|
|
1252
1252
|
}
|
|
1253
1253
|
export interface DescribeEventCategoriesMessage {
|
|
1254
1254
|
/**
|
|
1255
|
-
* The type of
|
|
1255
|
+
* The type of DMS resource that generates events. Valid values: replication-instance | replication-task
|
|
1256
1256
|
*/
|
|
1257
1257
|
SourceType?: String;
|
|
1258
1258
|
/**
|
|
@@ -1268,7 +1268,7 @@ declare namespace DMS {
|
|
|
1268
1268
|
}
|
|
1269
1269
|
export interface DescribeEventSubscriptionsMessage {
|
|
1270
1270
|
/**
|
|
1271
|
-
* The name of the
|
|
1271
|
+
* The name of the DMS event subscription to be described.
|
|
1272
1272
|
*/
|
|
1273
1273
|
SubscriptionName?: String;
|
|
1274
1274
|
/**
|
|
@@ -1300,7 +1300,7 @@ declare namespace DMS {
|
|
|
1300
1300
|
*/
|
|
1301
1301
|
SourceIdentifier?: String;
|
|
1302
1302
|
/**
|
|
1303
|
-
* The type of
|
|
1303
|
+
* The type of DMS resource that generates events. Valid values: replication-instance | replication-task
|
|
1304
1304
|
*/
|
|
1305
1305
|
SourceType?: SourceType;
|
|
1306
1306
|
/**
|
|
@@ -1641,7 +1641,7 @@ declare namespace DMS {
|
|
|
1641
1641
|
export type DmsSslModeValue = "none"|"require"|"verify-ca"|"verify-full"|string;
|
|
1642
1642
|
export interface DmsTransferSettings {
|
|
1643
1643
|
/**
|
|
1644
|
-
* The IAM role that has permission to access the Amazon S3 bucket.
|
|
1644
|
+
* The IAM role that has permission to access the Amazon S3 bucket. When specified as part of request syntax, such as for the CreateEndpoint and ModifyEndpoint actions, the role must allow the iam:PassRole action.
|
|
1645
1645
|
*/
|
|
1646
1646
|
ServiceAccessRoleArn?: String;
|
|
1647
1647
|
/**
|
|
@@ -1683,11 +1683,11 @@ declare namespace DMS {
|
|
|
1683
1683
|
*/
|
|
1684
1684
|
DocsToInvestigate?: IntegerOptional;
|
|
1685
1685
|
/**
|
|
1686
|
-
* The
|
|
1686
|
+
* The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
|
|
1687
1687
|
*/
|
|
1688
1688
|
KmsKeyId?: String;
|
|
1689
1689
|
/**
|
|
1690
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
1690
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
1691
1691
|
*/
|
|
1692
1692
|
SecretsManagerAccessRoleArn?: String;
|
|
1693
1693
|
/**
|
|
@@ -1697,17 +1697,17 @@ declare namespace DMS {
|
|
|
1697
1697
|
}
|
|
1698
1698
|
export interface DynamoDbSettings {
|
|
1699
1699
|
/**
|
|
1700
|
-
* The Amazon Resource Name (ARN) used by the service access IAM role.
|
|
1700
|
+
* The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
|
|
1701
1701
|
*/
|
|
1702
1702
|
ServiceAccessRoleArn: String;
|
|
1703
1703
|
}
|
|
1704
1704
|
export interface ElasticsearchSettings {
|
|
1705
1705
|
/**
|
|
1706
|
-
* The Amazon Resource Name (ARN) used by service to access the IAM role.
|
|
1706
|
+
* The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
|
|
1707
1707
|
*/
|
|
1708
1708
|
ServiceAccessRoleArn: String;
|
|
1709
1709
|
/**
|
|
1710
|
-
* The endpoint for the Elasticsearch cluster.
|
|
1710
|
+
* The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
|
|
1711
1711
|
*/
|
|
1712
1712
|
EndpointUri: String;
|
|
1713
1713
|
/**
|
|
@@ -1763,7 +1763,7 @@ declare namespace DMS {
|
|
|
1763
1763
|
*/
|
|
1764
1764
|
Status?: String;
|
|
1765
1765
|
/**
|
|
1766
|
-
* An
|
|
1766
|
+
* An KMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
|
|
1767
1767
|
*/
|
|
1768
1768
|
KmsKeyId?: String;
|
|
1769
1769
|
/**
|
|
@@ -1779,7 +1779,7 @@ declare namespace DMS {
|
|
|
1779
1779
|
*/
|
|
1780
1780
|
SslMode?: DmsSslModeValue;
|
|
1781
1781
|
/**
|
|
1782
|
-
* The Amazon Resource Name (ARN) used by the service access IAM role.
|
|
1782
|
+
* The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
|
|
1783
1783
|
*/
|
|
1784
1784
|
ServiceAccessRoleArn?: String;
|
|
1785
1785
|
/**
|
|
@@ -1799,7 +1799,7 @@ declare namespace DMS {
|
|
|
1799
1799
|
*/
|
|
1800
1800
|
S3Settings?: S3Settings;
|
|
1801
1801
|
/**
|
|
1802
|
-
* The settings in JSON format for the DMS transfer type of source endpoint. Possible settings include the following: ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
|
|
1802
|
+
* The settings in JSON format for the DMS transfer type of source endpoint. Possible settings include the following: ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. The role must allow the iam:PassRole action. BucketName - The name of the S3 bucket to use. Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string, JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}
|
|
1803
1803
|
*/
|
|
1804
1804
|
DmsTransferSettings?: DmsTransferSettings;
|
|
1805
1805
|
/**
|
|
@@ -1886,6 +1886,10 @@ declare namespace DMS {
|
|
|
1886
1886
|
* The maximum value of an endpoint setting that is of type int.
|
|
1887
1887
|
*/
|
|
1888
1888
|
IntValueMax?: IntegerOptional;
|
|
1889
|
+
/**
|
|
1890
|
+
* The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.
|
|
1891
|
+
*/
|
|
1892
|
+
DefaultValue?: String;
|
|
1889
1893
|
}
|
|
1890
1894
|
export type EndpointSettingEnumValues = String[];
|
|
1891
1895
|
export type EndpointSettingTypeValue = "string"|"boolean"|"integer"|"enum"|string;
|
|
@@ -1896,7 +1900,7 @@ declare namespace DMS {
|
|
|
1896
1900
|
*/
|
|
1897
1901
|
SourceIdentifier?: String;
|
|
1898
1902
|
/**
|
|
1899
|
-
* The type of
|
|
1903
|
+
* The type of DMS resource that generates events. Valid values: replication-instance | endpoint | replication-task
|
|
1900
1904
|
*/
|
|
1901
1905
|
SourceType?: SourceType;
|
|
1902
1906
|
/**
|
|
@@ -1915,7 +1919,7 @@ declare namespace DMS {
|
|
|
1915
1919
|
export type EventCategoriesList = String[];
|
|
1916
1920
|
export interface EventCategoryGroup {
|
|
1917
1921
|
/**
|
|
1918
|
-
* The type of
|
|
1922
|
+
* The type of DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | replication-task
|
|
1919
1923
|
*/
|
|
1920
1924
|
SourceType?: String;
|
|
1921
1925
|
/**
|
|
@@ -1927,27 +1931,27 @@ declare namespace DMS {
|
|
|
1927
1931
|
export type EventList = Event[];
|
|
1928
1932
|
export interface EventSubscription {
|
|
1929
1933
|
/**
|
|
1930
|
-
* The
|
|
1934
|
+
* The Amazon Web Services customer account associated with the DMS event notification subscription.
|
|
1931
1935
|
*/
|
|
1932
1936
|
CustomerAwsId?: String;
|
|
1933
1937
|
/**
|
|
1934
|
-
* The
|
|
1938
|
+
* The DMS event notification subscription Id.
|
|
1935
1939
|
*/
|
|
1936
1940
|
CustSubscriptionId?: String;
|
|
1937
1941
|
/**
|
|
1938
|
-
* The topic ARN of the
|
|
1942
|
+
* The topic ARN of the DMS event notification subscription.
|
|
1939
1943
|
*/
|
|
1940
1944
|
SnsTopicArn?: String;
|
|
1941
1945
|
/**
|
|
1942
|
-
* The status of the
|
|
1946
|
+
* The status of the DMS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
|
|
1943
1947
|
*/
|
|
1944
1948
|
Status?: String;
|
|
1945
1949
|
/**
|
|
1946
|
-
* The time the
|
|
1950
|
+
* The time the DMS event notification subscription was created.
|
|
1947
1951
|
*/
|
|
1948
1952
|
SubscriptionCreationTime?: String;
|
|
1949
1953
|
/**
|
|
1950
|
-
* The type of
|
|
1954
|
+
* The type of DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | replication-task
|
|
1951
1955
|
*/
|
|
1952
1956
|
SourceType?: String;
|
|
1953
1957
|
/**
|
|
@@ -1987,7 +1991,7 @@ declare namespace DMS {
|
|
|
1987
1991
|
*/
|
|
1988
1992
|
Password?: SecretString;
|
|
1989
1993
|
/**
|
|
1990
|
-
* Endpoint TCP port.
|
|
1994
|
+
* Endpoint TCP port. The default value is 50000.
|
|
1991
1995
|
*/
|
|
1992
1996
|
Port?: IntegerOptional;
|
|
1993
1997
|
/**
|
|
@@ -2011,7 +2015,7 @@ declare namespace DMS {
|
|
|
2011
2015
|
*/
|
|
2012
2016
|
Username?: String;
|
|
2013
2017
|
/**
|
|
2014
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
2018
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2015
2019
|
*/
|
|
2016
2020
|
SecretsManagerAccessRoleArn?: String;
|
|
2017
2021
|
/**
|
|
@@ -2029,7 +2033,7 @@ declare namespace DMS {
|
|
|
2029
2033
|
*/
|
|
2030
2034
|
CertificatePem?: SecretString;
|
|
2031
2035
|
/**
|
|
2032
|
-
* The location of an imported Oracle Wallet certificate for use with SSL.
|
|
2036
|
+
* The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso file using the fileb:// prefix. You can't provide the certificate inline.
|
|
2033
2037
|
*/
|
|
2034
2038
|
CertificateWallet?: CertificateWallet;
|
|
2035
2039
|
/**
|
|
@@ -2050,11 +2054,11 @@ declare namespace DMS {
|
|
|
2050
2054
|
export type KafkaSecurityProtocol = "plaintext"|"ssl-authentication"|"ssl-encryption"|"sasl-ssl"|string;
|
|
2051
2055
|
export interface KafkaSettings {
|
|
2052
2056
|
/**
|
|
2053
|
-
* A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for
|
|
2057
|
+
* A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
|
|
2054
2058
|
*/
|
|
2055
2059
|
Broker?: String;
|
|
2056
2060
|
/**
|
|
2057
|
-
* The topic to which you migrate the data. If you don't specify a topic,
|
|
2061
|
+
* The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.
|
|
2058
2062
|
*/
|
|
2059
2063
|
Topic?: String;
|
|
2060
2064
|
/**
|
|
@@ -2066,7 +2070,7 @@ declare namespace DMS {
|
|
|
2066
2070
|
*/
|
|
2067
2071
|
IncludeTransactionDetails?: BooleanOptional;
|
|
2068
2072
|
/**
|
|
2069
|
-
* Shows the partition value within the Kafka message output
|
|
2073
|
+
* Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
|
|
2070
2074
|
*/
|
|
2071
2075
|
IncludePartitionValue?: BooleanOptional;
|
|
2072
2076
|
/**
|
|
@@ -2106,17 +2110,21 @@ declare namespace DMS {
|
|
|
2106
2110
|
*/
|
|
2107
2111
|
SslClientKeyPassword?: SecretString;
|
|
2108
2112
|
/**
|
|
2109
|
-
* The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that
|
|
2113
|
+
* The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
|
|
2110
2114
|
*/
|
|
2111
2115
|
SslCaCertificateArn?: String;
|
|
2112
2116
|
/**
|
|
2113
|
-
* The secure
|
|
2117
|
+
* The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
|
|
2114
2118
|
*/
|
|
2115
2119
|
SaslUsername?: String;
|
|
2116
2120
|
/**
|
|
2117
2121
|
* The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
|
|
2118
2122
|
*/
|
|
2119
2123
|
SaslPassword?: SecretString;
|
|
2124
|
+
/**
|
|
2125
|
+
* If this attribute is Y, it allows hexadecimal values that don't have the 0x prefix when migrated to a Kafka target. If this attribute is N, all hexadecimal values include this prefix when migrated to Kafka.
|
|
2126
|
+
*/
|
|
2127
|
+
NoHexPrefix?: BooleanOptional;
|
|
2120
2128
|
}
|
|
2121
2129
|
export type KeyList = String[];
|
|
2122
2130
|
export interface KinesisSettings {
|
|
@@ -2129,7 +2137,7 @@ declare namespace DMS {
|
|
|
2129
2137
|
*/
|
|
2130
2138
|
MessageFormat?: MessageFormatValue;
|
|
2131
2139
|
/**
|
|
2132
|
-
* The Amazon Resource Name (ARN) for the
|
|
2140
|
+
* The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
|
|
2133
2141
|
*/
|
|
2134
2142
|
ServiceAccessRoleArn?: String;
|
|
2135
2143
|
/**
|
|
@@ -2156,10 +2164,14 @@ declare namespace DMS {
|
|
|
2156
2164
|
* Include NULL and empty columns for records migrated to the endpoint. The default is false.
|
|
2157
2165
|
*/
|
|
2158
2166
|
IncludeNullAndEmpty?: BooleanOptional;
|
|
2167
|
+
/**
|
|
2168
|
+
* If this attribute is Y, it allows hexadecimal values that don't have the 0x prefix when migrated to a Kinesis target. If this attribute is N, all hexadecimal values include this prefix when migrated to Kinesis.
|
|
2169
|
+
*/
|
|
2170
|
+
NoHexPrefix?: BooleanOptional;
|
|
2159
2171
|
}
|
|
2160
2172
|
export interface ListTagsForResourceMessage {
|
|
2161
2173
|
/**
|
|
2162
|
-
* The Amazon Resource Name (ARN) string that uniquely identifies the
|
|
2174
|
+
* The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource.
|
|
2163
2175
|
*/
|
|
2164
2176
|
ResourceArn: String;
|
|
2165
2177
|
}
|
|
@@ -2185,7 +2197,7 @@ declare namespace DMS {
|
|
|
2185
2197
|
*/
|
|
2186
2198
|
DatabaseName?: String;
|
|
2187
2199
|
/**
|
|
2188
|
-
* Specifies a file group for the
|
|
2200
|
+
* Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
|
|
2189
2201
|
*/
|
|
2190
2202
|
ControlTablesFileGroup?: String;
|
|
2191
2203
|
/**
|
|
@@ -2197,11 +2209,11 @@ declare namespace DMS {
|
|
|
2197
2209
|
*/
|
|
2198
2210
|
QuerySingleAlwaysOnNode?: BooleanOptional;
|
|
2199
2211
|
/**
|
|
2200
|
-
* When this attribute is set to Y,
|
|
2212
|
+
* When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. 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.
|
|
2201
2213
|
*/
|
|
2202
2214
|
ReadBackupOnly?: BooleanOptional;
|
|
2203
2215
|
/**
|
|
2204
|
-
* Use this attribute to minimize the need to access the backup log and enable
|
|
2216
|
+
* Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods. Start transactions in the database: This is the default method. When this method is used, 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. Exclusively use sp_repldone within a single task: When this method is used, 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 DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.
|
|
2205
2217
|
*/
|
|
2206
2218
|
SafeguardPolicy?: SafeguardPolicy;
|
|
2207
2219
|
/**
|
|
@@ -2221,7 +2233,7 @@ declare namespace DMS {
|
|
|
2221
2233
|
*/
|
|
2222
2234
|
UseThirdPartyBackupDevice?: BooleanOptional;
|
|
2223
2235
|
/**
|
|
2224
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
2236
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2225
2237
|
*/
|
|
2226
2238
|
SecretsManagerAccessRoleArn?: String;
|
|
2227
2239
|
/**
|
|
@@ -2264,7 +2276,7 @@ declare namespace DMS {
|
|
|
2264
2276
|
*/
|
|
2265
2277
|
Port?: IntegerOptional;
|
|
2266
2278
|
/**
|
|
2267
|
-
* The name of the endpoint database.
|
|
2279
|
+
* The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
|
|
2268
2280
|
*/
|
|
2269
2281
|
DatabaseName?: String;
|
|
2270
2282
|
/**
|
|
@@ -2280,7 +2292,7 @@ declare namespace DMS {
|
|
|
2280
2292
|
*/
|
|
2281
2293
|
SslMode?: DmsSslModeValue;
|
|
2282
2294
|
/**
|
|
2283
|
-
* The Amazon Resource Name (ARN) for the
|
|
2295
|
+
* The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.
|
|
2284
2296
|
*/
|
|
2285
2297
|
ServiceAccessRoleArn?: String;
|
|
2286
2298
|
/**
|
|
@@ -2288,66 +2300,70 @@ declare namespace DMS {
|
|
|
2288
2300
|
*/
|
|
2289
2301
|
ExternalTableDefinition?: String;
|
|
2290
2302
|
/**
|
|
2291
|
-
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the
|
|
2303
|
+
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
|
|
2292
2304
|
*/
|
|
2293
2305
|
DynamoDbSettings?: DynamoDbSettings;
|
|
2294
2306
|
/**
|
|
2295
|
-
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for
|
|
2307
|
+
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
|
|
2296
2308
|
*/
|
|
2297
2309
|
S3Settings?: S3Settings;
|
|
2298
2310
|
/**
|
|
2299
|
-
* The settings in JSON format for the DMS transfer type of source endpoint. Attributes include the following: serviceAccessRoleArn - The
|
|
2311
|
+
* The settings in JSON format for the DMS transfer type of source endpoint. Attributes include the following: serviceAccessRoleArn - The Identity and Access Management (IAM) role that has permission to access the Amazon S3 bucket. The role must allow the iam:PassRole action. BucketName - The name of the S3 bucket to use. Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}
|
|
2300
2312
|
*/
|
|
2301
2313
|
DmsTransferSettings?: DmsTransferSettings;
|
|
2302
2314
|
/**
|
|
2303
|
-
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in
|
|
2315
|
+
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
|
|
2304
2316
|
*/
|
|
2305
2317
|
MongoDbSettings?: MongoDbSettings;
|
|
2306
2318
|
/**
|
|
2307
|
-
* Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using
|
|
2319
|
+
* Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
|
|
2308
2320
|
*/
|
|
2309
2321
|
KinesisSettings?: KinesisSettings;
|
|
2310
2322
|
/**
|
|
2311
|
-
* Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using
|
|
2323
|
+
* Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
|
|
2312
2324
|
*/
|
|
2313
2325
|
KafkaSettings?: KafkaSettings;
|
|
2314
2326
|
/**
|
|
2315
|
-
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for
|
|
2327
|
+
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in the Database Migration Service User Guide.
|
|
2316
2328
|
*/
|
|
2317
2329
|
ElasticsearchSettings?: ElasticsearchSettings;
|
|
2318
2330
|
/**
|
|
2319
|
-
* Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying
|
|
2331
|
+
* Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
|
|
2320
2332
|
*/
|
|
2321
2333
|
NeptuneSettings?: NeptuneSettings;
|
|
2322
2334
|
RedshiftSettings?: RedshiftSettings;
|
|
2323
2335
|
/**
|
|
2324
|
-
* Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for
|
|
2336
|
+
* Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
|
|
2325
2337
|
*/
|
|
2326
2338
|
PostgreSQLSettings?: PostgreSQLSettings;
|
|
2327
2339
|
/**
|
|
2328
|
-
* Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for
|
|
2340
|
+
* Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
|
|
2329
2341
|
*/
|
|
2330
2342
|
MySQLSettings?: MySQLSettings;
|
|
2331
2343
|
/**
|
|
2332
|
-
* Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for
|
|
2344
|
+
* Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
|
|
2333
2345
|
*/
|
|
2334
2346
|
OracleSettings?: OracleSettings;
|
|
2335
2347
|
/**
|
|
2336
|
-
* Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for
|
|
2348
|
+
* Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
|
|
2337
2349
|
*/
|
|
2338
2350
|
SybaseSettings?: SybaseSettings;
|
|
2339
2351
|
/**
|
|
2340
|
-
* Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for
|
|
2352
|
+
* Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
|
|
2341
2353
|
*/
|
|
2342
2354
|
MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings;
|
|
2343
2355
|
/**
|
|
2344
|
-
* Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for
|
|
2356
|
+
* Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
|
|
2345
2357
|
*/
|
|
2346
2358
|
IBMDb2Settings?: IBMDb2Settings;
|
|
2347
2359
|
/**
|
|
2348
|
-
* Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for
|
|
2360
|
+
* Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.
|
|
2349
2361
|
*/
|
|
2350
2362
|
DocDbSettings?: DocDbSettings;
|
|
2363
|
+
/**
|
|
2364
|
+
* If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things: It replaces any endpoint settings that already exist with new values, for settings with the same names. It creates new endpoint settings that you specify in the call, for settings with different names. For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'. However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.
|
|
2365
|
+
*/
|
|
2366
|
+
ExactSettings?: BooleanOptional;
|
|
2351
2367
|
}
|
|
2352
2368
|
export interface ModifyEndpointResponse {
|
|
2353
2369
|
/**
|
|
@@ -2357,7 +2373,7 @@ declare namespace DMS {
|
|
|
2357
2373
|
}
|
|
2358
2374
|
export interface ModifyEventSubscriptionMessage {
|
|
2359
2375
|
/**
|
|
2360
|
-
* The name of the
|
|
2376
|
+
* The name of the DMS event notification subscription to be modified.
|
|
2361
2377
|
*/
|
|
2362
2378
|
SubscriptionName: String;
|
|
2363
2379
|
/**
|
|
@@ -2365,7 +2381,7 @@ declare namespace DMS {
|
|
|
2365
2381
|
*/
|
|
2366
2382
|
SnsTopicArn?: String;
|
|
2367
2383
|
/**
|
|
2368
|
-
* The type of
|
|
2384
|
+
* The type of DMS resource that generates the events you want to subscribe to. Valid values: replication-instance | replication-task
|
|
2369
2385
|
*/
|
|
2370
2386
|
SourceType?: String;
|
|
2371
2387
|
/**
|
|
@@ -2397,7 +2413,7 @@ declare namespace DMS {
|
|
|
2397
2413
|
*/
|
|
2398
2414
|
ApplyImmediately?: Boolean;
|
|
2399
2415
|
/**
|
|
2400
|
-
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right
|
|
2416
|
+
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
|
|
2401
2417
|
*/
|
|
2402
2418
|
ReplicationInstanceClass?: String;
|
|
2403
2419
|
/**
|
|
@@ -2421,7 +2437,7 @@ declare namespace DMS {
|
|
|
2421
2437
|
*/
|
|
2422
2438
|
AllowMajorVersionUpgrade?: Boolean;
|
|
2423
2439
|
/**
|
|
2424
|
-
* A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible. An outage does result if these factors apply: This parameter is set to true during the maintenance window. A newer minor version is available.
|
|
2440
|
+
* A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible. An outage does result if these factors apply: This parameter is set to true during the maintenance window. A newer minor version is available. DMS has enabled automatic patching for the given engine version.
|
|
2425
2441
|
*/
|
|
2426
2442
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
2427
2443
|
/**
|
|
@@ -2469,7 +2485,7 @@ declare namespace DMS {
|
|
|
2469
2485
|
*/
|
|
2470
2486
|
MigrationType?: MigrationTypeValue;
|
|
2471
2487
|
/**
|
|
2472
|
-
* When using the
|
|
2488
|
+
* When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.
|
|
2473
2489
|
*/
|
|
2474
2490
|
TableMappings?: String;
|
|
2475
2491
|
/**
|
|
@@ -2481,7 +2497,7 @@ declare namespace DMS {
|
|
|
2481
2497
|
*/
|
|
2482
2498
|
CdcStartTime?: TStamp;
|
|
2483
2499
|
/**
|
|
2484
|
-
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” 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
|
|
2500
|
+
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” 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 DMS.
|
|
2485
2501
|
*/
|
|
2486
2502
|
CdcStartPosition?: String;
|
|
2487
2503
|
/**
|
|
@@ -2489,7 +2505,7 @@ declare namespace DMS {
|
|
|
2489
2505
|
*/
|
|
2490
2506
|
CdcStopPosition?: String;
|
|
2491
2507
|
/**
|
|
2492
|
-
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the
|
|
2508
|
+
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
|
|
2493
2509
|
*/
|
|
2494
2510
|
TaskData?: String;
|
|
2495
2511
|
}
|
|
@@ -2545,11 +2561,11 @@ declare namespace DMS {
|
|
|
2545
2561
|
*/
|
|
2546
2562
|
AuthSource?: String;
|
|
2547
2563
|
/**
|
|
2548
|
-
* The
|
|
2564
|
+
* The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
|
|
2549
2565
|
*/
|
|
2550
2566
|
KmsKeyId?: String;
|
|
2551
2567
|
/**
|
|
2552
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
2568
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2553
2569
|
*/
|
|
2554
2570
|
SecretsManagerAccessRoleArn?: String;
|
|
2555
2571
|
/**
|
|
@@ -2575,7 +2591,7 @@ declare namespace DMS {
|
|
|
2575
2591
|
}
|
|
2576
2592
|
export interface MySQLSettings {
|
|
2577
2593
|
/**
|
|
2578
|
-
* Specifies a script to run immediately after
|
|
2594
|
+
* Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails. For this parameter, provide the code of the script itself, not the name of a file containing the script.
|
|
2579
2595
|
*/
|
|
2580
2596
|
AfterConnectScript?: String;
|
|
2581
2597
|
/**
|
|
@@ -2583,11 +2599,11 @@ declare namespace DMS {
|
|
|
2583
2599
|
*/
|
|
2584
2600
|
CleanSourceMetadataOnMismatch?: BooleanOptional;
|
|
2585
2601
|
/**
|
|
2586
|
-
* Database name for the endpoint.
|
|
2602
|
+
* Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
|
|
2587
2603
|
*/
|
|
2588
2604
|
DatabaseName?: String;
|
|
2589
2605
|
/**
|
|
2590
|
-
* Specifies how often to check the binary log for new changes/events when the database is idle. Example: eventsPollInterval=5; In the example,
|
|
2606
|
+
* Specifies how often to check the binary log for new changes/events when the database is idle. Example: eventsPollInterval=5; In the example, DMS checks for changes in the binary logs every five seconds.
|
|
2591
2607
|
*/
|
|
2592
2608
|
EventsPollInterval?: IntegerOptional;
|
|
2593
2609
|
/**
|
|
@@ -2623,7 +2639,7 @@ declare namespace DMS {
|
|
|
2623
2639
|
*/
|
|
2624
2640
|
Username?: String;
|
|
2625
2641
|
/**
|
|
2626
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
2642
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2627
2643
|
*/
|
|
2628
2644
|
SecretsManagerAccessRoleArn?: String;
|
|
2629
2645
|
/**
|
|
@@ -2633,31 +2649,31 @@ declare namespace DMS {
|
|
|
2633
2649
|
}
|
|
2634
2650
|
export interface NeptuneSettings {
|
|
2635
2651
|
/**
|
|
2636
|
-
* The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the
|
|
2652
|
+
* The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service User Guide.
|
|
2637
2653
|
*/
|
|
2638
2654
|
ServiceAccessRoleArn?: String;
|
|
2639
2655
|
/**
|
|
2640
|
-
* The name of the Amazon S3 bucket where
|
|
2656
|
+
* The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.
|
|
2641
2657
|
*/
|
|
2642
2658
|
S3BucketName: String;
|
|
2643
2659
|
/**
|
|
2644
|
-
* A folder path where you want
|
|
2660
|
+
* A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
|
|
2645
2661
|
*/
|
|
2646
2662
|
S3BucketFolder: String;
|
|
2647
2663
|
/**
|
|
2648
|
-
* The number of milliseconds for
|
|
2664
|
+
* The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.
|
|
2649
2665
|
*/
|
|
2650
2666
|
ErrorRetryDuration?: IntegerOptional;
|
|
2651
2667
|
/**
|
|
2652
|
-
* The maximum size in kilobytes of migrated graph data stored in a .csv file before
|
|
2668
|
+
* The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.
|
|
2653
2669
|
*/
|
|
2654
2670
|
MaxFileSize?: IntegerOptional;
|
|
2655
2671
|
/**
|
|
2656
|
-
* The number of times for
|
|
2672
|
+
* The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
|
|
2657
2673
|
*/
|
|
2658
2674
|
MaxRetryCount?: IntegerOptional;
|
|
2659
2675
|
/**
|
|
2660
|
-
* If you want
|
|
2676
|
+
* If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.
|
|
2661
2677
|
*/
|
|
2662
2678
|
IamAuthEnabled?: BooleanOptional;
|
|
2663
2679
|
}
|
|
@@ -2668,11 +2684,11 @@ declare namespace DMS {
|
|
|
2668
2684
|
*/
|
|
2669
2685
|
AddSupplementalLogging?: BooleanOptional;
|
|
2670
2686
|
/**
|
|
2671
|
-
* Specifies the
|
|
2687
|
+
* Specifies the ID of the destination for the archived redo logs. 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.
|
|
2672
2688
|
*/
|
|
2673
2689
|
ArchivedLogDestId?: IntegerOptional;
|
|
2674
2690
|
/**
|
|
2675
|
-
* Set this attribute with
|
|
2691
|
+
* Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, 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. Although 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 in the Oracle Database Backup and Recovery User's Guide.
|
|
2676
2692
|
*/
|
|
2677
2693
|
AdditionalArchivedLogDestId?: IntegerOptional;
|
|
2678
2694
|
/**
|
|
@@ -2680,11 +2696,11 @@ declare namespace DMS {
|
|
|
2680
2696
|
*/
|
|
2681
2697
|
AllowSelectNestedTables?: BooleanOptional;
|
|
2682
2698
|
/**
|
|
2683
|
-
* Set this attribute to change the number of threads that DMS configures to perform a
|
|
2699
|
+
* 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). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
|
|
2684
2700
|
*/
|
|
2685
2701
|
ParallelAsmReadThreads?: IntegerOptional;
|
|
2686
2702
|
/**
|
|
2687
|
-
* Set this attribute to change the number of read-ahead blocks that DMS configures to perform a
|
|
2703
|
+
* 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). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
|
|
2688
2704
|
*/
|
|
2689
2705
|
ReadAheadBlocks?: IntegerOptional;
|
|
2690
2706
|
/**
|
|
@@ -2716,7 +2732,7 @@ declare namespace DMS {
|
|
|
2716
2732
|
*/
|
|
2717
2733
|
DirectPathNoLog?: BooleanOptional;
|
|
2718
2734
|
/**
|
|
2719
|
-
* When this field is set to Y,
|
|
2735
|
+
* When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the DMS user account needs to be granted ASM privileges.
|
|
2720
2736
|
*/
|
|
2721
2737
|
ArchivedLogsOnly?: BooleanOptional;
|
|
2722
2738
|
/**
|
|
@@ -2740,7 +2756,7 @@ declare namespace DMS {
|
|
|
2740
2756
|
*/
|
|
2741
2757
|
DatabaseName?: String;
|
|
2742
2758
|
/**
|
|
2743
|
-
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the
|
|
2759
|
+
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
|
|
2744
2760
|
*/
|
|
2745
2761
|
DirectPathParallelLoad?: BooleanOptional;
|
|
2746
2762
|
/**
|
|
@@ -2768,11 +2784,11 @@ declare namespace DMS {
|
|
|
2768
2784
|
*/
|
|
2769
2785
|
RetryInterval?: IntegerOptional;
|
|
2770
2786
|
/**
|
|
2771
|
-
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for
|
|
2787
|
+
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.
|
|
2772
2788
|
*/
|
|
2773
2789
|
SecurityDbEncryption?: SecretString;
|
|
2774
2790
|
/**
|
|
2775
|
-
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for
|
|
2791
|
+
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.
|
|
2776
2792
|
*/
|
|
2777
2793
|
SecurityDbEncryptionName?: String;
|
|
2778
2794
|
/**
|
|
@@ -2783,12 +2799,28 @@ declare namespace DMS {
|
|
|
2783
2799
|
* Use this attribute to convert SDO_GEOMETRY to GEOJSON format. 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.
|
|
2784
2800
|
*/
|
|
2785
2801
|
SpatialDataOptionToGeoJsonFunctionName?: String;
|
|
2802
|
+
/**
|
|
2803
|
+
* Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. In 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.
|
|
2804
|
+
*/
|
|
2805
|
+
StandbyDelayTime?: IntegerOptional;
|
|
2786
2806
|
/**
|
|
2787
2807
|
* Endpoint connection user name.
|
|
2788
2808
|
*/
|
|
2789
2809
|
Username?: String;
|
|
2790
2810
|
/**
|
|
2791
|
-
*
|
|
2811
|
+
* Set this attribute to Y to capture change data using the Binary Reader utility. 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 DMS Binary Reader for CDC.
|
|
2812
|
+
*/
|
|
2813
|
+
UseBFile?: BooleanOptional;
|
|
2814
|
+
/**
|
|
2815
|
+
* Set this attribute to Y to have DMS use a direct path full load. 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.
|
|
2816
|
+
*/
|
|
2817
|
+
UseDirectPathFullLoad?: BooleanOptional;
|
|
2818
|
+
/**
|
|
2819
|
+
* Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). 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 DMS Binary Reader for CDC in the DMS User Guide.
|
|
2820
|
+
*/
|
|
2821
|
+
UseLogminerReader?: BooleanOptional;
|
|
2822
|
+
/**
|
|
2823
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2792
2824
|
*/
|
|
2793
2825
|
SecretsManagerAccessRoleArn?: String;
|
|
2794
2826
|
/**
|
|
@@ -2796,7 +2828,7 @@ declare namespace DMS {
|
|
|
2796
2828
|
*/
|
|
2797
2829
|
SecretsManagerSecretId?: String;
|
|
2798
2830
|
/**
|
|
2799
|
-
* Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies
|
|
2831
|
+
* Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that specifies 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. 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 AsmUserName, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2800
2832
|
*/
|
|
2801
2833
|
SecretsManagerOracleAsmAccessRoleArn?: String;
|
|
2802
2834
|
/**
|
|
@@ -2810,7 +2842,7 @@ declare namespace DMS {
|
|
|
2810
2842
|
*/
|
|
2811
2843
|
EngineVersion?: String;
|
|
2812
2844
|
/**
|
|
2813
|
-
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right
|
|
2845
|
+
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
|
|
2814
2846
|
*/
|
|
2815
2847
|
ReplicationInstanceClass?: String;
|
|
2816
2848
|
/**
|
|
@@ -2838,7 +2870,7 @@ declare namespace DMS {
|
|
|
2838
2870
|
*/
|
|
2839
2871
|
AvailabilityZones?: AvailabilityZonesList;
|
|
2840
2872
|
/**
|
|
2841
|
-
* The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.
|
|
2873
|
+
* The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected. DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
|
|
2842
2874
|
*/
|
|
2843
2875
|
ReleaseStatus?: ReleaseStatusValues;
|
|
2844
2876
|
}
|
|
@@ -2872,13 +2904,14 @@ declare namespace DMS {
|
|
|
2872
2904
|
}
|
|
2873
2905
|
export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
|
|
2874
2906
|
export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
|
|
2907
|
+
export type PluginNameValue = "no-preference"|"test-decoding"|"pglogical"|string;
|
|
2875
2908
|
export interface PostgreSQLSettings {
|
|
2876
2909
|
/**
|
|
2877
|
-
* For use with change data capture (CDC) only, this attribute has
|
|
2910
|
+
* For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. Example: afterConnectScript=SET session_replication_role='replica'
|
|
2878
2911
|
*/
|
|
2879
2912
|
AfterConnectScript?: String;
|
|
2880
2913
|
/**
|
|
2881
|
-
* To capture DDL events,
|
|
2914
|
+
* To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts. If this value is set to N, you don't have to create tables or triggers on the source database.
|
|
2882
2915
|
*/
|
|
2883
2916
|
CaptureDdls?: BooleanOptional;
|
|
2884
2917
|
/**
|
|
@@ -2901,6 +2934,18 @@ declare namespace DMS {
|
|
|
2901
2934
|
* 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. If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
|
|
2902
2935
|
*/
|
|
2903
2936
|
FailTasksOnLobTruncation?: BooleanOptional;
|
|
2937
|
+
/**
|
|
2938
|
+
* If this attribute is set to true, the write-ahead log (WAL) heartbeat keeps restart_lsn moving and prevents storage full scenarios. The WAL heartbeat mimics a dummy transaction, so that idle logical replication slots don't hold onto old WAL logs that result in storage full situations on the source.
|
|
2939
|
+
*/
|
|
2940
|
+
HeartbeatEnable?: BooleanOptional;
|
|
2941
|
+
/**
|
|
2942
|
+
* Sets the schema in which the heartbeat artifacts are created.
|
|
2943
|
+
*/
|
|
2944
|
+
HeartbeatSchema?: String;
|
|
2945
|
+
/**
|
|
2946
|
+
* Sets the WAL heartbeat frequency (in minutes).
|
|
2947
|
+
*/
|
|
2948
|
+
HeartbeatFrequency?: IntegerOptional;
|
|
2904
2949
|
/**
|
|
2905
2950
|
* Endpoint connection password.
|
|
2906
2951
|
*/
|
|
@@ -2918,11 +2963,15 @@ declare namespace DMS {
|
|
|
2918
2963
|
*/
|
|
2919
2964
|
Username?: String;
|
|
2920
2965
|
/**
|
|
2921
|
-
* Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance. When used with the
|
|
2966
|
+
* Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance. When used with the DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
|
|
2922
2967
|
*/
|
|
2923
2968
|
SlotName?: String;
|
|
2924
2969
|
/**
|
|
2925
|
-
*
|
|
2970
|
+
* Specifies the plugin to use to create a replication slot.
|
|
2971
|
+
*/
|
|
2972
|
+
PluginName?: PluginNameValue;
|
|
2973
|
+
/**
|
|
2974
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
2926
2975
|
*/
|
|
2927
2976
|
SecretsManagerAccessRoleArn?: String;
|
|
2928
2977
|
/**
|
|
@@ -2956,7 +3005,7 @@ declare namespace DMS {
|
|
|
2956
3005
|
*/
|
|
2957
3006
|
AfterConnectScript?: String;
|
|
2958
3007
|
/**
|
|
2959
|
-
* An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. For full load mode,
|
|
3008
|
+
* An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. For full load mode, DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. 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 in the Amazon Redshift Database Developer Guide. For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
|
|
2960
3009
|
*/
|
|
2961
3010
|
BucketFolder?: String;
|
|
2962
3011
|
/**
|
|
@@ -2984,11 +3033,11 @@ declare namespace DMS {
|
|
|
2984
3033
|
*/
|
|
2985
3034
|
DateFormat?: String;
|
|
2986
3035
|
/**
|
|
2987
|
-
* A value that specifies whether
|
|
3036
|
+
* A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
|
|
2988
3037
|
*/
|
|
2989
3038
|
EmptyAsNull?: BooleanOptional;
|
|
2990
3039
|
/**
|
|
2991
|
-
* The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS. To use SSE_S3, create an
|
|
3040
|
+
* The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS. To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
|
|
2992
3041
|
*/
|
|
2993
3042
|
EncryptionMode?: EncryptionModeValue;
|
|
2994
3043
|
/**
|
|
@@ -3000,7 +3049,7 @@ declare namespace DMS {
|
|
|
3000
3049
|
*/
|
|
3001
3050
|
FileTransferUploadStreams?: IntegerOptional;
|
|
3002
3051
|
/**
|
|
3003
|
-
* The amount of time to wait (in milliseconds) before timing out of operations performed by
|
|
3052
|
+
* The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
|
|
3004
3053
|
*/
|
|
3005
3054
|
LoadTimeout?: IntegerOptional;
|
|
3006
3055
|
/**
|
|
@@ -3032,11 +3081,11 @@ declare namespace DMS {
|
|
|
3032
3081
|
*/
|
|
3033
3082
|
ServerName?: String;
|
|
3034
3083
|
/**
|
|
3035
|
-
* The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
|
|
3084
|
+
* The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the iam:PassRole action.
|
|
3036
3085
|
*/
|
|
3037
3086
|
ServiceAccessRoleArn?: String;
|
|
3038
3087
|
/**
|
|
3039
|
-
* The
|
|
3088
|
+
* The KMS key ID. 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.
|
|
3040
3089
|
*/
|
|
3041
3090
|
ServerSideEncryptionKmsKeyId?: String;
|
|
3042
3091
|
/**
|
|
@@ -3060,7 +3109,7 @@ declare namespace DMS {
|
|
|
3060
3109
|
*/
|
|
3061
3110
|
WriteBufferSize?: IntegerOptional;
|
|
3062
3111
|
/**
|
|
3063
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
3112
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
3064
3113
|
*/
|
|
3065
3114
|
SecretsManagerAccessRoleArn?: String;
|
|
3066
3115
|
/**
|
|
@@ -3131,7 +3180,7 @@ declare namespace DMS {
|
|
|
3131
3180
|
}
|
|
3132
3181
|
export interface RemoveTagsFromResourceMessage {
|
|
3133
3182
|
/**
|
|
3134
|
-
* An
|
|
3183
|
+
* An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
|
|
3135
3184
|
*/
|
|
3136
3185
|
ResourceArn: String;
|
|
3137
3186
|
/**
|
|
@@ -3148,7 +3197,7 @@ declare namespace DMS {
|
|
|
3148
3197
|
*/
|
|
3149
3198
|
ReplicationInstanceIdentifier?: String;
|
|
3150
3199
|
/**
|
|
3151
|
-
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a
|
|
3200
|
+
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console. For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
|
|
3152
3201
|
*/
|
|
3153
3202
|
ReplicationInstanceClass?: String;
|
|
3154
3203
|
/**
|
|
@@ -3196,7 +3245,7 @@ declare namespace DMS {
|
|
|
3196
3245
|
*/
|
|
3197
3246
|
AutoMinorVersionUpgrade?: Boolean;
|
|
3198
3247
|
/**
|
|
3199
|
-
* An
|
|
3248
|
+
* An KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
|
|
3200
3249
|
*/
|
|
3201
3250
|
KmsKeyId?: String;
|
|
3202
3251
|
/**
|
|
@@ -3256,7 +3305,7 @@ declare namespace DMS {
|
|
|
3256
3305
|
export type ReplicationInstanceTaskLogsList = ReplicationInstanceTaskLog[];
|
|
3257
3306
|
export interface ReplicationPendingModifiedValues {
|
|
3258
3307
|
/**
|
|
3259
|
-
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For more information on the settings and capacities for the available replication instance classes, see Selecting the right
|
|
3308
|
+
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
|
|
3260
3309
|
*/
|
|
3261
3310
|
ReplicationInstanceClass?: String;
|
|
3262
3311
|
/**
|
|
@@ -3365,7 +3414,7 @@ declare namespace DMS {
|
|
|
3365
3414
|
*/
|
|
3366
3415
|
ReplicationTaskStats?: ReplicationTaskStats;
|
|
3367
3416
|
/**
|
|
3368
|
-
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the
|
|
3417
|
+
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
|
|
3369
3418
|
*/
|
|
3370
3419
|
TaskData?: String;
|
|
3371
3420
|
/**
|
|
@@ -3395,11 +3444,11 @@ declare namespace DMS {
|
|
|
3395
3444
|
*/
|
|
3396
3445
|
AssessmentResultsFile?: String;
|
|
3397
3446
|
/**
|
|
3398
|
-
* The task assessment results in JSON format.
|
|
3447
|
+
* The task assessment results in JSON format. The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
|
|
3399
3448
|
*/
|
|
3400
3449
|
AssessmentResults?: String;
|
|
3401
3450
|
/**
|
|
3402
|
-
* The URL of the S3 object containing the task assessment results.
|
|
3451
|
+
* The URL of the S3 object containing the task assessment results. The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
|
|
3403
3452
|
*/
|
|
3404
3453
|
S3ObjectUrl?: String;
|
|
3405
3454
|
}
|
|
@@ -3430,15 +3479,15 @@ declare namespace DMS {
|
|
|
3430
3479
|
*/
|
|
3431
3480
|
LastFailureMessage?: String;
|
|
3432
3481
|
/**
|
|
3433
|
-
* ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
|
|
3482
|
+
* ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
|
|
3434
3483
|
*/
|
|
3435
3484
|
ServiceAccessRoleArn?: String;
|
|
3436
3485
|
/**
|
|
3437
|
-
* Amazon S3 bucket where
|
|
3486
|
+
* Amazon S3 bucket where DMS stores the results of this assessment run.
|
|
3438
3487
|
*/
|
|
3439
3488
|
ResultLocationBucket?: String;
|
|
3440
3489
|
/**
|
|
3441
|
-
* Folder in an Amazon S3 bucket where
|
|
3490
|
+
* Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
|
|
3442
3491
|
*/
|
|
3443
3492
|
ResultLocationFolder?: String;
|
|
3444
3493
|
/**
|
|
@@ -3446,7 +3495,7 @@ declare namespace DMS {
|
|
|
3446
3495
|
*/
|
|
3447
3496
|
ResultEncryptionMode?: String;
|
|
3448
3497
|
/**
|
|
3449
|
-
* ARN of the
|
|
3498
|
+
* ARN of the KMS encryption key used to encrypt the assessment run results.
|
|
3450
3499
|
*/
|
|
3451
3500
|
ResultKmsKeyArn?: String;
|
|
3452
3501
|
/**
|
|
@@ -3537,7 +3586,7 @@ declare namespace DMS {
|
|
|
3537
3586
|
}
|
|
3538
3587
|
export interface ResourcePendingMaintenanceActions {
|
|
3539
3588
|
/**
|
|
3540
|
-
* The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) for
|
|
3589
|
+
* The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) for DMS in the DMS documentation.
|
|
3541
3590
|
*/
|
|
3542
3591
|
ResourceIdentifier?: String;
|
|
3543
3592
|
/**
|
|
@@ -3547,7 +3596,7 @@ declare namespace DMS {
|
|
|
3547
3596
|
}
|
|
3548
3597
|
export interface S3Settings {
|
|
3549
3598
|
/**
|
|
3550
|
-
* The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
|
|
3599
|
+
* The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action. It is a required parameter that enables DMS to write and read objects from an S3 bucket.
|
|
3551
3600
|
*/
|
|
3552
3601
|
ServiceAccessRoleArn?: String;
|
|
3553
3602
|
/**
|
|
@@ -3575,11 +3624,11 @@ declare namespace DMS {
|
|
|
3575
3624
|
*/
|
|
3576
3625
|
CompressionType?: CompressionTypeValue;
|
|
3577
3626
|
/**
|
|
3578
|
-
* The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS. To use SSE_S3, you need an
|
|
3627
|
+
* The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS. To use SSE_S3, you need an Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions: s3:CreateBucket s3:ListBucket s3:DeleteBucket s3:GetBucketLocation s3:GetObject s3:PutObject s3:DeleteObject s3:GetObjectVersion s3:GetBucketPolicy s3:PutBucketPolicy s3:DeleteBucketPolicy
|
|
3579
3628
|
*/
|
|
3580
3629
|
EncryptionMode?: EncryptionModeValue;
|
|
3581
3630
|
/**
|
|
3582
|
-
* If you are using SSE_KMS for the EncryptionMode, provide the
|
|
3631
|
+
* If you are using SSE_KMS for the EncryptionMode, provide the KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management (IAM) user permissions and allows use of the key. 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
|
|
3583
3632
|
*/
|
|
3584
3633
|
ServerSideEncryptionKmsKeyId?: String;
|
|
3585
3634
|
/**
|
|
@@ -3611,27 +3660,27 @@ declare namespace DMS {
|
|
|
3611
3660
|
*/
|
|
3612
3661
|
EnableStatistics?: BooleanOptional;
|
|
3613
3662
|
/**
|
|
3614
|
-
* 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.
|
|
3663
|
+
* 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. DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later. 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. 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 in the Database Migration Service User Guide..
|
|
3615
3664
|
*/
|
|
3616
3665
|
IncludeOpForFullLoad?: BooleanOptional;
|
|
3617
3666
|
/**
|
|
3618
|
-
* 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. 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 in the
|
|
3667
|
+
* 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. 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 in the Database Migration Service User Guide.. DMS supports the interaction described preceding between the CdcInsertsOnly and IncludeOpForFullLoad parameters in versions 3.1.4 and later. 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.
|
|
3619
3668
|
*/
|
|
3620
3669
|
CdcInsertsOnly?: BooleanOptional;
|
|
3621
3670
|
/**
|
|
3622
|
-
* A value that when nonblank causes
|
|
3671
|
+
* A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target. DMS supports the TimestampColumnName parameter in versions 3.1.4 and later. 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. 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. 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. 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. When the AddColumnName parameter is set to true, DMS also includes a name for the timestamp column that you set with TimestampColumnName.
|
|
3623
3672
|
*/
|
|
3624
3673
|
TimestampColumnName?: String;
|
|
3625
3674
|
/**
|
|
3626
|
-
* A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
|
|
3675
|
+
* A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format. DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later. When ParquetTimestampInMillisecond is set to true or y, DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision. Currently, Amazon Athena and 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 Glue. DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision. Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.
|
|
3627
3676
|
*/
|
|
3628
3677
|
ParquetTimestampInMillisecond?: BooleanOptional;
|
|
3629
3678
|
/**
|
|
3630
|
-
* 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. 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 in the
|
|
3679
|
+
* 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. 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 in the Database Migration Service User Guide.. DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later. 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.
|
|
3631
3680
|
*/
|
|
3632
3681
|
CdcInsertsAndUpdates?: BooleanOptional;
|
|
3633
3682
|
/**
|
|
3634
|
-
* When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false. For more information about date-based folder
|
|
3683
|
+
* When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false. For more information about date-based folder partitioning, see Using date-based folder partitioning.
|
|
3635
3684
|
*/
|
|
3636
3685
|
DatePartitionEnabled?: BooleanOptional;
|
|
3637
3686
|
/**
|
|
@@ -3643,19 +3692,19 @@ declare namespace DMS {
|
|
|
3643
3692
|
*/
|
|
3644
3693
|
DatePartitionDelimiter?: DatePartitionDelimiterValue;
|
|
3645
3694
|
/**
|
|
3646
|
-
* This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to true for columns not included in the supplemental log,
|
|
3695
|
+
* This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to true for columns not included in the supplemental log, DMS uses the value specified by CsvNoSupValue . If not set or set to false, DMS uses the null value for these columns. This setting is supported in DMS versions 3.4.1 and later.
|
|
3647
3696
|
*/
|
|
3648
3697
|
UseCsvNoSupValue?: BooleanOptional;
|
|
3649
3698
|
/**
|
|
3650
|
-
* This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want
|
|
3699
|
+
* This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want DMS to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting. This setting is supported in DMS versions 3.4.1 and later.
|
|
3651
3700
|
*/
|
|
3652
3701
|
CsvNoSupValue?: String;
|
|
3653
3702
|
/**
|
|
3654
|
-
* If set to true,
|
|
3703
|
+
* If set to true, DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath . For more information, see Capturing data changes (CDC) including transaction order on the S3 target. This setting is supported in DMS versions 3.4.2 and later.
|
|
3655
3704
|
*/
|
|
3656
3705
|
PreserveTransactions?: BooleanOptional;
|
|
3657
3706
|
/**
|
|
3658
|
-
* Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set,
|
|
3707
|
+
* Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set, DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set PreserveTransactions to true, DMS verifies that you have set this parameter to a folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by BucketFolder and BucketName . For example, if you specify CdcPath as MyChangedData, and you specify BucketName as MyTargetBucket but do not specify BucketFolder, DMS creates the CDC folder path following: MyTargetBucket/MyChangedData. If you specify the same CdcPath, and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData, DMS creates the CDC folder path following: MyTargetBucket/MyTargetData/MyChangedData. For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target. This setting is supported in DMS versions 3.4.2 and later.
|
|
3659
3708
|
*/
|
|
3660
3709
|
CdcPath?: String;
|
|
3661
3710
|
}
|
|
@@ -3682,19 +3731,19 @@ declare namespace DMS {
|
|
|
3682
3731
|
*/
|
|
3683
3732
|
ReplicationTaskArn: String;
|
|
3684
3733
|
/**
|
|
3685
|
-
* ARN of
|
|
3734
|
+
* ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.
|
|
3686
3735
|
*/
|
|
3687
3736
|
ServiceAccessRoleArn: String;
|
|
3688
3737
|
/**
|
|
3689
|
-
* Amazon S3 bucket where you want
|
|
3738
|
+
* Amazon S3 bucket where you want DMS to store the results of this assessment run.
|
|
3690
3739
|
*/
|
|
3691
3740
|
ResultLocationBucket: String;
|
|
3692
3741
|
/**
|
|
3693
|
-
* Folder within an Amazon S3 bucket where you want
|
|
3742
|
+
* Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
|
|
3694
3743
|
*/
|
|
3695
3744
|
ResultLocationFolder?: String;
|
|
3696
3745
|
/**
|
|
3697
|
-
* Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter,
|
|
3746
|
+
* Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following: "SSE_S3" – The server-side encryption provided as a default by Amazon S3. "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
|
|
3698
3747
|
*/
|
|
3699
3748
|
ResultEncryptionMode?: String;
|
|
3700
3749
|
/**
|
|
@@ -3706,11 +3755,11 @@ declare namespace DMS {
|
|
|
3706
3755
|
*/
|
|
3707
3756
|
AssessmentRunName: String;
|
|
3708
3757
|
/**
|
|
3709
|
-
* Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that
|
|
3758
|
+
* Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn. You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation. To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
|
|
3710
3759
|
*/
|
|
3711
3760
|
IncludeOnly?: IncludeTestList;
|
|
3712
3761
|
/**
|
|
3713
|
-
* Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that
|
|
3762
|
+
* Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn. You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation. To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
|
|
3714
3763
|
*/
|
|
3715
3764
|
Exclude?: ExcludeTestList;
|
|
3716
3765
|
}
|
|
@@ -3734,7 +3783,7 @@ declare namespace DMS {
|
|
|
3734
3783
|
*/
|
|
3735
3784
|
CdcStartTime?: TStamp;
|
|
3736
3785
|
/**
|
|
3737
|
-
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” 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
|
|
3786
|
+
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” 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 DMS.
|
|
3738
3787
|
*/
|
|
3739
3788
|
CdcStartPosition?: String;
|
|
3740
3789
|
/**
|
|
@@ -3784,7 +3833,7 @@ declare namespace DMS {
|
|
|
3784
3833
|
*/
|
|
3785
3834
|
EngineName?: String;
|
|
3786
3835
|
/**
|
|
3787
|
-
* Indicates if
|
|
3836
|
+
* Indicates if change data capture (CDC) is supported.
|
|
3788
3837
|
*/
|
|
3789
3838
|
SupportsCDC?: Boolean;
|
|
3790
3839
|
/**
|
|
@@ -3792,7 +3841,7 @@ declare namespace DMS {
|
|
|
3792
3841
|
*/
|
|
3793
3842
|
EndpointType?: ReplicationEndpointTypeValue;
|
|
3794
3843
|
/**
|
|
3795
|
-
* The earliest
|
|
3844
|
+
* The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.
|
|
3796
3845
|
*/
|
|
3797
3846
|
ReplicationInstanceEngineMinimumVersion?: String;
|
|
3798
3847
|
/**
|
|
@@ -3823,7 +3872,7 @@ declare namespace DMS {
|
|
|
3823
3872
|
*/
|
|
3824
3873
|
Username?: String;
|
|
3825
3874
|
/**
|
|
3826
|
-
* The full Amazon Resource Name (ARN) of the IAM role that specifies
|
|
3875
|
+
* The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint. You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
|
|
3827
3876
|
*/
|
|
3828
3877
|
SecretsManagerAccessRoleArn?: String;
|
|
3829
3878
|
/**
|