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

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.gkebackup/v1.getRestore

Explore with Pulumi AI

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Retrieves the details of a single Restore.

Using getRestore

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRestore(args: GetRestoreArgs, opts?: InvokeOptions): Promise<GetRestoreResult>
function getRestoreOutput(args: GetRestoreOutputArgs, opts?: InvokeOptions): Output<GetRestoreResult>
Copy
def get_restore(location: Optional[str] = None,
                project: Optional[str] = None,
                restore_id: Optional[str] = None,
                restore_plan_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRestoreResult
def get_restore_output(location: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                restore_id: Optional[pulumi.Input[str]] = None,
                restore_plan_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRestoreResult]
Copy
func LookupRestore(ctx *Context, args *LookupRestoreArgs, opts ...InvokeOption) (*LookupRestoreResult, error)
func LookupRestoreOutput(ctx *Context, args *LookupRestoreOutputArgs, opts ...InvokeOption) LookupRestoreResultOutput
Copy

> Note: This function is named LookupRestore in the Go SDK.

public static class GetRestore 
{
    public static Task<GetRestoreResult> InvokeAsync(GetRestoreArgs args, InvokeOptions? opts = null)
    public static Output<GetRestoreResult> Invoke(GetRestoreInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRestoreResult> getRestore(GetRestoreArgs args, InvokeOptions options)
public static Output<GetRestoreResult> getRestore(GetRestoreArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:gkebackup/v1:getRestore
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
RestoreId This property is required. string
RestorePlanId This property is required. string
Project string
Location This property is required. string
RestoreId This property is required. string
RestorePlanId This property is required. string
Project string
location This property is required. String
restoreId This property is required. String
restorePlanId This property is required. String
project String
location This property is required. string
restoreId This property is required. string
restorePlanId This property is required. string
project string
location This property is required. str
restore_id This property is required. str
restore_plan_id This property is required. str
project str
location This property is required. String
restoreId This property is required. String
restorePlanId This property is required. String
project String

getRestore Result

The following output properties are available:

Backup string
Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
Cluster string
The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.
CompleteTime string
Timestamp of when the restore operation completed.
CreateTime string
The timestamp when this Restore resource was created.
Description string
User specified descriptive string for this Restore.
Etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.
Labels Dictionary<string, string>
A set of custom labels supplied by user.
Name string
The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
ResourcesExcludedCount int
Number of resources excluded during the restore execution.
ResourcesFailedCount int
Number of resources that failed to be restored during the restore execution.
ResourcesRestoredCount int
Number of resources restored during the restore execution.
RestoreConfig Pulumi.GoogleNative.Gkebackup.V1.Outputs.RestoreConfigResponse
Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
State string
The current state of the Restore.
StateReason string
Human-readable description of why the Restore is in its current state.
Uid string
Server generated global unique identifier of UUID format.
UpdateTime string
The timestamp when this Restore resource was last updated.
VolumesRestoredCount int
Number of volumes restored during the restore execution.
Backup string
Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
Cluster string
The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.
CompleteTime string
Timestamp of when the restore operation completed.
CreateTime string
The timestamp when this Restore resource was created.
Description string
User specified descriptive string for this Restore.
Etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.
Labels map[string]string
A set of custom labels supplied by user.
Name string
The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
ResourcesExcludedCount int
Number of resources excluded during the restore execution.
ResourcesFailedCount int
Number of resources that failed to be restored during the restore execution.
ResourcesRestoredCount int
Number of resources restored during the restore execution.
RestoreConfig RestoreConfigResponse
Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
State string
The current state of the Restore.
StateReason string
Human-readable description of why the Restore is in its current state.
Uid string
Server generated global unique identifier of UUID format.
UpdateTime string
The timestamp when this Restore resource was last updated.
VolumesRestoredCount int
Number of volumes restored during the restore execution.
backup String
Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
cluster String
The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.
completeTime String
Timestamp of when the restore operation completed.
createTime String
The timestamp when this Restore resource was created.
description String
User specified descriptive string for this Restore.
etag String
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.
labels Map<String,String>
A set of custom labels supplied by user.
name String
The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
resourcesExcludedCount Integer
Number of resources excluded during the restore execution.
resourcesFailedCount Integer
Number of resources that failed to be restored during the restore execution.
resourcesRestoredCount Integer
Number of resources restored during the restore execution.
restoreConfig RestoreConfigResponse
Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
state String
The current state of the Restore.
stateReason String
Human-readable description of why the Restore is in its current state.
uid String
Server generated global unique identifier of UUID format.
updateTime String
The timestamp when this Restore resource was last updated.
volumesRestoredCount Integer
Number of volumes restored during the restore execution.
backup string
Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
cluster string
The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.
completeTime string
Timestamp of when the restore operation completed.
createTime string
The timestamp when this Restore resource was created.
description string
User specified descriptive string for this Restore.
etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.
labels {[key: string]: string}
A set of custom labels supplied by user.
name string
The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
resourcesExcludedCount number
Number of resources excluded during the restore execution.
resourcesFailedCount number
Number of resources that failed to be restored during the restore execution.
resourcesRestoredCount number
Number of resources restored during the restore execution.
restoreConfig RestoreConfigResponse
Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
state string
The current state of the Restore.
stateReason string
Human-readable description of why the Restore is in its current state.
uid string
Server generated global unique identifier of UUID format.
updateTime string
The timestamp when this Restore resource was last updated.
volumesRestoredCount number
Number of volumes restored during the restore execution.
backup str
Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
cluster str
The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.
complete_time str
Timestamp of when the restore operation completed.
create_time str
The timestamp when this Restore resource was created.
description str
User specified descriptive string for this Restore.
etag str
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.
labels Mapping[str, str]
A set of custom labels supplied by user.
name str
The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
resources_excluded_count int
Number of resources excluded during the restore execution.
resources_failed_count int
Number of resources that failed to be restored during the restore execution.
resources_restored_count int
Number of resources restored during the restore execution.
restore_config RestoreConfigResponse
Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
state str
The current state of the Restore.
state_reason str
Human-readable description of why the Restore is in its current state.
uid str
Server generated global unique identifier of UUID format.
update_time str
The timestamp when this Restore resource was last updated.
volumes_restored_count int
Number of volumes restored during the restore execution.
backup String
Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
cluster String
The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.
completeTime String
Timestamp of when the restore operation completed.
createTime String
The timestamp when this Restore resource was created.
description String
User specified descriptive string for this Restore.
etag String
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.
labels Map<String>
A set of custom labels supplied by user.
name String
The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
resourcesExcludedCount Number
Number of resources excluded during the restore execution.
resourcesFailedCount Number
Number of resources that failed to be restored during the restore execution.
resourcesRestoredCount Number
Number of resources restored during the restore execution.
restoreConfig Property Map
Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
state String
The current state of the Restore.
stateReason String
Human-readable description of why the Restore is in its current state.
uid String
Server generated global unique identifier of UUID format.
updateTime String
The timestamp when this Restore resource was last updated.
volumesRestoredCount Number
Number of volumes restored during the restore execution.

Supporting Types

ClusterResourceRestoreScopeResponse

AllGroupKinds This property is required. bool
Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
ExcludedGroupKinds This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.GroupKindResponse>
Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
NoGroupKinds This property is required. bool
Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
SelectedGroupKinds This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.GroupKindResponse>
Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
AllGroupKinds This property is required. bool
Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
ExcludedGroupKinds This property is required. []GroupKindResponse
Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
NoGroupKinds This property is required. bool
Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
SelectedGroupKinds This property is required. []GroupKindResponse
Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
allGroupKinds This property is required. Boolean
Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
excludedGroupKinds This property is required. List<GroupKindResponse>
Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
noGroupKinds This property is required. Boolean
Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
selectedGroupKinds This property is required. List<GroupKindResponse>
Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
allGroupKinds This property is required. boolean
Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
excludedGroupKinds This property is required. GroupKindResponse[]
Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
noGroupKinds This property is required. boolean
Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
selectedGroupKinds This property is required. GroupKindResponse[]
Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
all_group_kinds This property is required. bool
Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
excluded_group_kinds This property is required. Sequence[GroupKindResponse]
Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
no_group_kinds This property is required. bool
Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
selected_group_kinds This property is required. Sequence[GroupKindResponse]
Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
allGroupKinds This property is required. Boolean
Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
excludedGroupKinds This property is required. List<Property Map>
Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
noGroupKinds This property is required. Boolean
Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
selectedGroupKinds This property is required. List<Property Map>
Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

GroupKindResponse

ResourceGroup This property is required. string
Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
ResourceKind This property is required. string
Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
ResourceGroup This property is required. string
Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
ResourceKind This property is required. string
Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
resourceGroup This property is required. String
Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
resourceKind This property is required. String
Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
resourceGroup This property is required. string
Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
resourceKind This property is required. string
Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
resource_group This property is required. str
Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
resource_kind This property is required. str
Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
resourceGroup This property is required. String
Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
resourceKind This property is required. String
Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.

NamespacedNameResponse

Name This property is required. string
Optional. The name of the Kubernetes resource.
Namespace This property is required. string
Optional. The Namespace of the Kubernetes resource.
Name This property is required. string
Optional. The name of the Kubernetes resource.
Namespace This property is required. string
Optional. The Namespace of the Kubernetes resource.
name This property is required. String
Optional. The name of the Kubernetes resource.
namespace This property is required. String
Optional. The Namespace of the Kubernetes resource.
name This property is required. string
Optional. The name of the Kubernetes resource.
namespace This property is required. string
Optional. The Namespace of the Kubernetes resource.
name This property is required. str
Optional. The name of the Kubernetes resource.
namespace This property is required. str
Optional. The Namespace of the Kubernetes resource.
name This property is required. String
Optional. The name of the Kubernetes resource.
namespace This property is required. String
Optional. The Namespace of the Kubernetes resource.

NamespacedNamesResponse

NamespacedNames This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacedNameResponse>
Optional. A list of namespaced Kubernetes resources.
NamespacedNames This property is required. []NamespacedNameResponse
Optional. A list of namespaced Kubernetes resources.
namespacedNames This property is required. List<NamespacedNameResponse>
Optional. A list of namespaced Kubernetes resources.
namespacedNames This property is required. NamespacedNameResponse[]
Optional. A list of namespaced Kubernetes resources.
namespaced_names This property is required. Sequence[NamespacedNameResponse]
Optional. A list of namespaced Kubernetes resources.
namespacedNames This property is required. List<Property Map>
Optional. A list of namespaced Kubernetes resources.

NamespacesResponse

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

ResourceFilterResponse

GroupKinds This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.GroupKindResponse>
Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
JsonPath This property is required. string
Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
Namespaces This property is required. List<string>
Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).
GroupKinds This property is required. []GroupKindResponse
Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
JsonPath This property is required. string
Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
Namespaces This property is required. []string
Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).
groupKinds This property is required. List<GroupKindResponse>
Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
jsonPath This property is required. String
Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
namespaces This property is required. List<String>
Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).
groupKinds This property is required. GroupKindResponse[]
Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
jsonPath This property is required. string
Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
namespaces This property is required. string[]
Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).
group_kinds This property is required. Sequence[GroupKindResponse]
Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
json_path This property is required. str
Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
namespaces This property is required. Sequence[str]
Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).
groupKinds This property is required. List<Property Map>
Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
jsonPath This property is required. String
Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
namespaces This property is required. List<String>
Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).

