DatabaseMigrationService class

AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.

Constructors

DatabaseMigrationService({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addTagsToResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Adds metadata tags to an AWS 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.
applyPendingMaintenanceAction({required String applyAction, required String optInType, required String replicationInstanceArn}) → Future<ApplyPendingMaintenanceActionResponse>
Applies a pending maintenance action to a resource (for example, to a replication instance).
cancelReplicationTaskAssessmentRun({required String replicationTaskAssessmentRunArn}) → Future<CancelReplicationTaskAssessmentRunResponse>
Cancels a single premigration assessment run.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createEndpoint({required String endpointIdentifier, required ReplicationEndpointTypeValue endpointType, required String engineName, String? certificateArn, String? databaseName, DmsTransferSettings? dmsTransferSettings, DocDbSettings? docDbSettings, DynamoDbSettings? dynamoDbSettings, ElasticsearchSettings? elasticsearchSettings, String? externalTableDefinition, String? extraConnectionAttributes, IBMDb2Settings? iBMDb2Settings, KafkaSettings? kafkaSettings, KinesisSettings? kinesisSettings, String? kmsKeyId, MicrosoftSQLServerSettings? microsoftSQLServerSettings, MongoDbSettings? mongoDbSettings, MySQLSettings? mySQLSettings, NeptuneSettings? neptuneSettings, OracleSettings? oracleSettings, String? password, int? port, PostgreSQLSettings? postgreSQLSettings, RedshiftSettings? redshiftSettings, String? resourceIdentifier, S3Settings? s3Settings, String? serverName, String? serviceAccessRoleArn, DmsSslModeValue? sslMode, SybaseSettings? sybaseSettings, List<Tag>? tags, String? username}) → Future<CreateEndpointResponse>
Creates an endpoint using the provided settings.
createEventSubscription({required String snsTopicArn, required String subscriptionName, bool? enabled, List<String>? eventCategories, List<String>? sourceIds, String? sourceType, List<Tag>? tags}) → Future<CreateEventSubscriptionResponse>
Creates an AWS DMS event notification subscription.
createReplicationInstance({required String replicationInstanceClass, required String replicationInstanceIdentifier, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, String? dnsNameServers, String? engineVersion, String? kmsKeyId, bool? multiAZ, String? preferredMaintenanceWindow, bool? publiclyAccessible, String? replicationSubnetGroupIdentifier, String? resourceIdentifier, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<CreateReplicationInstanceResponse>
Creates the replication instance using the specified parameters.
createReplicationSubnetGroup({required String replicationSubnetGroupDescription, required String replicationSubnetGroupIdentifier, required List<String> subnetIds, List<Tag>? tags}) → Future<CreateReplicationSubnetGroupResponse>
Creates a replication subnet group given a list of the subnet IDs in a VPC.
createReplicationTask({required MigrationTypeValue migrationType, required String replicationInstanceArn, required String replicationTaskIdentifier, required String sourceEndpointArn, required String tableMappings, required String targetEndpointArn, String? cdcStartPosition, DateTime? cdcStartTime, String? cdcStopPosition, String? replicationTaskSettings, String? resourceIdentifier, List<Tag>? tags, String? taskData}) → Future<CreateReplicationTaskResponse>
Creates a replication task using the specified parameters.
deleteCertificate({required String certificateArn}) → Future<DeleteCertificateResponse>
Deletes the specified certificate.
deleteConnection({required String endpointArn, required String replicationInstanceArn}) → Future<DeleteConnectionResponse>
Deletes the connection between a replication instance and an endpoint.
deleteEndpoint({required String endpointArn}) → Future<DeleteEndpointResponse>
Deletes the specified endpoint.
deleteEventSubscription({required String subscriptionName}) → Future<DeleteEventSubscriptionResponse>
Deletes an AWS DMS event subscription.
deleteReplicationInstance({required String replicationInstanceArn}) → Future<DeleteReplicationInstanceResponse>
Deletes the specified replication instance.
deleteReplicationSubnetGroup({required String replicationSubnetGroupIdentifier}) → Future<void>
Deletes a subnet group.
deleteReplicationTask({required String replicationTaskArn}) → Future<DeleteReplicationTaskResponse>
Deletes the specified replication task.
deleteReplicationTaskAssessmentRun({required String replicationTaskAssessmentRunArn}) → Future<DeleteReplicationTaskAssessmentRunResponse>
Deletes the record of a single premigration assessment run.
describeAccountAttributes() → Future<DescribeAccountAttributesResponse>
Lists all of the AWS DMS attributes for a customer account. These attributes include AWS 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.
describeApplicableIndividualAssessments({String? marker, int? maxRecords, MigrationTypeValue? migrationType, String? replicationInstanceArn, String? replicationTaskArn, String? sourceEngineName, String? targetEngineName}) → Future<DescribeApplicableIndividualAssessmentsResponse>
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
describeCertificates({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeCertificatesResponse>
Provides a description of the certificate.
describeConnections({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeConnectionsResponse>
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
describeEndpoints({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEndpointsResponse>
Returns information about the endpoints for your account in the current region.
describeEndpointTypes({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEndpointTypesResponse>
Returns information about the type of endpoints available.
describeEventCategories({List<Filter>? filters, String? sourceType}) → Future<DescribeEventCategoriesResponse>
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 AWS Database Migration Service User Guide.
describeEvents({int? duration, DateTime? endTime, List<String>? eventCategories, List<Filter>? filters, String? marker, int? maxRecords, String? sourceIdentifier, SourceType? sourceType, DateTime? startTime}) → Future<DescribeEventsResponse>
Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
describeEventSubscriptions({List<Filter>? filters, String? marker, int? maxRecords, String? subscriptionName}) → Future<DescribeEventSubscriptionsResponse>
Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
describeOrderableReplicationInstances({String? marker, int? maxRecords}) → Future<DescribeOrderableReplicationInstancesResponse>
Returns information about the replication instance types that can be created in the specified region.
describePendingMaintenanceActions({List<Filter>? filters, String? marker, int? maxRecords, String? replicationInstanceArn}) → Future<DescribePendingMaintenanceActionsResponse>
For internal use only
describeRefreshSchemasStatus({required String endpointArn}) → Future<DescribeRefreshSchemasStatusResponse>
Returns the status of the RefreshSchemas operation.
describeReplicationInstances({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationInstancesResponse>
Returns information about replication instances for your account in the current region.
describeReplicationInstanceTaskLogs({required String replicationInstanceArn, String? marker, int? maxRecords}) → Future<DescribeReplicationInstanceTaskLogsResponse>
Returns information about the task logs for the specified task.
describeReplicationSubnetGroups({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationSubnetGroupsResponse>
Returns information about the replication subnet groups.
describeReplicationTaskAssessmentResults({String? marker, int? maxRecords, String? replicationTaskArn}) → Future<DescribeReplicationTaskAssessmentResultsResponse>
Returns the task assessment results from Amazon S3. This action always returns the latest results.
describeReplicationTaskAssessmentRuns({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationTaskAssessmentRunsResponse>
Returns a paginated list of premigration assessment runs based on filter settings.
describeReplicationTaskIndividualAssessments({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationTaskIndividualAssessmentsResponse>
Returns a paginated list of individual assessments based on filter settings.
describeReplicationTasks({List<Filter>? filters, String? marker, int? maxRecords, bool? withoutSettings}) → Future<DescribeReplicationTasksResponse>
Returns information about replication tasks for your account in the current region.
describeSchemas({required String endpointArn, String? marker, int? maxRecords}) → Future<DescribeSchemasResponse>
Returns information about the schema for the specified endpoint.
describeTableStatistics({required String replicationTaskArn, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeTableStatisticsResponse>
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
importCertificate({required String certificateIdentifier, String? certificatePem, Uint8List? certificateWallet, List<Tag>? tags}) → Future<ImportCertificateResponse>
Uploads the specified certificate.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists all metadata tags attached to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
modifyEndpoint({required String endpointArn, String? certificateArn, String? databaseName, DmsTransferSettings? dmsTransferSettings, DocDbSettings? docDbSettings, DynamoDbSettings? dynamoDbSettings, ElasticsearchSettings? elasticsearchSettings, String? endpointIdentifier, ReplicationEndpointTypeValue? endpointType, String? engineName, String? externalTableDefinition, String? extraConnectionAttributes, IBMDb2Settings? iBMDb2Settings, KafkaSettings? kafkaSettings, KinesisSettings? kinesisSettings, MicrosoftSQLServerSettings? microsoftSQLServerSettings, MongoDbSettings? mongoDbSettings, MySQLSettings? mySQLSettings, NeptuneSettings? neptuneSettings, OracleSettings? oracleSettings, String? password, int? port, PostgreSQLSettings? postgreSQLSettings, RedshiftSettings? redshiftSettings, S3Settings? s3Settings, String? serverName, String? serviceAccessRoleArn, DmsSslModeValue? sslMode, SybaseSettings? sybaseSettings, String? username}) → Future<ModifyEndpointResponse>
Modifies the specified endpoint.
modifyEventSubscription({required String subscriptionName, bool? enabled, List<String>? eventCategories, String? snsTopicArn, String? sourceType}) → Future<ModifyEventSubscriptionResponse>
Modifies an existing AWS DMS event notification subscription.
modifyReplicationInstance({required String replicationInstanceArn, int? allocatedStorage, bool? allowMajorVersionUpgrade, bool? applyImmediately, bool? autoMinorVersionUpgrade, String? engineVersion, bool? multiAZ, String? preferredMaintenanceWindow, String? replicationInstanceClass, String? replicationInstanceIdentifier, List<String>? vpcSecurityGroupIds}) → Future<ModifyReplicationInstanceResponse>
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
modifyReplicationSubnetGroup({required String replicationSubnetGroupIdentifier, required List<String> subnetIds, String? replicationSubnetGroupDescription}) → Future<ModifyReplicationSubnetGroupResponse>
Modifies the settings for the specified replication subnet group.
modifyReplicationTask({required String replicationTaskArn, String? cdcStartPosition, DateTime? cdcStartTime, String? cdcStopPosition, MigrationTypeValue? migrationType, String? replicationTaskIdentifier, String? replicationTaskSettings, String? tableMappings, String? taskData}) → Future<ModifyReplicationTaskResponse>
Modifies the specified replication task.
moveReplicationTask({required String replicationTaskArn, required String targetReplicationInstanceArn}) → Future<MoveReplicationTaskResponse>
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 AWS DMS version as the current replication instance.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebootReplicationInstance({required String replicationInstanceArn, bool? forceFailover}) → Future<RebootReplicationInstanceResponse>
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
refreshSchemas({required String endpointArn, required String replicationInstanceArn}) → Future<RefreshSchemasResponse>
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
reloadTables({required String replicationTaskArn, required List<TableToReload> tablesToReload, ReloadOptionValue? reloadOption}) → Future<ReloadTablesResponse>
Reloads the target database table with the source data.
removeTagsFromResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes metadata tags from an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
startReplicationTask({required String replicationTaskArn, required StartReplicationTaskTypeValue startReplicationTaskType, String? cdcStartPosition, DateTime? cdcStartTime, String? cdcStopPosition}) → Future<StartReplicationTaskResponse>
Starts the replication task.
startReplicationTaskAssessment({required String replicationTaskArn}) → Future<StartReplicationTaskAssessmentResponse>
Starts the replication task assessment for unsupported data types in the source database.
startReplicationTaskAssessmentRun({required String assessmentRunName, required String replicationTaskArn, required String resultLocationBucket, required String serviceAccessRoleArn, List<String>? exclude, List<String>? includeOnly, String? resultEncryptionMode, String? resultKmsKeyArn, String? resultLocationFolder}) → Future<StartReplicationTaskAssessmentRunResponse>
Starts a new premigration assessment run for one or more individual assessments of a migration task.
stopReplicationTask({required String replicationTaskArn}) → Future<StopReplicationTaskResponse>
Stops the replication task.
testConnection({required String endpointArn, required String replicationInstanceArn}) → Future<TestConnectionResponse>
Tests the connection between the replication instance and the endpoint.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited