DatabaseInstanceFromSnapshotProps Struct

Construction properties for a DatabaseInstanceFromSnapshot.

Source: aws-rds/lib/instance.ts
Type last changed: v2.201.0 · 13 Jun 2025

Example

declare const vpc: ec2.Vpc;
const engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_16_3 });
const myKey = new kms.Key(this, 'MyKey');

new rds.DatabaseInstanceFromSnapshot(this, 'InstanceFromSnapshotWithCustomizedSecret', {
  engine,
  vpc,
  snapshotIdentifier: 'mySnapshot',
  credentials: rds.SnapshotCredentials.fromGeneratedSecret('username', {
    encryptionKey: myKey,
    excludeCharacters: '!&*^#@()',
    replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],
  }),
});

Properties

allocatedStoragenumberallocated_storageint | floatallocatedStorageNumberAllocatedStoragedoubleAllocatedStorage*float64= 100#

The allocated storage size, specified in gibibytes (GiB).

allowMajorVersionUpgradebooleanallow_major_version_upgradeboolallowMajorVersionUpgradeBooleanAllowMajorVersionUpgradeboolAllowMajorVersionUpgrade*bool= false#

Whether to allow major version upgrades.

applyImmediatelybooleanapply_immediatelyboolapplyImmediatelyBooleanApplyImmediatelyboolApplyImmediately*bool#

Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the `preferredMaintenanceWindow` setting.

Default: Changes will be applied immediately

notes

If set to false, changes are applied during the next maintenance window.

Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.

This property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.

autoMinorVersionUpgradebooleanauto_minor_version_upgradeboolautoMinorVersionUpgradeBooleanAutoMinorVersionUpgradeboolAutoMinorVersionUpgrade*bool= true#

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

availabilityZonestringavailability_zonestravailabilityZoneStringAvailabilityZonestringAvailabilityZone*string#

The name of the Availability Zone where the DB instance will be located.

Default: no preference

backupRetentionDurationbackup_retentionDurationbackupRetentionDurationBackupRetentionDurationBackupRetentionDuration#

The number of days during which automatic DB snapshots are retained.

Default: Duration.days(1) for source instances, disabled for read replicas

Set to zero to disable backups. When creating a read replica, you must enable automatic backups on the source database instance by setting the backup retention to a value other than zero.

caCertificateCaCertificateca_certificateCaCertificatecaCertificateCaCertificateCaCertificateCaCertificateCaCertificateCaCertificate#

The identifier of the CA certificate for this DB instance.

Default: RDS will choose a certificate authority

Specifying or updating this property triggers a reboot.

For RDS DB engines:

cloudwatchLogsExportsstring[]cloudwatch_logs_exportstyping.List[str]cloudwatchLogsExportsList<String>CloudwatchLogsExportsstring[]CloudwatchLogsExports*[]*string#

The list of log types that need to be enabled for exporting to CloudWatch Logs.

Default: no log exports

cloudwatchLogsRetentionRetentionDayscloudwatch_logs_retentionRetentionDayscloudwatchLogsRetentionRetentionDaysCloudwatchLogsRetentionRetentionDaysCloudwatchLogsRetentionRetentionDays#

The number of days log events are kept in CloudWatch Logs.

Default: logs never expire

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

cloudwatchLogsRetentionRoleIRolecloudwatch_logs_retention_roleIRolecloudwatchLogsRetentionRoleIRoleCloudwatchLogsRetentionRoleIRoleCloudwatchLogsRetentionRoleIRole#

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default: a new role is created.

clusterSnapshotIdentifierstringcluster_snapshot_identifierstrclusterSnapshotIdentifierStringClusterSnapshotIdentifierstringClusterSnapshotIdentifier*string= None#

The identifier for the Multi-AZ DB cluster snapshot to restore from.

notes

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide .

Constraints:

Can't be specified when snapshotIdentifier is specified.
Must be specified when snapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the clusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.

copyTagsToSnapshotbooleancopy_tags_to_snapshotboolcopyTagsToSnapshotBooleanCopyTagsToSnapshotboolCopyTagsToSnapshot*bool= true#

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.

credentialsSnapshotCredentialscredentialsSnapshotCredentialscredentialsSnapshotCredentialsCredentialsSnapshotCredentialsCredentialsSnapshotCredentials#

Master user credentials.

Default: The existing username and password from the snapshot will be used.

Note - It is not possible to change the master username for a snapshot; however, it is possible to provide (or generate) a new password.

databaseInsightsModeDatabaseInsightsModedatabase_insights_modeDatabaseInsightsModedatabaseInsightsModeDatabaseInsightsModeDatabaseInsightsModeDatabaseInsightsModeDatabaseInsightsModeDatabaseInsightsMode#

The database insights mode.

Default: DatabaseInsightsMode.STANDARD when performance insights are enabled, otherwise not set.

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*string#

The name of the database.

Default: no name

