DatabaseInstanceBuilder (FsCDK)

DatabaseInstanceBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`DatabaseInstanceBuilder(name)` Full Usage: `DatabaseInstanceBuilder(name)` Parameters: name : `string` Returns: `DatabaseInstanceBuilder`	name : `string` Returns: `DatabaseInstanceBuilder`


                
                  
                    
                      DatabaseInstanceBuilder(name)

Full Usage: DatabaseInstanceBuilder(name)

Parameters:

name : string

Returns: DatabaseInstanceBuilder

name : string

Returns: DatabaseInstanceBuilder

Instance members

Instance member	Description
`allocatedStorage gb` Full Usage: `allocatedStorage gb` Parameters: gb : `int` Returns: `DatabaseInstanceConfig`	Sets the allocated storage in GB. gb : `int` Returns: `DatabaseInstanceConfig`
`autoMinorVersionUpgrade enabled` Full Usage: `autoMinorVersionUpgrade enabled` Parameters: enabled : `bool` Returns: `DatabaseInstanceConfig`	Enables or disables auto minor version upgrades. enabled : `bool` Returns: `DatabaseInstanceConfig`
`backupRetentionDays days` Full Usage: `backupRetentionDays days` Parameters: days : `float` Returns: `DatabaseInstanceConfig`	Sets the backup retention period in days. days : `float` Returns: `DatabaseInstanceConfig`
`cloudwatchLogsExports logTypes` Full Usage: `cloudwatchLogsExports logTypes` Parameters: logTypes : `string list` - List of log types to export (engine-specific). Returns: `DatabaseInstanceConfig`	Enables CloudWatch Logs export for database audit and error logs. Security Best Practice: Export logs to CloudWatch for: - Audit trails and compliance requirements - Security incident investigation - Performance troubleshooting - Anomaly detection Log Types by Engine: - PostgreSQL: ["postgresql", "upgrade"] - MySQL: ["error", "general", "slowquery", "audit"] - MariaDB: ["error", "general", "slowquery", "audit"] - Oracle: ["alert", "audit", "trace", "listener"] - SQL Server: ["error", "agent"] Default: None (opt-in for cost considerations) logTypes : `string list` List of log types to export (engine-specific). Returns: `DatabaseInstanceConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: a : `DatabaseInstanceConfig` b : `DatabaseInstanceConfig` Returns: `DatabaseInstanceConfig`	a : `DatabaseInstanceConfig` b : `DatabaseInstanceConfig` Returns: `DatabaseInstanceConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` Returns: `DatabaseInstanceConfig`	Sets the construct ID for the database instance. id : `string` Returns: `DatabaseInstanceConfig`
`credentials credentials` Full Usage: `credentials credentials` Parameters: credentials : `Credentials` Returns: `DatabaseInstanceConfig`	Sets the credentials. credentials : `Credentials` Returns: `DatabaseInstanceConfig`
`databaseName dbName` Full Usage: `databaseName dbName` Parameters: dbName : `string` Returns: `DatabaseInstanceConfig`	Sets the database name. dbName : `string` Returns: `DatabaseInstanceConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> DatabaseInstanceConfig` Returns: `DatabaseInstanceConfig` Modifiers: inline	f : `unit -> DatabaseInstanceConfig` Returns: `DatabaseInstanceConfig`
`deleteAutomatedBackups delete` Full Usage: `deleteAutomatedBackups delete` Parameters: delete : `bool` Returns: `DatabaseInstanceConfig`	Sets whether to delete automated backups. delete : `bool` Returns: `DatabaseInstanceConfig`
`deletionProtection enabled` Full Usage: `deletionProtection enabled` Parameters: enabled : `bool` Returns: `DatabaseInstanceConfig`	Enables or disables deletion protection. enabled : `bool` Returns: `DatabaseInstanceConfig`
`enablePerformanceInsights enabled` Full Usage: `enablePerformanceInsights enabled` Parameters: enabled : `bool` Returns: `DatabaseInstanceConfig`	Enables performance insights. enabled : `bool` Returns: `DatabaseInstanceConfig`
`engine engine` Full Usage: `engine engine` Parameters: engine : `IInstanceEngine` Returns: `DatabaseInstanceConfig`	Sets the database engine. engine : `IInstanceEngine` Returns: `DatabaseInstanceConfig`
`this.For` Full Usage: `this.For` Parameters: config : `DatabaseInstanceConfig` f : `unit -> DatabaseInstanceConfig` Returns: `DatabaseInstanceConfig` Modifiers: inline	config : `DatabaseInstanceConfig` f : `unit -> DatabaseInstanceConfig` Returns: `DatabaseInstanceConfig`
`iamAuthentication enabled` Full Usage: `iamAuthentication enabled` Parameters: enabled : `bool` Returns: `DatabaseInstanceConfig`	Enables IAM authentication. enabled : `bool` Returns: `DatabaseInstanceConfig`
`instanceType instanceType` Full Usage: `instanceType instanceType` Parameters: instanceType : `InstanceType` Returns: `DatabaseInstanceConfig`	Sets the instance type. instanceType : `InstanceType` Returns: `DatabaseInstanceConfig`
`masterUsername username` Full Usage: `masterUsername username` Parameters: username : `string` Returns: `DatabaseInstanceConfig`	Sets the master username (note: credentials typically encapsulate username/password/secret). username : `string` Returns: `DatabaseInstanceConfig`
`maxAllocatedStorage gb` Full Usage: `maxAllocatedStorage gb` Parameters: gb : `int` Returns: `DatabaseInstanceConfig`	Sets the maximum allocated storage in GB for autoscaling. gb : `int` Returns: `DatabaseInstanceConfig`
`monitoringInterval interval` Full Usage: `monitoringInterval interval` Parameters: interval : `Duration` Returns: `DatabaseInstanceConfig`	Sets the CloudWatch monitoring interval. interval : `Duration` Returns: `DatabaseInstanceConfig`
`multiAz enabled` Full Usage: `multiAz enabled` Parameters: enabled : `bool` Returns: `DatabaseInstanceConfig`	Enables or disables Multi-AZ deployment. enabled : `bool` Returns: `DatabaseInstanceConfig`
`performanceInsightRetention retention` Full Usage: `performanceInsightRetention retention` Parameters: retention : `PerformanceInsightRetention` Returns: `DatabaseInstanceConfig`	Sets performance insights retention. retention : `PerformanceInsightRetention` Returns: `DatabaseInstanceConfig`
`postgresEngine ?version` Full Usage: `postgresEngine ?version` Parameters: ?version : `PostgresEngineVersion` Returns: `DatabaseInstanceConfig`	Sets PostgreSQL as the database engine with a specific version. ?version : `PostgresEngineVersion` Returns: `DatabaseInstanceConfig`
`preferredBackupWindow window` Full Usage: `preferredBackupWindow window` Parameters: window : `string` Returns: `DatabaseInstanceConfig`	Sets the preferred backup window. window : `string` Returns: `DatabaseInstanceConfig`
`preferredMaintenanceWindow window` Full Usage: `preferredMaintenanceWindow window` Parameters: window : `string` Returns: `DatabaseInstanceConfig`	Sets the preferred maintenance window. window : `string` Returns: `DatabaseInstanceConfig`
`publiclyAccessible accessible` Full Usage: `publiclyAccessible accessible` Parameters: accessible : `bool` Returns: `DatabaseInstanceConfig`	Sets whether the database is publicly accessible. accessible : `bool` Returns: `DatabaseInstanceConfig`
`removalPolicy policy` Full Usage: `removalPolicy policy` Parameters: policy : `RemovalPolicy` Returns: `DatabaseInstanceConfig`	Sets the removal policy. policy : `RemovalPolicy` Returns: `DatabaseInstanceConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `DatabaseInstanceConfig` Returns: `DatabaseInstanceSpec`	config : `DatabaseInstanceConfig` Returns: `DatabaseInstanceSpec`
`securityGroup sg` Full Usage: `securityGroup sg` Parameters: sg : `ISecurityGroup` Returns: `DatabaseInstanceConfig`	Adds a security group. sg : `ISecurityGroup` Returns: `DatabaseInstanceConfig`
`storageEncrypted encrypted` Full Usage: `storageEncrypted encrypted` Parameters: encrypted : `bool` Returns: `DatabaseInstanceConfig`	Enables storage encryption. encrypted : `bool` Returns: `DatabaseInstanceConfig`
`storageType storageType` Full Usage: `storageType storageType` Parameters: storageType : `StorageType` Returns: `DatabaseInstanceConfig`	Sets the storage type. storageType : `StorageType` Returns: `DatabaseInstanceConfig`
`vpc vpc` Full Usage: `vpc vpc` Parameters: vpc : `IVpc` Returns: `DatabaseInstanceConfig`	Sets the VPC. vpc : `IVpc` Returns: `DatabaseInstanceConfig`
`vpcSubnets subnets` Full Usage: `vpcSubnets subnets` Parameters: subnets : `SubnetSelection` Returns: `DatabaseInstanceConfig`	Sets the VPC subnets. subnets : `SubnetSelection` Returns: `DatabaseInstanceConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `DatabaseInstanceConfig`	() : `unit` Returns: `DatabaseInstanceConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `DatabaseInstanceConfig`	Returns: `DatabaseInstanceConfig`