1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firestore
  5. firestore/v1
  6. BackupSchedule

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.firestore/v1.BackupSchedule

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

    Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks. Auto-naming is currently not supported for this resource.

    Create BackupSchedule Resource

    new BackupSchedule(name: string, args: BackupScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def BackupSchedule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       daily_recurrence: Optional[GoogleFirestoreAdminV1DailyRecurrenceArgs] = None,
                       database_id: Optional[str] = None,
                       project: Optional[str] = None,
                       retention: Optional[str] = None,
                       weekly_recurrence: Optional[GoogleFirestoreAdminV1WeeklyRecurrenceArgs] = None)
    @overload
    def BackupSchedule(resource_name: str,
                       args: BackupScheduleArgs,
                       opts: Optional[ResourceOptions] = 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: google-native:firestore/v1:BackupSchedule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args BackupScheduleArgs
    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 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 string
    The unique name of the resource.
    args BackupScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupScheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The BackupSchedule resource accepts the following input properties:

    DatabaseId string
    DailyRecurrence Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1DailyRecurrence

    For a schedule that runs daily at a specified time.

    Project string
    Retention string

    At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.

    WeeklyRecurrence Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1WeeklyRecurrence

    For a schedule that runs weekly on a specific day and time.

    DatabaseId string
    DailyRecurrence GoogleFirestoreAdminV1DailyRecurrenceArgs

    For a schedule that runs daily at a specified time.

    Project string
    Retention string

    At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.

    WeeklyRecurrence GoogleFirestoreAdminV1WeeklyRecurrenceArgs

    For a schedule that runs weekly on a specific day and time.

    databaseId String
    dailyRecurrence GoogleFirestoreAdminV1DailyRecurrence

    For a schedule that runs daily at a specified time.

    project String
    retention String

    At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.

    weeklyRecurrence GoogleFirestoreAdminV1WeeklyRecurrence

    For a schedule that runs weekly on a specific day and time.

    databaseId string
    dailyRecurrence GoogleFirestoreAdminV1DailyRecurrence

    For a schedule that runs daily at a specified time.

    project string
    retention string

    At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.

    weeklyRecurrence GoogleFirestoreAdminV1WeeklyRecurrence

    For a schedule that runs weekly on a specific day and time.

    database_id str
    daily_recurrence GoogleFirestoreAdminV1DailyRecurrenceArgs

    For a schedule that runs daily at a specified time.

    project str
    retention str

    At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.

    weekly_recurrence GoogleFirestoreAdminV1WeeklyRecurrenceArgs

    For a schedule that runs weekly on a specific day and time.

    databaseId String
    dailyRecurrence Property Map

    For a schedule that runs daily at a specified time.

    project String
    retention String

    At what relative time in the future, compared to the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.

    weeklyRecurrence Property Map

    For a schedule that runs weekly on a specific day and time.

    Outputs

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

    CreateTime string

    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.

    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. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

    UpdateTime string

    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

    CreateTime string

    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.

    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. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

    UpdateTime string

    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

    createTime String

    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.

    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. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

    updateTime String

    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

    createTime string

    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.

    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. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

    updateTime string

    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

    create_time str

    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.

    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. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

    update_time str

    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

    createTime String

    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.

    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. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

    updateTime String

    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

    Supporting Types

    GoogleFirestoreAdminV1WeeklyRecurrence, GoogleFirestoreAdminV1WeeklyRecurrenceArgs

    Day Pulumi.GoogleNative.Firestore.V1.GoogleFirestoreAdminV1WeeklyRecurrenceDay

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    Day GoogleFirestoreAdminV1WeeklyRecurrenceDay

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day GoogleFirestoreAdminV1WeeklyRecurrenceDay

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day GoogleFirestoreAdminV1WeeklyRecurrenceDay

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day GoogleFirestoreAdminV1WeeklyRecurrenceDay

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    GoogleFirestoreAdminV1WeeklyRecurrenceDay, GoogleFirestoreAdminV1WeeklyRecurrenceDayArgs

    DayOfWeekUnspecified
    DAY_OF_WEEK_UNSPECIFIED

    The day of the week is unspecified.

    Monday
    MONDAY

    Monday

    Tuesday
    TUESDAY

    Tuesday

    Wednesday
    WEDNESDAY

    Wednesday

    Thursday
    THURSDAY

    Thursday

    Friday
    FRIDAY

    Friday

    Saturday
    SATURDAY

    Saturday

    Sunday
    SUNDAY

    Sunday

    GoogleFirestoreAdminV1WeeklyRecurrenceDayDayOfWeekUnspecified
    DAY_OF_WEEK_UNSPECIFIED

    The day of the week is unspecified.

    GoogleFirestoreAdminV1WeeklyRecurrenceDayMonday
    MONDAY

    Monday

    GoogleFirestoreAdminV1WeeklyRecurrenceDayTuesday
    TUESDAY

    Tuesday

    GoogleFirestoreAdminV1WeeklyRecurrenceDayWednesday
    WEDNESDAY

    Wednesday

    GoogleFirestoreAdminV1WeeklyRecurrenceDayThursday
    THURSDAY

    Thursday

    GoogleFirestoreAdminV1WeeklyRecurrenceDayFriday
    FRIDAY

    Friday

    GoogleFirestoreAdminV1WeeklyRecurrenceDaySaturday
    SATURDAY

    Saturday

    GoogleFirestoreAdminV1WeeklyRecurrenceDaySunday
    SUNDAY

    Sunday

    DayOfWeekUnspecified
    DAY_OF_WEEK_UNSPECIFIED

    The day of the week is unspecified.

    Monday
    MONDAY

    Monday

    Tuesday
    TUESDAY

    Tuesday

    Wednesday
    WEDNESDAY

    Wednesday

    Thursday
    THURSDAY

    Thursday

    Friday
    FRIDAY

    Friday

    Saturday
    SATURDAY

    Saturday

    Sunday
    SUNDAY

    Sunday

    DayOfWeekUnspecified
    DAY_OF_WEEK_UNSPECIFIED

    The day of the week is unspecified.

    Monday
    MONDAY

    Monday

    Tuesday
    TUESDAY

    Tuesday

    Wednesday
    WEDNESDAY

    Wednesday

    Thursday
    THURSDAY

    Thursday

    Friday
    FRIDAY

    Friday

    Saturday
    SATURDAY

    Saturday

    Sunday
    SUNDAY

    Sunday

    DAY_OF_WEEK_UNSPECIFIED
    DAY_OF_WEEK_UNSPECIFIED

    The day of the week is unspecified.

    MONDAY
    MONDAY

    Monday

    TUESDAY
    TUESDAY

    Tuesday

    WEDNESDAY
    WEDNESDAY

    Wednesday

    THURSDAY
    THURSDAY

    Thursday

    FRIDAY
    FRIDAY

    Friday

    SATURDAY
    SATURDAY

    Saturday

    SUNDAY
    SUNDAY

    Sunday

    "DAY_OF_WEEK_UNSPECIFIED"
    DAY_OF_WEEK_UNSPECIFIED

    The day of the week is unspecified.

    "MONDAY"
    MONDAY

    Monday

    "TUESDAY"
    TUESDAY

    Tuesday

    "WEDNESDAY"
    WEDNESDAY

    Wednesday

    "THURSDAY"
    THURSDAY

    Thursday

    "FRIDAY"
    FRIDAY

    Friday

    "SATURDAY"
    SATURDAY

    Saturday

    "SUNDAY"
    SUNDAY

    Sunday

    GoogleFirestoreAdminV1WeeklyRecurrenceResponse, GoogleFirestoreAdminV1WeeklyRecurrenceResponseArgs

    Day string

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    Day string

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day String

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day string

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day str

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    day String

    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi