Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. gkebackup
  5. gkebackup/v1
  6. getBackupPlan

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.gkebackup/v1.getBackupPlan

Explore with Pulumi AI

google-native logo

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Retrieve the details of a single BackupPlan.

    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: google-native:gkebackup/v1: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:

    BackupConfig Pulumi.GoogleNative.Gkebackup.V1.Outputs.BackupConfigResponse
    Optional. Defines the configuration of Backups created via this BackupPlan.
    BackupSchedule Pulumi.GoogleNative.Gkebackup.V1.Outputs.ScheduleResponse
    Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
    Cluster string
    Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
    CreateTime string
    The timestamp when this BackupPlan resource was created.
    Deactivated bool
    Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
    Description string
    Optional. User specified descriptive string for this BackupPlan.
    Etag string
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
    Labels Dictionary<string, string>
    Optional. A set of custom labels supplied by user.
    Name string
    The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
    ProtectedPodCount int
    The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    RetentionPolicy Pulumi.GoogleNative.Gkebackup.V1.Outputs.RetentionPolicyResponse
    Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
    State string
    State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
    StateReason string
    Human-readable description of why BackupPlan is in the current state
    Uid string
    Server generated global unique identifier of UUID format.
    UpdateTime string
    The timestamp when this BackupPlan resource was last updated.
    BackupConfig BackupConfigResponse
    Optional. Defines the configuration of Backups created via this BackupPlan.
    BackupSchedule ScheduleResponse
    Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
    Cluster string
    Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
    CreateTime string
    The timestamp when this BackupPlan resource was created.
    Deactivated bool
    Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
    Description string
    Optional. User specified descriptive string for this BackupPlan.
    Etag string
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
    Labels map[string]string
    Optional. A set of custom labels supplied by user.
    Name string
    The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
    ProtectedPodCount int
    The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    RetentionPolicy RetentionPolicyResponse
    Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
    State string
    State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
    StateReason string
    Human-readable description of why BackupPlan is in the current state
    Uid string
    Server generated global unique identifier of UUID format.
    UpdateTime string
    The timestamp when this BackupPlan resource was last updated.
    backupConfig BackupConfigResponse
    Optional. Defines the configuration of Backups created via this BackupPlan.
    backupSchedule ScheduleResponse
    Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
    cluster String
    Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
    createTime String
    The timestamp when this BackupPlan resource was created.
    deactivated Boolean
    Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
    description String
    Optional. User specified descriptive string for this BackupPlan.
    etag String
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
    labels Map<String,String>
    Optional. A set of custom labels supplied by user.
    name String
    The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
    protectedPodCount Integer
    The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    retentionPolicy RetentionPolicyResponse
    Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
    state String
    State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
    stateReason String
    Human-readable description of why BackupPlan is in the current state
    uid String
    Server generated global unique identifier of UUID format.
    updateTime String
    The timestamp when this BackupPlan resource was last updated.
    backupConfig BackupConfigResponse
    Optional. Defines the configuration of Backups created via this BackupPlan.
    backupSchedule ScheduleResponse
    Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
    cluster string
    Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
    createTime string
    The timestamp when this BackupPlan resource was created.
    deactivated boolean
    Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
    description string
    Optional. User specified descriptive string for this BackupPlan.
    etag string
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
    labels {[key: string]: string}
    Optional. A set of custom labels supplied by user.
    name string
    The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
    protectedPodCount number
    The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    retentionPolicy RetentionPolicyResponse
    Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
    state string
    State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
    stateReason string
    Human-readable description of why BackupPlan is in the current state
    uid string
    Server generated global unique identifier of UUID format.
    updateTime string
    The timestamp when this BackupPlan resource was last updated.
    backup_config BackupConfigResponse
    Optional. Defines the configuration of Backups created via this BackupPlan.
    backup_schedule ScheduleResponse
    Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
    cluster str
    Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
    create_time str
    The timestamp when this BackupPlan resource was created.
    deactivated bool
    Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
    description str
    Optional. User specified descriptive string for this BackupPlan.
    etag str
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
    labels Mapping[str, str]
    Optional. A set of custom labels supplied by user.
    name str
    The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
    protected_pod_count int
    The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    retention_policy RetentionPolicyResponse
    Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
    state str
    State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
    state_reason str
    Human-readable description of why BackupPlan is in the current state
    uid str
    Server generated global unique identifier of UUID format.
    update_time str
    The timestamp when this BackupPlan resource was last updated.
    backupConfig Property Map
    Optional. Defines the configuration of Backups created via this BackupPlan.
    backupSchedule Property Map
    Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
    cluster String
    Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
    createTime String
    The timestamp when this BackupPlan resource was created.
    deactivated Boolean
    Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
    description String
    Optional. User specified descriptive string for this BackupPlan.
    etag String
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
    labels Map<String>
    Optional. A set of custom labels supplied by user.
    name String
    The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
    protectedPodCount Number
    The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    retentionPolicy Property Map
    Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
    state String
    State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
    stateReason String
    Human-readable description of why BackupPlan is in the current state
    uid String
    Server generated global unique identifier of UUID format.
    updateTime String
    The timestamp when this BackupPlan resource was last updated.

    Supporting Types

    BackupConfigResponse

    AllNamespaces bool
    If True, include all namespaced resources
    EncryptionKey Pulumi.GoogleNative.Gkebackup.V1.Inputs.EncryptionKeyResponse
    Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
    IncludeSecrets bool
    Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    IncludeVolumeData bool
    Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
    SelectedApplications Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacedNamesResponse
    If set, include just the resources referenced by the listed ProtectedApplications.
    SelectedNamespaces Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacesResponse
    If set, include just the resources in the listed namespaces.
    AllNamespaces bool
    If True, include all namespaced resources
    EncryptionKey EncryptionKeyResponse
    Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
    IncludeSecrets bool
    Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    IncludeVolumeData bool
    Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
    SelectedApplications NamespacedNamesResponse
    If set, include just the resources referenced by the listed ProtectedApplications.
    SelectedNamespaces NamespacesResponse
    If set, include just the resources in the listed namespaces.
    allNamespaces Boolean
    If True, include all namespaced resources
    encryptionKey EncryptionKeyResponse
    Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
    includeSecrets Boolean
    Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    includeVolumeData Boolean
    Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
    selectedApplications NamespacedNamesResponse
    If set, include just the resources referenced by the listed ProtectedApplications.
    selectedNamespaces NamespacesResponse
    If set, include just the resources in the listed namespaces.
    allNamespaces boolean
    If True, include all namespaced resources
    encryptionKey EncryptionKeyResponse
    Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
    includeSecrets boolean
    Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    includeVolumeData boolean
    Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
    selectedApplications NamespacedNamesResponse
    If set, include just the resources referenced by the listed ProtectedApplications.
    selectedNamespaces NamespacesResponse
    If set, include just the resources in the listed namespaces.
    all_namespaces bool
    If True, include all namespaced resources
    encryption_key EncryptionKeyResponse
    Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
    include_secrets bool
    Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    include_volume_data bool
    Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
    selected_applications NamespacedNamesResponse
    If set, include just the resources referenced by the listed ProtectedApplications.
    selected_namespaces NamespacesResponse
    If set, include just the resources in the listed namespaces.
    allNamespaces Boolean
    If True, include all namespaced resources
    encryptionKey Property Map
    Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
    includeSecrets Boolean
    Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    includeVolumeData Boolean
    Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
    selectedApplications Property Map
    If set, include just the resources referenced by the listed ProtectedApplications.
    selectedNamespaces Property Map
    If set, include just the resources in the listed namespaces.

    EncryptionKeyResponse

    GcpKmsEncryptionKey string
    Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
    GcpKmsEncryptionKey string
    Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
    gcpKmsEncryptionKey String
    Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
    gcpKmsEncryptionKey string
    Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
    gcp_kms_encryption_key str
    Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
    gcpKmsEncryptionKey String
    Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

    NamespacedNameResponse

    Name string
    Optional. The name of the Kubernetes resource.
    Namespace string
    Optional. The Namespace of the Kubernetes resource.
    Name string
    Optional. The name of the Kubernetes resource.
    Namespace string
    Optional. The Namespace of the Kubernetes resource.
    name String
    Optional. The name of the Kubernetes resource.
    namespace String
    Optional. The Namespace of the Kubernetes resource.
    name string
    Optional. The name of the Kubernetes resource.
    namespace string
    Optional. The Namespace of the Kubernetes resource.
    name str
    Optional. The name of the Kubernetes resource.
    namespace str
    Optional. The Namespace of the Kubernetes resource.
    name String
    Optional. The name of the Kubernetes resource.
    namespace String
    Optional. The Namespace of the Kubernetes resource.

    NamespacedNamesResponse

    NamespacedNames []NamespacedNameResponse
    Optional. A list of namespaced Kubernetes resources.
    namespacedNames List<NamespacedNameResponse>
    Optional. A list of namespaced Kubernetes resources.
    namespacedNames NamespacedNameResponse[]
    Optional. A list of namespaced Kubernetes resources.
    namespaced_names Sequence[NamespacedNameResponse]
    Optional. A list of namespaced Kubernetes resources.
    namespacedNames List<Property Map>
    Optional. A list of namespaced Kubernetes resources.

    NamespacesResponse

    Namespaces List<string>
    Optional. A list of Kubernetes Namespaces
    Namespaces []string
    Optional. A list of Kubernetes Namespaces
    namespaces List<String>
    Optional. A list of Kubernetes Namespaces
    namespaces string[]
    Optional. A list of Kubernetes Namespaces
    namespaces Sequence[str]
    Optional. A list of Kubernetes Namespaces
    namespaces List<String>
    Optional. A list of Kubernetes Namespaces

    RetentionPolicyResponse

    BackupDeleteLockDays int
    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    BackupRetainDays int
    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
    Locked bool
    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False
    BackupDeleteLockDays int
    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    BackupRetainDays int
    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
    Locked bool
    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False
    backupDeleteLockDays Integer
    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    backupRetainDays Integer
    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
    locked Boolean
    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False
    backupDeleteLockDays number
    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    backupRetainDays number
    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
    locked boolean
    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False
    backup_delete_lock_days int
    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    backup_retain_days int
    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
    locked bool
    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False
    backupDeleteLockDays Number
    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    backupRetainDays Number
    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
    locked Boolean
    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself. Default: False

    ScheduleResponse

    CronSchedule string
    Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    Paused bool
    Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
    CronSchedule string
    Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    Paused bool
    Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
    cronSchedule String
    Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    paused Boolean
    Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
    cronSchedule string
    Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    paused boolean
    Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
    cron_schedule str
    Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    paused bool
    Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
    cronSchedule String
    Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    paused Boolean
    Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

    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.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native