API.md

API Reference

Constructs

PostgresRDSCluster

Initializers

import { PostgresRDSCluster } from '@smallcase/cdk-rds-module'

new PostgresRDSCluster(scope: Construct, id: string, props: PostgresProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	PostgresProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: PostgresProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { PostgresRDSCluster } from '@smallcase/cdk-rds-module'

PostgresRDSCluster.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
readReplicas	aws-cdk-lib.aws_rds.DatabaseInstanceReadReplica[]	No description.
securityGroup	aws-cdk-lib.aws_ec2.ISecurityGroup	No description.
metricSnsTopic	aws-cdk-lib.aws_sns.ITopic	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

readReplicas^Required

public readonly readReplicas: DatabaseInstanceReadReplica[];

• Type: aws-cdk-lib.aws_rds.DatabaseInstanceReadReplica[]

---

securityGroup^Required

public readonly securityGroup: ISecurityGroup;

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup

---

metricSnsTopic^Optional

public readonly metricSnsTopic: ITopic;

• Type: aws-cdk-lib.aws_sns.ITopic

---

RDSMonitoring

Initializers

import { RDSMonitoring } from '@smallcase/cdk-rds-module'

new RDSMonitoring(scope: Construct, id: string, config: MonitoringConfig)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
config	MonitoringConfig	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

config^Required

• Type: MonitoringConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
createPrimaryMonitoring	Create all monitoring for primary instance.
createReplicaMonitoring	Create all monitoring for read replicas.

---

toString

public toString(): string

Returns a string representation of this construct.

createPrimaryMonitoring

public createPrimaryMonitoring(primaryInstance: DatabaseInstance): void

Create all monitoring for primary instance.

primaryInstance^Required

• Type: aws-cdk-lib.aws_rds.DatabaseInstance

---

createReplicaMonitoring

public createReplicaMonitoring(replicaInstance: DatabaseInstanceReadReplica, replicaIndex: number): void

Create all monitoring for read replicas.

replicaInstance^Required

• Type: aws-cdk-lib.aws_rds.DatabaseInstanceReadReplica

---

replicaIndex^Required

• Type: number

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { RDSMonitoring } from '@smallcase/cdk-rds-module'

RDSMonitoring.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
metricSnsTopic	aws-cdk-lib.aws_sns.ITopic	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

metricSnsTopic^Optional

public readonly metricSnsTopic: ITopic;

• Type: aws-cdk-lib.aws_sns.ITopic

---

SlackChatbotIntegration

Initializers

import { SlackChatbotIntegration } from '@smallcase/cdk-rds-module'

new SlackChatbotIntegration(scope: Construct, id: string, props: SlackChatbotProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	SlackChatbotProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: SlackChatbotProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { SlackChatbotIntegration } from '@smallcase/cdk-rds-module'

SlackChatbotIntegration.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chatbotRole	aws-cdk-lib.aws_iam.Role	No description.
slackChannel	aws-cdk-lib.aws_chatbot.SlackChannelConfiguration	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chatbotRole^Required

public readonly chatbotRole: Role;

• Type: aws-cdk-lib.aws_iam.Role

---

slackChannel^Required

public readonly slackChannel: SlackChannelConfiguration;

• Type: aws-cdk-lib.aws_chatbot.SlackChannelConfiguration

---

Structs

AlertThresholds

Initializer

import { AlertThresholds } from '@smallcase/cdk-rds-module'

const alertThresholds: AlertThresholds = { ... }

Properties

Name	Type	Description
cpu	number	No description.
dbConnections	number	No description.
diskQueueDepth	number	No description.
freeStorage	number	No description.
memory	number	No description.
networkThroughput	number	No description.
readIops	number	No description.
replicationLag	number	No description.
writeIops	number	No description.

---

cpu^Optional

public readonly cpu: number;

• Type: number

---

dbConnections^Optional

public readonly dbConnections: number;

• Type: number

---

diskQueueDepth^Optional

public readonly diskQueueDepth: number;

• Type: number

---

freeStorage^Optional

public readonly freeStorage: number;

• Type: number

---

memory^Optional

public readonly memory: number;

• Type: number

---

networkThroughput^Optional

public readonly networkThroughput: number;

• Type: number

---

readIops^Optional

public readonly readIops: number;

• Type: number

---

replicationLag^Optional

public readonly replicationLag: number;

• Type: number

---

writeIops^Optional

public readonly writeIops: number;

• Type: number

---

IngressRule

Initializer

import { IngressRule } from '@smallcase/cdk-rds-module'

const ingressRule: IngressRule = { ... }

Properties

Name	Type	Description
connection	aws-cdk-lib.aws_ec2.Port	No description.
peer	aws-cdk-lib.aws_ec2.IPeer | aws-cdk-lib.aws_ec2.ISecurityGroup	No description.
description	string	No description.
remoteRule	boolean	No description.

---

connection^Required

public readonly connection: Port;

• Type: aws-cdk-lib.aws_ec2.Port

---

peer^Required

public readonly peer: IPeer | ISecurityGroup;

• Type: aws-cdk-lib.aws_ec2.IPeer | aws-cdk-lib.aws_ec2.ISecurityGroup

---

description^Optional

public readonly description: string;

• Type: string

---

remoteRule^Optional

public readonly remoteRule: boolean;

• Type: boolean

---

InternalRole

Initializer

import { InternalRole } from '@smallcase/cdk-rds-module'

const internalRole: InternalRole = { ... }

Properties

Name	Type	Description
type	ResourceType	No description.
roleArn	string	No description.
roleProps	aws-cdk-lib.aws_iam.RoleProps	No description.

---

type^Required

public readonly type: ResourceType;

• Type: ResourceType

---

roleArn^Optional

public readonly roleArn: string;

• Type: string

---

roleProps^Optional

public readonly roleProps: RoleProps;

• Type: aws-cdk-lib.aws_iam.RoleProps

---

MonitoringConfig

Initializer

import { MonitoringConfig } from '@smallcase/cdk-rds-module'

const monitoringConfig: MonitoringConfig = { ... }

Properties

Name	Type	Description
clusterName	string	No description.
instanceType	aws-cdk-lib.aws_ec2.InstanceType	No description.
alertSubcriptionWebhooks	string[]	No description.
backupRetention	number	No description.
enableAlerts	boolean	No description.
metricTopicName	string	No description.
multiAz	boolean	No description.
primaryAlertThresholds	AlertThresholds	No description.
readReplicas	ReadReplicaConfig	No description.
replicaAlertThresholds	AlertThresholds	No description.

---

clusterName^Required

public readonly clusterName: string;

• Type: string

---

instanceType^Required

public readonly instanceType: InstanceType;

• Type: aws-cdk-lib.aws_ec2.InstanceType

---

alertSubcriptionWebhooks^Optional

public readonly alertSubcriptionWebhooks: string[];

• Type: string[]

---

backupRetention^Optional

public readonly backupRetention: number;

• Type: number

---

enableAlerts^Optional

public readonly enableAlerts: boolean;

• Type: boolean

---

metricTopicName^Optional

public readonly metricTopicName: string;

• Type: string

---

multiAz^Optional

public readonly multiAz: boolean;

• Type: boolean

---

primaryAlertThresholds^Optional

public readonly primaryAlertThresholds: AlertThresholds;

• Type: AlertThresholds

---

readReplicas^Optional

public readonly readReplicas: ReadReplicaConfig;

• Type: ReadReplicaConfig

---

replicaAlertThresholds^Optional

public readonly replicaAlertThresholds: AlertThresholds;

• Type: AlertThresholds

---

Network

Initializer

import { Network } from '@smallcase/cdk-rds-module'

const network: Network = { ... }

Properties

Name	Type	Description
subnetsId	string[]	No description.
vpcId	string	No description.
existingSecurityGroupId	string	No description.
ingressSgRule	IngressRule[]	No description.

---

subnetsId^Required

public readonly subnetsId: string[];

• Type: string[]

---

vpcId^Required

public readonly vpcId: string;

• Type: string

---

existingSecurityGroupId^Optional

public readonly existingSecurityGroupId: string;

• Type: string

---

ingressSgRule^Optional

public readonly ingressSgRule: IngressRule[];

• Type: IngressRule[]

---

PostgresProps

Initializer

import { PostgresProps } from '@smallcase/cdk-rds-module'

const postgresProps: PostgresProps = { ... }

Properties

Name	Type	Description
clusterName	string	No description.
databaseMasterUserName	string	No description.
databaseName	string	No description.
instanceType	aws-cdk-lib.aws_ec2.InstanceType	No description.
network	Network	No description.
postgresVersion	aws-cdk-lib.aws_rds.IInstanceEngine	No description.
alertSubcriptionWebhooks	string[]	No description.
allocatedStorage	number	No description.
allowMajorVersionUpgrade	boolean	No description.
autoMinorVersionUpgrade	boolean	No description.
backupRetention	number	No description.
deletionProtection	boolean	No description.
enableAlerts	boolean	No description.
enablePerformanceInsights	boolean	No description.
maxAllocatedStorage	number	No description.
metricTopicName	string	No description.
monitoringInterval	number	No description.
multiAz	boolean	No description.
parameters	{[ key: string ]: string}	No description.
performanceInsightRetention	aws-cdk-lib.aws_rds.PerformanceInsightRetention	No description.
primaryAlertThresholds	AlertThresholds	No description.
publiclyAccessible	boolean	No description.
readReplicas	ReadReplica	No description.
replicaAlertThresholds	AlertThresholds	No description.
replicaAllocatedStorage	number	No description.
replicaMaxAllocatedStorage	number	No description.
replicaStorageType	aws-cdk-lib.aws_rds.StorageType	No description.
snapshotIdentifier	string	No description.
snsTopicCreate	boolean	No description.
storageEncrypted	boolean	No description.
storageType	aws-cdk-lib.aws_rds.StorageType	No description.
tags	{[ key: string ]: string}	No description.

---

clusterName^Required

public readonly clusterName: string;

• Type: string

---

databaseMasterUserName^Required

public readonly databaseMasterUserName: string;

• Type: string

---

databaseName^Required

public readonly databaseName: string;

• Type: string

---

instanceType^Required

public readonly instanceType: InstanceType;

• Type: aws-cdk-lib.aws_ec2.InstanceType

---

network^Required

public readonly network: Network;

• Type: Network

---

postgresVersion^Required

public readonly postgresVersion: IInstanceEngine;

• Type: aws-cdk-lib.aws_rds.IInstanceEngine

---

alertSubcriptionWebhooks^Optional

public readonly alertSubcriptionWebhooks: string[];

• Type: string[]

---

allocatedStorage^Optional

public readonly allocatedStorage: number;

• Type: number

---

allowMajorVersionUpgrade^Optional

public readonly allowMajorVersionUpgrade: boolean;

• Type: boolean

---

autoMinorVersionUpgrade^Optional

public readonly autoMinorVersionUpgrade: boolean;

• Type: boolean

---

backupRetention^Optional

public readonly backupRetention: number;

• Type: number

---

deletionProtection^Optional

public readonly deletionProtection: boolean;

• Type: boolean

---

enableAlerts^Optional

public readonly enableAlerts: boolean;

• Type: boolean

---

enablePerformanceInsights^Optional

public readonly enablePerformanceInsights: boolean;

• Type: boolean

---

maxAllocatedStorage^Optional

public readonly maxAllocatedStorage: number;

• Type: number

---

metricTopicName^Optional

public readonly metricTopicName: string;

• Type: string

---

monitoringInterval^Optional

public readonly monitoringInterval: number;

• Type: number

---

multiAz^Optional

public readonly multiAz: boolean;

• Type: boolean

---

parameters^Optional

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

performanceInsightRetention^Optional

public readonly performanceInsightRetention: PerformanceInsightRetention;

• Type: aws-cdk-lib.aws_rds.PerformanceInsightRetention

---

primaryAlertThresholds^Optional

public readonly primaryAlertThresholds: AlertThresholds;

• Type: AlertThresholds

---

publiclyAccessible^Optional

public readonly publiclyAccessible: boolean;

• Type: boolean

---

readReplicas^Optional

public readonly readReplicas: ReadReplica;

• Type: ReadReplica

---

replicaAlertThresholds^Optional

public readonly replicaAlertThresholds: AlertThresholds;

• Type: AlertThresholds

---

replicaAllocatedStorage^Optional

public readonly replicaAllocatedStorage: number;

• Type: number

---

replicaMaxAllocatedStorage^Optional

public readonly replicaMaxAllocatedStorage: number;

• Type: number

---

replicaStorageType^Optional

public readonly replicaStorageType: StorageType;

• Type: aws-cdk-lib.aws_rds.StorageType

---

snapshotIdentifier^Optional

public readonly snapshotIdentifier: string;

• Type: string

---

snsTopicCreate^Optional

public readonly snsTopicCreate: boolean;

• Type: boolean

---

storageEncrypted^Optional

public readonly storageEncrypted: boolean;

• Type: boolean

---

storageType^Optional

public readonly storageType: StorageType;

• Type: aws-cdk-lib.aws_rds.StorageType

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

ReadReplica

Initializer

import { ReadReplica } from '@smallcase/cdk-rds-module'

const readReplica: ReadReplica = { ... }

Properties

Name	Type	Description
instanceType	aws-cdk-lib.aws_ec2.InstanceType	No description.
replicas	number	No description.
alertThresholds	AlertThresholds	No description.
parameters	{[ key: string ]: string}	No description.

---

instanceType^Required

public readonly instanceType: InstanceType;

• Type: aws-cdk-lib.aws_ec2.InstanceType

---

replicas^Required

public readonly replicas: number;

• Type: number

---

alertThresholds^Optional

public readonly alertThresholds: AlertThresholds;

• Type: AlertThresholds

---

parameters^Optional

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

ReadReplicaConfig

Initializer

import { ReadReplicaConfig } from '@smallcase/cdk-rds-module'

const readReplicaConfig: ReadReplicaConfig = { ... }

Properties

Name	Type	Description
instanceType	aws-cdk-lib.aws_ec2.InstanceType	No description.
replicas	number	No description.
alertThresholds	AlertThresholds	No description.

---

instanceType^Required

public readonly instanceType: InstanceType;

• Type: aws-cdk-lib.aws_ec2.InstanceType

---

replicas^Required

public readonly replicas: number;

• Type: number

---

alertThresholds^Optional

public readonly alertThresholds: AlertThresholds;

• Type: AlertThresholds

---

SlackChatbotProps

Initializer

import { SlackChatbotProps } from '@smallcase/cdk-rds-module'

const slackChatbotProps: SlackChatbotProps = { ... }

Properties

Name	Type	Description
notificationTopics	aws-cdk-lib.aws_sns.ITopic[]	No description.
slackChannelConfigurationName	string	No description.
slackChannelId	string	No description.
slackWorkspaceId	string	No description.

---

notificationTopics^Required

public readonly notificationTopics: ITopic[];

• Type: aws-cdk-lib.aws_sns.ITopic[]

---

slackChannelConfigurationName^Required

public readonly slackChannelConfigurationName: string;

• Type: string

---

slackChannelId^Required

public readonly slackChannelId: string;

• Type: string

---

slackWorkspaceId^Required

public readonly slackWorkspaceId: string;

• Type: string

---

Enums

ResourceType

Members

Name	Description
NEW	No description.
EXISTING	No description.

---

NEW

---

EXISTING

---