Package software.amazon.awscdk.services.rds

Interface DatabaseInstanceProps

All Superinterfaces:

DatabaseInstanceNewProps, DatabaseInstanceSourceProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-07-02T13:32:45.969Z")
@Stability(Stable)
public interface DatabaseInstanceProps
extends software.amazon.jsii.JsiiSerializable, DatabaseInstanceSourceProps

Construction properties for a DatabaseInstance.

Example:

 Vpc vpc;
 DatabaseInstance iopsInstance = DatabaseInstance.Builder.create(this, "IopsInstance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_39).build()))
         .vpc(vpc)
         .storageType(StorageType.IO1)
         .iops(5000)
         .build();
 DatabaseInstance gp3Instance = DatabaseInstance.Builder.create(this, "Gp3Instance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_39).build()))
         .vpc(vpc)
         .allocatedStorage(500)
         .storageType(StorageType.GP3)
         .storageThroughput(500)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatabaseInstanceProps.Builder	A builder for DatabaseInstanceProps
static final class	DatabaseInstanceProps.Jsii$Proxy	An implementation for DatabaseInstanceProps

Method Summary

Modifier and Type	Method	Description
static DatabaseInstanceProps.Builder	builder()
default String	getCharacterSetName()	For supported engines, specifies the character set to associate with the DB instance.
default Credentials	getCredentials()	Credentials for the administrative user.
default Boolean	getManageMasterUserPassword()	Whether to use RDS native integration with AWS Secrets Manager for master user password management.
default Boolean	getStorageEncrypted()	Indicates whether the DB instance is encrypted.
default IKeyRef	getStorageEncryptionKey()	The KMS key that's used to encrypt the DB instance.

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceNewProps

getApplyImmediately, getAutoMinorVersionUpgrade, getAvailabilityZone, getBackupRetention, getCaCertificate, getCloudwatchLogsExports, getCloudwatchLogsRetention, getCloudwatchLogsRetentionRole, getCopyTagsToSnapshot, getDatabaseInsightsMode, getDeleteAutomatedBackups, getDeletionProtection, getDomain, getDomainRole, getEnablePerformanceInsights, getEngineLifecycleSupport, getIamAuthentication, getInstanceIdentifier, getIops, getMaxAllocatedStorage, getMonitoringInterval, getMonitoringRole, getMultiAz, getNetworkType, getOptionGroup, getParameterGroup, getPerformanceInsightEncryptionKey, getPerformanceInsightRetention, getPort, getPreferredBackupWindow, getPreferredMaintenanceWindow, getProcessorFeatures, getPubliclyAccessible, getRemovalPolicy, getS3ExportBuckets, getS3ExportRole, getS3ImportBuckets, getS3ImportRole, getSecurityGroups, getStorageThroughput, getStorageType, getSubnetGroup, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceSourceProps

getAllocatedStorage, getAllowMajorVersionUpgrade, getDatabaseName, getEngine, getInstanceType, getLicenseModel, getParameters, getTimezone

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCharacterSetName

@Stability(Stable)
@Nullable
default String getCharacterSetName()

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

Default: - RDS default character set name

getCredentials

@Stability(Stable)
@Nullable
default Credentials getCredentials()

Credentials for the administrative user.

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

getManageMasterUserPassword

@Stability(Stable)
@Nullable
default Boolean getManageMasterUserPassword()

Whether to use RDS native integration with AWS Secrets Manager for master user password management.

When enabled, RDS generates and manages the master user password in Secrets Manager. Cannot be used together with credentials containing a password.

Default: false

See Also:

• https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html

getStorageEncrypted

@Stability(Stable)
@Nullable
default Boolean getStorageEncrypted()

Indicates whether the DB instance is encrypted.

Default: - true if storageEncryptionKey has been provided, false otherwise

getStorageEncryptionKey

@Stability(Stable)
@Nullable
default IKeyRef getStorageEncryptionKey()

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

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

builder

@Stability(Stable)
static DatabaseInstanceProps.Builder builder()

Returns:

a DatabaseInstanceProps.Builder of DatabaseInstanceProps