A simple CDK seeder for SQL Server RDS databases.
Project description
cdk-sqlserver-seeder
A simple CDK seeder for SQL Server RDS databases.
When you create an RDS SQL Server instance using CloudFormation template, there is no way to provide initial schema definition as part of CloudFormation stack deployment. Custom schema deployment scripts can be executed only after the database deployment is complete.
cdk-sqlserver-seeder library is a AWS CDK construct that provides a way to automate this process and eliminate manual steps involved in the process of preparing new RDS SQL Server environment by executing custom SQL scripts on RDS SQL Server instance creation/deletion.
The construct relies on Invoke-SqlCmd cmdlet to run the scripts and provides a way to handle transient errors during stack provisioning.
Usage
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import aws_cdk.core as cdk
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_rds as rds
from cdk_sqlserver_seeder import SqlServerSeeder
class DatabaseStack(cdk.Stack):
def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None):
super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection)
sql_server = rds.DatabaseInstance(self, "Instance",
engine=rds.DatabaseInstanceEngine.SQL_SERVER_WEB
)
seeder = SqlServerSeeder(self, "SqlSeeder",
database=sql_server,
port=1433,
vpc=vpc,
create_script_path="./SQL/v1.0.0.sql", # script to be executed on resource creation
delete_script_path="./SQL/cleanup.sql"
)
Configuration properties
SqlServerSeeder construct accepts the following configuration properties:
Parameter | Required | Default | Description |
---|---|---|---|
vpc |
yes | VPC for Lambda function deployment | |
database |
yes | RDS SQL Server database instance | |
createScriptPath |
yes | SQL scripts to run on resource creation | |
deleteScriptPath |
no | SQL script to run on resource deletion | |
port |
no | 1433 | RSD SQL Server database port |
memorySize |
no | 512 | Lambda function memory size |
ignoreSqlErrors |
no | false | Whether to ignore SQL error or not |
Architecture
cdk-sqlserver-seeder
deploys a custom resource backed by PowerShell lambda to connect to SQL Server instance. Lambda function is deployed in private subnets of your VPC where RDS instance resides.
Lambda function retrieves database credentials from AWS Secrets Manager and uses them to construct connection string to the database.
SQL scripts are uploaded into S3 bucket during CDK application deployment. Lambda function downloads these scripts during execution.
Security considerations
Lambda function has the following permissions:
-
Managed policies
AWSLambdaBasicExecutionRole
for CloudWatch logsAWSLambdaVPCAccessExecutionRole
for VPC access
-
Inline policy
secretsmanager:GetSecretValue
for RDS credentials secrets3:GetObject*
,s3:GetBucket*
,s3:List*
for S3 bucket with SQL scripts
Acknowledgements
The whole project inspired by aws-cdk-dynamodb-seeder. I though it would be very helpful to have a similar way to seed initial schema to more traditional SQL Server databases.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk-sqlserver-seeder-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 249e3a89c88a6077424c24d0cc1e603ebf8437f70d5cf1484e54edd6fc8f2242 |
|
MD5 | dd6b11e38033b654491a74c61cd4a093 |
|
BLAKE2b-256 | 346989aac21953cc3b1ec6d00f52062f900bb67e8d579c2e5a8cee4fdd9bda6a |
Hashes for cdk_sqlserver_seeder-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f36a89222a7d215e99840f52b3ccdcb10cbd441271948597508c0d206a527f5 |
|
MD5 | 7ffae3ae6c5b97a55191e5af3cd0a9a2 |
|
BLAKE2b-256 | e3eb960b071d479f6999a7d53920bc00affaf36d7a3aad65a0dd224aa269e80b |