1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. backupdisasterrecovery
  5. getBackupPlan
Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.backupdisasterrecovery.getBackupPlan

Start a Neo task
Explain and create a gcp.backupdisasterrecovery.getBackupPlan resource
gcp logo
Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
pulumi/pulumi-gcp

    Using getBackupPlan

    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 getBackupPlan(args: GetBackupPlanArgs, opts?: InvokeOptions): Promise<GetBackupPlanResult>
function getBackupPlanOutput(args: GetBackupPlanOutputArgs, opts?: InvokeOptions): Output<GetBackupPlanResult>
    def get_backup_plan(backup_plan_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetBackupPlanResult
def get_backup_plan_output(backup_plan_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetBackupPlanResult]
    func LookupBackupPlan(ctx *Context, args *LookupBackupPlanArgs, opts ...InvokeOption) (*LookupBackupPlanResult, error)
func LookupBackupPlanOutput(ctx *Context, args *LookupBackupPlanOutputArgs, opts ...InvokeOption) LookupBackupPlanResultOutput

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

    public static class GetBackupPlan 
{
    public static Task<GetBackupPlanResult> InvokeAsync(GetBackupPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupPlanResult> Invoke(GetBackupPlanInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupPlanResult> getBackupPlan(GetBackupPlanArgs args, InvokeOptions options)
public static Output<GetBackupPlanResult> getBackupPlan(GetBackupPlanArgs args, InvokeOptions options)

    fn::invoke:
  function: gcp:backupdisasterrecovery/getBackupPlan:getBackupPlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BackupPlanId string
    Location string
    Project string
    BackupPlanId string
    Location string
    Project string
    backupPlanId String
    location String
    project String
    backupPlanId string
    location string
    project string
    backupPlanId String
    location String
    project String

    getBackupPlan Result

    The following output properties are available:

    BackupPlanId string
    BackupRules List<GetBackupPlanBackupRule>
    BackupVault string
    BackupVaultServiceAccount string
    CreateTime string
    Description string
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    LogRetentionDays int
    Name string
    ResourceType string
    SupportedResourceTypes List<string>
    UpdateTime string
    Project string
    BackupPlanId string
    BackupRules []GetBackupPlanBackupRule
    BackupVault string
    BackupVaultServiceAccount string
    CreateTime string
    Description string
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    LogRetentionDays int
    Name string
    ResourceType string
    SupportedResourceTypes []string
    UpdateTime string
    Project string
    backupPlanId String
    backupRules List<GetBackupPlanBackupRule>
    backupVault String
    backupVaultServiceAccount String
    createTime String
    description String
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    logRetentionDays Integer
    name String
    resourceType String
    supportedResourceTypes List<String>
    updateTime String
    project String
    backupPlanId string
    backupRules GetBackupPlanBackupRule[]
    backupVault string
    backupVaultServiceAccount string
    createTime string
    description string
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    logRetentionDays number
    name string
    resourceType string
    supportedResourceTypes string[]
    updateTime string
    project string
    backupPlanId String
    backupRules List<Property Map>
    backupVault String
    backupVaultServiceAccount String
    createTime String
    description String
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    logRetentionDays Number
    name String
    resourceType String
    supportedResourceTypes List<String>
    updateTime String
    project String

    Supporting Types

    GetBackupPlanBackupRule

    BackupRetentionDays int
    Configures the duration for which backup data will be kept. The value should be greater than or equal to minimum enforced retention of the backup vault.
    RuleId string
    The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
    StandardSchedules List<GetBackupPlanBackupRuleStandardSchedule>
    StandardSchedule defines a schedule that runs within the confines of a defined window of days.
    BackupRetentionDays int
    Configures the duration for which backup data will be kept. The value should be greater than or equal to minimum enforced retention of the backup vault.
    RuleId string
    The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
    StandardSchedules []GetBackupPlanBackupRuleStandardSchedule
    StandardSchedule defines a schedule that runs within the confines of a defined window of days.
    backupRetentionDays Integer
    Configures the duration for which backup data will be kept. The value should be greater than or equal to minimum enforced retention of the backup vault.
    ruleId String
    The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
    standardSchedules List<GetBackupPlanBackupRuleStandardSchedule>
    StandardSchedule defines a schedule that runs within the confines of a defined window of days.
    backupRetentionDays number
    Configures the duration for which backup data will be kept. The value should be greater than or equal to minimum enforced retention of the backup vault.
    ruleId string
    The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
    standardSchedules GetBackupPlanBackupRuleStandardSchedule[]
    StandardSchedule defines a schedule that runs within the confines of a defined window of days.
    backup_retention_days int
    Configures the duration for which backup data will be kept. The value should be greater than or equal to minimum enforced retention of the backup vault.
    rule_id str
    The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
    standard_schedules Sequence[GetBackupPlanBackupRuleStandardSchedule]
    StandardSchedule defines a schedule that runs within the confines of a defined window of days.
    backupRetentionDays Number
    Configures the duration for which backup data will be kept. The value should be greater than or equal to minimum enforced retention of the backup vault.
    ruleId String
    The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
    standardSchedules List<Property Map>
    StandardSchedule defines a schedule that runs within the confines of a defined window of days.

    GetBackupPlanBackupRuleStandardSchedule

    BackupWindows List<GetBackupPlanBackupRuleStandardScheduleBackupWindow>
    A BackupWindow defines the window of the day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as 'NOT_RUN' if they do not start by the end of the window.
    DaysOfMonths List<int>
    Specifies days of months like 1, 5, or 14 on which jobs will run.
    DaysOfWeeks List<string>
    Specifies days of week like MONDAY or TUESDAY, on which jobs will run. This is required for 'recurrence_type', 'WEEKLY' and is not applicable otherwise. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    HourlyFrequency int
    Specifies frequency for hourly backups. An hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise.
    Months List<string>
    Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
    RecurrenceType string
    RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
    TimeZone string
    The time zone to be used when interpreting the schedule.
    WeekDayOfMonths List<GetBackupPlanBackupRuleStandardScheduleWeekDayOfMonth>
    Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
    BackupWindows []GetBackupPlanBackupRuleStandardScheduleBackupWindow
    A BackupWindow defines the window of the day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as 'NOT_RUN' if they do not start by the end of the window.
    DaysOfMonths []int
    Specifies days of months like 1, 5, or 14 on which jobs will run.
    DaysOfWeeks []string
    Specifies days of week like MONDAY or TUESDAY, on which jobs will run. This is required for 'recurrence_type', 'WEEKLY' and is not applicable otherwise. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    HourlyFrequency int
    Specifies frequency for hourly backups. An hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise.
    Months []string
    Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
    RecurrenceType string
    RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
    TimeZone string
    The time zone to be used when interpreting the schedule.
    WeekDayOfMonths []GetBackupPlanBackupRuleStandardScheduleWeekDayOfMonth
    Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
    backupWindows List<GetBackupPlanBackupRuleStandardScheduleBackupWindow>
    A BackupWindow defines the window of the day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as 'NOT_RUN' if they do not start by the end of the window.
    daysOfMonths List<Integer>
    Specifies days of months like 1, 5, or 14 on which jobs will run.
    daysOfWeeks List<String>
    Specifies days of week like MONDAY or TUESDAY, on which jobs will run. This is required for 'recurrence_type', 'WEEKLY' and is not applicable otherwise. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    hourlyFrequency Integer
    Specifies frequency for hourly backups. An hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise.
    months List<String>
    Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
    recurrenceType String
    RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
    timeZone String
    The time zone to be used when interpreting the schedule.
    weekDayOfMonths List<GetBackupPlanBackupRuleStandardScheduleWeekDayOfMonth>
    Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
    backupWindows GetBackupPlanBackupRuleStandardScheduleBackupWindow[]
    A BackupWindow defines the window of the day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as 'NOT_RUN' if they do not start by the end of the window.
    daysOfMonths number[]
    Specifies days of months like 1, 5, or 14 on which jobs will run.
    daysOfWeeks string[]
    Specifies days of week like MONDAY or TUESDAY, on which jobs will run. This is required for 'recurrence_type', 'WEEKLY' and is not applicable otherwise. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    hourlyFrequency number
    Specifies frequency for hourly backups. An hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise.
    months string[]
    Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
    recurrenceType string
    RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
    timeZone string
    The time zone to be used when interpreting the schedule.
    weekDayOfMonths GetBackupPlanBackupRuleStandardScheduleWeekDayOfMonth[]
    Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
    backup_windows Sequence[GetBackupPlanBackupRuleStandardScheduleBackupWindow]
    A BackupWindow defines the window of the day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as 'NOT_RUN' if they do not start by the end of the window.
    days_of_months Sequence[int]
    Specifies days of months like 1, 5, or 14 on which jobs will run.
    days_of_weeks Sequence[str]
    Specifies days of week like MONDAY or TUESDAY, on which jobs will run. This is required for 'recurrence_type', 'WEEKLY' and is not applicable otherwise. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    hourly_frequency int
    Specifies frequency for hourly backups. An hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise.
    months Sequence[str]
    Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
    recurrence_type str
    RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
    time_zone str
    The time zone to be used when interpreting the schedule.
    week_day_of_months Sequence[GetBackupPlanBackupRuleStandardScheduleWeekDayOfMonth]
    Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
    backupWindows List<Property Map>
    A BackupWindow defines the window of the day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as 'NOT_RUN' if they do not start by the end of the window.
    daysOfMonths List<Number>
    Specifies days of months like 1, 5, or 14 on which jobs will run.
    daysOfWeeks List<String>
    Specifies days of week like MONDAY or TUESDAY, on which jobs will run. This is required for 'recurrence_type', 'WEEKLY' and is not applicable otherwise. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    hourlyFrequency Number
    Specifies frequency for hourly backups. An hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for 'recurrence_type', 'HOURLY' and is not applicable otherwise.
    months List<String>
    Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
    recurrenceType String
    RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
    timeZone String
    The time zone to be used when interpreting the schedule.
    weekDayOfMonths List<Property Map>
    Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.

    GetBackupPlanBackupRuleStandardScheduleBackupWindow

    EndHourOfDay int
    The hour of the day (1-24) when the window ends, for example, if the value of end hour of the day is 10, that means the backup window end time is 10:00. The end hour of the day should be greater than the start
    StartHourOfDay int
    The hour of the day (0-23) when the window starts, for example, if the value of the start hour of the day is 6, that means the backup window starts at 6:00.
    EndHourOfDay int
    The hour of the day (1-24) when the window ends, for example, if the value of end hour of the day is 10, that means the backup window end time is 10:00. The end hour of the day should be greater than the start
    StartHourOfDay int
    The hour of the day (0-23) when the window starts, for example, if the value of the start hour of the day is 6, that means the backup window starts at 6:00.
    endHourOfDay Integer
    The hour of the day (1-24) when the window ends, for example, if the value of end hour of the day is 10, that means the backup window end time is 10:00. The end hour of the day should be greater than the start
    startHourOfDay Integer
    The hour of the day (0-23) when the window starts, for example, if the value of the start hour of the day is 6, that means the backup window starts at 6:00.
    endHourOfDay number
    The hour of the day (1-24) when the window ends, for example, if the value of end hour of the day is 10, that means the backup window end time is 10:00. The end hour of the day should be greater than the start
    startHourOfDay number
    The hour of the day (0-23) when the window starts, for example, if the value of the start hour of the day is 6, that means the backup window starts at 6:00.
    end_hour_of_day int
    The hour of the day (1-24) when the window ends, for example, if the value of end hour of the day is 10, that means the backup window end time is 10:00. The end hour of the day should be greater than the start
    start_hour_of_day int
    The hour of the day (0-23) when the window starts, for example, if the value of the start hour of the day is 6, that means the backup window starts at 6:00.
    endHourOfDay Number
    The hour of the day (1-24) when the window ends, for example, if the value of end hour of the day is 10, that means the backup window end time is 10:00. The end hour of the day should be greater than the start
    startHourOfDay Number
    The hour of the day (0-23) when the window starts, for example, if the value of the start hour of the day is 6, that means the backup window starts at 6:00.

    GetBackupPlanBackupRuleStandardScheduleWeekDayOfMonth

    DayOfWeek string
    Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    WeekOfMonth string
    WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month. Possible values: ["WEEK_OF_MONTH_UNSPECIFIED", "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]
    DayOfWeek string
    Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    WeekOfMonth string
    WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month. Possible values: ["WEEK_OF_MONTH_UNSPECIFIED", "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]
    dayOfWeek String
    Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    weekOfMonth String
    WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month. Possible values: ["WEEK_OF_MONTH_UNSPECIFIED", "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]
    dayOfWeek string
    Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    weekOfMonth string
    WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month. Possible values: ["WEEK_OF_MONTH_UNSPECIFIED", "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]
    day_of_week str
    Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    week_of_month str
    WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month. Possible values: ["WEEK_OF_MONTH_UNSPECIFIED", "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]
    dayOfWeek String
    Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
    weekOfMonth String
    WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month. Possible values: ["WEEK_OF_MONTH_UNSPECIFIED", "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"]

    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.
    gcp logo
    Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate