AWS Data Pipeline is no longer available to new customers. Existing customers of AWS Data Pipeline can continue to use the service as normal. [Learn more](https://aws.amazon.com/blogs/big-data/migrate-workloads-from-aws-data-pipeline/)
# Databases
The following are the AWS Data Pipeline database objects:
**Topics**
+ [JdbcDatabase](dp-object-jdbcdatabase.md)
+ [RdsDatabase](dp-object-rdsdatabase.md)
+ [RedshiftDatabase](dp-object-redshiftdatabase.md)
# JdbcDatabase
Defines a JDBC database.
## Example
The following is an example of this object type.
```
{
"id" : "MyJdbcDatabase",
"type" : "JdbcDatabase",
"connectionString" : "jdbc:redshift://hostname:portnumber/dbname",
"jdbcDriverClass" : "com.amazon.redshift.jdbc41.Driver",
"jdbcDriverJarUri" : "s3://redshift-downloads/drivers/RedshiftJDBC41-1.1.6.1006.jar",
"username" : "user_name",
"*password" : "my_password"
}
```
## Syntax
****
| Required Fields | Description | Slot Type |
| --- | --- | --- |
| connectionString | The JDBC connection string to access the database. | String |
| jdbcDriverClass | The driver class to load before establishing the JDBC connection. | String |
| \$1password | The password to supply. | String |
| username | The user name to supply when connecting to the database. | String |
****
| Optional Fields | Description | Slot Type |
| --- | --- | --- |
| databaseName | Name of the logical database to attach to | String |
| jdbcDriverJarUri | The location in Amazon S3 of the JDBC driver JAR file used to connect to the database. AWS Data Pipeline must have permission to read this JAR file. | String |
| jdbcProperties | Pairs of the form A=B that will be set as properties on JDBC connections for this database. | String |
| parent | Parent of the current object from which slots will be inherited. | Reference Object, e.g. "parent":\$1"ref":"myBaseObjectId"\$1 |
****
| Runtime Fields | Description | Slot Type |
| --- | --- | --- |
| @version | Pipeline version that the object was created with. | String |
****
| System Fields | Description | Slot Type |
| --- | --- | --- |
| @error | Error describing the ill-formed object. | String |
| @pipelineId | ID of the pipeline to which this object belongs. | String |
| @sphere | The sphere of an object denotes its place in the lifecycle: Component Objects give rise to Instance Objects which execute Attempt Objects. | String |
# RdsDatabase
Defines an Amazon RDS database.
**Note**
RdsDatabase does not support Aurora. Use [JdbcDatabase](dp-object-jdbcdatabase.md) for Aurora, instead.
## Example
The following is an example of this object type.
```
{
"id" : "MyRdsDatabase",
"type" : "RdsDatabase",
"region" : "us-east-1",
"username" : "user_name",
"*password" : "my_password",
"rdsInstanceId" : "my_db_instance_identifier"
}
```
For the Oracle engine, the `jdbcDriverJarUri` field is required and you can specify the following driver: `http://www.oracle.com/technetwork/database/features/jdbc/jdbc-drivers-12c-download-1958347.html`. For the SQL Server engine, the `jdbcDriverJarUri` field is required and you can specify the following driver: `https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774`. For the MySQL and PostgreSQL engines, the `jdbcDriverJarUri` field is optional.
## Syntax
****
| Required Fields | Description | Slot Type |
| --- | --- | --- |
| \$1password | The password to supply. | String |
| rdsInstanceId | The DBInstanceIdentifier property of the DB instance. | String |
| username | The user name to supply when connecting to the database. | String |
****
| Optional Fields | Description | Slot Type |
| --- | --- | --- |
| databaseName | Name of the logical database to attach to | String |
| jdbcDriverJarUri | The location in Amazon S3 of the JDBC driver JAR file used to connect to the database. AWS Data Pipeline must have permission to read this JAR file. For the MySQL and PostgreSQL engines, the default driver is used if this field is not specified, but you can override the default using this field. For the Oracle and SQL Server engines, this field is required. | String |
| jdbcProperties | Pairs of the form A=B that will be set as properties on JDBC connections for this database. | String |
| parent | Parent of the current object from which slots will be inherited. | Reference Object, for example, "parent":\$1"ref":"myBaseObjectId"\$1 |
| region | The code for the region where the database exists. For example, us-east-1. | String |
****
| Runtime Fields | Description | Slot Type |
| --- | --- | --- |
| @version | Pipeline version that the object was created with. | String |
****
| System Fields | Description | Slot Type |
| --- | --- | --- |
| @error | Error describing the ill-formed object. | String |
| @pipelineId | ID of the pipeline to which this object belongs. | String |
| @sphere | The sphere of an object denotes its place in the lifecycle: Component Objects give rise to Instance Objects which execute Attempt Objects. | String |
# RedshiftDatabase
Defines an Amazon Redshift database. `RedshiftDatabase` represents the properties of the database used by your pipeline.
## Example
The following is an example of this object type.
```
{
"id" : "MyRedshiftDatabase",
"type" : "RedshiftDatabase",
"clusterId" : "myRedshiftClusterId",
"username" : "user_name",
"*password" : "my_password",
"databaseName" : "database_name"
}
```
By default, the object uses the Postgres driver, which requires the `clusterId` field. To use the Amazon Redshift driver, specify the Amazon Redshift database connection string from the Amazon Redshift console (starts with "jdbc:redshift:") in the `connectionString` field instead.
## Syntax
****
| Required Fields | Description | Slot Type |
| --- | --- | --- |
| \$1password | The password to supply. | String |
| username | The user name to supply when connecting to the database. | String |
****
| Required Group (One of the following is required) | Description | Slot Type |
| --- | --- | --- |
| clusterId | The identifier provided by the user when the Amazon Redshift cluster was created. For example, if the endpoint for your Amazon Redshift cluster is mydb.example.us-east-1.redshift.amazonaws.com, the correct identifier is mydb. In the Amazon Redshift console, you can get this value from Cluster Identifier or Cluster Name. | String |
| connectionString | The JDBC endpoint for connecting to an Amazon Redshift instance owned by an account different than the pipeline. You can't specify both connectionString and clusterId. | String |
****
| Optional Fields | Description | Slot Type |
| --- | --- | --- |
| databaseName | Name of the logical database to attach to. | String |
| jdbcProperties | Pairs of the form A=B to be set as properties on JDBC connections for this database. | String |
| parent | Parent of the current object from which slots are inherited. | Reference Object, for example, "parent":\$1"ref":"myBaseObjectId"\$1 |
| region | The code for the region where the database exists. For example, us-east-1. | Enumeration |
****
| Runtime Fields | Description | Slot Type |
| --- | --- | --- |
| @version | Pipeline version that the object was created with. | String |
****
| System Fields | Description | Slot Type |
| --- | --- | --- |
| @error | Error describing the ill-formed object. | String |
| @pipelineId | ID of the pipeline to which this object belongs. | String |
| @sphere | The sphere of an object denotes its place in the lifecycle: Component Objects give rise to Instance Objects which execute Attempt Objects. | String |