Google Cloud Classic v8.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
gcp.backupdisasterrecovery.getBackupPlan
Explore with Pulumi AI
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:backupdisasterrecovery/getBackupPlan:getBackupPlan
arguments:
# arguments dictionary
The following arguments are supported:
- Backup
Plan stringId - Location string
- Project string
- Backup
Plan stringId - Location string
- Project string
- backup
Plan StringId - location String
- project String
- backup
Plan stringId - location string
- project string
- backup_
plan_ strid - location str
- project str
- backup
Plan StringId - location String
- project String
getBackupPlan Result
The following output properties are available:
- Backup
Plan stringId - Backup
Rules List<GetBackup Plan Backup Rule> - Backup
Vault string - Backup
Vault stringService Account - Create
Time string - Description string
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- Name string
- Resource
Type string - Update
Time string - Project string
- Backup
Plan stringId - Backup
Rules []GetBackup Plan Backup Rule - Backup
Vault string - Backup
Vault stringService Account - Create
Time string - Description string
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- Name string
- Resource
Type string - Update
Time string - Project string
- backup
Plan StringId - backup
Rules List<GetBackup Plan Backup Rule> - backup
Vault String - backup
Vault StringService Account - create
Time String - description String
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- name String
- resource
Type String - update
Time String - project String
- backup
Plan stringId - backup
Rules GetBackup Plan Backup Rule[] - backup
Vault string - backup
Vault stringService Account - create
Time string - description string
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- name string
- resource
Type string - update
Time string - project string
- backup_
plan_ strid - backup_
rules Sequence[GetBackup Plan Backup Rule] - backup_
vault str - backup_
vault_ strservice_ account - create_
time str - description str
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- name str
- resource_
type str - update_
time str - project str
- backup
Plan StringId - backup
Rules List<Property Map> - backup
Vault String - backup
Vault StringService Account - create
Time String - description String
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- name String
- resource
Type String - update
Time String - project String
Supporting Types
GetBackupPlanBackupRule
- Backup
Retention intDays - 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 string - The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
- Standard
Schedules List<GetBackup Plan Backup Rule Standard Schedule> - StandardSchedule defines a schedule that runs within the confines of a defined window of days.
- Backup
Retention intDays - 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 string - The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
- Standard
Schedules []GetBackup Plan Backup Rule Standard Schedule - StandardSchedule defines a schedule that runs within the confines of a defined window of days.
- backup
Retention IntegerDays - 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 String - The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
- standard
Schedules List<GetBackup Plan Backup Rule Standard Schedule> - StandardSchedule defines a schedule that runs within the confines of a defined window of days.
- backup
Retention numberDays - 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 string - The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
- standard
Schedules GetBackup Plan Backup Rule Standard Schedule[] - StandardSchedule defines a schedule that runs within the confines of a defined window of days.
- backup_
retention_ intdays - 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[GetBackup Plan Backup Rule Standard Schedule] - StandardSchedule defines a schedule that runs within the confines of a defined window of days.
- backup
Retention NumberDays - 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 String - The unique ID of this 'BackupRule'. The 'rule_id' is unique per 'BackupPlan'.
- standard
Schedules List<Property Map> - StandardSchedule defines a schedule that runs within the confines of a defined window of days.
GetBackupPlanBackupRuleStandardSchedule
- Backup
Windows List<GetBackup Plan Backup Rule Standard Schedule Backup Window> - 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 List<int>Months - Specifies days of months like 1, 5, or 14 on which jobs will run.
- Days
Of List<string>Weeks - 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"]
- 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 List<string>
- Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
- Recurrence
Type string - RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
- Time
Zone string - The time zone to be used when interpreting the schedule.
- Week
Day List<GetOf Months Backup Plan Backup Rule Standard Schedule Week Day Of Month> - Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
- Backup
Windows []GetBackup Plan Backup Rule Standard Schedule Backup Window - 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 []intMonths - Specifies days of months like 1, 5, or 14 on which jobs will run.
- Days
Of []stringWeeks - 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"]
- 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 []string
- Specifies values of months Possible values: ["MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
- Recurrence
Type string - RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
- Time
Zone string - The time zone to be used when interpreting the schedule.
- Week
Day []GetOf Months Backup Plan Backup Rule Standard Schedule Week Day Of Month - Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
- backup
Windows List<GetBackup Plan Backup Rule Standard Schedule Backup Window> - 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 List<Integer>Months - Specifies days of months like 1, 5, or 14 on which jobs will run.
- days
Of List<String>Weeks - 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"]
- hourly
Frequency 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"]
- recurrence
Type String - RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
- time
Zone String - The time zone to be used when interpreting the schedule.
- week
Day List<GetOf Months Backup Plan Backup Rule Standard Schedule Week Day Of Month> - Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
- backup
Windows GetBackup Plan Backup Rule Standard Schedule Backup Window[] - 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 number[]Months - Specifies days of months like 1, 5, or 14 on which jobs will run.
- days
Of string[]Weeks - 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"]
- hourly
Frequency 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"]
- recurrence
Type string - RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
- time
Zone string - The time zone to be used when interpreting the schedule.
- week
Day GetOf Months Backup Plan Backup Rule Standard Schedule Week Day Of Month[] - Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
- backup_
windows Sequence[GetBackup Plan Backup Rule Standard Schedule Backup Window] - 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_ Sequence[int]months - Specifies days of months like 1, 5, or 14 on which jobs will run.
- days_
of_ Sequence[str]weeks - 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"]
- 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_ Sequence[Getof_ months Backup Plan Backup Rule Standard Schedule Week Day Of Month] - Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
- backup
Windows 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.
- days
Of List<Number>Months - Specifies days of months like 1, 5, or 14 on which jobs will run.
- days
Of List<String>Weeks - 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"]
- hourly
Frequency 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"]
- recurrence
Type String - RecurrenceType enumerates the applicable periodicity for the schedule. Possible values: ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
- time
Zone String - The time zone to be used when interpreting the schedule.
- week
Day List<Property Map>Of Months - Specifies a week day of the month like FIRST SUNDAY or LAST MONDAY, on which jobs will run.
GetBackupPlanBackupRuleStandardScheduleBackupWindow
- End
Hour intOf Day - 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 intOf Day - 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 intOf Day - 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 intOf Day - 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 IntegerOf Day - 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 IntegerOf Day - 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 numberOf Day - 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 numberOf Day - 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_ intof_ day - 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_ intof_ day - 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 NumberOf Day - 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 NumberOf Day - 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
- Day
Of stringWeek - Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
- Week
Of stringMonth - 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 stringWeek - Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
- Week
Of stringMonth - 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 StringWeek - Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
- week
Of StringMonth - 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 stringWeek - Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
- week
Of stringMonth - 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_ strweek - Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
- week_
of_ strmonth - 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 StringWeek - Specifies the day of the week. Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
- week
Of StringMonth - 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.