Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. firestore
  5. BackupSchedule
Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.firestore.BackupSchedule

Explore with Pulumi AI

Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-gcp

A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.

To get more information about BackupSchedule, see:

Warning: This resource creates a Firestore Backup Schedule on a project that already has a Firestore database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.

Example Usage

Firestore Backup Schedule Daily

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const database = new gcp.firestore.Database("database", {
    project: "my-project-name",
    name: "database-id",
    locationId: "nam5",
    type: "FIRESTORE_NATIVE",
    deleteProtectionState: "DELETE_PROTECTION_ENABLED",
    deletionPolicy: "DELETE",
});
const daily_backup = new gcp.firestore.BackupSchedule("daily-backup", {
    project: "my-project-name",
    database: database.name,
    retention: "8467200s",
    dailyRecurrence: {},
});
Copy
import pulumi
import pulumi_gcp as gcp

database = gcp.firestore.Database("database",
    project="my-project-name",
    name="database-id",
    location_id="nam5",
    type="FIRESTORE_NATIVE",
    delete_protection_state="DELETE_PROTECTION_ENABLED",
    deletion_policy="DELETE")
daily_backup = gcp.firestore.BackupSchedule("daily-backup",
    project="my-project-name",
    database=database.name,
    retention="8467200s",
    daily_recurrence={})
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/firestore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		database, err := firestore.NewDatabase(ctx, "database", &firestore.DatabaseArgs{
			Project:               pulumi.String("my-project-name"),
			Name:                  pulumi.String("database-id"),
			LocationId:            pulumi.String("nam5"),
			Type:                  pulumi.String("FIRESTORE_NATIVE"),
			DeleteProtectionState: pulumi.String("DELETE_PROTECTION_ENABLED"),
			DeletionPolicy:        pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		_, err = firestore.NewBackupSchedule(ctx, "daily-backup", &firestore.BackupScheduleArgs{
			Project:         pulumi.String("my-project-name"),
			Database:        database.Name,
			Retention:       pulumi.String("8467200s"),
			DailyRecurrence: &firestore.BackupScheduleDailyRecurrenceArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var database = new Gcp.Firestore.Database("database", new()
    {
        Project = "my-project-name",
        Name = "database-id",
        LocationId = "nam5",
        Type = "FIRESTORE_NATIVE",
        DeleteProtectionState = "DELETE_PROTECTION_ENABLED",
        DeletionPolicy = "DELETE",
    });

    var daily_backup = new Gcp.Firestore.BackupSchedule("daily-backup", new()
    {
        Project = "my-project-name",
        Database = database.Name,
        Retention = "8467200s",
        DailyRecurrence = null,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firestore.Database;
import com.pulumi.gcp.firestore.DatabaseArgs;
import com.pulumi.gcp.firestore.BackupSchedule;
import com.pulumi.gcp.firestore.BackupScheduleArgs;
import com.pulumi.gcp.firestore.inputs.BackupScheduleDailyRecurrenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var database = new Database("database", DatabaseArgs.builder()
            .project("my-project-name")
            .name("database-id")
            .locationId("nam5")
            .type("FIRESTORE_NATIVE")
            .deleteProtectionState("DELETE_PROTECTION_ENABLED")
            .deletionPolicy("DELETE")
            .build());

        var daily_backup = new BackupSchedule("daily-backup", BackupScheduleArgs.builder()
            .project("my-project-name")
            .database(database.name())
            .retention("8467200s")
            .dailyRecurrence(BackupScheduleDailyRecurrenceArgs.builder()
                .build())
            .build());

    }
}
Copy
resources:
  database:
    type: gcp:firestore:Database
    properties:
      project: my-project-name
      name: database-id
      locationId: nam5
      type: FIRESTORE_NATIVE
      deleteProtectionState: DELETE_PROTECTION_ENABLED
      deletionPolicy: DELETE
  daily-backup:
    type: gcp:firestore:BackupSchedule
    properties:
      project: my-project-name
      database: ${database.name}
      retention: 8467200s
      dailyRecurrence: {}
Copy

Firestore Backup Schedule Weekly

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const database = new gcp.firestore.Database("database", {
    project: "my-project-name",
    name: "database-id",
    locationId: "nam5",
    type: "FIRESTORE_NATIVE",
    deleteProtectionState: "DELETE_PROTECTION_ENABLED",
    deletionPolicy: "DELETE",
});
const weekly_backup = new gcp.firestore.BackupSchedule("weekly-backup", {
    project: "my-project-name",
    database: database.name,
    retention: "8467200s",
    weeklyRecurrence: {
        day: "SUNDAY",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

database = gcp.firestore.Database("database",
    project="my-project-name",
    name="database-id",
    location_id="nam5",
    type="FIRESTORE_NATIVE",
    delete_protection_state="DELETE_PROTECTION_ENABLED",
    deletion_policy="DELETE")
weekly_backup = gcp.firestore.BackupSchedule("weekly-backup",
    project="my-project-name",
    database=database.name,
    retention="8467200s",
    weekly_recurrence={
        "day": "SUNDAY",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/firestore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		database, err := firestore.NewDatabase(ctx, "database", &firestore.DatabaseArgs{
			Project:               pulumi.String("my-project-name"),
			Name:                  pulumi.String("database-id"),
			LocationId:            pulumi.String("nam5"),
			Type:                  pulumi.String("FIRESTORE_NATIVE"),
			DeleteProtectionState: pulumi.String("DELETE_PROTECTION_ENABLED"),
			DeletionPolicy:        pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		_, err = firestore.NewBackupSchedule(ctx, "weekly-backup", &firestore.BackupScheduleArgs{
			Project:   pulumi.String("my-project-name"),
			Database:  database.Name,
			Retention: pulumi.String("8467200s"),
			WeeklyRecurrence: &firestore.BackupScheduleWeeklyRecurrenceArgs{
				Day: pulumi.String("SUNDAY"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var database = new Gcp.Firestore.Database("database", new()
    {
        Project = "my-project-name",
        Name = "database-id",
        LocationId = "nam5",
        Type = "FIRESTORE_NATIVE",
        DeleteProtectionState = "DELETE_PROTECTION_ENABLED",
        DeletionPolicy = "DELETE",
    });

    var weekly_backup = new Gcp.Firestore.BackupSchedule("weekly-backup", new()
    {
        Project = "my-project-name",
        Database = database.Name,
        Retention = "8467200s",
        WeeklyRecurrence = new Gcp.Firestore.Inputs.BackupScheduleWeeklyRecurrenceArgs
        {
            Day = "SUNDAY",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firestore.Database;
import com.pulumi.gcp.firestore.DatabaseArgs;
import com.pulumi.gcp.firestore.BackupSchedule;
import com.pulumi.gcp.firestore.BackupScheduleArgs;
import com.pulumi.gcp.firestore.inputs.BackupScheduleWeeklyRecurrenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var database = new Database("database", DatabaseArgs.builder()
            .project("my-project-name")
            .name("database-id")
            .locationId("nam5")
            .type("FIRESTORE_NATIVE")
            .deleteProtectionState("DELETE_PROTECTION_ENABLED")
            .deletionPolicy("DELETE")
            .build());

        var weekly_backup = new BackupSchedule("weekly-backup", BackupScheduleArgs.builder()
            .project("my-project-name")
            .database(database.name())
            .retention("8467200s")
            .weeklyRecurrence(BackupScheduleWeeklyRecurrenceArgs.builder()
                .day("SUNDAY")
                .build())
            .build());

    }
}
Copy
resources:
  database:
    type: gcp:firestore:Database
    properties:
      project: my-project-name
      name: database-id
      locationId: nam5
      type: FIRESTORE_NATIVE
      deleteProtectionState: DELETE_PROTECTION_ENABLED
      deletionPolicy: DELETE
  weekly-backup:
    type: gcp:firestore:BackupSchedule
    properties:
      project: my-project-name
      database: ${database.name}
      retention: 8467200s
      weeklyRecurrence:
        day: SUNDAY
Copy

Create BackupSchedule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BackupSchedule(name: string, args: BackupScheduleArgs, opts?: CustomResourceOptions);
@overload
def BackupSchedule(resource_name: str,
                   args: BackupScheduleArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def BackupSchedule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   retention: Optional[str] = None,
                   daily_recurrence: Optional[BackupScheduleDailyRecurrenceArgs] = None,
                   database: Optional[str] = None,
                   project: Optional[str] = None,
                   weekly_recurrence: Optional[BackupScheduleWeeklyRecurrenceArgs] = None)
func NewBackupSchedule(ctx *Context, name string, args BackupScheduleArgs, opts ...ResourceOption) (*BackupSchedule, error)
public BackupSchedule(string name, BackupScheduleArgs args, CustomResourceOptions? opts = null)
public BackupSchedule(String name, BackupScheduleArgs args)
public BackupSchedule(String name, BackupScheduleArgs args, CustomResourceOptions options)

type: gcp:firestore:BackupSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackupScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BackupScheduleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BackupScheduleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackupScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackupScheduleArgs
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 backupScheduleResource = new Gcp.Firestore.BackupSchedule("backupScheduleResource", new()
{
    Retention = "string",
    DailyRecurrence = null,
    Database = "string",
    Project = "string",
    WeeklyRecurrence = new Gcp.Firestore.Inputs.BackupScheduleWeeklyRecurrenceArgs
    {
        Day = "string",
    },
});
Copy
example, err := firestore.NewBackupSchedule(ctx, "backupScheduleResource", &firestore.BackupScheduleArgs{
	Retention:       pulumi.String("string"),
	DailyRecurrence: &firestore.BackupScheduleDailyRecurrenceArgs{},
	Database:        pulumi.String("string"),
	Project:         pulumi.String("string"),
	WeeklyRecurrence: &firestore.BackupScheduleWeeklyRecurrenceArgs{
		Day: pulumi.String("string"),
	},
})
Copy
var backupScheduleResource = new com.pulumi.gcp.firestore.BackupSchedule("backupScheduleResource", com.pulumi.gcp.firestore.BackupScheduleArgs.builder()
    .retention("string")
    .dailyRecurrence()
    .database("string")
    .project("string")
    .weeklyRecurrence(BackupScheduleWeeklyRecurrenceArgs.builder()
        .day("string")
        .build())
    .build());
Copy
backup_schedule_resource = gcp.firestore.BackupSchedule("backupScheduleResource",
    retention="string",
    daily_recurrence={},
    database="string",
    project="string",
    weekly_recurrence={
        "day": "string",
    })
Copy
const backupScheduleResource = new gcp.firestore.BackupSchedule("backupScheduleResource", {
    retention: "string",
    dailyRecurrence: {},
    database: "string",
    project: "string",
    weeklyRecurrence: {
        day: "string",
    },
});
Copy
type: gcp:firestore:BackupSchedule
properties:
    dailyRecurrence: {}
    database: string
    project: string
    retention: string
    weeklyRecurrence:
        day: string
Copy

BackupSchedule 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 BackupSchedule resource accepts the following input properties:

Retention This property is required. string
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

DailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrence
For a schedule that runs daily.
Database Changes to this property will trigger replacement. string
The Firestore database id. Defaults to "(default)".
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
WeeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrence
For a schedule that runs weekly on a specific day. Structure is documented below.
Retention This property is required. string
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

DailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrenceArgs
For a schedule that runs daily.
Database Changes to this property will trigger replacement. string
The Firestore database id. Defaults to "(default)".
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
WeeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrenceArgs
For a schedule that runs weekly on a specific day. Structure is documented below.
retention This property is required. String
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

dailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrence
For a schedule that runs daily.
database Changes to this property will trigger replacement. String
The Firestore database id. Defaults to "(default)".
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
weeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrence
For a schedule that runs weekly on a specific day. Structure is documented below.
retention This property is required. string
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

dailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrence
For a schedule that runs daily.
database Changes to this property will trigger replacement. string
The Firestore database id. Defaults to "(default)".
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
weeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrence
For a schedule that runs weekly on a specific day. Structure is documented below.
retention This property is required. str
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

daily_recurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrenceArgs
For a schedule that runs daily.
database Changes to this property will trigger replacement. str
The Firestore database id. Defaults to "(default)".
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
weekly_recurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrenceArgs
For a schedule that runs weekly on a specific day. Structure is documented below.
retention This property is required. String
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

dailyRecurrence Changes to this property will trigger replacement. Property Map
For a schedule that runs daily.
database Changes to this property will trigger replacement. String
The Firestore database id. Defaults to "(default)".
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
weeklyRecurrence Changes to this property will trigger replacement. Property Map
For a schedule that runs weekly on a specific day. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the BackupSchedule resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
Id string
The provider-assigned unique ID for this managed resource.
Name string
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
id String
The provider-assigned unique ID for this managed resource.
name String
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
id string
The provider-assigned unique ID for this managed resource.
name string
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
id str
The provider-assigned unique ID for this managed resource.
name str
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
id String
The provider-assigned unique ID for this managed resource.
name String
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}

Look up Existing BackupSchedule Resource

Get an existing BackupSchedule 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?: BackupScheduleState, opts?: CustomResourceOptions): BackupSchedule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        daily_recurrence: Optional[BackupScheduleDailyRecurrenceArgs] = None,
        database: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        retention: Optional[str] = None,
        weekly_recurrence: Optional[BackupScheduleWeeklyRecurrenceArgs] = None) -> BackupSchedule
func GetBackupSchedule(ctx *Context, name string, id IDInput, state *BackupScheduleState, opts ...ResourceOption) (*BackupSchedule, error)
public static BackupSchedule Get(string name, Input<string> id, BackupScheduleState? state, CustomResourceOptions? opts = null)
public static BackupSchedule get(String name, Output<String> id, BackupScheduleState state, CustomResourceOptions options)
resources:  _:    type: gcp:firestore:BackupSchedule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
DailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrence
For a schedule that runs daily.
Database Changes to this property will trigger replacement. string
The Firestore database id. Defaults to "(default)".
Name string
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Retention string
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

WeeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrence
For a schedule that runs weekly on a specific day. Structure is documented below.
DailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrenceArgs
For a schedule that runs daily.
Database Changes to this property will trigger replacement. string
The Firestore database id. Defaults to "(default)".
Name string
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Retention string
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

WeeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrenceArgs
For a schedule that runs weekly on a specific day. Structure is documented below.
dailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrence
For a schedule that runs daily.
database Changes to this property will trigger replacement. String
The Firestore database id. Defaults to "(default)".
name String
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
retention String
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

weeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrence
For a schedule that runs weekly on a specific day. Structure is documented below.
dailyRecurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrence
For a schedule that runs daily.
database Changes to this property will trigger replacement. string
The Firestore database id. Defaults to "(default)".
name string
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
retention string
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

weeklyRecurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrence
For a schedule that runs weekly on a specific day. Structure is documented below.
daily_recurrence Changes to this property will trigger replacement. BackupScheduleDailyRecurrenceArgs
For a schedule that runs daily.
database Changes to this property will trigger replacement. str
The Firestore database id. Defaults to "(default)".
name str
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
retention str
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

weekly_recurrence Changes to this property will trigger replacement. BackupScheduleWeeklyRecurrenceArgs
For a schedule that runs weekly on a specific day. Structure is documented below.
dailyRecurrence Changes to this property will trigger replacement. Property Map
For a schedule that runs daily.
database Changes to this property will trigger replacement. String
The Firestore database id. Defaults to "(default)".
name String
The unique backup schedule identifier across all locations and databases for the given project. Format: projects/{{project}}/databases/{{database}}/backupSchedules/{{backupSchedule}}
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
retention String
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". You can set this to a value up to 14 weeks.

weeklyRecurrence Changes to this property will trigger replacement. Property Map
For a schedule that runs weekly on a specific day. Structure is documented below.

Supporting Types

BackupScheduleWeeklyRecurrence
, BackupScheduleWeeklyRecurrenceArgs

Day string
The day of week to run. Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
Day string
The day of week to run. Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
day String
The day of week to run. Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
day string
The day of week to run. Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
day str
The day of week to run. Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
day String
The day of week to run. Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

Import

BackupSchedule can be imported using any of these accepted formats:

  • projects/{{project}}/databases/{{database}}/backupSchedules/{{name}}

  • {{project}}/{{database}}/{{name}}

  • {{database}}/{{name}}

When using the pulumi import command, BackupSchedule can be imported using one of the formats above. For example:

$ pulumi import gcp:firestore/backupSchedule:BackupSchedule default projects/{{project}}/databases/{{database}}/backupSchedules/{{name}}
Copy
$ pulumi import gcp:firestore/backupSchedule:BackupSchedule default {{project}}/{{database}}/{{name}}
Copy
$ pulumi import gcp:firestore/backupSchedule:BackupSchedule default {{database}}/{{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-gcp