Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresSnapshotSchedule
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresSnapshotSchedule

databricks logo databricks logo
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    API Documentation

    Using getPostgresSnapshotSchedule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPostgresSnapshotSchedule(args: GetPostgresSnapshotScheduleArgs, opts?: InvokeOptions): Promise<GetPostgresSnapshotScheduleResult>
function getPostgresSnapshotScheduleOutput(args: GetPostgresSnapshotScheduleOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresSnapshotScheduleResult>
    def get_postgres_snapshot_schedule(name: Optional[str] = None,
                                   provider_config: Optional[GetPostgresSnapshotScheduleProviderConfig] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetPostgresSnapshotScheduleResult
def get_postgres_snapshot_schedule_output(name: pulumi.Input[Optional[str]] = None,
                                   provider_config: pulumi.Input[Optional[GetPostgresSnapshotScheduleProviderConfigArgs]] = None,
                                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresSnapshotScheduleResult]
    func LookupPostgresSnapshotSchedule(ctx *Context, args *LookupPostgresSnapshotScheduleArgs, opts ...InvokeOption) (*LookupPostgresSnapshotScheduleResult, error)
func LookupPostgresSnapshotScheduleOutput(ctx *Context, args *LookupPostgresSnapshotScheduleOutputArgs, opts ...InvokeOption) LookupPostgresSnapshotScheduleResultOutput

    > Note: This function is named LookupPostgresSnapshotSchedule in the Go SDK.

    public static class GetPostgresSnapshotSchedule 
{
    public static Task<GetPostgresSnapshotScheduleResult> InvokeAsync(GetPostgresSnapshotScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresSnapshotScheduleResult> Invoke(GetPostgresSnapshotScheduleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresSnapshotScheduleResult> Invoke(GetPostgresSnapshotScheduleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPostgresSnapshotScheduleResult> getPostgresSnapshotSchedule(GetPostgresSnapshotScheduleArgs args, InvokeOptions options)
public static Output<GetPostgresSnapshotScheduleResult> getPostgresSnapshotSchedule(GetPostgresSnapshotScheduleArgs args, InvokeOptions options)
public static Output<GetPostgresSnapshotScheduleResult> getPostgresSnapshotSchedule(GetPostgresSnapshotScheduleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: databricks:index/getPostgresSnapshotSchedule:getPostgresSnapshotSchedule
  arguments:
    # arguments dictionary
    data "databricks_get_postgres_snapshot_schedule" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    ProviderConfig GetPostgresSnapshotScheduleProviderConfig
    Configure the provider for management through account provider.
    Name string
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    ProviderConfig GetPostgresSnapshotScheduleProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    provider_config object
    Configure the provider for management through account provider.
    name String
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    providerConfig GetPostgresSnapshotScheduleProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    providerConfig GetPostgresSnapshotScheduleProviderConfig
    Configure the provider for management through account provider.
    name str
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    provider_config GetPostgresSnapshotScheduleProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresSnapshotSchedule Result

    The following output properties are available:

    Name string
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    Schedules List<GetPostgresSnapshotScheduleSchedule>
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    ProviderConfig GetPostgresSnapshotScheduleProviderConfig
    Name string
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    Schedules []GetPostgresSnapshotScheduleSchedule
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    ProviderConfig GetPostgresSnapshotScheduleProviderConfig
    name string
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    schedules list(object)
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    provider_config object
    name String
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    schedules List<GetPostgresSnapshotScheduleSchedule>
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    providerConfig GetPostgresSnapshotScheduleProviderConfig
    name string
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    schedules GetPostgresSnapshotScheduleSchedule[]
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    providerConfig GetPostgresSnapshotScheduleProviderConfig
    name str
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    schedules Sequence[GetPostgresSnapshotScheduleSchedule]
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    provider_config GetPostgresSnapshotScheduleProviderConfig
    name String
    (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
    schedules List<Property Map>
    (list of ScheduleCadence) - The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot is taken, retained for the longest of their retentions
    providerConfig Property Map

    Supporting Types

    GetPostgresSnapshotScheduleProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetPostgresSnapshotScheduleSchedule

    Retention string
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    DailySchedule GetPostgresSnapshotScheduleScheduleDailySchedule
    (DailySchedule) - Take a snapshot once per day
    MonthlySchedule GetPostgresSnapshotScheduleScheduleMonthlySchedule
    (MonthlySchedule) - Take a snapshot once per month
    WeeklySchedule GetPostgresSnapshotScheduleScheduleWeeklySchedule
    (WeeklySchedule) - Take a snapshot once per week
    Retention string
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    DailySchedule GetPostgresSnapshotScheduleScheduleDailySchedule
    (DailySchedule) - Take a snapshot once per day
    MonthlySchedule GetPostgresSnapshotScheduleScheduleMonthlySchedule
    (MonthlySchedule) - Take a snapshot once per month
    WeeklySchedule GetPostgresSnapshotScheduleScheduleWeeklySchedule
    (WeeklySchedule) - Take a snapshot once per week
    retention string
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    daily_schedule object
    (DailySchedule) - Take a snapshot once per day
    monthly_schedule object
    (MonthlySchedule) - Take a snapshot once per month
    weekly_schedule object
    (WeeklySchedule) - Take a snapshot once per week
    retention String
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    dailySchedule GetPostgresSnapshotScheduleScheduleDailySchedule
    (DailySchedule) - Take a snapshot once per day
    monthlySchedule GetPostgresSnapshotScheduleScheduleMonthlySchedule
    (MonthlySchedule) - Take a snapshot once per month
    weeklySchedule GetPostgresSnapshotScheduleScheduleWeeklySchedule
    (WeeklySchedule) - Take a snapshot once per week
    retention string
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    dailySchedule GetPostgresSnapshotScheduleScheduleDailySchedule
    (DailySchedule) - Take a snapshot once per day
    monthlySchedule GetPostgresSnapshotScheduleScheduleMonthlySchedule
    (MonthlySchedule) - Take a snapshot once per month
    weeklySchedule GetPostgresSnapshotScheduleScheduleWeeklySchedule
    (WeeklySchedule) - Take a snapshot once per week
    retention str
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    daily_schedule GetPostgresSnapshotScheduleScheduleDailySchedule
    (DailySchedule) - Take a snapshot once per day
    monthly_schedule GetPostgresSnapshotScheduleScheduleMonthlySchedule
    (MonthlySchedule) - Take a snapshot once per month
    weekly_schedule GetPostgresSnapshotScheduleScheduleWeeklySchedule
    (WeeklySchedule) - Take a snapshot once per week
    retention String
    (string) - How long snapshots from this cadence are kept before automatic deletion. Must be at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots
    dailySchedule Property Map
    (DailySchedule) - Take a snapshot once per day
    monthlySchedule Property Map
    (MonthlySchedule) - Take a snapshot once per month
    weeklySchedule Property Map
    (WeeklySchedule) - Take a snapshot once per week

    GetPostgresSnapshotScheduleScheduleDailySchedule

    Hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    Hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    hour number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    hour Integer
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    hour number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    hour Number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]

    GetPostgresSnapshotScheduleScheduleMonthlySchedule

    Day int
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    Hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    Day int
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    Hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day number
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    hour number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day Integer
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    hour Integer
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day number
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    hour number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day int
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day Number
    (integer) - The day of the month on which to take the snapshot, in [1, 31]. In shorter months the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), so every month gets exactly one snapshot
    hour Number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]

    GetPostgresSnapshotScheduleScheduleWeeklySchedule

    DayOfWeek string
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    Hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    DayOfWeek string
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    Hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day_of_week string
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    hour number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    dayOfWeek String
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    hour Integer
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    dayOfWeek string
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    hour number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    day_of_week str
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    hour int
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]
    dayOfWeek String
    (string) - The day of the week on which to take the snapshot. Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
    hour Number
    (integer) - The hour of the day, in UTC, at which to take the snapshot, in [0, 23]

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo databricks logo
    Viewing docs for Databricks v1.109.0
    published on Tuesday, Sep 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial