aws dms create-data-provider

Creates a data provider using the provided settings. AWS CLI reference

2 examples 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To create a Microsoft SQL Server data provider

The following create-data-provider example creates a Microsoft SQL Server data provider.

aws dms create-data-provider --data-provider-name example-data-provider --engine sqlserver --description "Example data provider for documentation" --settings MicrosoftSqlServerSettings={ServerName=example-source-server.us-west-2.rds.amazonaws.com,Port=1433,DatabaseName=ExampleDatabase,SslMode=verify-full,CertificateArn=arn:aws:dms:us-west-2:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS}

Identify

--data-provider-nameA user-friendly name for the data provider.

--engineThe type of database engine for the data provider.

--descriptionA user-friendly description of the data provider.

--settingsThe settings in JSON format for a data provider.

Its output

{
    "DataProvider": {
        "DataProviderName": "example-data-provider",
        "DataProviderArn": "arn:aws:dms:us-west-2:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "Description": "Example data provider for documentation",
        "Engine": "sqlserver",
        "Settings": {
            "MicrosoftSqlServerSettings": {
                "ServerName": "example-source-server.us-west-2.rds.amazonaws.com",
                "Port": 1433,
                "DatabaseName": "ExampleDatabase",
                "SslMode": "verify-full",
                "CertificateArn": "arn:aws:dms:us-west-2:123456789012:cert:EXAMPLEABCDEFGHIJKLMNOPQRS"
            }
        }
    }
}

For more information, see Working with data providers in the AWS Database Migration Service User Guide.

Example 2: To create a virtual data provider

The following create-data-provider example creates a virtual data provider, which doesn't require a connection to the database.

aws dms create-data-provider --data-provider-name example-virtual-data-provider --engine aurora-postgresql --description "Example data provider for documentation" --virtual --settings PostgreSqlSettings={ServerName=virtual,Port=5432,DatabaseName=virtual,SslMode=none}

Identify

--data-provider-nameA user-friendly name for the data provider.

--engineThe type of database engine for the data provider.

--descriptionA user-friendly description of the data provider.

--virtualIndicates whether the data provider is virtual.

--settingsThe settings in JSON format for a data provider.

Its output

{
    "DataProvider": {
        "DataProviderName": "example-virtual-data-provider",
        "DataProviderArn": "arn:aws:dms:us-west-2:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "DataProviderCreationTime": "2026-01-09T12:30:00.000000+00:00",
        "Description": "Example data provider for documentation",
        "Engine": "aurora-postgresql",
        "Virtual": true,
        "Settings": {
            "PostgreSqlSettings": {
                "ServerName": "virtual",
                "Port": 5432,
                "DatabaseName": "virtual",
                "SslMode": "none"
            }
        }
    }
}

For more information, see Working with virtual data providers in the AWS Database Migration Service User Guide.

Options

6 in the AWS CLI reference

--data-provider-nameA user-friendly name for the data provider.

--descriptionA user-friendly description of the data provider.

--engineThe type of database engine for the data provider.

--settingsThe settings in JSON format for a data provider.

--tagsOne or more tags to be assigned to the data provider.

--virtualIndicates whether the data provider is virtual.