Optional Readonly allocated100
Optional Readonly allowWhether to allow major version upgrades.
false
Optional Readonly autoIndicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
true
Optional Readonly availabilityThe name of the Availability Zone where the DB instance will be located.
- no preference
Optional Readonly backupThe number of days during which automatic DB snapshots are retained. Set to zero to disable backups. When creating a read replica, you must enable automatic backups on the source database instance by setting the backup retention to a value other than zero.
- Duration.days(1) for source instances, disabled for read replicas
Optional Readonly caThe identifier of the CA certificate for this DB instance.
Specifying or updating this property triggers a reboot.
For RDS DB engines:
- RDS will choose a certificate authority
Optional Readonly characterFor supported engines, specifies the character set to associate with the DB instance.
- RDS default character set name
Optional Readonly cloudwatchThe list of log types that need to be enabled for exporting to CloudWatch Logs.
- no log exports
Optional Readonly cloudwatchThe 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.
- logs never expire
Optional Readonly cloudwatchThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.
- a new role is created.
Optional Readonly copyIndicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
true
Optional Readonly credentialsCredentials for the administrative user
- A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password
Optional Readonly databaseThe name of the database.
- no name
Optional Readonly deleteIndicates whether automated backups should be deleted or retained when you delete a DB instance.
false
Optional Readonly deletionIndicates whether the DB instance should have deletion protection enabled.
removalPolicy is RETAIN, false otherwiseOptional Readonly domainThe Active Directory directory ID to create the DB instance in.
- Do not join domain
Optional Readonly domainThe IAM role to be used when making API calls to the Directory Service. The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.
DatabaseInstanceNewProps#domain is specifiedOptional Readonly enableWhether to enable Performance Insights for the DB instance.
performanceInsightRentention or performanceInsightEncryptionKey is set.Readonly engineThe database engine.
Optional Readonly iamWhether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
false
Optional Readonly instanceA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase.
- a CloudFormation generated name
Optional Readonly iopsThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
- 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 licenseThe license model.
- RDS default license model
Optional Readonly maxUpper limit to which RDS can scale the storage in GiB(Gibibyte).
- No autoscaling of RDS instance
Optional Readonly monitoringThe interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
- no enhanced monitoring
Optional Readonly monitoringRole that will be used to manage DB instance monitoring.
- A role is automatically created for you
Optional Readonly multiSpecifies if the database instance is a multiple Availability Zone deployment.
false
Optional Readonly networkThe network type of the DB instance.
- IPV4
Optional Readonly optionThe option group to associate with the instance.
- no option group
Optional Readonly parameterThe DB parameter group to associate with the instance.
- no parameter group
Optional Readonly parametersThe 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.
- None
Optional Readonly performanceThe AWS KMS key for encryption of Performance Insights data.
- default master key
Optional Readonly performanceThe amount of time, in days, to retain Performance Insights data.
7 this is the free tier
Optional Readonly portThe port for the instance.
- the default port for the chosen engine.
Optional Readonly preferredThe daily time range during which automated backups are performed.
Constraints:
hh24:mi-hh24:mi.- a 30-minute window selected at random from an 8-hour block of
time for each AWS Region. To see the time blocks available, see
https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
Optional Readonly preferredThe weekly time range (in UTC) during which system maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Constraint: Minimum 30-minute window
- 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 processorThe number of CPU cores and the number of threads per core.
- 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 publiclyIndicates whether the DB instance is an internet-facing instance.
true if vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwiseOptional Readonly removalThe CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
- RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)
Optional Readonly s3S3 buckets that you want to load data into.
This property must not be used if s3ExportRole is used.
For Microsoft SQL Server:
Optional Readonly s3Role 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:
s3ExportBuckets is set, no role is defined otherwiseOptional Readonly s3S3 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:
- None
Optional Readonly s3Role 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:
s3ImportBuckets is set, no role is defined otherwiseOptional Readonly securityThe security groups to assign to the DB instance.
- a new security group is created
Optional Readonly storageIndicates whether the DB instance is encrypted.
- true if storageEncryptionKey has been provided, false otherwise
Optional Readonly storageThe KMS key that's used to encrypt the DB instance.
- default master key if storageEncrypted is true, no key otherwise
Optional Readonly storageThe storage throughput, specified in mebibytes per second (MiBps).
Only applicable for GP3.
https://docs.aws.amazon.com//AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage
- 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 storageThe storage type. Storage types supported are gp2, io1, standard.
Optional Readonly subnetExisting subnet group for the instance.
- a new subnet group will be created.
Optional Readonly timezoneThe time zone of the instance. This is currently supported only by Microsoft Sql Server.
- RDS default timezone
Readonly vpcThe VPC network where the DB subnet group should be created.
Optional Readonly vpcThe type of subnets to add to the created DB subnet group.
- private subnets
Generated using TypeDoc
The allocated storage size, specified in gibibytes (GiB).