deleteAutomatedBackupsbooleandelete_automated_backupsbooldeleteAutomatedBackupsBooleanDeleteAutomatedBackupsboolDeleteAutomatedBackups*bool= true#

Indicates whether automated backups should be deleted or retained when you delete a DB instance.

deletionProtectionbooleandeletion_protectionbooldeletionProtectionBooleanDeletionProtectionboolDeletionProtection*bool#

Indicates whether the DB instance should have deletion protection enabled.

Default: true if removalPolicy is RETAIN, false otherwise

domainstringdomainstrdomainStringDomainstringDomain*string#

The Active Directory directory ID to create the DB instance in.

Default: Do not join domain

domainRoleIRoleRefdomain_roleIRoleRefdomainRoleIRoleRefDomainRoleIRoleRefDomainRoleIRoleRef#

The IAM role to be used when making API calls to the Directory Service.

Default: The role will be created for you if DatabaseInstanceNewProps#domain is specified

The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.

enablePerformanceInsightsbooleanenable_performance_insightsboolenablePerformanceInsightsBooleanEnablePerformanceInsightsboolEnablePerformanceInsights*bool#

Whether to enable Performance Insights for the DB instance.

Default: false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.

engineIInstanceEngineengineIInstanceEngineengineIInstanceEngineEngineIInstanceEngineEngineIInstanceEnginerequired#

The database engine.

engineLifecycleSupportEngineLifecycleSupportengine_lifecycle_supportEngineLifecycleSupportengineLifecycleSupportEngineLifecycleSupportEngineLifecycleSupportEngineLifecycleSupportEngineLifecycleSupportEngineLifecycleSupport#

The life cycle type for this DB instance.

Default: undefined - AWS RDS default setting is EngineLifecycleSupport.OPEN_SOURCE_RDS_EXTENDED_SUPPORT

This setting applies only to RDS for MySQL and RDS for PostgreSQL.

iamAuthenticationbooleaniam_authenticationbooliamAuthenticationBooleanIamAuthenticationboolIamAuthentication*bool= false#

Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

instanceIdentifierstringinstance_identifierstrinstanceIdentifierStringInstanceIdentifierstringInstanceIdentifier*string#

A name for the DB instance.

Default: a CloudFormation generated name

If you specify a name, AWS CloudFormation converts it to lowercase.

instanceTypeInstanceTypeinstance_typeInstanceTypeinstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceType#

The name of the compute and memory capacity for the instance.

Default: m5.large (or, more specifically, db.m5.large)

iopsnumberiopsint | floatiopsNumberIopsdoubleIops*float64#

The number of I/O operations per second (IOPS) that the database provisions.

Default: no provisioned iops if storage type is not specified. For GP3: 3,000 IOPS if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 12,000 IOPS otherwise (except for SQL Server where the default is always 3,000 IOPS).

The value must be equal to or greater than 1000.

licenseModelLicenseModellicense_modelLicenseModellicenseModelLicenseModelLicenseModelLicenseModelLicenseModelLicenseModel#

The license model.

Default: RDS default license model

maxAllocatedStoragenumbermax_allocated_storageint | floatmaxAllocatedStorageNumberMaxAllocatedStoragedoubleMaxAllocatedStorage*float64#

Upper limit to which RDS can scale the storage in GiB(Gibibyte).

Default: No autoscaling of RDS instance

monitoringIntervalDurationmonitoring_intervalDurationmonitoringIntervalDurationMonitoringIntervalDurationMonitoringIntervalDuration#

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.

Default: no enhanced monitoring

monitoringRoleIRoleRefmonitoring_roleIRoleRefmonitoringRoleIRoleRefMonitoringRoleIRoleRefMonitoringRoleIRoleRef#

Role that will be used to manage DB instance monitoring.

Default: A role is automatically created for you

multiAzbooleanmulti_azboolmultiAzBooleanMultiAzboolMultiAz*bool= false#

Specifies if the database instance is a multiple Availability Zone deployment.

networkTypeNetworkTypenetwork_typeNetworkTypenetworkTypeNetworkTypeNetworkTypeNetworkTypeNetworkTypeNetworkType= IPV4#

The network type of the DB instance.

optionGroupIOptionGroupoption_groupIOptionGroupoptionGroupIOptionGroupOptionGroupIOptionGroupOptionGroupIOptionGroup#

The option group to associate with the instance.

Default: no option group

parameterGroupIParameterGroupparameter_groupIParameterGroupparameterGroupIParameterGroupParameterGroupIParameterGroupParameterGroupIParameterGroup#

The DB parameter group to associate with the instance.

Default: no parameter group

parameters{ [key: string]: string }parameterstyping.Mapping[str, str]parametersMap<String, String>ParametersIDictionary<string, string>Parameters*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.

performanceInsightEncryptionKeyIKeyRefperformance_insight_encryption_keyIKeyRefperformanceInsightEncryptionKeyIKeyRefPerformanceInsightEncryptionKeyIKeyRefPerformanceInsightEncryptionKeyIKeyRef#