RestoreConfigResponse

AllNamespaces This property is required. bool
Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
ClusterResourceConflictPolicy This property is required. string
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.
ClusterResourceRestoreScope This property is required. Pulumi.GoogleNative.Gkebackup.V1.Inputs.ClusterResourceRestoreScopeResponse
Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
ExcludedNamespaces This property is required. Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacesResponse
A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
NamespacedResourceRestoreMode This property is required. string
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.
NoNamespaces This property is required. bool
Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
SelectedApplications This property is required. Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacedNamesResponse
A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
SelectedNamespaces This property is required. Pulumi.GoogleNative.Gkebackup.V1.Inputs.NamespacesResponse
A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
SubstitutionRules This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.SubstitutionRuleResponse>
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
TransformationRules This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.TransformationRuleResponse>
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
VolumeDataRestorePolicy This property is required. string
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).
AllNamespaces This property is required. bool
Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
ClusterResourceConflictPolicy This property is required. string
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.
ClusterResourceRestoreScope This property is required. ClusterResourceRestoreScopeResponse
Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
ExcludedNamespaces This property is required. NamespacesResponse
A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
NamespacedResourceRestoreMode This property is required. string
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.
NoNamespaces This property is required. bool
Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
SelectedApplications This property is required. NamespacedNamesResponse
A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
SelectedNamespaces This property is required. NamespacesResponse
A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
SubstitutionRules This property is required. []SubstitutionRuleResponse
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
TransformationRules This property is required. []TransformationRuleResponse
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
VolumeDataRestorePolicy This property is required. string
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).
allNamespaces This property is required. Boolean
Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
clusterResourceConflictPolicy This property is required. String
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.
clusterResourceRestoreScope This property is required. ClusterResourceRestoreScopeResponse
Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
excludedNamespaces This property is required. NamespacesResponse
A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
namespacedResourceRestoreMode This property is required. String
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.
noNamespaces This property is required. Boolean
Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
selectedApplications This property is required. NamespacedNamesResponse
A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
selectedNamespaces This property is required. NamespacesResponse
A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
substitutionRules This property is required. List<SubstitutionRuleResponse>
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
transformationRules This property is required. List<TransformationRuleResponse>
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
volumeDataRestorePolicy This property is required. String
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).
allNamespaces This property is required. boolean
Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
clusterResourceConflictPolicy This property is required. string
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.
clusterResourceRestoreScope This property is required. ClusterResourceRestoreScopeResponse
Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
excludedNamespaces This property is required. NamespacesResponse
A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
namespacedResourceRestoreMode This property is required. string
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.
noNamespaces This property is required. boolean
Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
selectedApplications This property is required. NamespacedNamesResponse
A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
selectedNamespaces This property is required. NamespacesResponse
A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
substitutionRules This property is required. SubstitutionRuleResponse[]
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
transformationRules This property is required. TransformationRuleResponse[]
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
volumeDataRestorePolicy This property is required. string
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).
all_namespaces This property is required. bool
Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
cluster_resource_conflict_policy This property is required. str
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.
cluster_resource_restore_scope This property is required. ClusterResourceRestoreScopeResponse
Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
excluded_namespaces This property is required. NamespacesResponse
A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
namespaced_resource_restore_mode This property is required. str
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.
no_namespaces This property is required. bool
Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
selected_applications This property is required. NamespacedNamesResponse
A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
selected_namespaces This property is required. NamespacesResponse
A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
substitution_rules This property is required. Sequence[SubstitutionRuleResponse]
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
transformation_rules This property is required. Sequence[TransformationRuleResponse]
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
volume_data_restore_policy This property is required. str
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).
allNamespaces This property is required. Boolean
Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
clusterResourceConflictPolicy This property is required. String
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.
clusterResourceRestoreScope This property is required. Property Map
Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
excludedNamespaces This property is required. Property Map
A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
namespacedResourceRestoreMode This property is required. String
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.
noNamespaces This property is required. Boolean
Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
selectedApplications This property is required. Property Map
A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
selectedNamespaces This property is required. Property Map
A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
substitutionRules This property is required. List<Property Map>
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
transformationRules This property is required. List<Property Map>
Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
volumeDataRestorePolicy This property is required. String
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).

