gkebackup library

Classes

AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditConfigResponse
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
AuditLogConfigResponse
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Backup
Creates a Backup for the given BackupPlan. Auto-naming is currently not supported for this resource.
BackupArgs
The set of arguments for Backup. The set of arguments for Backup.
BackupConfig
BackupConfig defines the configuration of Backups created via this BackupPlan.
BackupConfigResponse
BackupConfig defines the configuration of Backups created via this BackupPlan.
BackupPlan
Creates a new BackupPlan in a given location. Auto-naming is currently not supported for this resource.
BackupPlanArgs
The set of arguments for BackupPlan. The set of arguments for BackupPlan.
BackupPlanBackupIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
BackupPlanBackupIamBindingArgs
The set of arguments for BackupPlanBackupIamBinding. The set of arguments for BackupPlanBackupIamBinding.
BackupPlanBackupIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
BackupPlanBackupIamMemberArgs
The set of arguments for BackupPlanBackupIamMember. The set of arguments for BackupPlanBackupIamMember.
BackupPlanBackupIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
BackupPlanBackupIamPolicyArgs
The set of arguments for BackupPlanBackupIamPolicy. The set of arguments for BackupPlanBackupIamPolicy.
BackupPlanBackupVolumeBackupIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
BackupPlanBackupVolumeBackupIamBindingArgs
The set of arguments for BackupPlanBackupVolumeBackupIamBinding. The set of arguments for BackupPlanBackupVolumeBackupIamBinding.
BackupPlanBackupVolumeBackupIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
BackupPlanBackupVolumeBackupIamMemberArgs
The set of arguments for BackupPlanBackupVolumeBackupIamMember. The set of arguments for BackupPlanBackupVolumeBackupIamMember.
BackupPlanBackupVolumeBackupIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
BackupPlanBackupVolumeBackupIamPolicyArgs
The set of arguments for BackupPlanBackupVolumeBackupIamPolicy. The set of arguments for BackupPlanBackupVolumeBackupIamPolicy.
BackupPlanIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
BackupPlanIamBindingArgs
The set of arguments for BackupPlanIamBinding. The set of arguments for BackupPlanIamBinding.
BackupPlanIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
BackupPlanIamMemberArgs
The set of arguments for BackupPlanIamMember. The set of arguments for BackupPlanIamMember.
BackupPlanIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
BackupPlanIamPolicyArgs
The set of arguments for BackupPlanIamPolicy. The set of arguments for BackupPlanIamPolicy.
Binding
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
ClusterMetadataResponse
Information about the GKE cluster from which this Backup was created.
ClusterResourceRestoreScope
Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume
ClusterResourceRestoreScopeResponse
Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume
EncryptionKey
Defined a customer managed encryption key that will be used to encrypt Backup artifacts.
EncryptionKeyResponse
Defined a customer managed encryption key that will be used to encrypt Backup artifacts.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
GetBackupArgs
Arguments for getBackup. Arguments for getBackup.
GetBackupPlanArgs
Arguments for getBackupPlan. Arguments for getBackupPlan.
GetBackupPlanBackupIamPolicyArgs
Arguments for getBackupPlanBackupIamPolicy. Arguments for getBackupPlanBackupIamPolicy.
GetBackupPlanBackupIamPolicyResult
Result data returned by getBackupPlanBackupIamPolicy.
GetBackupPlanBackupVolumeBackupIamPolicyArgs
Arguments for getBackupPlanBackupVolumeBackupIamPolicy. Arguments for getBackupPlanBackupVolumeBackupIamPolicy.
GetBackupPlanBackupVolumeBackupIamPolicyResult
Result data returned by getBackupPlanBackupVolumeBackupIamPolicy.
GetBackupPlanIamPolicyArgs
Arguments for getBackupPlanIamPolicy. Arguments for getBackupPlanIamPolicy.
GetBackupPlanIamPolicyResult
Result data returned by getBackupPlanIamPolicy.
GetBackupPlanResult
Result data returned by getBackupPlan.
GetBackupResult
Result data returned by getBackup.
GetRestoreArgs
Arguments for getRestore. Arguments for getRestore.
GetRestorePlanArgs
Arguments for getRestorePlan. Arguments for getRestorePlan.
GetRestorePlanIamPolicyArgs
Arguments for getRestorePlanIamPolicy. Arguments for getRestorePlanIamPolicy.
GetRestorePlanIamPolicyResult
Result data returned by getRestorePlanIamPolicy.
GetRestorePlanRestoreIamPolicyArgs
Arguments for getRestorePlanRestoreIamPolicy. Arguments for getRestorePlanRestoreIamPolicy.
GetRestorePlanRestoreIamPolicyResult
Result data returned by getRestorePlanRestoreIamPolicy.
GetRestorePlanRestoreVolumeRestoreIamPolicyArgs
Arguments for getRestorePlanRestoreVolumeRestoreIamPolicy. Arguments for getRestorePlanRestoreVolumeRestoreIamPolicy.
GetRestorePlanRestoreVolumeRestoreIamPolicyResult
Result data returned by getRestorePlanRestoreVolumeRestoreIamPolicy.
GetRestorePlanResult
Result data returned by getRestorePlan.
GetRestoreResult
Result data returned by getRestore.
GroupKind
This is a direct map to the Kubernetes GroupKind type GroupKind and is used for identifying specific "types" of resources to restore.
GroupKindResponse
This is a direct map to the Kubernetes GroupKind type GroupKind and is used for identifying specific "types" of resources to restore.
NamespacedName
A reference to a namespaced resource in Kubernetes.
NamespacedNameResponse
A reference to a namespaced resource in Kubernetes.
NamespacedNames
A list of namespaced Kubernetes resources.
NamespacedNamesResponse
A list of namespaced Kubernetes resources.
Namespaces
A list of Kubernetes Namespaces
NamespacesResponse
A list of Kubernetes Namespaces
ResourceFilter
ResourceFilter specifies matching criteria to limit the scope of a change to a specific set of kubernetes resources that are selected for restoration from a backup.
ResourceFilterResponse
ResourceFilter specifies matching criteria to limit the scope of a change to a specific set of kubernetes resources that are selected for restoration from a backup.
Restore
Creates a new Restore for the given RestorePlan. Auto-naming is currently not supported for this resource.
RestoreArgs
The set of arguments for Restore. The set of arguments for Restore.
RestoreConfig
Configuration of a restore. Next id: 13
RestoreConfigResponse
Configuration of a restore. Next id: 13
RestorePlan
Creates a new RestorePlan in a given location. Auto-naming is currently not supported for this resource.
RestorePlanArgs
The set of arguments for RestorePlan. The set of arguments for RestorePlan.
RestorePlanIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RestorePlanIamBindingArgs
The set of arguments for RestorePlanIamBinding. The set of arguments for RestorePlanIamBinding.
RestorePlanIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RestorePlanIamMemberArgs
The set of arguments for RestorePlanIamMember. The set of arguments for RestorePlanIamMember.
RestorePlanIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
RestorePlanIamPolicyArgs
The set of arguments for RestorePlanIamPolicy. The set of arguments for RestorePlanIamPolicy.
RestorePlanRestoreIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RestorePlanRestoreIamBindingArgs
The set of arguments for RestorePlanRestoreIamBinding. The set of arguments for RestorePlanRestoreIamBinding.
RestorePlanRestoreIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RestorePlanRestoreIamMemberArgs
The set of arguments for RestorePlanRestoreIamMember. The set of arguments for RestorePlanRestoreIamMember.
RestorePlanRestoreIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
RestorePlanRestoreIamPolicyArgs
The set of arguments for RestorePlanRestoreIamPolicy. The set of arguments for RestorePlanRestoreIamPolicy.
RestorePlanRestoreVolumeRestoreIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RestorePlanRestoreVolumeRestoreIamBindingArgs
The set of arguments for RestorePlanRestoreVolumeRestoreIamBinding. The set of arguments for RestorePlanRestoreVolumeRestoreIamBinding.
RestorePlanRestoreVolumeRestoreIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RestorePlanRestoreVolumeRestoreIamMemberArgs
The set of arguments for RestorePlanRestoreVolumeRestoreIamMember. The set of arguments for RestorePlanRestoreVolumeRestoreIamMember.
RestorePlanRestoreVolumeRestoreIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
RestorePlanRestoreVolumeRestoreIamPolicyArgs
The set of arguments for RestorePlanRestoreVolumeRestoreIamPolicy. The set of arguments for RestorePlanRestoreVolumeRestoreIamPolicy.
RetentionPolicy
RetentionPolicy defines a Backup retention policy for a BackupPlan.
RetentionPolicyResponse
RetentionPolicy defines a Backup retention policy for a BackupPlan.
Schedule
Defines scheduling parameters for automatically creating Backups via this BackupPlan.
ScheduleResponse
Defines scheduling parameters for automatically creating Backups via this BackupPlan.
SubstitutionRule
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.
SubstitutionRuleResponse
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.
TransformationRule
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to transform) and transformation logic.
TransformationRuleAction
TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)
TransformationRuleActionResponse
TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)
TransformationRuleResponse
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to transform) and transformation logic.

