Interface GuDatabaseInstanceProps

interface GuDatabaseInstanceProps {
    allocatedStorage?: number;
    allowMajorVersionUpgrade?: boolean;
    app: string;
    applyImmediately?: boolean;
    autoMinorVersionUpgrade?: boolean;
    availabilityZone?: string;
    caCertificate?: CaCertificate;
    characterSetName?: string;
    cloudwatchLogsExports?: string[];
    cloudwatchLogsRetention?: RetentionDays;
    cloudwatchLogsRetentionRole?: IRole;
    copyTagsToSnapshot?: boolean;
    credentials?: Credentials;
    databaseInsightsMode?: DatabaseInsightsMode;
    databaseName?: string;
    deleteAutomatedBackups?: boolean;
    deletionProtection?: boolean;
    devXBackups: OptIn | OptOut;
    domain?: string;
    domainRole?: IRoleRef;
    enablePerformanceInsights?: boolean;
    engine: IInstanceEngine;
    engineLifecycleSupport?: EngineLifecycleSupport;
    iamAuthentication?: boolean;
    instanceIdentifier?: string;
    instanceType: string;
    iops?: number;
    licenseModel?: LicenseModel;
    maxAllocatedStorage?: number;
    monitoringInterval?: Duration;
    monitoringRole?: IRoleRef;
    multiAz?: boolean;
    networkType?: NetworkType;
    optionGroup?: IOptionGroup;
    parameterGroup?: IParameterGroup;
    parameters?: { [key: string]: string };
    performanceInsightEncryptionKey?: IKeyRef;
    performanceInsightRetention?: PerformanceInsightRetention;
    port?: number;
    preferredMaintenanceWindow?: string;
    processorFeatures?: ProcessorFeatures;
    publiclyAccessible?: boolean;
    removalPolicy?: RemovalPolicy;
    s3ExportBuckets?: IBucket[];
    s3ExportRole?: IRole;
    s3ImportBuckets?: IBucket[];
    s3ImportRole?: IRole;
    securityGroups?: ISecurityGroup[];
    storageEncrypted?: boolean;
    storageEncryptionKey?: IKeyRef;
    storageThroughput?: number;
    storageType?: StorageType;
    subnetGroup?: ISubnetGroup;
    timezone?: string;
    vpc: IVpc;
    vpcSubnets?: SubnetSelection;
}

Hierarchy (View Summary)

Omit<
    DatabaseInstanceProps,
    "instanceType"
    | "backupRetention"
    | "preferredBackupWindow",
>
AppIdentity
- GuDatabaseInstanceProps

Index

Properties

allocatedStorage? allowMajorVersionUpgrade? app applyImmediately? autoMinorVersionUpgrade? availabilityZone? caCertificate? characterSetName? cloudwatchLogsExports? cloudwatchLogsRetention? cloudwatchLogsRetentionRole? copyTagsToSnapshot? credentials? databaseInsightsMode? databaseName? deleteAutomatedBackups? deletionProtection? devXBackups domain? domainRole? enablePerformanceInsights? engine engineLifecycleSupport? iamAuthentication? instanceIdentifier? instanceType iops? licenseModel? maxAllocatedStorage? monitoringInterval? monitoringRole? multiAz? networkType? optionGroup? parameterGroup? parameters? performanceInsightEncryptionKey? performanceInsightRetention? port? preferredMaintenanceWindow? processorFeatures? publiclyAccessible? removalPolicy? s3ExportBuckets? s3ExportRole? s3ImportBuckets? s3ImportRole? securityGroups? storageEncrypted? storageEncryptionKey? storageThroughput? storageType? subnetGroup? timezone? vpc vpcSubnets?

Properties

`Optional` `Readonly`allocatedStorage

allocatedStorage?: number

The allocated storage size, specified in gibibytes (GiB).

Default

`Optional` `Readonly`allowMajorVersionUpgrade

allowMajorVersionUpgrade?: boolean

Whether to allow major version upgrades.

Default

false

app

app: string

`Optional` `Readonly`applyImmediately

applyImmediately?: boolean

Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the preferredMaintenanceWindow setting. If set to false, changes are applied during the next maintenance window.

Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.

This property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html

Default

- Changes will be applied immediately

`Optional` `Readonly`autoMinorVersionUpgrade

autoMinorVersionUpgrade?: boolean

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default

true

`Optional` `Readonly`availabilityZone

availabilityZone?: string

The name of the Availability Zone where the DB instance will be located.

