Interface IDatabaseInstanceProps

Construction properties for a DatabaseInstance.

Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDatabaseInstanceProps : IDatabaseInstanceSourceProps, IDatabaseInstanceNewProps
Syntax (vb)
Public Interface IDatabaseInstanceProps Inherits IDatabaseInstanceSourceProps, IDatabaseInstanceNewProps
Remarks

ExampleMetadata: infused

Examples
Vpc vpc;


            var iopsInstance = new DatabaseInstance(this, "IopsInstance", new DatabaseInstanceProps {
                Engine = DatabaseInstanceEngine.Mysql(new MySqlInstanceEngineProps { Version = MysqlEngineVersion.VER_8_0_39 }),
                Vpc = vpc,
                StorageType = StorageType.IO1,
                Iops = 5000
            });

            var gp3Instance = new DatabaseInstance(this, "Gp3Instance", new DatabaseInstanceProps {
                Engine = DatabaseInstanceEngine.Mysql(new MySqlInstanceEngineProps { Version = MysqlEngineVersion.VER_8_0_39 }),
                Vpc = vpc,
                AllocatedStorage = 500,
                StorageType = StorageType.GP3,
                StorageThroughput = 500
            });

Synopsis

Properties

CharacterSetName

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

Credentials for the administrative user.
StorageEncrypted

Indicates whether the DB instance is encrypted.
StorageEncryptionKey

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

Properties

CharacterSetName

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

string? CharacterSetName { get; }
Property Value

string

Remarks

Default: - RDS default character set name

Credentials

Credentials for the administrative user.

Credentials? Credentials { get; }
Property Value

Credentials

Remarks

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

StorageEncrypted

Indicates whether the DB instance is encrypted.

bool? StorageEncrypted { get; }
Property Value

bool?

Remarks

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

StorageEncryptionKey

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

IKeyRef? StorageEncryptionKey { get; }
Property Value

IKeyRef

Remarks

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