Skip to content

API.md

Latest commit

 

History

History
302 lines (180 loc) · 9.76 KB

API.md

File metadata and controls

302 lines (180 loc) · 9.76 KB

API Reference

Constructs

DatabaseScript

  • Implements: aws-cdk-lib.aws_ec2.IConnectable

Initializers 

import { DatabaseScript } from '@matthewbonig/rds-tools'

new DatabaseScript(scope: Construct, id: string, props: DatabaseScriptProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props DatabaseScriptProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
bind Grants access to the Lambda Function to the given SecurityGroup.
slugify No description.
toString 
public toString(): string

Returns a string representation of this construct.

bind 
public bind(securityGroup: SecurityGroup, port: Port): DatabaseScript

Grants access to the Lambda Function to the given SecurityGroup.

Adds an ingress rule to the given security group and for the given port.

securityGroupRequired
  • Type: aws-cdk-lib.aws_ec2.SecurityGroup
portRequired
  • Type: aws-cdk-lib.aws_ec2.Port
slugify 
public slugify(x: string): string
xRequired
  • Type: string

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { DatabaseScript } from '@matthewbonig/rds-tools'

DatabaseScript.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
adhocConnections aws-cdk-lib.aws_ec2.Connections No description.
connections aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource.
handler aws-cdk-lib.aws_lambda.IFunction No description.
adhocHandler aws-cdk-lib.aws_lambda.IFunction The underlying Lambda handler function for making adhoc commands against the database.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

adhocConnectionsRequired 
public readonly adhocConnections: Connections;
  • Type: aws-cdk-lib.aws_ec2.Connections
connectionsRequired 
public readonly connections: Connections;
  • Type: aws-cdk-lib.aws_ec2.Connections

The network connections associated with this resource.

handlerRequired 
public readonly handler: IFunction;
  • Type: aws-cdk-lib.aws_lambda.IFunction
adhocHandlerOptional 
public readonly adhocHandler: IFunction;
  • Type: aws-cdk-lib.aws_lambda.IFunction

The underlying Lambda handler function for making adhoc commands against the database.

Undefined unless 'enableAdhoc' is true

Structs

DatabaseScriptProps

Initializer 

import { DatabaseScriptProps } from '@matthewbonig/rds-tools'

const databaseScriptProps: DatabaseScriptProps = { ... }

Properties

Name Type Description
script string The script to execute.
databaseInstance aws-cdk-lib.aws_rds.DatabaseInstance The database instance to run the script against.
databaseName string An optional databaseName.
enableAdhoc boolean Deploy a second Lambda function that allows for adhoc sql against the database?
secret aws-cdk-lib.aws_secretsmanager.ISecret An optional secret that provides credentials for the database.
vpc aws-cdk-lib.aws_ec2.IVpc The VPC for the Lambda Function to attach to.
scriptRequired 
public readonly script: string;
  • Type: string

The script to execute.

databaseInstanceOptional 
public readonly databaseInstance: DatabaseInstance;
  • Type: aws-cdk-lib.aws_rds.DatabaseInstance

The database instance to run the script against.

databaseNameOptional 
public readonly databaseName: string;
  • Type: string

An optional databaseName.

If none is provided then it will be the default for the rds instance, as defined by the AWS docs.

mysql - mysql mssql - master postgres - postgres

enableAdhocOptional 
public readonly enableAdhoc: boolean;
  • Type: boolean
  • Default: false

Deploy a second Lambda function that allows for adhoc sql against the database?

secretOptional 
public readonly secret: ISecret;
  • Type: aws-cdk-lib.aws_secretsmanager.ISecret
  • Default: the root secret from the database instance

An optional secret that provides credentials for the database.

Must have fields 'username' and 'password'

vpcOptional 
public readonly vpc: IVpc;
  • Type: aws-cdk-lib.aws_ec2.IVpc

The VPC for the Lambda Function to attach to.

If one is not provide, it's assumed from the database instance.