DatabaseMigration class

Database Migration Service (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

DatabaseMigration({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 DMS resource, including replication instance, endpoint, subnet 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).
batchStartRecommendations({List<StartRecommendationsRequestEntry>? data}) → Future<BatchStartRecommendationsResponse>
StartRecommendations
cancelMetadataModelConversion({required String migrationProjectIdentifier, required String requestIdentifier}) → Future<CancelMetadataModelConversionResponse>
Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion.
cancelMetadataModelCreation({required String migrationProjectIdentifier, required String requestIdentifier}) → Future<CancelMetadataModelCreationResponse>
Cancels a single metadata model creation operation that was started with StartMetadataModelCreation.
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.
createDataMigration({required MigrationTypeValue dataMigrationType, required String migrationProjectIdentifier, required String serviceAccessRoleArn, String? dataMigrationName, bool? enableCloudwatchLogs, int? numberOfJobs, String? selectionRules, List<SourceDataSetting>? sourceDataSettings, List<Tag>? tags, List<TargetDataSetting>? targetDataSettings}) → Future<CreateDataMigrationResponse>
Creates a data migration using the provided settings.
createDataProvider({required String engine, required DataProviderSettings settings, String? dataProviderName, String? description, List<Tag>? tags, bool? virtual}) → Future<CreateDataProviderResponse>
Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
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, GcpMySQLSettings? gcpMySQLSettings, IBMDb2Settings? iBMDb2Settings, KafkaSettings? kafkaSettings, KinesisSettings? kinesisSettings, String? kmsKeyId, MicrosoftSQLServerSettings? microsoftSQLServerSettings, MongoDbSettings? mongoDbSettings, MySQLSettings? mySQLSettings, NeptuneSettings? neptuneSettings, OracleSettings? oracleSettings, String? password, int? port, PostgreSQLSettings? postgreSQLSettings, RedisSettings? redisSettings, RedshiftSettings? redshiftSettings, String? resourceIdentifier, S3Settings? s3Settings, String? serverName, String? serviceAccessRoleArn, DmsSslModeValue? sslMode, SybaseSettings? sybaseSettings, List<Tag>? tags, TimestreamSettings? timestreamSettings, 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 DMS event notification subscription.
createFleetAdvisorCollector({required String collectorName, required String s3BucketName, required String serviceAccessRoleArn, String? description}) → Future<CreateFleetAdvisorCollectorResponse>
May throw AccessDeniedFault. May throw InvalidResourceStateFault. May throw ResourceQuotaExceededFault. May throw S3AccessDeniedFault. May throw S3ResourceNotFoundFault.
createInstanceProfile({String? availabilityZone, String? description, String? instanceProfileName, String? kmsKeyArn, String? networkType, bool? publiclyAccessible, String? subnetGroupIdentifier, List<Tag>? tags, List<String>? vpcSecurityGroups}) → Future<CreateInstanceProfileResponse>
Creates the instance profile using the specified parameters.
createMigrationProject({required String instanceProfileIdentifier, required List<DataProviderDescriptorDefinition> sourceDataProviderDescriptors, required List<DataProviderDescriptorDefinition> targetDataProviderDescriptors, String? description, String? migrationProjectName, SCApplicationAttributes? schemaConversionApplicationAttributes, List<Tag>? tags, String? transformationRules}) → Future<CreateMigrationProjectResponse>
Creates the migration project using the specified parameters.
createReplicationConfig({required ComputeConfig computeConfig, required String replicationConfigIdentifier, required MigrationTypeValue replicationType, required String sourceEndpointArn, required String tableMappings, required String targetEndpointArn, String? replicationSettings, String? resourceIdentifier, String? supplementalSettings, List<Tag>? tags}) → Future<CreateReplicationConfigResponse>
Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.
createReplicationInstance({required String replicationInstanceClass, required String replicationInstanceIdentifier, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, String? dnsNameServers, String? engineVersion, KerberosAuthenticationSettings? kerberosAuthenticationSettings, String? kmsKeyId, bool? multiAZ, String? networkType, 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.
deleteDataMigration({required String dataMigrationIdentifier}) → Future<DeleteDataMigrationResponse>
Deletes the specified data migration.
deleteDataProvider({required String dataProviderIdentifier}) → Future<DeleteDataProviderResponse>
Deletes the specified data provider.
deleteEndpoint({required String endpointArn}) → Future<DeleteEndpointResponse>
Deletes the specified endpoint.
deleteEventSubscription({required String subscriptionName}) → Future<DeleteEventSubscriptionResponse>
Deletes an DMS event subscription.
deleteFleetAdvisorCollector({required String collectorReferencedId}) → Future<void>
May throw AccessDeniedFault. May throw CollectorNotFoundFault. May throw InvalidResourceStateFault.
deleteFleetAdvisorDatabases({required List<String> databaseIds}) → Future<DeleteFleetAdvisorDatabasesResponse>
May throw AccessDeniedFault. May throw InvalidOperationFault. May throw ResourceNotFoundFault.
deleteInstanceProfile({required String instanceProfileIdentifier}) → Future<DeleteInstanceProfileResponse>
Deletes the specified instance profile.
deleteMigrationProject({required String migrationProjectIdentifier}) → Future<DeleteMigrationProjectResponse>
Deletes the specified migration project.
deleteReplicationConfig({required String replicationConfigArn}) → Future<DeleteReplicationConfigResponse>
Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
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 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.
describeApplicableIndividualAssessments({String? marker, int? maxRecords, MigrationTypeValue? migrationType, String? replicationConfigArn, 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.
describeConversionConfiguration({required String migrationProjectIdentifier}) → Future<DescribeConversionConfigurationResponse>
Returns configuration parameters for a schema conversion project.
describeDataMigrations({List<Filter>? filters, String? marker, int? maxRecords, bool? withoutSettings, bool? withoutStatistics}) → Future<DescribeDataMigrationsResponse>
Returns information about data migrations.
describeDataProviders({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeDataProvidersResponse>
Returns a paginated list of data providers for your account in the current region.
describeEndpoints({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEndpointsResponse>
Returns information about the endpoints for your account in the current region.
describeEndpointSettings({required String engineName, String? marker, int? maxRecords}) → Future<DescribeEndpointSettingsResponse>
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
describeEndpointTypes({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEndpointTypesResponse>
Returns information about the type of endpoints available.
describeEngineVersions({String? marker, int? maxRecords}) → Future<DescribeEngineVersionsResponse>
Returns information about the replication instance versions used in the project.
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 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 DMS events, see Working with Events and Notifications in the Database Migration Service 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.
describeExtensionPackAssociations({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeExtensionPackAssociationsResponse>
Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
describeFleetAdvisorCollectors({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<DescribeFleetAdvisorCollectorsResponse>
May throw InvalidResourceStateFault.
describeFleetAdvisorDatabases({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<DescribeFleetAdvisorDatabasesResponse>
May throw InvalidResourceStateFault.
describeFleetAdvisorLsaAnalysis({int? maxRecords, String? nextToken}) → Future<DescribeFleetAdvisorLsaAnalysisResponse>
May throw InvalidResourceStateFault.
describeFleetAdvisorSchemaObjectSummary({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<DescribeFleetAdvisorSchemaObjectSummaryResponse>
May throw InvalidResourceStateFault.
describeFleetAdvisorSchemas({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<DescribeFleetAdvisorSchemasResponse>
May throw InvalidResourceStateFault.
describeInstanceProfiles({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeInstanceProfilesResponse>
Returns a paginated list of instance profiles for your account in the current region.
describeMetadataModel({required String migrationProjectIdentifier, required OriginTypeValue origin, required String selectionRules}) → Future<DescribeMetadataModelResponse>
Gets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable.
describeMetadataModelAssessments({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMetadataModelAssessmentsResponse>
Returns a paginated list of metadata model assessments for your account in the current region.
describeMetadataModelChildren({required String migrationProjectIdentifier, required OriginTypeValue origin, required String selectionRules, String? marker, int? maxRecords}) → Future<DescribeMetadataModelChildrenResponse>
Gets a list of child metadata models for the specified metadata model in the database hierarchy.
describeMetadataModelConversions({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMetadataModelConversionsResponse>
Returns a paginated list of metadata model conversions for a migration project.
describeMetadataModelCreations({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMetadataModelCreationsResponse>
Returns a paginated list of metadata model creation requests for a migration project.
describeMetadataModelExportsAsScript({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMetadataModelExportsAsScriptResponse>
Returns a paginated list of metadata model exports.
describeMetadataModelExportsToTarget({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMetadataModelExportsToTargetResponse>
Returns a paginated list of metadata model exports.
describeMetadataModelImports({required String migrationProjectIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMetadataModelImportsResponse>
Returns a paginated list of metadata model imports.
describeMigrationProjects({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeMigrationProjectsResponse>
Returns a paginated list of migration projects for your account in the current region.
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>
Returns a list of upcoming maintenance events for replication instances in your account in the current Region.
describeRecommendationLimitations({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<DescribeRecommendationLimitationsResponse>
May throw AccessDeniedFault. May throw InvalidResourceStateFault.
describeRecommendations({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<DescribeRecommendationsResponse>
May throw AccessDeniedFault. May throw InvalidResourceStateFault.
describeRefreshSchemasStatus({required String endpointArn}) → Future<DescribeRefreshSchemasStatusResponse>
Returns the status of the RefreshSchemas operation.
describeReplicationConfigs({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationConfigsResponse>
Returns one or more existing DMS Serverless replication configurations as a list of structures.
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.
describeReplications({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationsResponse>
Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
describeReplicationSubnetGroups({List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationSubnetGroupsResponse>
Returns information about the replication subnet groups.
describeReplicationTableStatistics({required String replicationConfigArn, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeReplicationTableStatisticsResponse>
Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.
describeReplicationTaskAssessmentResults({String? marker, int? maxRecords, String? replicationTaskArn}) → Future<DescribeReplicationTaskAssessmentResultsResponse>
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. 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.
exportMetadataModelAssessment({required String migrationProjectIdentifier, required String selectionRules, List<AssessmentReportType>? assessmentReportTypes, String? fileName}) → Future<ExportMetadataModelAssessmentResponse>
Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.
getTargetSelectionRules({required String migrationProjectIdentifier, required String selectionRules}) → Future<GetTargetSelectionRulesResponse>
Converts source selection rules into their target counterparts for schema conversion operations.
importCertificate({required String certificateIdentifier, String? certificatePem, Uint8List? certificateWallet, String? kmsKeyId, List<Tag>? tags}) → Future<ImportCertificateResponse>
Uploads the specified certificate.
listTagsForResource({String? resourceArn, List<String>? resourceArnList}) → Future<ListTagsForResourceResponse>
Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.
modifyConversionConfiguration({required String conversionConfiguration, required String migrationProjectIdentifier}) → Future<ModifyConversionConfigurationResponse>
Modifies the specified schema conversion configuration using the provided parameters.
modifyDataMigration({required String dataMigrationIdentifier, String? dataMigrationName, MigrationTypeValue? dataMigrationType, bool? enableCloudwatchLogs, int? numberOfJobs, String? selectionRules, String? serviceAccessRoleArn, List<SourceDataSetting>? sourceDataSettings, List<TargetDataSetting>? targetDataSettings}) → Future<ModifyDataMigrationResponse>
Modifies an existing DMS data migration.
modifyDataProvider({required String dataProviderIdentifier, String? dataProviderName, String? description, String? engine, bool? exactSettings, DataProviderSettings? settings, bool? virtual}) → Future<ModifyDataProviderResponse>
Modifies the specified data provider using the provided settings.
modifyEndpoint({required String endpointArn, String? certificateArn, String? databaseName, DmsTransferSettings? dmsTransferSettings, DocDbSettings? docDbSettings, DynamoDbSettings? dynamoDbSettings, ElasticsearchSettings? elasticsearchSettings, String? endpointIdentifier, ReplicationEndpointTypeValue? endpointType, String? engineName, bool? exactSettings, String? externalTableDefinition, String? extraConnectionAttributes, GcpMySQLSettings? gcpMySQLSettings, IBMDb2Settings? iBMDb2Settings, KafkaSettings? kafkaSettings, KinesisSettings? kinesisSettings, MicrosoftSQLServerSettings? microsoftSQLServerSettings, MongoDbSettings? mongoDbSettings, MySQLSettings? mySQLSettings, NeptuneSettings? neptuneSettings, OracleSettings? oracleSettings, String? password, int? port, PostgreSQLSettings? postgreSQLSettings, RedisSettings? redisSettings, RedshiftSettings? redshiftSettings, S3Settings? s3Settings, String? serverName, String? serviceAccessRoleArn, DmsSslModeValue? sslMode, SybaseSettings? sybaseSettings, TimestreamSettings? timestreamSettings, 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 DMS event notification subscription.
modifyInstanceProfile({required String instanceProfileIdentifier, String? availabilityZone, String? description, String? instanceProfileName, String? kmsKeyArn, String? networkType, bool? publiclyAccessible, String? subnetGroupIdentifier, List<String>? vpcSecurityGroups}) → Future<ModifyInstanceProfileResponse>
Modifies the specified instance profile using the provided parameters.
modifyMigrationProject({required String migrationProjectIdentifier, String? description, String? instanceProfileIdentifier, String? migrationProjectName, SCApplicationAttributes? schemaConversionApplicationAttributes, List<DataProviderDescriptorDefinition>? sourceDataProviderDescriptors, List<DataProviderDescriptorDefinition>? targetDataProviderDescriptors, String? transformationRules}) → Future<ModifyMigrationProjectResponse>
Modifies the specified migration project using the provided parameters.
modifyReplicationConfig({required String replicationConfigArn, ComputeConfig? computeConfig, String? replicationConfigIdentifier, String? replicationSettings, MigrationTypeValue? replicationType, String? sourceEndpointArn, String? supplementalSettings, String? tableMappings, String? targetEndpointArn}) → Future<ModifyReplicationConfigResponse>
Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it.
modifyReplicationInstance({required String replicationInstanceArn, int? allocatedStorage, bool? allowMajorVersionUpgrade, bool? applyImmediately, bool? autoMinorVersionUpgrade, String? engineVersion, KerberosAuthenticationSettings? kerberosAuthenticationSettings, bool? multiAZ, String? networkType, 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 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, bool? forcePlannedFailover}) → 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.
reloadReplicationTables({required String replicationConfigArn, required List<TableToReload> tablesToReload, ReloadOptionValue? reloadOption}) → Future<ReloadReplicationTablesResponse>
Reloads the target database table with the source data for a given DMS Serverless replication configuration.
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 DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.
runFleetAdvisorLsaAnalysis() → Future<RunFleetAdvisorLsaAnalysisResponse>
May throw InvalidResourceStateFault. May throw ResourceNotFoundFault.
startDataMigration({required String dataMigrationIdentifier, required StartReplicationMigrationTypeValue startType}) → Future<StartDataMigrationResponse>
Starts the specified data migration.
startExtensionPackAssociation({required String migrationProjectIdentifier}) → Future<StartExtensionPackAssociationResponse>
Applies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
startMetadataModelAssessment({required String migrationProjectIdentifier, required String selectionRules}) → Future<StartMetadataModelAssessmentResponse>
Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.
startMetadataModelConversion({required String migrationProjectIdentifier, required String selectionRules}) → Future<StartMetadataModelConversionResponse>
Converts your source database objects to a format compatible with the target database.
startMetadataModelCreation({required String metadataModelName, required String migrationProjectIdentifier, required MetadataModelProperties properties, required String selectionRules}) → Future<StartMetadataModelCreationResponse>
Creates source metadata model of the given type with the specified properties for schema conversion operations.
startMetadataModelExportAsScript({required String migrationProjectIdentifier, required OriginTypeValue origin, required String selectionRules, String? fileName}) → Future<StartMetadataModelExportAsScriptResponse>
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
startMetadataModelExportToTarget({required String migrationProjectIdentifier, required String selectionRules, bool? overwriteExtensionPack}) → Future<StartMetadataModelExportToTargetResponse>
Applies converted database objects to your target database.
startMetadataModelImport({required String migrationProjectIdentifier, required OriginTypeValue origin, required String selectionRules, bool? refresh}) → Future<StartMetadataModelImportResponse>
Loads the metadata for all the dependent database objects of the parent object.
startRecommendations({required String databaseId, required RecommendationSettings settings}) → Future<void>
You can create recommendations for multiple source databases using BatchStartRecommendations.
startReplication({required String replicationConfigArn, required String startReplicationType, String? cdcStartPosition, DateTime? cdcStartTime, String? cdcStopPosition, String? premigrationAssessmentSettings}) → Future<StartReplicationResponse>
For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.
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, List<Tag>? tags}) → Future<StartReplicationTaskAssessmentRunResponse>
Starts a new premigration assessment run for one or more individual assessments of a migration task.
stopDataMigration({required String dataMigrationIdentifier}) → Future<StopDataMigrationResponse>
Stops the specified data migration.
stopReplication({required String replicationConfigArn}) → Future<StopReplicationResponse>
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.
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
updateSubscriptionsToEventBridge({bool? forceMove}) → Future<UpdateSubscriptionsToEventBridgeResponse>
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.5 or higher. If any replication instances are from versions earlier than 3.4.5, the operation raises an error and tells you to upgrade these instances to version 3.4.5 or higher. To enable migration regardless of version, set the Force option to true. However, if you don't upgrade instances earlier than version 3.4.5, some types of events might not be available when you use Amazon EventBridge.

Operators

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