Default

- no preference

`Optional` `Readonly`caCertificate

caCertificate?: CaCertificate

The identifier of the CA certificate for this DB instance.

Specifying or updating this property triggers a reboot.

For RDS DB engines:

See

Default

- RDS will choose a certificate authority

`Optional` `Readonly`characterSetName

characterSetName?: string

For supported engines, specifies the character set to associate with the DB instance.

Default

- RDS default character set name

`Optional` `Readonly`cloudwatchLogsExports

cloudwatchLogsExports?: string[]

The list of log types that need to be enabled for exporting to CloudWatch Logs.

Default

- no log exports

`Optional` `Readonly`cloudwatchLogsRetention

cloudwatchLogsRetention?: RetentionDays

The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

Default

- logs never expire

`Optional` `Readonly`cloudwatchLogsRetentionRole

cloudwatchLogsRetentionRole?: IRole

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default

- a new role is created.

`Optional` `Readonly`copyTagsToSnapshot

copyTagsToSnapshot?: boolean

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.

Default

true

`Optional` `Readonly`credentials

credentials?: Credentials

Credentials for the administrative user

Default

- A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password

`Optional` `Readonly`databaseInsightsMode

databaseInsightsMode?: DatabaseInsightsMode

The database insights mode.

Default

- DatabaseInsightsMode.STANDARD when performance insights are enabled, otherwise not set.

`Optional` `Readonly`databaseName

databaseName?: string

The name of the database.

Default

- no name

`Optional` `Readonly`deleteAutomatedBackups

deleteAutomatedBackups?: boolean

Indicates whether automated backups should be deleted or retained when you delete a DB instance.

Default

true

`Optional` `Readonly`deletionProtection

deletionProtection?: boolean

Indicates whether the DB instance should have deletion protection enabled.

Default

true if removalPolicy is RETAIN, false otherwise

devXBackups

devXBackups: OptIn | OptOut

We recommend using DevX Backups to protect your RDS instance's backups. For more details on this feature, see the documentation.

`Optional` `Readonly`domain

domain?: string

The Active Directory directory ID to create the DB instance in.

Default

- Do not join domain

`Optional` `Readonly`domainRole

domainRole?: IRoleRef

The IAM role to be used when making API calls to the Directory Service. The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.

Default

The role will be created for you if DatabaseInstanceNewProps#domain is specified

`Optional` `Readonly`enablePerformanceInsights

enablePerformanceInsights?: boolean

Whether to enable Performance Insights for the DB instance.

Default

false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.

`Readonly`engine

engine: IInstanceEngine

The database engine.

`Optional` `Readonly`engineLifecycleSupport

engineLifecycleSupport?: EngineLifecycleSupport

The life cycle type for this DB instance. This setting applies only to RDS for MySQL and RDS for PostgreSQL.

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html

Default

undefined - AWS RDS default setting is EngineLifecycleSupport.OPEN_SOURCE_RDS_EXTENDED_SUPPORT

`Optional` `Readonly`iamAuthentication

iamAuthentication?: boolean

Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

Default

false

`Optional` `Readonly`instanceIdentifier

instanceIdentifier?: string

A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase.

Default

- a CloudFormation generated name

instanceType

instanceType: string

`Optional` `Readonly`iops

iops?: number

The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.

Default

- no provisioned iops if storage type is not specified. For GP3: 3,000 IOPS if allocated
storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and
less than 20 GiB for SQL Server. 12,000 IOPS otherwise (except for SQL Server where the default is
always 3,000 IOPS).

`Optional` `Readonly`licenseModel

licenseModel?: LicenseModel

The license model.

Default

- RDS default license model

`Optional` `Readonly`maxAllocatedStorage

maxAllocatedStorage?: number

Upper limit to which RDS can scale the storage in GiB(Gibibyte).

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling

Default

- No autoscaling of RDS instance

`Optional` `Readonly`monitoringInterval

monitoringInterval?: Duration

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.

Default

- no enhanced monitoring

`Optional` `Readonly`monitoringRole

monitoringRole?: IRoleRef

Role that will be used to manage DB instance monitoring.

Default

- A role is automatically created for you

`Optional` `Readonly`multiAz

multiAz?: boolean

Specifies if the database instance is a multiple Availability Zone deployment.

Default

false

`Optional` `Readonly`networkType

networkType?: NetworkType

The network type of the DB instance.

Default

- IPV4

`Optional` `Readonly`optionGroup