Enums

AuditLogConfigLogType
The log type that this config enables.
RestoreConfigClusterResourceConflictPolicy
Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
RestoreConfigNamespacedResourceRestoreMode
Optional. Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. This MUST be set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
RestoreConfigVolumeDataRestorePolicy
Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).
TransformationRuleActionOp
Required. op specifies the operation to perform.

Functions

getBackup(GetBackupArgs args, {InvokeOptions? options}) → Future<GetBackupResult>
Retrieve the details of a single Backup. args Arguments passed to this invoke. Arguments for getBackup. options Invoke options controlling this call.
getBackupPlan(GetBackupPlanArgs args, {InvokeOptions? options}) → Future<GetBackupPlanResult>
Retrieve the details of a single BackupPlan. args Arguments passed to this invoke. Arguments for getBackupPlan. options Invoke options controlling this call.
getBackupPlanBackupIamPolicy(GetBackupPlanBackupIamPolicyArgs args, {InvokeOptions? options}) → Future<GetBackupPlanBackupIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getBackupPlanBackupIamPolicy. options Invoke options controlling this call.
getBackupPlanBackupVolumeBackupIamPolicy(GetBackupPlanBackupVolumeBackupIamPolicyArgs args, {InvokeOptions? options}) → Future<GetBackupPlanBackupVolumeBackupIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getBackupPlanBackupVolumeBackupIamPolicy. options Invoke options controlling this call.
getBackupPlanIamPolicy(GetBackupPlanIamPolicyArgs args, {InvokeOptions? options}) → Future<GetBackupPlanIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getBackupPlanIamPolicy. options Invoke options controlling this call.
getRestore(GetRestoreArgs args, {InvokeOptions? options}) → Future<GetRestoreResult>
Retrieves the details of a single Restore. args Arguments passed to this invoke. Arguments for getRestore. options Invoke options controlling this call.
getRestorePlan(GetRestorePlanArgs args, {InvokeOptions? options}) → Future<GetRestorePlanResult>
Retrieve the details of a single RestorePlan. args Arguments passed to this invoke. Arguments for getRestorePlan. options Invoke options controlling this call.
getRestorePlanIamPolicy(GetRestorePlanIamPolicyArgs args, {InvokeOptions? options}) → Future<GetRestorePlanIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getRestorePlanIamPolicy. options Invoke options controlling this call.
getRestorePlanRestoreIamPolicy(GetRestorePlanRestoreIamPolicyArgs args, {InvokeOptions? options}) → Future<GetRestorePlanRestoreIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getRestorePlanRestoreIamPolicy. options Invoke options controlling this call.
getRestorePlanRestoreVolumeRestoreIamPolicy(GetRestorePlanRestoreVolumeRestoreIamPolicyArgs args, {InvokeOptions? options}) → Future<GetRestorePlanRestoreVolumeRestoreIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getRestorePlanRestoreVolumeRestoreIamPolicy. options Invoke options controlling this call.