class DatabaseInstanceFromSnapshot (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.RDS.DatabaseInstanceFromSnapshot`
Java	`software.amazon.awscdk.services.rds.DatabaseInstanceFromSnapshot`
Python	`aws_cdk.aws_rds.DatabaseInstanceFromSnapshot`
TypeScript (source)	`@aws-cdk/aws-rds` » `DatabaseInstanceFromSnapshot`

Implements IConstruct, IConstruct, IDependable, IResource, IDatabaseInstance, IConnectable, ISecretAttachmentTarget

A database instance restored from a snapshot.

Example

declare const vpc: ec2.Vpc;
new rds.DatabaseInstanceFromSnapshot(this, 'Instance', {
  snapshotIdentifier: 'my-snapshot',
  engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),
  // optional, defaults to m5.large
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),
  vpc,
});

declare const sourceInstance: rds.DatabaseInstance;
new rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {
  sourceDatabaseInstance: sourceInstance,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),
  vpc,
});

Initializer

new DatabaseInstanceFromSnapshot(scope: Construct, id: string, props: DatabaseInstanceFromSnapshotProps)

Parameters

scope Construct
id string
props DatabaseInstanceFromSnapshotProps

Construct Props

Name	Type	Description
engine	`IInstanceEngine`	The database engine.
snapshotIdentifier	`string`	The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
vpc	`IVpc`	The VPC network where the DB subnet group should be created.
allocatedStorage?	`number`	The allocated storage size, specified in gigabytes (GB).
allowMajorVersionUpgrade?	`boolean`	Whether to allow major version upgrades.
autoMinorVersionUpgrade?	`boolean`	Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
availabilityZone?	`string`	The name of the Availability Zone where the DB instance will be located.
backupRetention?	`Duration`	The number of days during which automatic DB snapshots are retained.
cloudwatchLogsExports?	`string[]`	The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention?	`RetentionDays`	The number of days log events are kept in CloudWatch Logs.
cloudwatchLogsRetentionRole?	`IRole`	The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
copyTagsToSnapshot?	`boolean`	Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
credentials?	`SnapshotCredentials`	Master user credentials.
databaseName?	`string`	The name of the database.
deleteAutomatedBackups?	`boolean`	Indicates whether automated backups should be deleted or retained when you delete a DB instance.
deletionProtection?	`boolean`	Indicates whether the DB instance should have deletion protection enabled.
domain?	`string`	The Active Directory directory ID to create the DB instance in.
domainRole?	`IRole`	The IAM role to be used when making API calls to the Directory Service.
enablePerformanceInsights?	`boolean`	Whether to enable Performance Insights for the DB instance.
iamAuthentication?	`boolean`	Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
instanceIdentifier?	`string`	A name for the DB instance.
instanceType?	`InstanceType`	The name of the compute and memory capacity for the instance.
iops?	`number`	The number of I/O operations per second (IOPS) that the database provisions.
licenseModel?	`LicenseModel`	The license model.
maxAllocatedStorage?	`number`	Upper limit to which RDS can scale the storage in GiB(Gibibyte).
monitoringInterval?	`Duration`	The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
monitoringRole?	`IRole`	Role that will be used to manage DB instance monitoring.
multiAz?	`boolean`	Specifies if the database instance is a multiple Availability Zone deployment.
optionGroup?	`IOptionGroup`	The option group to associate with the instance.
parameterGroup?	`IParameterGroup`	The DB parameter group to associate with the instance.
parameters?	`{ [string]: string }`	The parameters in the DBParameterGroup to create automatically.
performanceInsightEncryptionKey?	`IKey`	The AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention?	`PerformanceInsightRetention`	The amount of time, in days, to retain Performance Insights data.
port?	`number`	The port for the instance.
preferredBackupWindow?	`string`	The daily time range during which automated backups are performed.
preferredMaintenanceWindow?	`string`	The weekly time range (in UTC) during which system maintenance can occur.
processorFeatures?	`ProcessorFeatures`	The number of CPU cores and the number of threads per core.
publiclyAccessible?	`boolean`	Indicates whether the DB instance is an internet-facing instance.
removalPolicy?	`RemovalPolicy`	The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
s3ExportBuckets?	`IBucket[]`	S3 buckets that you want to load data into.
s3ExportRole?	`IRole`	Role that will be associated with this DB instance to enable S3 export.
s3ImportBuckets?	`IBucket[]`	S3 buckets that you want to load data from.
s3ImportRole?	`IRole`	Role that will be associated with this DB instance to enable S3 import.
securityGroups?	`ISecurityGroup[]`	The security groups to assign to the DB instance.
storageType?	`StorageType`	The storage type.
subnetGroup?	`ISubnetGroup`	Existing subnet group for the instance.
timezone?	`string`	The time zone of the instance.
vpcPlacement?⚠️	`SubnetSelection`	The type of subnets to add to the created DB subnet group.
vpcSubnets?	`SubnetSelection`	The type of subnets to add to the created DB subnet group.

engine

Type: IInstanceEngine

The database engine.

snapshotIdentifier

Type: string

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

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

vpc

Type: IVpc

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

allocatedStorage?

Type: number (optional, default: 100)

The allocated storage size, specified in gigabytes (GB).

allowMajorVersionUpgrade?

Type: boolean (optional, default: false)

Whether to allow major version upgrades.

autoMinorVersionUpgrade?

Type: boolean (optional, default: true)

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

availabilityZone?

Type: string (optional, default: no preference)

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

backupRetention?

Type: Duration (optional, default: Duration.days(1) for source instances, disabled for read replicas)

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

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.

cloudwatchLogsExports?

Type: string[] (optional, default: no log exports)

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

cloudwatchLogsRetention?

Type: RetentionDays (optional, default: logs never expire)

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

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

cloudwatchLogsRetentionRole?

Type: IRole (optional, default: a new role is created.)

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

copyTagsToSnapshot?

Type: boolean (optional, default: true)

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

credentials?

Type: SnapshotCredentials (optional, default: The existing username and password from the snapshot will be used.)

Master user credentials.

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

databaseName?

Type: string (optional, default: no name)

The name of the database.

deleteAutomatedBackups?

Type: boolean (optional, default: false)

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

deletionProtection?

Type: boolean (optional, default: true if removalPolicy is RETAIN, false otherwise)

Indicates whether the DB instance should have deletion protection enabled.

domain?

Type: string (optional, default: Do not join domain)

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

domainRole?

Type: IRole (optional, default: The role will be created for you if {@link DatabaseInstanceNewProps#domain} is specified)

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

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

enablePerformanceInsights?

Type: boolean (optional, default: false, unless performanceInsightRentention or performanceInsightEncryptionKey is set.)

Whether to enable Performance Insights for the DB instance.

iamAuthentication?

Type: boolean (optional, default: false)

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

instanceIdentifier?

Type: string (optional, default: a CloudFormation generated name)

A name for the DB instance.

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

instanceType?

Type: InstanceType (optional, default: m5.large (or, more specifically, db.m5.large))

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

iops?

Type: number (optional, default: no provisioned iops)

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

The value must be equal to or greater than 1000.

licenseModel?

Type: LicenseModel (optional, default: RDS default license model)

The license model.

maxAllocatedStorage?

Type: number (optional, default: No autoscaling of RDS instance)

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

monitoringInterval?

Type: Duration (optional, default: no enhanced monitoring)

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

monitoringRole?

Type: IRole (optional, default: A role is automatically created for you)

Role that will be used to manage DB instance monitoring.

multiAz?

Type: boolean (optional, default: false)

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

optionGroup?

Type: IOptionGroup (optional, default: no option group)

The option group to associate with the instance.

parameterGroup?

Type: IParameterGroup (optional, default: no parameter group)

The DB parameter group to associate with the instance.

parameters?

Type: { [string]: string } (optional, default: 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.

performanceInsightEncryptionKey?

Type: IKey (optional, default: default master key)

The AWS KMS key for encryption of Performance Insights data.

performanceInsightRetention?

Type: PerformanceInsightRetention (optional, default: 7)

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

port?

Type: number (optional, default: the default port for the chosen engine.)

The port for the instance.

preferredBackupWindow?

Type: string (optional, 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)

The daily time range during which automated backups are performed.

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.

preferredMaintenanceWindow?

Type: string (optional, 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)

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

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

processorFeatures?

Type: ProcessorFeatures *(optional, 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)*

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

publiclyAccessible?

Type: boolean (optional, default: true if vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise)

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

removalPolicy?

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

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

s3ExportBuckets?

Type: IBucket[] (optional, default: None)

S3 buckets that you want to load data into.

This property must not be used if s3ExportRole is used.

For Microsoft SQL Server:

s3ExportRole?

Type: IRole (optional, default: New role is created if s3ExportBuckets is set, no role is defined otherwise)

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

This property must not be used if s3ExportBuckets is used.

For Microsoft SQL Server:

s3ImportBuckets?

Type: IBucket[] (optional, default: 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:

s3ImportRole?

Type: IRole (optional, default: New role is created if s3ImportBuckets is set, no role is defined otherwise)

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

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:

securityGroups?

Type: ISecurityGroup[] (optional, default: a new security group is created)

The security groups to assign to the DB instance.

storageType?

Type: StorageType (optional, default: GP2)

The storage type.

Storage types supported are gp2, io1, standard.

subnetGroup?

Type: ISubnetGroup (optional, default: a new subnet group will be created.)

Existing subnet group for the instance.

timezone?

Type: string (optional, default: RDS default timezone)

The time zone of the instance.

This is currently supported only by Microsoft Sql Server.

vpcPlacement?⚠️

⚠️ Deprecated: use vpcSubnets

Type: SubnetSelection (optional, default: private subnets)

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

vpcSubnets?

Type: SubnetSelection (optional, default: private subnets)

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

Properties

Name	Type	Description
connections	`Connections`	Access to network connections.
dbInstanceEndpointAddress	`string`	The instance endpoint address.
dbInstanceEndpointPort	`string`	The instance endpoint port.
env	`ResourceEnvironment`	The environment this resource belongs to.
instanceArn	`string`	The instance arn.
instanceEndpoint	`Endpoint`	The instance endpoint.
instanceIdentifier	`string`	The instance identifier.
instanceType	`InstanceType`
newCfnProps	`CfnDBInstanceProps`
node	`ConstructNode`	The construct tree node associated with this construct.
sourceCfnProps	`CfnDBInstanceProps`
stack	`Stack`	The stack in which this resource is defined.
vpc	`IVpc`	The VPC where this database instance is deployed.
enableIamAuthentication?	`boolean`
engine?	`IInstanceEngine`	The engine of this database Instance.
secret?	`ISecret`	The AWS Secrets Manager secret attached to the instance.
vpcPlacement?	`SubnetSelection`

connections

Type: Connections

Access to network connections.

dbInstanceEndpointAddress

Type: string

The instance endpoint address.

dbInstanceEndpointPort

Type: string

The instance endpoint port.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

instanceArn

Type: string

The instance arn.

instanceEndpoint

Type: Endpoint

The instance endpoint.

instanceIdentifier

Type: string

The instance identifier.

The construct tree node associated with this construct.

sourceCfnProps

Type: CfnDBInstanceProps

stack

Type: Stack

The stack in which this resource is defined.

vpc

Type: IVpc

The VPC where this database instance is deployed.

enableIamAuthentication?

Type: boolean (optional)

engine?

Type: IInstanceEngine (optional)

The engine of this database Instance.

May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.

secret?

Type: ISecret (optional)

The AWS Secrets Manager secret attached to the instance.

vpcPlacement?

Type: SubnetSelection (optional)

Methods

Name	Description
addProxy(id, options)	Add a new db proxy to this instance.
addRotationMultiUser(id, options)	Adds the multi user rotation to this instance.
addRotationSingleUser(options?)	Adds the single user rotation of the master password to this instance.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
asSecretAttachmentTarget()	Renders the secret attachment target specifications.
grantConnect(grantee)	Grant the given identity connection access to the database.
metric(metricName, props?)	Return the given named metric for this DBInstance.
metricCPUUtilization(props?)	The percentage of CPU utilization.
metricDatabaseConnections(props?)	The number of database connections in use.
metricFreeStorageSpace(props?)	The amount of available storage space.
metricFreeableMemory(props?)	The amount of available random access memory.
metricReadIOPS(props?)	The average number of disk write I/O operations per second.
metricWriteIOPS(props?)	The average number of disk read I/O operations per second.
onEvent(id, options?)	Defines a CloudWatch event rule which triggers for instance events.
toString()	Returns a string representation of this construct.
protected setLogRetention()

addProxy(id, options)

public addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxy

Parameters

id string
options DatabaseProxyOptions

Returns

DatabaseProxy

Add a new db proxy to this instance.

addRotationMultiUser(id, options)

public addRotationMultiUser(id: string, options: RotationMultiUserOptions): SecretRotation

Parameters

id string
options RotationMultiUserOptions

Returns

SecretRotation

Adds the multi user rotation to this instance.

addRotationSingleUser(options?)

public addRotationSingleUser(options?: RotationSingleUserOptions): SecretRotation

Parameters

options RotationSingleUserOptions — the options for the rotation, if you want to override the defaults.

Returns

SecretRotation

Adds the single user rotation of the master password to this instance.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

asSecretAttachmentTarget()

public asSecretAttachmentTarget(): SecretAttachmentTargetProps

Returns

SecretAttachmentTargetProps

Renders the secret attachment target specifications.

grantConnect(grantee)

public grantConnect(grantee: IGrantable): Grant

Parameters

grantee IGrantable

Returns

Grant

Grant the given identity connection access to the database.

Note: this method does not currently work, see https://github.com/aws/aws-cdk/issues/11851 for details.

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

metricName string
props MetricOptions

Returns

Metric

Return the given named metric for this DBInstance.

metricCPUUtilization(props?)

public metricCPUUtilization(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The percentage of CPU utilization.

Average over 5 minutes

metricDatabaseConnections(props?)

public metricDatabaseConnections(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The number of database connections in use.

Average over 5 minutes

metricFreeStorageSpace(props?)

public metricFreeStorageSpace(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The amount of available storage space.

Average over 5 minutes

metricFreeableMemory(props?)

public metricFreeableMemory(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The amount of available random access memory.

Average over 5 minutes

metricReadIOPS(props?)

public metricReadIOPS(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The average number of disk write I/O operations per second.

Average over 5 minutes

metricWriteIOPS(props?)

public metricWriteIOPS(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The average number of disk read I/O operations per second.

Average over 5 minutes

onEvent(id, options?)

public onEvent(id: string, options?: OnEventOptions): Rule

Parameters

id string
options OnEventOptions

Returns

Rule

Defines a CloudWatch event rule which triggers for instance events.

Use rule.addEventPattern(pattern) to specify a filter.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected setLogRetention()

protected setLogRetention(): void