AwsRdsClusterRestoreArgs

interface AwsRdsClusterRestoreArgs {
applyImmediately?: boolean;
backupRetentionPeriod?: Input<number>;
backupWindow?: Input<string>;
clusterParameterGroup?: ClusterParameterGroup;
dbSubnetGroup: Input<string> | SubnetGroup;
decommission?: AwsRdsDecommissionArgs;
engine: 'aurora-mysql' | 'aurora-postgresql';
exportedLogs?: ('error' | 'audit' | 'general' | 'postgresql' | 'slowquery')[];
finalSnapshot?: boolean;
iamRoles?: AwsRdsIamRoleAssociationArgs[];
identity: string;
instanceClass: string;
instanceCount?: number;
instanceParameterGroup?: ParameterGroup;
kmsKey?: AwsKmsKeyInput;
maintenanceWindow?: Input<string>;
performanceInsights?: AwsRdsPerformanceInsightsArgs;
securityGroups: (Input<string> | SecurityGroup)[];
serverlessV2?: AwsRdsServerlessV2Args;
source: AwsRdsSnapshotRestoreSourceArgs | AwsRdsPointInTimeRestoreSourceArgs;
tags?: AwsRdsTags;
}

Inputs for restoring and managing an Aurora MySQL or PostgreSQL cluster.

Remarks

The source determines the initial database contents, credentials, and engine version. This capability therefore does not accept fresh-cluster credential or engine-version inputs. The supplied engine must match the restore source. Restored instances enable automatic minor-version upgrades because no exact version is selected by this capability.

Example

CODE

const restore: AwsRdsClusterRestoreArgs = {
  identity: 'disasterRecovery',
  engine: 'aurora-postgresql',
  source: { snapshotIdentifier: 'orders-snapshot' },
  dbSubnetGroup: 'shared-rds',
  securityGroups: ['sg-123'],
  instanceClass: 'db.t4g.medium',
};

Properties

`applyImmediately: boolean`

Applies cluster and instance changes immediately. Defaults to true; set to false to defer eligible changes to the maintenance window.

`backupRetentionPeriod: Input<number>`

Optional backup retention override from 1 to 35 days. Defaults to 7 days in prd, otherwise 1 day.

`backupWindow: Input<string>`

Backup window. Defaults to 00:00-01:00.

`clusterParameterGroup: ClusterParameterGroup`

Existing standalone Aurora cluster parameter-group reference to attach. This component never creates embedded parameter groups.

`dbSubnetGroup: Input<string> | SubnetGroup`

DB subnet group resource or name.

`decommission: AwsRdsDecommissionArgs`

Explicitly permits the restored cluster to be removed after a separate deployment. Defaults to disabled.

`engine: 'aurora-mysql' | 'aurora-postgresql'`

Aurora engine metadata. This must match the snapshot or source cluster.

`exportedLogs: ('error' | 'audit' | 'general' | 'postgresql' | 'slowquery')[]`

Optional CloudWatch log exports. Defaults to none.

`finalSnapshot: boolean`

Creates a final snapshot on deletion by default. Set false to skip it.

`iamRoles: AwsRdsIamRoleAssociationArgs[]`

Aurora PostgreSQL service-role associations.

`identity: string`

Logical-only synchronous identity for the component URN. It does not affect the restored Aurora cluster identifier.

`instanceClass: string`

Plain DB instance class, including db.serverless for Serverless v2.

`instanceCount: number`

Number of instances, including the writer. Defaults to 1; maximum 10.

`instanceParameterGroup: ParameterGroup`

Existing standalone Aurora instance parameter-group reference to attach. This component never creates embedded parameter groups.

`kmsKey: AwsKmsKeyInput`

Optional customer-managed KMS key for encrypted cluster storage. Defaults to the AWS-managed alias/aws/rds key.

`maintenanceWindow: Input<string>`

Maintenance window. Defaults to Thursday in prd, Tuesday otherwise.

`performanceInsights: AwsRdsPerformanceInsightsArgs`

Performance Insights configuration for restored cluster instances.

`securityGroups: (Input<string> | SecurityGroup)[]`

Security groups that may connect to the private restored cluster. At least one is required.

`serverlessV2: AwsRdsServerlessV2Args`

Optional Aurora Serverless v2 scaling configuration.

`source: AwsRdsSnapshotRestoreSourceArgs | AwsRdsPointInTimeRestoreSourceArgs`

Exactly one snapshot or point-in-time restore source.

`tags: AwsRdsTags`

Additional tags. The Name tag is reserved.