optionGroup?: IOptionGroup

The option group to associate with the instance.

Default

- no option group

`Optional` `Readonly`parameterGroup

parameterGroup?: IParameterGroup

The DB parameter group to associate with the instance.

Default

- no parameter group

`Optional` `Readonly`parameters

parameters?: { [key: string]: string }

The parameters in the DBParameterGroup to create automatically

You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.

Default

- None

`Optional` `Readonly`performanceInsightEncryptionKey

performanceInsightEncryptionKey?: IKeyRef

The AWS KMS key for encryption of Performance Insights data.

Default

- default master key

`Optional` `Readonly`performanceInsightRetention

performanceInsightRetention?: PerformanceInsightRetention

The amount of time, in days, to retain Performance Insights data.

If you set databaseInsightsMode to DatabaseInsightsMode.ADVANCED, you must set this property to PerformanceInsightRetention.MONTHS_15.

Default

7 this is the free tier

`Optional` `Readonly`port

port?: number

The port for the instance.

Default

- the default port for the chosen engine.

`Optional` `Readonly`preferredMaintenanceWindow

preferredMaintenanceWindow?: string

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

Default

- a 30-minute window selected at random from an 8-hour block of
time for each AWS Region, occurring on a random day of the week. To see
the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

`Optional` `Readonly`processorFeatures

processorFeatures?: ProcessorFeatures

The number of CPU cores and the number of threads per core.

Default

- the default number of CPU cores and threads per core for the
chosen instance class.

See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor

`Optional` `Readonly`publiclyAccessible

publiclyAccessible?: boolean

Indicates whether the DB instance is an internet-facing instance. If not specified, the instance's vpcSubnets will be used to determine if the instance is internet-facing or not.

Default

true if the instance's vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise

`Optional` `Readonly`removalPolicy

removalPolicy?: RemovalPolicy

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Default

- RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)

`Optional` `Readonly`s3ExportBuckets

s3ExportBuckets?: IBucket[]

S3 buckets that you want to load data into.

This property must not be used if s3ExportRole is used.

For Microsoft SQL Server:

See

Default

- None

`Optional` `Readonly`s3ExportRole

s3ExportRole?: IRole

Role that will be associated with this DB instance to enable S3 export.

This property must not be used if s3ExportBuckets is used.

For Microsoft SQL Server:

See

Default

New role is created if s3ExportBuckets is set, no role is defined otherwise

`Optional` `Readonly`s3ImportBuckets

s3ImportBuckets?: IBucket[]

S3 buckets that you want to load data from. This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportRole is used.

For Microsoft SQL Server:

See

Default

- None

`Optional` `Readonly`s3ImportRole

s3ImportRole?: IRole

Role that will be associated with this DB instance to enable S3 import. This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportBuckets is used.

For Microsoft SQL Server:

See

Default

New role is created if s3ImportBuckets is set, no role is defined otherwise

`Optional` `Readonly`securityGroups

securityGroups?: ISecurityGroup[]

The security groups to assign to the DB instance.

Default

- a new security group is created

`Optional` `Readonly`storageEncrypted

storageEncrypted?: boolean

Indicates whether the DB instance is encrypted.

Default

- true if storageEncryptionKey has been provided, false otherwise

`Optional` `Readonly`storageEncryptionKey

storageEncryptionKey?: IKeyRef

The KMS key that's used to encrypt the DB instance.

Default

- default master key if storageEncrypted is true, no key otherwise

`Optional` `Readonly`storageThroughput

storageThroughput?: number

The storage throughput, specified in mebibytes per second (MiBps).

Only applicable for GP3.

See

https://docs.aws.amazon.com//AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage

Default

- 125 MiBps if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL,
less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 500 MiBps otherwise (except for
SQL Server where the default is always 125 MiBps).

`Optional` `Readonly`storageType

storageType?: StorageType

The storage type. Storage types supported are gp2, io1, standard.

See

https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD

Default

GP2

`Optional` `Readonly`subnetGroup

subnetGroup?: ISubnetGroup

Existing subnet group for the instance.

Default

- a new subnet group will be created.

`Optional` `Readonly`timezone

timezone?: string

The time zone of the instance. This is currently supported only by Microsoft Sql Server.

Default

- RDS default timezone

`Readonly`vpc

vpc: IVpc

The VPC network where the DB subnet group should be created.

`Optional` `Readonly`vpcSubnets

vpcSubnets?: SubnetSelection

The type of subnets to add to the created DB subnet group.

