PostgresRestoreSettingsInput

Supported in v9.4+ PostgreSQL database cluster automated restore configuration.

Fields

Field	Type	Description
customRestartScriptFile	String	Supported in v9.6+ Absolute path on the host to the custom script to restart the PostgreSQL instance during standby restore. Required when shouldUseCustomRestartScript is true and shouldRestoreAsReplica or shouldRestoreAsReadOnly is true.
customStartScriptFile	String	Supported in v9.6+ Absolute path on the host to the custom script to start the PostgreSQL instance during restore. Required when shouldUseCustomRestartScript is true.
customStopScriptFile	String	Supported in v9.6+ Absolute path on the host to the custom script to stop the PostgreSQL instance during restore. Required when shouldUseCustomRestartScript is true.
dbUsername	String	Supported in v9.5+ PostgreSQL database role name for psql connections during restore. Use when peer authentication with ident maps requires a different DB role than the OS username.
postgresAutomatedRestoreDatabaseDetails	PostgresAutomatedRestoreDatabaseDetailsInput	Database-level restore options. Omit for cluster-level restores.
shouldOverrideConfFiles	Boolean	Supported in v9.4+ Specifies whether RSC should override the configuration file on the host.
shouldRestoreAsReadOnly	Boolean	Supported in v9.6+ Specifies whether the database should be restored in read-only mode.
shouldRestoreAsReplica	Boolean	Supported in v9.4+ Specifies whether the database should be restored as a replica or the primary database cluster.
shouldUseCustomRestartScript	Boolean	Supported in v9.6+ Whether to use custom scripts for start/stop during restore. When true, customStartScriptFile and customStopScriptFile are required. customRestartScriptFile is additionally required when shouldRestoreAsReplica or shouldRestoreAsReadOnly is true. Requires the enableApiCustomRestartScripts cluster configuration to be enabled.
systemUsername	String	Supported in v9.4+ Username for accessing the host machine.