# CreateDataProvider
<a name="API_CreateDataProvider"></a>

Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database. 

## Request Syntax
<a name="API_CreateDataProvider_RequestSyntax"></a>

```
{
   "DataProviderName": "string",
   "Description": "string",
   "Engine": "string",
   "Settings": { ... },
   "Tags": [ 
      { 
         "Key": "string",
         "ResourceArn": "string",
         "Value": "string"
      }
   ],
   "Virtual": boolean
}
```

## Request Parameters
<a name="API_CreateDataProvider_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DataProviderName](#API_CreateDataProvider_RequestSyntax) **   <a name="DMS-CreateDataProvider-request-DataProviderName"></a>
A user-friendly name for the data provider.  
Type: String  
Required: No

 ** [Description](#API_CreateDataProvider_RequestSyntax) **   <a name="DMS-CreateDataProvider-request-Description"></a>
A user-friendly description of the data provider.  
Type: String  
Required: No

 ** [Engine](#API_CreateDataProvider_RequestSyntax) **   <a name="DMS-CreateDataProvider-request-Engine"></a>
The type of database engine for the data provider. Valid values include `"aurora"`, `"aurora-postgresql"`, `"mysql"`, `"oracle"`, `"postgres"`, `"sqlserver"`, `redshift`, `mariadb`, `mongodb`, `db2`, `db2-zos`, `docdb`, and `sybase`. A value of `"aurora"` represents Amazon Aurora MySQL-Compatible Edition.  
Type: String  
Required: Yes

 ** [Settings](#API_CreateDataProvider_RequestSyntax) **   <a name="DMS-CreateDataProvider-request-Settings"></a>
The settings in JSON format for a data provider.  
Type: [DataProviderSettings](API_DataProviderSettings.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [Tags](#API_CreateDataProvider_RequestSyntax) **   <a name="DMS-CreateDataProvider-request-Tags"></a>
One or more tags to be assigned to the data provider.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [Virtual](#API_CreateDataProvider_RequestSyntax) **   <a name="DMS-CreateDataProvider-request-Virtual"></a>
Indicates whether the data provider is virtual.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateDataProvider_ResponseSyntax"></a>

```
{
   "DataProvider": { 
      "DataProviderArn": "string",
      "DataProviderCreationTime": "string",
      "DataProviderName": "string",
      "Description": "string",
      "Engine": "string",
      "Settings": { ... },
      "Virtual": boolean
   }
}
```

## Response Elements
<a name="API_CreateDataProvider_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataProvider](#API_CreateDataProvider_ResponseSyntax) **   <a name="DMS-CreateDataProvider-response-DataProvider"></a>
The data provider that was created.  
Type: [DataProvider](API_DataProvider.md) object

## Errors
<a name="API_CreateDataProvider_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedFault **   
 AWS DMS was denied access to the endpoint. Check that the role is correctly configured.    
 ** message **   

HTTP Status Code: 400

 ** FailedDependencyFault **   
A dependency threw an exception.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsFault **   
The resource you are attempting to create already exists.    
 ** message **   
  
 ** resourceArn **   

HTTP Status Code: 400

 ** ResourceQuotaExceededFault **   
The quota for this resource quota has been exceeded.    
 ** message **   

HTTP Status Code: 400

## Examples
<a name="API_CreateDataProvider_Examples"></a>

### Example
<a name="API_CreateDataProvider_Example_1"></a>

This example illustrates one usage of CreateDataProvider.

#### Sample Request
<a name="API_CreateDataProvider_Example_1_Request"></a>

```
{
        "DataProviderName": "sqlServer-dev",
        "Engine": "sqlserver",
        "Description": "description",
        "Settings": {
                "MicrosoftSqlServerSettings": {
                        "ServerName": "ServerName2",
                        "Port": 11112,
                        "DatabaseName": "DatabaseName",
                        "SslMode": "none"
                }
        },
        "Tags": [
                {
                    "Key": "access",
                    "Value": "authorizedusers"
                } 
        ]
}
```

## See Also
<a name="API_CreateDataProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dms-2016-01-01/CreateDataProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dms-2016-01-01/CreateDataProvider)