Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
Request Syntax
{
"DataProviderName": "string",
"Description": "string",
"Engine": "string",
"Settings": { ... },
"Tags": [
{
"Key": "string",
"ResourceArn": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DataProviderName
-
A user-friendly name for the data provider.
Type: String
Required: No
- Description
-
A user-friendly description of the data provider.
Type: String
Required: No
- Engine
-
The type of database engine for the data provider. Valid values include
"aurora","aurora-postgresql","mysql","oracle","postgres","sqlserver",redshift,mariadb,mongodb,db2,db2-zosanddocdb. A value of"aurora"represents Amazon Aurora MySQL-Compatible Edition.Type: String
Required: Yes
- Settings
-
The settings in JSON format for a data provider.
Type: DataProviderSettings object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- Tags
-
One or more tags to be assigned to the data provider.
Type: Array of Tag objects
Required: No
Response Syntax
{
"DataProvider": {
"DataProviderArn": "string",
"DataProviderCreationTime": "string",
"DataProviderName": "string",
"Description": "string",
"Engine": "string",
"Settings": { ... }
}
}Response Elements
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
-
The data provider that was created.
Type: DataProvider object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- FailedDependencyFault
-
A dependency threw an exception.
HTTP Status Code: 400
- ResourceAlreadyExistsFault
-
The resource you are attempting to create already exists.
HTTP Status Code: 400
- ResourceQuotaExceededFault
-
The quota for this resource quota has been exceeded.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreateDataProvider.
Sample Request
{
"DataProviderName": "sqlServer-dev",
"Engine": "sqlserver",
"Description": "description",
"Settings": {
"MicrosoftSqlServerSettings": {
"ServerName": "ServerName2",
"Port": 11112,
"DatabaseName": "DatabaseName",
"SslMode": "none"
}
},
"Tags": [
{
"Key": "access",
"Value": "authorizedusers"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
