Interface DatabaseInstanceProps
- All Superinterfaces:
DatabaseInstanceNewProps
,DatabaseInstanceSourceProps
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DatabaseInstanceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:49.151Z")
@Stability(Stable)
public interface DatabaseInstanceProps
extends software.amazon.jsii.JsiiSerializable, DatabaseInstanceSourceProps
Construction properties for a DatabaseInstance.
Example:
Vpc vpc; IInstanceEngine engine = DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder().version(PostgresEngineVersion.VER_12_3).build()); DatabaseInstance.Builder.create(this, "InstanceWithUsername") .engine(engine) .vpc(vpc) .credentials(Credentials.fromGeneratedSecret("postgres")) .build(); DatabaseInstance.Builder.create(this, "InstanceWithUsernameAndPassword") .engine(engine) .vpc(vpc) .credentials(Credentials.fromPassword("postgres", SecretValue.ssmSecure("/dbPassword", "1"))) .build(); ISecret mySecret = Secret.fromSecretName(this, "DBSecret", "myDBLoginInfo"); DatabaseInstance.Builder.create(this, "InstanceWithSecretLogin") .engine(engine) .vpc(vpc) .credentials(Credentials.fromSecret(mySecret)) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forDatabaseInstanceProps
static final class
An implementation forDatabaseInstanceProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
For supported engines, specifies the character set to associate with the DB instance.default Credentials
Credentials for the administrative user.default Boolean
Indicates whether the DB instance is encrypted.default IKey
The KMS key that's used to encrypt the DB instance.Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceNewProps
getAutoMinorVersionUpgrade, getAvailabilityZone, getBackupRetention, getCloudwatchLogsExports, getCloudwatchLogsRetention, getCloudwatchLogsRetentionRole, getCopyTagsToSnapshot, getDeleteAutomatedBackups, getDeletionProtection, getDomain, getDomainRole, getEnablePerformanceInsights, getIamAuthentication, getInstanceIdentifier, getIops, getMaxAllocatedStorage, getMonitoringInterval, getMonitoringRole, getMultiAz, getOptionGroup, getParameterGroup, getPerformanceInsightEncryptionKey, getPerformanceInsightRetention, getPort, getPreferredBackupWindow, getPreferredMaintenanceWindow, getProcessorFeatures, getPubliclyAccessible, getRemovalPolicy, getS3ExportBuckets, getS3ExportRole, getS3ImportBuckets, getS3ImportRole, getSecurityGroups, getStorageType, getSubnetGroup, getVpc, getVpcPlacement, 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
For supported engines, specifies the character set to associate with the DB instance.Default: - RDS default character set name
-
getCredentials
Credentials for the administrative user.Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password
-
getStorageEncrypted
Indicates whether the DB instance is encrypted.Default: - true if storageEncryptionKey has been provided, false otherwise
-
getStorageEncryptionKey
The KMS key that's used to encrypt the DB instance.Default: - default master key if storageEncrypted is true, no key otherwise
-
builder
- Returns:
- a
DatabaseInstanceProps.Builder
ofDatabaseInstanceProps
-