Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.gkebackup/v1.BackupPlan
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new BackupPlan in a given location. Auto-naming is currently not supported for this resource.
Create BackupPlan Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);@overload
def BackupPlan(resource_name: str,
               args: BackupPlanArgs,
               opts: Optional[ResourceOptions] = None)
@overload
def BackupPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               backup_plan_id: Optional[str] = None,
               cluster: Optional[str] = None,
               backup_config: Optional[BackupConfigArgs] = None,
               backup_schedule: Optional[ScheduleArgs] = None,
               deactivated: Optional[bool] = None,
               description: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               retention_policy: Optional[RetentionPolicyArgs] = None)func NewBackupPlan(ctx *Context, name string, args BackupPlanArgs, opts ...ResourceOption) (*BackupPlan, error)public BackupPlan(string name, BackupPlanArgs args, CustomResourceOptions? opts = null)
public BackupPlan(String name, BackupPlanArgs args)
public BackupPlan(String name, BackupPlanArgs args, CustomResourceOptions options)
type: google-native:gkebackup/v1:BackupPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BackupPlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BackupPlanArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BackupPlanArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackupPlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BackupPlanArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var backupPlanResource = new GoogleNative.Gkebackup.V1.BackupPlan("backupPlanResource", new()
{
    BackupPlanId = "string",
    Cluster = "string",
    BackupConfig = new GoogleNative.Gkebackup.V1.Inputs.BackupConfigArgs
    {
        AllNamespaces = false,
        EncryptionKey = new GoogleNative.Gkebackup.V1.Inputs.EncryptionKeyArgs
        {
            GcpKmsEncryptionKey = "string",
        },
        IncludeSecrets = false,
        IncludeVolumeData = false,
        SelectedApplications = new GoogleNative.Gkebackup.V1.Inputs.NamespacedNamesArgs
        {
            NamespacedNames = new[]
            {
                new GoogleNative.Gkebackup.V1.Inputs.NamespacedNameArgs
                {
                    Name = "string",
                    Namespace = "string",
                },
            },
        },
        SelectedNamespaces = new GoogleNative.Gkebackup.V1.Inputs.NamespacesArgs
        {
            Namespaces = new[]
            {
                "string",
            },
        },
    },
    BackupSchedule = new GoogleNative.Gkebackup.V1.Inputs.ScheduleArgs
    {
        CronSchedule = "string",
        Paused = false,
    },
    Deactivated = false,
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
    RetentionPolicy = new GoogleNative.Gkebackup.V1.Inputs.RetentionPolicyArgs
    {
        BackupDeleteLockDays = 0,
        BackupRetainDays = 0,
        Locked = false,
    },
});
example, err := gkebackup.NewBackupPlan(ctx, "backupPlanResource", &gkebackup.BackupPlanArgs{
	BackupPlanId: pulumi.String("string"),
	Cluster:      pulumi.String("string"),
	BackupConfig: &gkebackup.BackupConfigArgs{
		AllNamespaces: pulumi.Bool(false),
		EncryptionKey: &gkebackup.EncryptionKeyArgs{
			GcpKmsEncryptionKey: pulumi.String("string"),
		},
		IncludeSecrets:    pulumi.Bool(false),
		IncludeVolumeData: pulumi.Bool(false),
		SelectedApplications: &gkebackup.NamespacedNamesArgs{
			NamespacedNames: gkebackup.NamespacedNameArray{
				&gkebackup.NamespacedNameArgs{
					Name:      pulumi.String("string"),
					Namespace: pulumi.String("string"),
				},
			},
		},
		SelectedNamespaces: &gkebackup.NamespacesArgs{
			Namespaces: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	BackupSchedule: &gkebackup.ScheduleArgs{
		CronSchedule: pulumi.String("string"),
		Paused:       pulumi.Bool(false),
	},
	Deactivated: pulumi.Bool(false),
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
	RetentionPolicy: &gkebackup.RetentionPolicyArgs{
		BackupDeleteLockDays: pulumi.Int(0),
		BackupRetainDays:     pulumi.Int(0),
		Locked:               pulumi.Bool(false),
	},
})
var backupPlanResource = new BackupPlan("backupPlanResource", BackupPlanArgs.builder()
    .backupPlanId("string")
    .cluster("string")
    .backupConfig(BackupConfigArgs.builder()
        .allNamespaces(false)
        .encryptionKey(EncryptionKeyArgs.builder()
            .gcpKmsEncryptionKey("string")
            .build())
        .includeSecrets(false)
        .includeVolumeData(false)
        .selectedApplications(NamespacedNamesArgs.builder()
            .namespacedNames(NamespacedNameArgs.builder()
                .name("string")
                .namespace("string")
                .build())
            .build())
        .selectedNamespaces(NamespacesArgs.builder()
            .namespaces("string")
            .build())
        .build())
    .backupSchedule(ScheduleArgs.builder()
        .cronSchedule("string")
        .paused(false)
        .build())
    .deactivated(false)
    .description("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .retentionPolicy(RetentionPolicyArgs.builder()
        .backupDeleteLockDays(0)
        .backupRetainDays(0)
        .locked(false)
        .build())
    .build());
backup_plan_resource = google_native.gkebackup.v1.BackupPlan("backupPlanResource",
    backup_plan_id="string",
    cluster="string",
    backup_config={
        "all_namespaces": False,
        "encryption_key": {
            "gcp_kms_encryption_key": "string",
        },
        "include_secrets": False,
        "include_volume_data": False,
        "selected_applications": {
            "namespaced_names": [{
                "name": "string",
                "namespace": "string",
            }],
        },
        "selected_namespaces": {
            "namespaces": ["string"],
        },
    },
    backup_schedule={
        "cron_schedule": "string",
        "paused": False,
    },
    deactivated=False,
    description="string",
    labels={
        "string": "string",
    },
    location="string",
    project="string",
    retention_policy={
        "backup_delete_lock_days": 0,
        "backup_retain_days": 0,
        "locked": False,
    })
const backupPlanResource = new google_native.gkebackup.v1.BackupPlan("backupPlanResource", {
    backupPlanId: "string",
    cluster: "string",
    backupConfig: {
        allNamespaces: false,
        encryptionKey: {
            gcpKmsEncryptionKey: "string",
        },
        includeSecrets: false,
        includeVolumeData: false,
        selectedApplications: {
            namespacedNames: [{
                name: "string",
                namespace: "string",
            }],
        },
        selectedNamespaces: {
            namespaces: ["string"],
        },
    },
    backupSchedule: {
        cronSchedule: "string",
        paused: false,
    },
    deactivated: false,
    description: "string",
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
    retentionPolicy: {
        backupDeleteLockDays: 0,
        backupRetainDays: 0,
        locked: false,
    },
});
type: google-native:gkebackup/v1:BackupPlan
properties:
    backupConfig:
        allNamespaces: false
        encryptionKey:
            gcpKmsEncryptionKey: string
        includeSecrets: false
        includeVolumeData: false
        selectedApplications:
            namespacedNames:
                - name: string
                  namespace: string
        selectedNamespaces:
            namespaces:
                - string
    backupPlanId: string
    backupSchedule:
        cronSchedule: string
        paused: false
    cluster: string
    deactivated: false
    description: string
    labels:
        string: string
    location: string
    project: string
    retentionPolicy:
        backupDeleteLockDays: 0
        backupRetainDays: 0
        locked: false
BackupPlan Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BackupPlan resource accepts the following input properties:
- BackupPlan stringId 
- Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
- Cluster string
- Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/*-projects/*/zones/*/clusters/*
- BackupConfig Pulumi.Google Native. Gkebackup. V1. Inputs. Backup Config 
- Optional. Defines the configuration of Backups created via this BackupPlan.
- BackupSchedule Pulumi.Google Native. Gkebackup. V1. Inputs. Schedule 
- Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- Labels Dictionary<string, string>
- Optional. A set of custom labels supplied by user.
- Location string
- Project string
- RetentionPolicy Pulumi.Google Native. Gkebackup. V1. Inputs. Retention Policy 
- Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
- BackupPlan stringId 
- Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
- Cluster string
- Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/*-projects/*/zones/*/clusters/*
- BackupConfig BackupConfig Args 
- Optional. Defines the configuration of Backups created via this BackupPlan.
- BackupSchedule ScheduleArgs 
- Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- Labels map[string]string
- Optional. A set of custom labels supplied by user.
- Location string
- Project string
- RetentionPolicy RetentionPolicy Args 
- Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
- backupPlan StringId 
- Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
- cluster String
- Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/*-projects/*/zones/*/clusters/*
- backupConfig BackupConfig 
- Optional. Defines the configuration of Backups created via this BackupPlan.
- backupSchedule Schedule
- Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels Map<String,String>
- Optional. A set of custom labels supplied by user.
- location String
- project String
- retentionPolicy RetentionPolicy 
- Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
- backupPlan stringId 
- Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
- cluster string
- Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/*-projects/*/zones/*/clusters/*
- backupConfig BackupConfig 
- Optional. Defines the configuration of Backups created via this BackupPlan.
- backupSchedule Schedule
- Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels {[key: string]: string}
- Optional. A set of custom labels supplied by user.
- location string
- project string
- retentionPolicy RetentionPolicy 
- Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
- backup_plan_ strid 
- Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
- cluster str
- Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/*-projects/*/zones/*/clusters/*
- backup_config BackupConfig Args 
- Optional. Defines the configuration of Backups created via this BackupPlan.
- backup_schedule ScheduleArgs 
- Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels Mapping[str, str]
- Optional. A set of custom labels supplied by user.
- location str
- project str
- retention_policy RetentionPolicy Args 
- Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
- backupPlan StringId 
- Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
- cluster String
- Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/*-projects/*/zones/*/clusters/*
- 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.
- 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.
- labels Map<String>
- Optional. A set of custom labels supplied by user.
- location String
- project String
- retentionPolicy Property Map
- Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
Outputs
All input properties are implicitly available as output properties. Additionally, the BackupPlan resource produces the following output properties:
- CreateTime string
- The timestamp when this BackupPlan resource was created.
- Etag string
- etagis 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- etagis returned in the response to- GetBackupPlan, and systems are expected to put that etag in the request to- UpdateBackupPlanor- DeleteBackupPlanto ensure that their change will be applied to the same version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
- ProtectedPod intCount 
- The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- 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.
- CreateTime string
- The timestamp when this BackupPlan resource was created.
- Etag string
- etagis 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- etagis returned in the response to- GetBackupPlan, and systems are expected to put that etag in the request to- UpdateBackupPlanor- DeleteBackupPlanto ensure that their change will be applied to the same version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
- ProtectedPod intCount 
- The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- 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.
- createTime String
- The timestamp when this BackupPlan resource was created.
- etag String
- etagis 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- etagis returned in the response to- GetBackupPlan, and systems are expected to put that etag in the request to- UpdateBackupPlanor- DeleteBackupPlanto ensure that their change will be applied to the same version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
- protectedPod IntegerCount 
- The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- 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.
- createTime string
- The timestamp when this BackupPlan resource was created.
- etag string
- etagis 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- etagis returned in the response to- GetBackupPlan, and systems are expected to put that etag in the request to- UpdateBackupPlanor- DeleteBackupPlanto ensure that their change will be applied to the same version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
- protectedPod numberCount 
- The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- 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.
- create_time str
- The timestamp when this BackupPlan resource was created.
- etag str
- etagis 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- etagis returned in the response to- GetBackupPlan, and systems are expected to put that etag in the request to- UpdateBackupPlanor- DeleteBackupPlanto ensure that their change will be applied to the same version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
- protected_pod_ intcount 
- The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- 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.
- createTime String
- The timestamp when this BackupPlan resource was created.
- etag String
- etagis 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- etagis returned in the response to- GetBackupPlan, and systems are expected to put that etag in the request to- UpdateBackupPlanor- DeleteBackupPlanto ensure that their change will be applied to the same version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
- protectedPod NumberCount 
- The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- 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
BackupConfig, BackupConfigArgs    
- AllNamespaces bool
- If True, include all namespaced resources
- EncryptionKey Pulumi.Google Native. Gkebackup. V1. Inputs. Encryption Key 
- 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
- IncludeVolume boolData 
- 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.Google Native. Gkebackup. V1. Inputs. Namespaced Names 
- If set, include just the resources referenced by the listed ProtectedApplications.
- SelectedNamespaces Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaces 
- If set, include just the resources in the listed namespaces.
- AllNamespaces bool
- If True, include all namespaced resources
- EncryptionKey EncryptionKey 
- 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
- IncludeVolume boolData 
- Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- SelectedApplications NamespacedNames 
- If set, include just the resources referenced by the listed ProtectedApplications.
- SelectedNamespaces Namespaces
- If set, include just the resources in the listed namespaces.
- allNamespaces Boolean
- If True, include all namespaced resources
- encryptionKey EncryptionKey 
- 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
- includeVolume BooleanData 
- Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- selectedApplications NamespacedNames 
- If set, include just the resources referenced by the listed ProtectedApplications.
- selectedNamespaces Namespaces
- If set, include just the resources in the listed namespaces.
- allNamespaces boolean
- If True, include all namespaced resources
- encryptionKey EncryptionKey 
- 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
- includeVolume booleanData 
- Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- selectedApplications NamespacedNames 
- If set, include just the resources referenced by the listed ProtectedApplications.
- selectedNamespaces Namespaces
- If set, include just the resources in the listed namespaces.
- all_namespaces bool
- If True, include all namespaced resources
- encryption_key EncryptionKey 
- 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_ booldata 
- 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 NamespacedNames 
- If set, include just the resources referenced by the listed ProtectedApplications.
- selected_namespaces Namespaces
- 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
- includeVolume BooleanData 
- 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.
BackupConfigResponse, BackupConfigResponseArgs      
- AllNamespaces bool
- If True, include all namespaced resources
- EncryptionKey Pulumi.Google Native. Gkebackup. V1. Inputs. Encryption Key Response 
- 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
- IncludeVolume boolData 
- 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.Google Native. Gkebackup. V1. Inputs. Namespaced Names Response 
- If set, include just the resources referenced by the listed ProtectedApplications.
- SelectedNamespaces Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaces Response 
- If set, include just the resources in the listed namespaces.
- AllNamespaces bool
- If True, include all namespaced resources
- EncryptionKey EncryptionKey Response 
- 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
- IncludeVolume boolData 
- Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- SelectedApplications NamespacedNames Response 
- 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 EncryptionKey Response 
- 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
- includeVolume BooleanData 
- Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- selectedApplications NamespacedNames Response 
- 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 EncryptionKey Response 
- 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
- includeVolume booleanData 
- Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- selectedApplications NamespacedNames Response 
- 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 EncryptionKey Response 
- 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_ booldata 
- 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 NamespacedNames Response 
- 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
- includeVolume BooleanData 
- 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.
EncryptionKey, EncryptionKeyArgs    
- GcpKms stringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- GcpKms stringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcpKms StringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcpKms stringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp_kms_ strencryption_ key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcpKms StringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
EncryptionKeyResponse, EncryptionKeyResponseArgs      
- GcpKms stringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- GcpKms stringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcpKms StringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcpKms stringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp_kms_ strencryption_ key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcpKms StringEncryption Key 
- Optional. Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
NamespacedName, NamespacedNameArgs    
NamespacedNameResponse, NamespacedNameResponseArgs      
NamespacedNames, NamespacedNamesArgs    
- NamespacedNames List<Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Name> 
- Optional. A list of namespaced Kubernetes resources.
- NamespacedNames []NamespacedName 
- Optional. A list of namespaced Kubernetes resources.
- namespacedNames List<NamespacedName> 
- Optional. A list of namespaced Kubernetes resources.
- namespacedNames NamespacedName[] 
- Optional. A list of namespaced Kubernetes resources.
- namespaced_names Sequence[NamespacedName] 
- Optional. A list of namespaced Kubernetes resources.
- namespacedNames List<Property Map>
- Optional. A list of namespaced Kubernetes resources.
NamespacedNamesResponse, NamespacedNamesResponseArgs      
- NamespacedNames List<Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Name Response> 
- Optional. A list of namespaced Kubernetes resources.
- NamespacedNames []NamespacedName Response 
- Optional. A list of namespaced Kubernetes resources.
- namespacedNames List<NamespacedName Response> 
- Optional. A list of namespaced Kubernetes resources.
- namespacedNames NamespacedName Response[] 
- Optional. A list of namespaced Kubernetes resources.
- namespaced_names Sequence[NamespacedName Response] 
- Optional. A list of namespaced Kubernetes resources.
- namespacedNames List<Property Map>
- Optional. A list of namespaced Kubernetes resources.
Namespaces, NamespacesArgs  
- 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
NamespacesResponse, NamespacesResponseArgs    
- 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
RetentionPolicy, RetentionPolicyArgs    
- BackupDelete intLock Days 
- 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)
- BackupRetain intDays 
- 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 lockedfield itself. Default: False
- BackupDelete intLock Days 
- 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)
- BackupRetain intDays 
- 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 lockedfield itself. Default: False
- backupDelete IntegerLock Days 
- 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)
- backupRetain IntegerDays 
- 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 lockedfield itself. Default: False
- backupDelete numberLock Days 
- 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)
- backupRetain numberDays 
- 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 lockedfield itself. Default: False
- backup_delete_ intlock_ days 
- 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_ intdays 
- 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 lockedfield itself. Default: False
- backupDelete NumberLock Days 
- 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)
- backupRetain NumberDays 
- 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 lockedfield itself. Default: False
RetentionPolicyResponse, RetentionPolicyResponseArgs      
- BackupDelete intLock Days 
- 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)
- BackupRetain intDays 
- 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 lockedfield itself. Default: False
- BackupDelete intLock Days 
- 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)
- BackupRetain intDays 
- 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 lockedfield itself. Default: False
- backupDelete IntegerLock Days 
- 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)
- backupRetain IntegerDays 
- 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 lockedfield itself. Default: False
- backupDelete numberLock Days 
- 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)
- backupRetain numberDays 
- 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 lockedfield itself. Default: False
- backup_delete_ intlock_ days 
- 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_ intdays 
- 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 lockedfield itself. Default: False
- backupDelete NumberLock Days 
- 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)
- backupRetain NumberDays 
- 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 lockedfield itself. Default: False
Schedule, ScheduleArgs  
- 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
ScheduleResponse, ScheduleResponseArgs    
- 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 Cloud Native is in preview. Google Cloud Classic is fully supported.