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
new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);
@overload
def BackupPlan(resource_name: str,
opts: Optional[ResourceOptions] = None,
backup_config: Optional[BackupConfigArgs] = None,
backup_plan_id: Optional[str] = None,
backup_schedule: Optional[ScheduleArgs] = None,
cluster: Optional[str] = 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)
@overload
def BackupPlan(resource_name: str,
args: BackupPlanArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The BackupPlan resource accepts the following input properties:
- Backup
Plan 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/*
- Backup
Config Pulumi.Google Native. Gkebackup. V1. Inputs. Backup Config Defines the configuration of Backups created via this BackupPlan.
- Backup
Schedule Pulumi.Google Native. Gkebackup. V1. Inputs. Schedule Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- Labels Dictionary<string, string>
A set of custom labels supplied by user.
- Location string
- Project string
- Retention
Policy Pulumi.Google Native. Gkebackup. V1. Inputs. Retention Policy RetentionPolicy governs lifecycle of Backups created under this plan.
- Backup
Plan 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/*
- Backup
Config BackupConfig Args Defines the configuration of Backups created via this BackupPlan.
- Backup
Schedule ScheduleArgs Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- Labels map[string]string
A set of custom labels supplied by user.
- Location string
- Project string
- Retention
Policy RetentionPolicy Args RetentionPolicy governs lifecycle of Backups created under this plan.
- backup
Plan 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/*
- backup
Config BackupConfig Defines the configuration of Backups created via this BackupPlan.
- backup
Schedule Schedule Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels Map<String,String>
A set of custom labels supplied by user.
- location String
- project String
- retention
Policy RetentionPolicy RetentionPolicy governs lifecycle of Backups created under this plan.
- backup
Plan 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/*
- backup
Config BackupConfig Defines the configuration of Backups created via this BackupPlan.
- backup
Schedule Schedule Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels {[key: string]: string}
A set of custom labels supplied by user.
- location string
- project string
- retention
Policy RetentionPolicy 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 Defines the configuration of Backups created via this BackupPlan.
- backup_
schedule ScheduleArgs Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels Mapping[str, str]
A set of custom labels supplied by user.
- location str
- project str
- retention_
policy RetentionPolicy Args RetentionPolicy governs lifecycle of Backups created under this plan.
- backup
Plan 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/*
- backup
Config Property Map Defines the configuration of Backups created via this BackupPlan.
- backup
Schedule Property Map Defines a schedule for automatic Backup creation via this BackupPlan.
- 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.
- labels Map<String>
A set of custom labels supplied by user.
- location String
- project String
- retention
Policy Property Map 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:
- Create
Time string The timestamp when this BackupPlan resource was created.
- 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: Anetag
is returned in the response toGetBackupPlan
, and systems are expected to put that etag in the request toUpdateBackupPlan
orDeleteBackupPlan
to 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/*
- Protected
Pod intCount The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- Uid string
Server generated global unique identifier of UUID format.
- Update
Time string The timestamp when this BackupPlan resource was last updated.
- Create
Time string The timestamp when this BackupPlan resource was created.
- 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: Anetag
is returned in the response toGetBackupPlan
, and systems are expected to put that etag in the request toUpdateBackupPlan
orDeleteBackupPlan
to 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/*
- Protected
Pod intCount The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- Uid string
Server generated global unique identifier of UUID format.
- Update
Time string The timestamp when this BackupPlan resource was last updated.
- create
Time String The timestamp when this BackupPlan resource was created.
- 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: Anetag
is returned in the response toGetBackupPlan
, and systems are expected to put that etag in the request toUpdateBackupPlan
orDeleteBackupPlan
to 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/*
- protected
Pod IntegerCount The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- uid String
Server generated global unique identifier of UUID format.
- update
Time String The timestamp when this BackupPlan resource was last updated.
- create
Time string The timestamp when this BackupPlan resource was created.
- 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: Anetag
is returned in the response toGetBackupPlan
, and systems are expected to put that etag in the request toUpdateBackupPlan
orDeleteBackupPlan
to 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/*
- protected
Pod numberCount The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- uid string
Server generated global unique identifier of UUID format.
- update
Time string The timestamp when this BackupPlan resource was last updated.
- create_
time str The timestamp when this BackupPlan resource was created.
- 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: Anetag
is returned in the response toGetBackupPlan
, and systems are expected to put that etag in the request toUpdateBackupPlan
orDeleteBackupPlan
to 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.
- uid str
Server generated global unique identifier of UUID format.
- update_
time str The timestamp when this BackupPlan resource was last updated.
- create
Time String The timestamp when this BackupPlan resource was created.
- 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: Anetag
is returned in the response toGetBackupPlan
, and systems are expected to put that etag in the request toUpdateBackupPlan
orDeleteBackupPlan
to 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/*
- protected
Pod NumberCount The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
- uid String
Server generated global unique identifier of UUID format.
- update
Time String The timestamp when this BackupPlan resource was last updated.
Supporting Types
BackupConfig, BackupConfigArgs
- All
Namespaces bool If True, include all namespaced resources
- Encryption
Key Pulumi.Google Native. Gkebackup. V1. Inputs. Encryption Key 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 boolData This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- Selected
Applications Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Names If set, include just the resources referenced by the listed ProtectedApplications.
- Selected
Namespaces Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaces If set, include just the resources in the listed namespaces.
- All
Namespaces bool If True, include all namespaced resources
- Encryption
Key EncryptionKey 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 boolData 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.
- all
Namespaces Boolean If True, include all namespaced resources
- encryption
Key EncryptionKey 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 Boolean This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
- include
Volume BooleanData 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.
- all
Namespaces boolean If True, include all namespaced resources
- encryption
Key EncryptionKey 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 boolean This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
- include
Volume booleanData 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.
- all_
namespaces bool If True, include all namespaced resources
- encryption_
key EncryptionKey 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_ booldata 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.
- all
Namespaces Boolean If True, include all namespaced resources
- encryption
Key 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.
- include
Secrets Boolean This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
- include
Volume BooleanData This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- selected
Applications Property Map If set, include just the resources referenced by the listed ProtectedApplications.
- selected
Namespaces Property Map If set, include just the resources in the listed namespaces.
BackupConfigResponse, BackupConfigResponseArgs
- All
Namespaces bool If True, include all namespaced resources
- Encryption
Key Pulumi.Google Native. Gkebackup. V1. Inputs. Encryption Key Response 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 boolData This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- Selected
Applications Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Names Response If set, include just the resources referenced by the listed ProtectedApplications.
- Selected
Namespaces Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaces Response If set, include just the resources in the listed namespaces.
- All
Namespaces bool If True, include all namespaced resources
- Encryption
Key EncryptionKey Response 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 boolData 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.
- all
Namespaces Boolean If True, include all namespaced resources
- encryption
Key EncryptionKey Response 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 Boolean This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
- include
Volume BooleanData 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.
- all
Namespaces boolean If True, include all namespaced resources
- encryption
Key EncryptionKey Response 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 boolean This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
- include
Volume booleanData 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.
- all_
namespaces bool If True, include all namespaced resources
- encryption_
key EncryptionKey Response 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_ booldata 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.
- all
Namespaces Boolean If True, include all namespaced resources
- encryption
Key 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.
- include
Secrets Boolean This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
- include
Volume BooleanData This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
- selected
Applications Property Map If set, include just the resources referenced by the listed ProtectedApplications.
- selected
Namespaces Property Map If set, include just the resources in the listed namespaces.
EncryptionKey, EncryptionKeyArgs
- Gcp
Kms stringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- Gcp
Kms stringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp
Kms StringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp
Kms stringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp_
kms_ strencryption_ key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp
Kms StringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
EncryptionKeyResponse, EncryptionKeyResponseArgs
- Gcp
Kms stringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- Gcp
Kms stringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp
Kms StringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp
Kms stringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp_
kms_ strencryption_ key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
- gcp
Kms StringEncryption Key Google Cloud KMS encryption key. Format:
projects/*/locations/*/keyRings/*/cryptoKeys/*
NamespacedName, NamespacedNameArgs
NamespacedNameResponse, NamespacedNameResponseArgs
NamespacedNames, NamespacedNamesArgs
- Namespaced
Names List<Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Name> A list of namespaced Kubernetes resources.
- Namespaced
Names []NamespacedName A list of namespaced Kubernetes resources.
- namespaced
Names List<NamespacedName> A list of namespaced Kubernetes resources.
- namespaced
Names NamespacedName[] A list of namespaced Kubernetes resources.
- namespaced_
names Sequence[NamespacedName] A list of namespaced Kubernetes resources.
- namespaced
Names List<Property Map> A list of namespaced Kubernetes resources.
NamespacedNamesResponse, NamespacedNamesResponseArgs
- Namespaced
Names List<Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Name Response> A list of namespaced Kubernetes resources.
- Namespaced
Names []NamespacedName Response A list of namespaced Kubernetes resources.
- namespaced
Names List<NamespacedName Response> A list of namespaced Kubernetes resources.
- namespaced
Names NamespacedName Response[] A list of namespaced Kubernetes resources.
- namespaced_
names Sequence[NamespacedName Response] A list of namespaced Kubernetes resources.
- namespaced
Names List<Property Map> A list of namespaced Kubernetes resources.
Namespaces, NamespacesArgs
- 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
NamespacesResponse, NamespacesResponseArgs
- 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
RetentionPolicy, RetentionPolicyArgs
- Backup
Delete intLock Days 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 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
- Backup
Delete intLock Days 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 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
- backup
Delete IntegerLock Days 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 IntegerDays 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 numberLock Days 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 numberDays 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_ intlock_ days 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 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
- backup
Delete NumberLock Days 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 NumberDays 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
RetentionPolicyResponse, RetentionPolicyResponseArgs
- Backup
Delete intLock Days 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 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
- Backup
Delete intLock Days 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 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
- backup
Delete IntegerLock Days 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 IntegerDays 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 numberLock Days 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 numberDays 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_ intlock_ days 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 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
- backup
Delete NumberLock Days 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 NumberDays 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
Schedule, ScheduleArgs
- Cron
Schedule 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
- Cron
Schedule 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
- cron
Schedule 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 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
- cron
Schedule 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
ScheduleResponse, ScheduleResponseArgs
- Cron
Schedule 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
- Cron
Schedule 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
- cron
Schedule 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 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
- cron
Schedule 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
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.