published on Tuesday, Sep 8, 2026 by Pulumi
published on Tuesday, Sep 8, 2026 by Pulumi
Create PostgresSnapshotSchedule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PostgresSnapshotSchedule(name: string, args?: PostgresSnapshotScheduleArgs, opts?: CustomResourceOptions);@overload
def PostgresSnapshotSchedule(resource_name: str,
args: Optional[PostgresSnapshotScheduleArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def PostgresSnapshotSchedule(resource_name: str,
opts: Optional[ResourceOptions] = None,
provider_config: Optional[PostgresSnapshotScheduleProviderConfigArgs] = None,
schedules: Optional[Sequence[PostgresSnapshotScheduleScheduleArgs]] = None)func NewPostgresSnapshotSchedule(ctx *Context, name string, args *PostgresSnapshotScheduleArgs, opts ...ResourceOption) (*PostgresSnapshotSchedule, error)public PostgresSnapshotSchedule(string name, PostgresSnapshotScheduleArgs? args = null, CustomResourceOptions? opts = null)
public PostgresSnapshotSchedule(String name, PostgresSnapshotScheduleArgs args)
public PostgresSnapshotSchedule(String name, PostgresSnapshotScheduleArgs args, CustomResourceOptions options)
type: databricks:PostgresSnapshotSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "databricks_postgres_snapshot_schedule" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PostgresSnapshotScheduleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PostgresSnapshotScheduleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PostgresSnapshotScheduleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PostgresSnapshotScheduleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PostgresSnapshotScheduleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var postgresSnapshotScheduleResource = new Databricks.PostgresSnapshotSchedule("postgresSnapshotScheduleResource", new()
{
ProviderConfig = new Databricks.Inputs.PostgresSnapshotScheduleProviderConfigArgs
{
WorkspaceId = "string",
},
Schedules = new[]
{
new Databricks.Inputs.PostgresSnapshotScheduleScheduleArgs
{
Retention = "string",
DailySchedule = new Databricks.Inputs.PostgresSnapshotScheduleScheduleDailyScheduleArgs
{
Hour = 0,
},
MonthlySchedule = new Databricks.Inputs.PostgresSnapshotScheduleScheduleMonthlyScheduleArgs
{
Day = 0,
Hour = 0,
},
WeeklySchedule = new Databricks.Inputs.PostgresSnapshotScheduleScheduleWeeklyScheduleArgs
{
DayOfWeek = "string",
Hour = 0,
},
},
},
});
example, err := databricks.NewPostgresSnapshotSchedule(ctx, "postgresSnapshotScheduleResource", &databricks.PostgresSnapshotScheduleArgs{
ProviderConfig: &databricks.PostgresSnapshotScheduleProviderConfigArgs{
WorkspaceId: pulumi.String("string"),
},
Schedules: databricks.PostgresSnapshotScheduleScheduleArray{
&databricks.PostgresSnapshotScheduleScheduleArgs{
Retention: pulumi.String("string"),
DailySchedule: &databricks.PostgresSnapshotScheduleScheduleDailyScheduleArgs{
Hour: pulumi.Int(0),
},
MonthlySchedule: &databricks.PostgresSnapshotScheduleScheduleMonthlyScheduleArgs{
Day: pulumi.Int(0),
Hour: pulumi.Int(0),
},
WeeklySchedule: &databricks.PostgresSnapshotScheduleScheduleWeeklyScheduleArgs{
DayOfWeek: pulumi.String("string"),
Hour: pulumi.Int(0),
},
},
},
})
resource "databricks_postgres_snapshot_schedule" "postgresSnapshotScheduleResource" {
lifecycle {
create_before_destroy = true
}
provider_config = {
workspace_id = "string"
}
schedules {
retention = "string"
daily_schedule = {
hour = 0
}
monthly_schedule = {
day = 0
hour = 0
}
weekly_schedule = {
day_of_week = "string"
hour = 0
}
}
}
var postgresSnapshotScheduleResource = new PostgresSnapshotSchedule("postgresSnapshotScheduleResource", PostgresSnapshotScheduleArgs.builder()
.providerConfig(PostgresSnapshotScheduleProviderConfigArgs.builder()
.workspaceId("string")
.build())
.schedules(PostgresSnapshotScheduleScheduleArgs.builder()
.retention("string")
.dailySchedule(PostgresSnapshotScheduleScheduleDailyScheduleArgs.builder()
.hour(0)
.build())
.monthlySchedule(PostgresSnapshotScheduleScheduleMonthlyScheduleArgs.builder()
.day(0)
.hour(0)
.build())
.weeklySchedule(PostgresSnapshotScheduleScheduleWeeklyScheduleArgs.builder()
.dayOfWeek("string")
.hour(0)
.build())
.build())
.build());
postgres_snapshot_schedule_resource = databricks.PostgresSnapshotSchedule("postgresSnapshotScheduleResource",
provider_config={
"workspace_id": "string",
},
schedules=[{
"retention": "string",
"daily_schedule": {
"hour": 0,
},
"monthly_schedule": {
"day": 0,
"hour": 0,
},
"weekly_schedule": {
"day_of_week": "string",
"hour": 0,
},
}])
const postgresSnapshotScheduleResource = new databricks.PostgresSnapshotSchedule("postgresSnapshotScheduleResource", {
providerConfig: {
workspaceId: "string",
},
schedules: [{
retention: "string",
dailySchedule: {
hour: 0,
},
monthlySchedule: {
day: 0,
hour: 0,
},
weeklySchedule: {
dayOfWeek: "string",
hour: 0,
},
}],
});
type: databricks:PostgresSnapshotSchedule
properties:
providerConfig:
workspaceId: string
schedules:
- dailySchedule:
hour: 0
monthlySchedule:
day: 0
hour: 0
retention: string
weeklySchedule:
dayOfWeek: string
hour: 0
PostgresSnapshotSchedule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PostgresSnapshotSchedule resource accepts the following input properties:
- Provider
Config PostgresSnapshot Schedule Provider Config - Configure the provider for management through account provider.
- Schedules
List<Postgres
Snapshot Schedule Schedule> - 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 PostgresSnapshot Schedule Provider Config Args - Configure the provider for management through account provider.
- Schedules
[]Postgres
Snapshot Schedule Schedule Args - 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 - Configure the provider for management through account provider.
- schedules list(object)
- 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 PostgresSnapshot Schedule Provider Config - Configure the provider for management through account provider.
- schedules
List<Postgres
Snapshot Schedule Schedule> - 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 PostgresSnapshot Schedule Provider Config - Configure the provider for management through account provider.
- schedules
Postgres
Snapshot Schedule Schedule[] - 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 PostgresSnapshot Schedule Provider Config Args - Configure the provider for management through account provider.
- schedules
Sequence[Postgres
Snapshot Schedule Schedule Args] - 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 Property Map - Configure the provider for management through account provider.
- schedules List<Property Map>
- 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
Outputs
All input properties are implicitly available as output properties. Additionally, the PostgresSnapshotSchedule resource produces the following output properties:
Look up Existing PostgresSnapshotSchedule Resource
Get an existing PostgresSnapshotSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PostgresSnapshotScheduleState, opts?: CustomResourceOptions): PostgresSnapshotSchedule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
provider_config: Optional[PostgresSnapshotScheduleProviderConfigArgs] = None,
schedules: Optional[Sequence[PostgresSnapshotScheduleScheduleArgs]] = None) -> PostgresSnapshotSchedulefunc GetPostgresSnapshotSchedule(ctx *Context, name string, id IDInput, state *PostgresSnapshotScheduleState, opts ...ResourceOption) (*PostgresSnapshotSchedule, error)public static PostgresSnapshotSchedule Get(string name, Input<string> id, PostgresSnapshotScheduleState? state, CustomResourceOptions? opts = null)public static PostgresSnapshotSchedule get(String name, Output<String> id, PostgresSnapshotScheduleState state, CustomResourceOptions options)resources: _: type: databricks:PostgresSnapshotSchedule get: id: ${id}import {
to = databricks_postgres_snapshot_schedule.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Name string
- (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
- Provider
Config PostgresSnapshot Schedule Provider Config - Configure the provider for management through account provider.
- Schedules
List<Postgres
Snapshot Schedule Schedule> - 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
- Name string
- (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
- Provider
Config PostgresSnapshot Schedule Provider Config Args - Configure the provider for management through account provider.
- Schedules
[]Postgres
Snapshot Schedule Schedule Args - 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
- name string
- (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.
- schedules list(object)
- 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
- name String
- (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
- provider
Config PostgresSnapshot Schedule Provider Config - Configure the provider for management through account provider.
- schedules
List<Postgres
Snapshot Schedule Schedule> - 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
- name string
- (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
- provider
Config PostgresSnapshot Schedule Provider Config - Configure the provider for management through account provider.
- schedules
Postgres
Snapshot Schedule Schedule[] - 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
- name str
- (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
- provider_
config PostgresSnapshot Schedule Provider Config Args - Configure the provider for management through account provider.
- schedules
Sequence[Postgres
Snapshot Schedule Schedule Args] - 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
- name String
- (string) - The resource name of the branch's snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule
- provider
Config Property Map - Configure the provider for management through account provider.
- schedules List<Property Map>
- 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
Supporting Types
PostgresSnapshotScheduleProviderConfig, PostgresSnapshotScheduleProviderConfigArgs
- Workspace
Id 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.
- workspace_
id 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.
- workspace
Id 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.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
PostgresSnapshotScheduleSchedule, PostgresSnapshotScheduleScheduleArgs
- Retention 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 PostgresSnapshot Schedule Schedule Daily Schedule - Take a snapshot once per day
- Monthly
Schedule PostgresSnapshot Schedule Schedule Monthly Schedule - Take a snapshot once per month
- Weekly
Schedule PostgresSnapshot Schedule Schedule Weekly Schedule - Take a snapshot once per week
- Retention 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 PostgresSnapshot Schedule Schedule Daily Schedule - Take a snapshot once per day
- Monthly
Schedule PostgresSnapshot Schedule Schedule Monthly Schedule - Take a snapshot once per month
- Weekly
Schedule PostgresSnapshot Schedule Schedule Weekly Schedule - Take a snapshot once per week
- retention 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 - Take a snapshot once per day
- monthly_
schedule object - Take a snapshot once per month
- weekly_
schedule object - Take a snapshot once per week
- retention 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 PostgresSnapshot Schedule Schedule Daily Schedule - Take a snapshot once per day
- monthly
Schedule PostgresSnapshot Schedule Schedule Monthly Schedule - Take a snapshot once per month
- weekly
Schedule PostgresSnapshot Schedule Schedule Weekly Schedule - Take a snapshot once per week
- retention 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 PostgresSnapshot Schedule Schedule Daily Schedule - Take a snapshot once per day
- monthly
Schedule PostgresSnapshot Schedule Schedule Monthly Schedule - Take a snapshot once per month
- weekly
Schedule PostgresSnapshot Schedule Schedule Weekly Schedule - Take a snapshot once per week
- retention str
- 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 PostgresSnapshot Schedule Schedule Daily Schedule - Take a snapshot once per day
- monthly_
schedule PostgresSnapshot Schedule Schedule Monthly Schedule - Take a snapshot once per month
- weekly_
schedule PostgresSnapshot Schedule Schedule Weekly Schedule - Take a snapshot once per week
- retention 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 Property Map - Take a snapshot once per day
- monthly
Schedule Property Map - Take a snapshot once per month
- weekly
Schedule Property Map - Take a snapshot once per week
PostgresSnapshotScheduleScheduleDailySchedule, PostgresSnapshotScheduleScheduleDailyScheduleArgs
- Hour int
- Hour int
- hour number
- hour Integer
- hour number
- hour int
- hour Number
PostgresSnapshotScheduleScheduleMonthlySchedule, PostgresSnapshotScheduleScheduleMonthlyScheduleArgs
PostgresSnapshotScheduleScheduleWeeklySchedule, PostgresSnapshotScheduleScheduleWeeklyScheduleArgs
- day_
of_ stringweek - The day of the week on which to take the snapshot. Possible values are:
FRIDAY,MONDAY,SATURDAY,SUNDAY,THURSDAY,TUESDAY,WEDNESDAY - hour number
- day_
of_ strweek - The day of the week on which to take the snapshot. Possible values are:
FRIDAY,MONDAY,SATURDAY,SUNDAY,THURSDAY,TUESDAY,WEDNESDAY - hour int
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
published on Tuesday, Sep 8, 2026 by Pulumi