InstanceProps Struct
Instance properties for database instances.
Example
ts
declare const vpc: ec2.Vpc;
const cluster = new rds.DatabaseCluster(this, 'Database', {
engine: rds.DatabaseClusterEngine.auroraMysql({
version: rds.AuroraMysqlEngineVersion.VER_3_03_0,
}),
instances: 2,
instanceProps: {
instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },
vpc,
},
});
Properties
allowMajorVersionUpgradeoptionalbooleanallow_major_version_upgradeoptionalboolallowMajorVersionUpgradeoptionalBooleanAllowMajorVersionUpgradeoptionalboolAllowMajorVersionUpgradeoptional*bool= false#Whether to allow upgrade of major version for the DB instance.
autoMinorVersionUpgradeoptionalbooleanauto_minor_version_upgradeoptionalboolautoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptional*bool= true#Whether to enable automatic upgrade of minor version for the DB instance.
deleteAutomatedBackupsoptionalbooleandelete_automated_backupsoptionalbooldeleteAutomatedBackupsoptionalBooleanDeleteAutomatedBackupsoptionalboolDeleteAutomatedBackupsoptional*bool= true#Whether to remove automated backups immediately after the DB instance is deleted for the DB instance.
enablePerformanceInsightsoptionalbooleanenable_performance_insightsoptionalboolenablePerformanceInsightsoptionalBooleanEnablePerformanceInsightsoptionalboolEnablePerformanceInsightsoptional*bool#Whether to enable Performance Insights for the DB instance.
Default: false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.
instanceTypeoptionalInstanceTypeinstance_typeoptionalInstanceTypeinstanceTypeoptionalInstanceTypeInstanceTypeoptionalInstanceTypeInstanceTypeoptionalInstanceType#What type of instance to start for the replicas.
Default: t3.medium (or, more precisely, db.t3.medium)
parameterGroupoptionalIParameterGroupparameter_groupoptionalIParameterGroupparameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroup#The DB parameter group to associate with the instance.
Default: no parameter group
parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string= None#The 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.
performanceInsightEncryptionKeyoptionalIKeyperformance_insight_encryption_keyoptionalIKeyperformanceInsightEncryptionKeyoptionalIKeyPerformanceInsightEncryptionKeyoptionalIKeyPerformanceInsightEncryptionKeyoptionalIKey#The AWS KMS key for encryption of Performance Insights data.
Default: default master key
performanceInsightRetentionoptionalPerformanceInsightRetentionperformance_insight_retentionoptionalPerformanceInsightRetentionperformanceInsightRetentionoptionalPerformanceInsightRetentionPerformanceInsightRetentionoptionalPerformanceInsightRetentionPerformanceInsightRetentionoptionalPerformanceInsightRetention= 7#The amount of time, in days, to retain Performance Insights data.
preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string#A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
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.
Example: 'Sun:23:45-Mon:00:15'
publiclyAccessibleoptionalbooleanpublicly_accessibleoptionalboolpubliclyAccessibleoptionalBooleanPubliclyAccessibleoptionalboolPubliclyAccessibleoptional*bool#Indicates whether the DB instance is an internet-facing instance.
Default: true if vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#Security group.
Default: a new security group is created.
What subnets to run the RDS instances in.
Must be at least 2 subnets in two different AZs.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Where to place the instances within the VPC.
Default: the Vpc default strategy if not specified.