Default

- private subnets

Interface GuDatabaseInstanceProps

Hierarchy (View Summary)

Index

Properties

Properties

Optional ReadonlyallocatedStorage

Default

Optional ReadonlyallowMajorVersionUpgrade

Default

app

Optional ReadonlyapplyImmediately

See

Default

Optional ReadonlyautoMinorVersionUpgrade

Default

Optional ReadonlyavailabilityZone

Default

Optional ReadonlycaCertificate

See

Default

Optional ReadonlycharacterSetName

Default

Optional ReadonlycloudwatchLogsExports

Default

Optional ReadonlycloudwatchLogsRetention

Default

Optional ReadonlycloudwatchLogsRetentionRole

Default

Optional ReadonlycopyTagsToSnapshot

Default

Optional Readonlycredentials

Default

Optional ReadonlydatabaseInsightsMode

Default

Optional ReadonlydatabaseName

Default

Optional ReadonlydeleteAutomatedBackups

Default

Optional ReadonlydeletionProtection

Default

devXBackups

Optional Readonlydomain

Default

Optional ReadonlydomainRole

Default

Optional ReadonlyenablePerformanceInsights

Default

Readonlyengine

Optional ReadonlyengineLifecycleSupport

See

Default

Optional ReadonlyiamAuthentication

Default

Optional ReadonlyinstanceIdentifier

Default

instanceType

Optional Readonlyiops

Default

Optional ReadonlylicenseModel

Default

Optional ReadonlymaxAllocatedStorage

See

Default

Optional ReadonlymonitoringInterval

Default

Optional ReadonlymonitoringRole

Default

Optional ReadonlymultiAz

Default

Optional ReadonlynetworkType

Default

Optional ReadonlyoptionGroup

Default

Optional ReadonlyparameterGroup

Default

Optional Readonlyparameters

Default

Optional ReadonlyperformanceInsightEncryptionKey

Default

Optional ReadonlyperformanceInsightRetention

`Optional` `Readonly`allocatedStorage

`Optional` `Readonly`allowMajorVersionUpgrade

`Optional` `Readonly`applyImmediately

`Optional` `Readonly`autoMinorVersionUpgrade

`Optional` `Readonly`availabilityZone

`Optional` `Readonly`caCertificate

`Optional` `Readonly`characterSetName

`Optional` `Readonly`cloudwatchLogsExports

`Optional` `Readonly`cloudwatchLogsRetention

`Optional` `Readonly`cloudwatchLogsRetentionRole

`Optional` `Readonly`copyTagsToSnapshot

`Optional` `Readonly`credentials

`Optional` `Readonly`databaseInsightsMode

`Optional` `Readonly`databaseName

`Optional` `Readonly`deleteAutomatedBackups

`Optional` `Readonly`deletionProtection

`Optional` `Readonly`domain

`Optional` `Readonly`domainRole

`Optional` `Readonly`enablePerformanceInsights

`Readonly`engine

`Optional` `Readonly`engineLifecycleSupport

`Optional` `Readonly`iamAuthentication

`Optional` `Readonly`instanceIdentifier

`Optional` `Readonly`iops

`Optional` `Readonly`licenseModel

`Optional` `Readonly`maxAllocatedStorage

`Optional` `Readonly`monitoringInterval

`Optional` `Readonly`monitoringRole

`Optional` `Readonly`multiAz

`Optional` `Readonly`networkType

`Optional` `Readonly`optionGroup

`Optional` `Readonly`parameterGroup

`Optional` `Readonly`parameters

`Optional` `Readonly`performanceInsightEncryptionKey

`Optional` `Readonly`performanceInsightRetention

`Optional` `Readonly`port

`Optional` `Readonly`preferredMaintenanceWindow

`Optional` `Readonly`processorFeatures

`Optional` `Readonly`publiclyAccessible

`Optional` `Readonly`removalPolicy

`Optional` `Readonly`s3ExportBuckets

`Optional` `Readonly`s3ExportRole

`Optional` `Readonly`s3ImportBuckets

`Optional` `Readonly`s3ImportRole

`Optional` `Readonly`securityGroups

`Optional` `Readonly`storageEncrypted

`Optional` `Readonly`storageEncryptionKey

`Optional` `Readonly`storageThroughput

`Optional` `Readonly`storageType

`Optional` `Readonly`subnetGroup

`Optional` `Readonly`timezone

`Readonly`vpc

`Optional` `Readonly`vpcSubnets