Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getBackupPlan

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

Defines the configuration of Backups created via this BackupPlan.

BackupSchedule Pulumi.GoogleNative.Gkebackup.V1.Outputs.ScheduleResponse

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

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

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>

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

RetentionPolicy governs lifecycle of Backups created under this plan.

Uid string

Server generated global unique identifier of UUID format.

UpdateTime string

The timestamp when this BackupPlan resource was last updated.

BackupConfig BackupConfigResponse

Defines the configuration of Backups created via this BackupPlan.

BackupSchedule ScheduleResponse

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

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

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

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

RetentionPolicy governs lifecycle of Backups created under this plan.

Uid string

Server generated global unique identifier of UUID format.

UpdateTime string

The timestamp when this BackupPlan resource was last updated.

backupConfig BackupConfigResponse

Defines the configuration of Backups created via this BackupPlan.

backupSchedule ScheduleResponse

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

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

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>

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

RetentionPolicy governs lifecycle of Backups created under this plan.

uid String

Server generated global unique identifier of UUID format.

updateTime String

The timestamp when this BackupPlan resource was last updated.

backupConfig BackupConfigResponse

Defines the configuration of Backups created via this BackupPlan.

backupSchedule ScheduleResponse

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

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

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}

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

RetentionPolicy governs lifecycle of Backups created under this plan.

uid string

Server generated global unique identifier of UUID format.

updateTime string

The timestamp when this BackupPlan resource was last updated.

backup_config BackupConfigResponse

Defines the configuration of Backups created via this BackupPlan.

backup_schedule ScheduleResponse

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

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

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]

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

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Defines the configuration of Backups created via this BackupPlan.

backupSchedule Property Map

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

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

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>

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

RetentionPolicy governs lifecycle of Backups created under this plan.

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

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

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

IncludeVolumeData bool

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

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

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

IncludeVolumeData bool

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

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

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData Boolean

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

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

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData boolean

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

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

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

include_volume_data bool

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

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

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False

includeVolumeData Boolean

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

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

GcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey String

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey string

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcp_kms_encryption_key str

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

gcpKmsEncryptionKey String

Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

NamespacedNameResponse

Name string

The name of the Kubernetes resource.

Namespace string

The Namespace of the Kubernetes resource.

Name string

The name of the Kubernetes resource.

Namespace string

The Namespace of the Kubernetes resource.

name String

The name of the Kubernetes resource.

namespace String

The Namespace of the Kubernetes resource.

name string

The name of the Kubernetes resource.

namespace string

The Namespace of the Kubernetes resource.

name str

The name of the Kubernetes resource.

namespace str

The Namespace of the Kubernetes resource.

name String

The name of the Kubernetes resource.

namespace String

The Namespace of the Kubernetes resource.

NamespacedNamesResponse

NamespacedNames []NamespacedNameResponse

A list of namespaced Kubernetes resources.

namespacedNames List<NamespacedNameResponse>

A list of namespaced Kubernetes resources.

namespacedNames NamespacedNameResponse[]

A list of namespaced Kubernetes resources.

namespaced_names Sequence[NamespacedNameResponse]

A list of namespaced Kubernetes resources.

namespacedNames List<Property Map>

A list of namespaced Kubernetes resources.

NamespacesResponse

Namespaces List<string>

A list of Kubernetes Namespaces

Namespaces []string

A list of Kubernetes Namespaces

namespaces List<String>

A list of Kubernetes Namespaces

namespaces string[]

A list of Kubernetes Namespaces

namespaces Sequence[str]

A list of Kubernetes Namespaces

namespaces List<String>

A list of Kubernetes Namespaces

RetentionPolicyResponse

BackupDeleteLockDays int

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

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. Default: 0 (no automatic deletion)

Locked bool

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

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

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. Default: 0 (no automatic deletion)

Locked bool

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

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

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. Default: 0 (no automatic deletion)

locked Boolean

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

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

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. Default: 0 (no automatic deletion)

locked boolean

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

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

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. Default: 0 (no automatic deletion)

locked bool

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

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

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. Default: 0 (no automatic deletion)

locked Boolean

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

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

Paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

CronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

Paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule String

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused Boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cron_schedule str

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

cronSchedule String

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

paused Boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0