The AWS KMS key for encryption of Performance Insights data.

Default: default master key

performanceInsightRetentionPerformanceInsightRetentionperformance_insight_retentionPerformanceInsightRetentionperformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetentionPerformanceInsightRetention#

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

Default: 7 this is the free tier

If you set databaseInsightsMode to DatabaseInsightsMode.ADVANCED, you must set this property to PerformanceInsightRetention.MONTHS_15.

portnumberportint | floatportNumberPortdoublePort*float64#

The port for the instance.

Default: the default port for the chosen engine.

preferredBackupWindowstringpreferred_backup_windowstrpreferredBackupWindowStringPreferredBackupWindowstringPreferredBackupWindow*string#

The daily time range during which automated backups are performed.

Default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

preferredMaintenanceWindowstringpreferred_maintenance_windowstrpreferredMaintenanceWindowStringPreferredMaintenanceWindowstringPreferredMaintenanceWindow*string#

The weekly time range (in UTC) during which system maintenance can occur.

Default: a 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. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

processorFeaturesProcessorFeaturesprocessor_featuresProcessorFeaturesprocessorFeaturesProcessorFeaturesProcessorFeaturesProcessorFeaturesProcessorFeaturesProcessorFeatures#

The number of CPU cores and the number of threads per core.

Default: the default number of CPU cores and threads per core for the chosen instance class. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor

publiclyAccessiblebooleanpublicly_accessibleboolpubliclyAccessibleBooleanPubliclyAccessibleboolPubliclyAccessible*bool#

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

Default: true if the instance's vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise

If not specified, the instance's vpcSubnets will be used to determine if the instance is internet-facing or not.

removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy#

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Default: RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)

s3ExportBucketsIBucket[]s3_export_bucketstyping.List[IBucket]s3ExportBucketsList<IBucket>S3ExportBucketsIBucket[]S3ExportBuckets*[]IBucket= None#

S3 buckets that you want to load data into.

This property must not be used if s3ExportRole is used.

For Microsoft SQL Server:

s3ExportRoleIRoles3_export_roleIRoles3ExportRoleIRoleS3ExportRoleIRoleS3ExportRoleIRole#

Role that will be associated with this DB instance to enable S3 export.

Default: New role is created if s3ExportBuckets is set, no role is defined otherwise

This property must not be used if s3ExportBuckets is used.

For Microsoft SQL Server:

s3ImportBucketsIBucket[]s3_import_bucketstyping.List[IBucket]s3ImportBucketsList<IBucket>S3ImportBucketsIBucket[]S3ImportBuckets*[]IBucket= None#

S3 buckets that you want to load data from.

This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportRole is used.

For Microsoft SQL Server:

s3ImportRoleIRoles3_import_roleIRoles3ImportRoleIRoleS3ImportRoleIRoleS3ImportRoleIRole#

Role that will be associated with this DB instance to enable S3 import.

Default: New role is created if s3ImportBuckets is set, no role is defined otherwise

This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportBuckets is used.

For Microsoft SQL Server:

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup#

The security groups to assign to the DB instance.

Default: a new security group is created

snapshotIdentifierstringsnapshot_identifierstrsnapshotIdentifierStringSnapshotIdentifierstringSnapshotIdentifier*string= None#

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

notes

If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. Constraints:

Can't be specified when clusterSnapshotIdentifier is specified.
Must be specified when clusterSnapshotIdentifier isn't specified.

storageThroughputnumberstorage_throughputint | floatstorageThroughputNumberStorageThroughputdoubleStorageThroughput*float64#

The storage throughput, specified in mebibytes per second (MiBps).

Default: 125 MiBps if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 500 MiBps otherwise (except for SQL Server where the default is always 125 MiBps).

Only applicable for GP3.

storageTypeStorageTypestorage_typeStorageTypestorageTypeStorageTypeStorageTypeStorageTypeStorageTypeStorageType= StorageType.GP2#

The storage type to associate with the DB instance.

Storage types supported are gp2, gp3, io1, io2, and standard.

subnetGroupIDBSubnetGroupRefsubnet_groupIDBSubnetGroupRefsubnetGroupIDBSubnetGroupRefSubnetGroupIDBSubnetGroupRefSubnetGroupIDBSubnetGroupRef#

Existing subnet group for the instance.

Default: a new subnet group will be created.

timezonestringtimezonestrtimezoneStringTimezonestringTimezone*string#

The time zone of the instance.

Default: RDS default timezone

This is currently supported only by Microsoft Sql Server.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#

The VPC network where the DB subnet group should be created.

vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection#

The type of subnets to add to the created DB subnet group.

Default: private subnets

DatabaseInstanceFromSnapshotProps Struct ​

Example ​

Properties ​

DatabaseInstanceFromSnapshotProps Struct

Example

Properties