This API provides simple restful API access to Amazon's RDS service.
This API uses the standard format for input and output of parameters as defined by the AWS SDK (for reference see https://docs.aws.amazon.com/sdk-for-go/api/service/rds/).
You can define multiple accounts in your config.json file which are mapped to endpoints by the API and allow RDS instances to be created in different AWS accounts. See example config
In each account you can optionally define certain defaults that will be used if those parameters are not specified in the POST request when creating a database:
defaultSubnetGroup- the subnet group that will be used if one is not givendefaultDBParameterGroupName- map of ParameterGroupFamily to ParameterGroupName'sdefaultDBClusterParameterGroupName- map of ParameterGroupFamily to ClusterParameterGroupName's
Note that any default parameters need to refer to existing resources (groups), i.e. they need to be created separately outside of this API.
Authentication is accomplished via a pre-shared key (hashed string) in the X-Auth-Token header.
You can specify both database cluster and instance information in the POST to create just an instance or a cluster and a member instance.
For example, to create a single Postgres database instance:
POST http://127.0.0.1:3000/v1/rds/{account}
{
"Instance":{
"AllocatedStorage":20,
"AutoMinorVersionUpgrade":true,
"BackupRetentionPeriod":0,
"DBInstanceClass":"db.t2.small",
"DBInstanceIdentifier":"mypostgres",
"Engine":"postgres",
"MasterUserPassword":"MyPassword",
"MasterUsername":"MyUser",
"PubliclyAccessible":false,
"StorageEncrypted":true
}
}
All instance creation parameters are listed at https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#CreateDBInstanceInput
To create an Aurora provisioned cluster with one database instance:
POST http://127.0.0.1:3000/v1/rds/{account}
{
"Cluster":{
"AutoMinorVersionUpgrade":true,
"BackupRetentionPeriod":1,
"DBClusterIdentifier":"myaurora",
"Engine":"aurora",
"MasterUserPassword":"MyPassword",
"MasterUsername":"MyUser",
"StorageEncrypted":true,
"VpcSecurityGroupIds":[
"sg-12345678"
]
},
"Instance":{
"DBClusterIdentifier":"myaurora",
"DBInstanceClass":"db.t2.small",
"DBInstanceIdentifier":"myaurora-1",
"Engine":"aurora",
"PubliclyAccessible":false
}
}
All cluster creation parameters are listed at https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#CreateDBClusterInput
To create an Aurora serverless cluster you need to pass the EngineMode parameter and can optionally specify custom ScalingConfiguration:
POST http://127.0.0.1:3000/v1/rds/{account}
{
"Cluster":{
"AutoMinorVersionUpgrade":true,
"BackupRetentionPeriod":1,
"DBClusterIdentifier":"myserverless",
"Engine":"aurora-mysql",
"EngineMode":"serverless",
"MasterUserPassword":"MyPassword",
"MasterUsername":"MyUser",
"ScalingConfiguration": {
"AutoPause": true,
"MaxCapacity": 4,
"MinCapacity": 1,
"SecondsUntilAutoPause": 300
},
"StorageEncrypted":true,
"VpcSecurityGroupIds":[
"sg-12345678"
]
}
}
You can use the same endpoint for creating a database but just specify the name of the snapshot (SnapshotIdentifier) in the input.
For example, to restore a Postgres database instance:
POST http://127.0.0.1:3000/v1/rds/{account}
{
"Instance":{
"DBInstanceIdentifier":"restored-mypostgres",
"SnapshotIdentifier": "rds:spinup-db000001-2021-08-08-08-08",
"VpcSecurityGroupIds":[
"sg-12345678"
]
}
}
To restore an Aurora provisioned cluster (you need to specify the size of the database instance):
POST http://127.0.0.1:3000/v1/rds/{account}
{
"Cluster":{
"DBClusterIdentifier":"restored-myaurora",
"SnapshotIdentifier": "rds:spinup-db000fff-2021-08-09-10-11",
"VpcSecurityGroupIds":[
"sg-12345678"
]
},
"Instance": {
"DBInstanceClass": "db.t3.small"
}
}
To restore an Aurora serverless cluster:
POST http://127.0.0.1:3000/v1/rds/{account}
{
"Cluster":{
"DBClusterIdentifier":"test-restored-svrless-aurora",
"SnapshotIdentifier": "rds:spinup-db123abc-2021-08-07-06-05",
"ScalingConfiguration": {
"AutoPause": true,
"MaxCapacity": 1,
"MinCapacity": 1,
"SecondsUntilAutoPause": 300
},
"VpcSecurityGroupIds":[
"sg-12345678"
]
}
}
To get details about a specific database instance or cluster:
GET http://127.0.0.1:3000/v1/rds/{account}/mypostgres
{
"DBInstances": [
{
"AllocatedStorage": 20,
"AutoMinorVersionUpgrade": true,
"AvailabilityZone": "us-east-1d",
"BackupRetentionPeriod": 0,
"DBClusterIdentifier": null,
"DBInstanceClass": "db.t2.micro",
"DBInstanceIdentifier": "mypostgres",
"DBInstanceStatus": "available",
"Endpoint": {
"Address": "mypostgres.c8ukc5s0qnag.us-east-1.rds.amazonaws.com",
"HostedZoneId": "Z3R2ITVGPH62AM",
"Port": 5432
},
...
}
]
}
To get details about all database instances in the given account (to list both database instances and clusters you can add all=true query parameter):
GET http://127.0.0.1:3000/v1/rds/{account}[?all=true]
This will return list of snapshots (with details) for the specified database in either DBClusterSnapshots or DBSnapshots, depending if it's a cluster or an instance.
It will also set an X-Items header containing the total number of snapshots in the list.
GET http://127.0.0.1:3000/v1/rds/{account}/mydbcluster/snapshots
{
"DBClusterSnapshots": [
{
...
"DBClusterIdentifier": "mydbcluster",
"DBClusterSnapshotIdentifier": "rds:mydbcluster-2021-07-21-08-37",
...
},
{
...
"DBClusterIdentifier": "mydbcluster",
"DBClusterSnapshotIdentifier": "rds:mydbcluster-2021-07-22-08-37",
...
},
...
or
GET http://127.0.0.1:3000/v1/rds/{account}/mydbinstance/snapshots
{
"DBSnapshots": [
{
...
"DBInstanceIdentifier": "mydbinstance",
"DBSnapshotIdentifier": "rds:mydbinstance-2021-07-21-05-20",
...
},
{
...
"DBInstanceIdentifier": "mydbinstance",
"DBSnapshotIdentifier": "rds:mydbinstance-2021-07-22-05-20",
...
},
...
This will return details about a snapshot in either DBClusterSnapshot or DBSnapshot, depending if it's a cluster or an instance snapshot.
GET http://127.0.0.1:3000/v1/rds/{account}/snapshots/rds:mydbinstance-2021-07-22-05-20
{
"DBSnapshot": {
"AllocatedStorage": 20,
"AvailabilityZone": "us-east-1d",
"DBInstanceIdentifier": "mydbinstance",
"DBSnapshotArn": "arn:aws:rds:us-east-1:01234567890:snapshot:rds:mydbinstance-2021-07-22-05-20",
"DBSnapshotIdentifier": "rds:mydbinstance-2021-07-22-05-20",
"DbiResourceId": "db-DH55SGP1L9S4DHZ6564CAO7PUQ",
"Encrypted": true,
"Engine": "postgres",
"EngineVersion": "10.15",
"IAMDatabaseAuthenticationEnabled": false,
"InstanceCreateTime": "2021-05-07T18:46:08.571Z",
"Iops": null,
"KmsKeyId": "arn:aws:kms:us-east-1:01234567890:key/32c76e50-8fab-5e15-cba4-eef7f4a042f7",
"LicenseModel": "postgresql-license",
"MasterUsername": "test",
"OptionGroupName": "default:postgres-10",
"PercentProgress": 100,
"Port": 5432,
"ProcessorFeatures": null,
"SnapshotCreateTime": "2021-07-22T05:20:00.000Z",
"SnapshotType": "automated",
"SourceDBSnapshotIdentifier": null,
"SourceRegion": null,
"Status": "available",
"StorageType": "gp2",
"TdeCredentialArn": null,
"Timezone": null,
"VpcId": "vpc-01234567"
}
}
This will create a manual snapshot of the specified database.
POST http://127.0.0.1:3000/v1/rds/{account}/{db}/snapshots
{
"SnapshotIdentifier": "mytestbackup-1"
}
This will delete a manual snapshot (automatic snapshots cannot be deleted but can be controlled by the backup retention period).
DELETE http://127.0.0.1:3000/v1/rds/{account}/snapshots/mytestbackup-1
You can specify either cluster or instance parameters in the PUT to modify a cluster or an instance.
For example, to change the master password for an Aurora cluster:
PUT http://127.0.0.1:3000/v1/rds/{account}/myaurora
{
"Cluster": {
"MasterUserPassword": "EXAMPLE",
"ApplyImmediately": true
}
}
You can pass a list of tags (Key/Value pairs) to add or updated on the given database. If there is an RDS cluster and instance with the same name, the tags for both will be updated.
PUT http://127.0.0.1:3000/v1/rds/{account}/myaurora
{
"Tags": [
{
"Key": "NewTag",
"Value": "new"
}
]
}
By default, a final snapshot is not created when deleting a database instance. You can override that by adding snapshot=true query parameter.
DELETE http://127.0.0.1:3000/v1/rds/{account}/mypostgres[?snapshot=true]
The API will check if the database instance belongs to a cluster and will automatically delete the cluster if this is the last member.
PUT http://127.0.0.1:3000/v1/rds/{account}/myaurora/power
{
"state": "stop|start"
}
- Install Buffalo framework (v0.13+): https://gobuffalo.io/en/docs/installation
- Run
buffalo setupto install required dependencies - Run
buffalo devto start the app locally - Run
buffalo tests -vto run all tests
To build a container locally for testing:
$ cd docker/
$ docker-compose up -d
$ curl http://localhost:8088/v1/rds/ping
pong
# do your work, then shut it down
$ docker-compose down
Tenyo Grozev [email protected]