SubstitutionRuleResponse

NewValue This property is required. string
Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
OriginalValuePattern This property is required. string
Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
TargetGroupKinds This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.GroupKindResponse>
Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
TargetJsonPath This property is required. string
This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
TargetNamespaces This property is required. List<string>
Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
NewValue This property is required. string
Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
OriginalValuePattern This property is required. string
Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
TargetGroupKinds This property is required. []GroupKindResponse
Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
TargetJsonPath This property is required. string
This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
TargetNamespaces This property is required. []string
Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
newValue This property is required. String
Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
originalValuePattern This property is required. String
Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
targetGroupKinds This property is required. List<GroupKindResponse>
Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
targetJsonPath This property is required. String
This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
targetNamespaces This property is required. List<String>
Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
newValue This property is required. string
Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
originalValuePattern This property is required. string
Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
targetGroupKinds This property is required. GroupKindResponse[]
Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
targetJsonPath This property is required. string
This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
targetNamespaces This property is required. string[]
Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
new_value This property is required. str
Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
original_value_pattern This property is required. str
Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
target_group_kinds This property is required. Sequence[GroupKindResponse]
Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
target_json_path This property is required. str
This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
target_namespaces This property is required. Sequence[str]
Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
newValue This property is required. String
Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
originalValuePattern This property is required. String
Optional. (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
targetGroupKinds This property is required. List<Property Map>
Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
targetJsonPath This property is required. String
This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
targetNamespaces This property is required. List<String>
Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.

TransformationRuleActionResponse

FromPath This property is required. string
Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
Op This property is required. string
op specifies the operation to perform.
Path This property is required. string
Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
Value This property is required. string
Optional. A string that specifies the desired value in string format to use for transformation.
FromPath This property is required. string
Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
Op This property is required. string
op specifies the operation to perform.
Path This property is required. string
Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
Value This property is required. string
Optional. A string that specifies the desired value in string format to use for transformation.
fromPath This property is required. String
Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
op This property is required. String
op specifies the operation to perform.
path This property is required. String
Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
value This property is required. String
Optional. A string that specifies the desired value in string format to use for transformation.
fromPath This property is required. string
Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
op This property is required. string
op specifies the operation to perform.
path This property is required. string
Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
value This property is required. string
Optional. A string that specifies the desired value in string format to use for transformation.
from_path This property is required. str
Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
op This property is required. str
op specifies the operation to perform.
path This property is required. str
Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
value This property is required. str
Optional. A string that specifies the desired value in string format to use for transformation.
fromPath This property is required. String
Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
op This property is required. String
op specifies the operation to perform.
path This property is required. String
Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
value This property is required. String
Optional. A string that specifies the desired value in string format to use for transformation.

TransformationRuleResponse

Description This property is required. string
Optional. The description is a user specified string description of the transformation rule.
FieldActions This property is required. List<Pulumi.GoogleNative.Gkebackup.V1.Inputs.TransformationRuleActionResponse>
A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
ResourceFilter This property is required. Pulumi.GoogleNative.Gkebackup.V1.Inputs.ResourceFilterResponse
Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
Description This property is required. string
Optional. The description is a user specified string description of the transformation rule.
FieldActions This property is required. []TransformationRuleActionResponse
A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
ResourceFilter This property is required. ResourceFilterResponse
Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
description This property is required. String
Optional. The description is a user specified string description of the transformation rule.
fieldActions This property is required. List<TransformationRuleActionResponse>
A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
resourceFilter This property is required. ResourceFilterResponse
Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
description This property is required. string
Optional. The description is a user specified string description of the transformation rule.
fieldActions This property is required. TransformationRuleActionResponse[]
A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
resourceFilter This property is required. ResourceFilterResponse
Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
description This property is required. str
Optional. The description is a user specified string description of the transformation rule.
field_actions This property is required. Sequence[TransformationRuleActionResponse]
A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
resource_filter This property is required. ResourceFilterResponse
Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
description This property is required. String
Optional. The description is a user specified string description of the transformation rule.
fieldActions This property is required. List<Property Map>
A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
resourceFilter This property is required. Property Map
Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.

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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi