DatabaseClusterFromSnapshot

What kind of database to start.

The identifier for the DB instance snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB instance snapshot.

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

Default: true

The number of seconds to set a cluster's target backtrack window to. This feature is only supported by the Aurora MySQL database engine and cannot be enabled on existing clusters.

Default: 0 seconds (no backtrack)

Backup settings.

Default: - Backup retention period for automated backups is 1 day. Backup preferred window is set to 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.

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

Default: - no log exports

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`.

Default: - logs never expire

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

Default: - a new role is created.

An optional identifier for the cluster.

Default: - A name is automatically generated.

[Misspelled] Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.

Default: ClusterScailabilityType.STANDARD

Deprecated: Use clusterScalabilityType instead. This will be removed in the next major version.

Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.

Default: ClusterScalabilityType.STANDARD

Whether to copy tags to the snapshot when a snapshot is created.

Default: - true

Credentials for the administrative user. Note - using this prop only works with `Credentials.fromPassword()` with the username of the snapshot, `Credentials.fromUsername()` with the username and password of the snapshot or `Credentials.fromSecret()` with a secret containing the username and password of the snapshot.

Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password that **will not be applied** to the cluster, use `snapshotCredentials` for the correct behavior.

Deprecated: use `snapshotCredentials` which allows to generate a new password

The database insights mode.

Default: - DatabaseInsightsMode.STANDARD when performance insights are enabled and Amazon Aurora engine is used, otherwise not set.

Name of a database which is automatically created inside the cluster.

Default: - Database is not created in cluster.

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

Default: undefined - AWS RDS default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.

Indicates whether the DB cluster should have deletion protection enabled.

Default: - true if `removalPolicy` is RETAIN, `undefined` otherwise, which will not enable deletion protection. To disable deletion protection after it has been enabled, you must explicitly set this value to `false`.

Directory ID for associating the DB cluster with a specific Active Directory. Necessary for enabling Kerberos authentication. If specified, the DB cluster joins the given Active Directory, enabling Kerberos authentication. If not specified, the DB cluster will not be associated with any Active Directory, and Kerberos authentication will not be enabled.

Default: - DB cluster is not associated with an Active Directory; Kerberos authentication is not enabled.

The IAM role to be used when making API calls to the Directory Service. The role needs the AWS-managed policy `AmazonRDSDirectoryServiceAccess` or equivalent.

Default: - If `DatabaseClusterBaseProps.domain` is specified, a role with the `AmazonRDSDirectoryServiceAccess` policy is automatically created.

Whether to enable enhanced monitoring at the cluster level. If set to true, `monitoringInterval` and `monitoringRole` are applied to not the instances, but the cluster. `monitoringInterval` is required to be set if `enableClusterLevelEnhancedMonitoring` is set to true.

Default: - When the `monitoringInterval` is set, enhanced monitoring is enabled for each instance.

Whether to enable the Data API for the cluster.

Default: - false

Whether read replicas can forward write operations to the writer DB instance in the DB cluster. This setting can only be enabled for Aurora MySQL 3.04 or higher, and for Aurora PostgreSQL 16.4 or higher (for version 16), 15.8 or higher (for version 15), and 14.13 or higher (for version 14).

Default: false

Whether to enable Performance Insights for the DB cluster.

Default: - false, unless `performanceInsightRetention` or `performanceInsightEncryptionKey` is set, or `databaseInsightsMode` is set to `DatabaseInsightsMode.ADVANCED`.

The life cycle type for this DB cluster.

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

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

Default: false

Base identifier for instances. Every replica is named by appending the replica number to this string, 1-based.

Default: - clusterIdentifier is used with the word "Instance" appended. If clusterIdentifier is not provided, the identifier is automatically generated.

Settings for the individual instances that are launched.

Deprecated: - use writer and readers instead

How many replicas/instances to create. Has to be at least 1.

Default: 2

Deprecated: - use writer and readers instead

The ordering of updates for instances.

Default: InstanceUpdateBehaviour.BULK

The interval between points when Amazon RDS collects enhanced monitoring metrics. If you enable `enableClusterLevelEnhancedMonitoring`, this property is applied to the cluster, otherwise it is applied to the instances.

Default: - no enhanced monitoring

Role that will be used to manage DB monitoring. If you enable `enableClusterLevelEnhancedMonitoring`, this property is applied to the cluster, otherwise it is applied to the instances.

Default: - A role is automatically created for you

The network type of the DB instance.

Default: - IPV4

Additional parameters to pass to the database engine.

Default: - No parameter group.

The parameters in the DBClusterParameterGroup to create automatically. You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBClusterParameterGroup.

Default: - None

The AWS KMS key for encryption of Performance Insights data.

Default: - default master key

The amount of time, in days, to retain Performance Insights data. If you set `databaseInsightsMode` to `DatabaseInsightsMode.ADVANCED`, you must set this property to `PerformanceInsightRetention.MONTHS_15`.

Default: - 7

What port to listen on.

Default: - The default for the engine is used.

A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). 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.

A list of instances to create as cluster reader instances.

Default: - no readers are created. The cluster will have a single writer/reader

The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)

S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. This property must not be used if `s3ExportRole` is used. For MySQL:

Default: - None

Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if `s3ExportBuckets` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine For MySQL:

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

S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. This property must not be used if `s3ImportRole` is used. For MySQL:

Default: - None

Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if `s3ImportBuckets` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine For MySQL:

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

Security group.

Default: - a new security group is created.

Specifies the duration an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. The duration must be between 300 seconds (5 minutes) and 86,400 seconds (24 hours).

Default: - The default is 300 seconds (5 minutes).

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 256. The maximum capacity must be higher than 0.5 ACUs.

Default: 2

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.

Default: 0.5

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.

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

Whether to enable storage encryption.

Default: - true if storageEncryptionKey is provided, false otherwise

The KMS key for storage encryption. If specified, `storageEncrypted` will be set to `true`.

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

The storage type to be associated with the DB cluster.

Default: - DBClusterStorageType.AURORA

Existing subnet group for the cluster.

Default: - a new subnet group will be created.

What subnets to run the RDS instances in. Must be at least 2 subnets in two different AZs.

Where to place the instances within the VPC.

Default: - the Vpc default strategy if not specified.

The instance to use for the cluster writer.

Default: - required if instanceProps is not provided