Interface IInstanceProps

Instance properties for database instances.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IInstanceProps

Syntax (vb)

Public Interface IInstanceProps

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;

            var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
                Engine = DatabaseClusterEngine.AuroraMysql(new AuroraMysqlClusterEngineProps {
                    Version = AuroraMysqlEngineVersion.VER_3_03_0
                }),
                Instances = 2,
                InstanceProps = new InstanceProps {
                    InstanceType = InstanceType.Of(InstanceClass.BURSTABLE3, InstanceSize.SMALL),
                    VpcSubnets = new SubnetSelection { SubnetType = SubnetType.PUBLIC },
                    Vpc = vpc
                }
            });

Synopsis

Properties

AllowMajorVersionUpgrade	Whether to allow upgrade of major version for the DB instance.
AutoMinorVersionUpgrade	Whether to enable automatic upgrade of minor version for the DB instance.
DeleteAutomatedBackups	Whether to remove automated backups immediately after the DB instance is deleted for the DB instance.
EnablePerformanceInsights	Whether to enable Performance Insights for the DB instance.
InstanceType	What type of instance to start for the replicas.
ParameterGroup	The DB parameter group to associate with the instance.
Parameters	The parameters in the DBParameterGroup to create automatically.
PerformanceInsightEncryptionKey	The AWS KMS key for encryption of Performance Insights data.
PerformanceInsightRetention	The amount of time, in days, to retain Performance Insights data.
PreferredMaintenanceWindow	A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
PubliclyAccessible	Indicates whether the DB instance is an internet-facing instance.
SecurityGroups	Security group.
Vpc	What subnets to run the RDS instances in.
VpcSubnets	Where to place the instances within the VPC.

Properties

AllowMajorVersionUpgrade

Whether to allow upgrade of major version for the DB instance.

bool? AllowMajorVersionUpgrade { get; }

Property Value

bool?

Remarks

Default: - false

AutoMinorVersionUpgrade

Whether to enable automatic upgrade of minor version for the DB instance.

bool? AutoMinorVersionUpgrade { get; }

Property Value

bool?

Remarks

Default: - true

DeleteAutomatedBackups

Whether to remove automated backups immediately after the DB instance is deleted for the DB instance.

bool? DeleteAutomatedBackups { get; }

Property Value

bool?

Remarks

Default: - true

EnablePerformanceInsights

Whether to enable Performance Insights for the DB instance.

bool? EnablePerformanceInsights { get; }

Property Value

bool?

Remarks

Default: - false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.

InstanceType

What type of instance to start for the replicas.

InstanceType? InstanceType { get; }

Property Value

InstanceType

Remarks

Default: - t3.medium (or, more precisely, db.t3.medium)

ParameterGroup

The DB parameter group to associate with the instance.

IParameterGroup? ParameterGroup { get; }

Property Value

IParameterGroup

Remarks

Default: no parameter group

Parameters

The parameters in the DBParameterGroup to create automatically.

IDictionary<string, string>? Parameters { get; }

Property Value

IDictionary<string, string>

Remarks

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

Default: - None

PerformanceInsightEncryptionKey

The AWS KMS key for encryption of Performance Insights data.

IKey? PerformanceInsightEncryptionKey { get; }

Property Value

IKey

Remarks

Default: - default master key

PerformanceInsightRetention

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

PerformanceInsightRetention? PerformanceInsightRetention { get; }

Property Value

PerformanceInsightRetention?

Remarks

Default: 7

PreferredMaintenanceWindow

A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).

string? PreferredMaintenanceWindow { get; }

Property Value

string

Remarks

Example: 'Sun:23:45-Mon:00:15'

Default: - 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.

See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

PubliclyAccessible

Indicates whether the DB instance is an internet-facing instance.

bool? PubliclyAccessible { get; }

Property Value

bool?

Remarks

Default: - true if vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise

SecurityGroups

Security group.

ISecurityGroup[]? SecurityGroups { get; }

Property Value

ISecurityGroup[]

Remarks

Default: a new security group is created.

Vpc

What subnets to run the RDS instances in.

IVpc Vpc { get; }

Property Value

IVpc

Remarks

Must be at least 2 subnets in two different AZs.

VpcSubnets

Where to place the instances within the VPC.

ISubnetSelection? VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

Default: - the Vpc default strategy if not specified.