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>
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]
func LookupRestore(ctx *Context, args *LookupRestoreArgs, opts ...InvokeOption) (*LookupRestoreResult, error)
func LookupRestoreOutput(ctx *Context, args *LookupRestoreOutputArgs, opts ...InvokeOption) LookupRestoreResultOutput
> 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)
}
public static CompletableFuture<GetRestoreResult> getRestore(GetRestoreArgs args, InvokeOptions options)
public static Output<GetRestoreResult> getRestore(GetRestoreArgs args, InvokeOptions options)
fn::invoke:
function: google-native:gkebackup/v1:getRestore
arguments:
# arguments dictionary
The following arguments are supported:
- Location
This property is required. string - Restore
Id This property is required. string - Restore
Plan Id This property is required. string - Project string
- Location
This property is required. string - Restore
Id This property is required. string - Restore
Plan Id This property is required. string - Project string
- location
This property is required. String - restore
Id This property is required. String - restore
Plan Id This property is required. String - project String
- location
This property is required. string - restore
Id This property is required. string - restore
Plan Id 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 - restore
Id This property is required. String - restore
Plan Id 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. - Complete
Time string - Timestamp of when the restore operation completed.
- Create
Time 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 theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
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/*
- Resources
Excluded intCount - Number of resources excluded during the restore execution.
- Resources
Failed intCount - Number of resources that failed to be restored during the restore execution.
- Resources
Restored intCount - Number of resources restored during the restore execution.
- Restore
Config Pulumi.Google Native. Gkebackup. V1. Outputs. Restore Config Response - Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
- State string
- The current state of the Restore.
- State
Reason string - Human-readable description of why the Restore is in its current state.
- Uid string
- Server generated global unique identifier of UUID format.
- Update
Time string - The timestamp when this Restore resource was last updated.
- Volumes
Restored intCount - 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. - Complete
Time string - Timestamp of when the restore operation completed.
- Create
Time 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 theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
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/*
- Resources
Excluded intCount - Number of resources excluded during the restore execution.
- Resources
Failed intCount - Number of resources that failed to be restored during the restore execution.
- Resources
Restored intCount - Number of resources restored during the restore execution.
- Restore
Config RestoreConfig Response - Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
- State string
- The current state of the Restore.
- State
Reason string - Human-readable description of why the Restore is in its current state.
- Uid string
- Server generated global unique identifier of UUID format.
- Update
Time string - The timestamp when this Restore resource was last updated.
- Volumes
Restored intCount - 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. - complete
Time String - Timestamp of when the restore operation completed.
- create
Time 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 theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
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/*
- resources
Excluded IntegerCount - Number of resources excluded during the restore execution.
- resources
Failed IntegerCount - Number of resources that failed to be restored during the restore execution.
- resources
Restored IntegerCount - Number of resources restored during the restore execution.
- restore
Config RestoreConfig Response - Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
- state String
- The current state of the Restore.
- state
Reason String - Human-readable description of why the Restore is in its current state.
- uid String
- Server generated global unique identifier of UUID format.
- update
Time String - The timestamp when this Restore resource was last updated.
- volumes
Restored IntegerCount - 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. - complete
Time string - Timestamp of when the restore operation completed.
- create
Time 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 theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
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/*
- resources
Excluded numberCount - Number of resources excluded during the restore execution.
- resources
Failed numberCount - Number of resources that failed to be restored during the restore execution.
- resources
Restored numberCount - Number of resources restored during the restore execution.
- restore
Config RestoreConfig Response - Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
- state string
- The current state of the Restore.
- state
Reason string - Human-readable description of why the Restore is in its current state.
- uid string
- Server generated global unique identifier of UUID format.
- update
Time string - The timestamp when this Restore resource was last updated.
- volumes
Restored numberCount - 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 theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
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_ intcount - Number of resources excluded during the restore execution.
- resources_
failed_ intcount - Number of resources that failed to be restored during the restore execution.
- resources_
restored_ intcount - Number of resources restored during the restore execution.
- restore_
config RestoreConfig Response - 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_ intcount - 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. - complete
Time String - Timestamp of when the restore operation completed.
- create
Time 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 theetag
in the read-modify-write cycle to perform restore updates in order to avoid race conditions: Anetag
is returned in the response toGetRestore
, and systems are expected to put that etag in the request toUpdateRestore
orDeleteRestore
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/*
- resources
Excluded NumberCount - Number of resources excluded during the restore execution.
- resources
Failed NumberCount - Number of resources that failed to be restored during the restore execution.
- resources
Restored NumberCount - Number of resources restored during the restore execution.
- restore
Config Property Map - Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
- state String
- The current state of the Restore.
- state
Reason String - Human-readable description of why the Restore is in its current state.
- uid String
- Server generated global unique identifier of UUID format.
- update
Time String - The timestamp when this Restore resource was last updated.
- volumes
Restored NumberCount - Number of volumes restored during the restore execution.
Supporting Types
ClusterResourceRestoreScopeResponse
- 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. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Group Kind Response> - 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. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Group Kind Response> - 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. []GroupKind Response - 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. []GroupKind Response - 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. Boolean - 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. List<GroupKind Response> - 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. 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.
- selected
Group Kinds This property is required. List<GroupKind Response> - 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. boolean - 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. GroupKind Response[] - 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. 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.
- selected
Group Kinds This property is required. GroupKind Response[] - 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[GroupKind Response] - 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[GroupKind Response] - 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. Boolean - 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. 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.
- no
Group Kinds 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.
- selected
Group Kinds 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
- Resource
Group 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
- Resource
Kind 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. 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
- Resource
Kind 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. 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
- resource
Kind 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. 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
- resource
Kind 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.
- resource
Group 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
- resource
Kind 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
NamespacedNamesResponse
- Namespaced
Names This property is required. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Name Response> - Optional. A list of namespaced Kubernetes resources.
- Namespaced
Names This property is required. []NamespacedName Response - Optional. A list of namespaced Kubernetes resources.
- namespaced
Names This property is required. List<NamespacedName Response> - Optional. A list of namespaced Kubernetes resources.
- namespaced
Names This property is required. NamespacedName Response[] - Optional. A list of namespaced Kubernetes resources.
- namespaced_
names This property is required. Sequence[NamespacedName Response] - Optional. A list of namespaced Kubernetes resources.
- namespaced
Names 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
- Group
Kinds This property is required. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Group Kind Response> - 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. 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).
- Group
Kinds This property is required. []GroupKind Response - 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. 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. List<GroupKind Response> - 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. 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).
- group
Kinds This property is required. GroupKind Response[] - 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. 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[GroupKind Response] - 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).
- group
Kinds 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).
- json
Path 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
- 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. 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.
- Cluster
Resource Restore Scope This property is required. Pulumi.Google Native. Gkebackup. V1. Inputs. Cluster Resource Restore Scope Response - 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. Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaces Response - 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. 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.
- 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. Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaced Names Response - 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. Pulumi.Google Native. Gkebackup. V1. Inputs. Namespaces Response - 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. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Substitution Rule Response> - 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. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Transformation Rule Response> - 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. 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. 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.
- Cluster
Resource Restore Scope This property is required. ClusterResource Restore Scope Response - 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. 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.
- 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. NamespacedNames Response - 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. []SubstitutionRule Response - 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. []TransformationRule Response - 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. 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. Boolean - 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. 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.
- cluster
Resource Restore Scope This property is required. ClusterResource Restore Scope Response - 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. 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.
- no
Namespaces This property is required. Boolean - Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
- selected
Applications This property is required. NamespacedNames Response - 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. List<SubstitutionRule Response> - 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. List<TransformationRule Response> - 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. 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. boolean - 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. 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.
- cluster
Resource Restore Scope This property is required. ClusterResource Restore Scope Response - 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. 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.
- no
Namespaces This property is required. boolean - Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
- selected
Applications This property is required. NamespacedNames Response - 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. SubstitutionRule Response[] - 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. TransformationRule Response[] - 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. 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. ClusterResource Restore Scope Response - 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. NamespacedNames Response - 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[SubstitutionRule Response] - 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[TransformationRule Response] - 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).
- all
Namespaces This property is required. Boolean - 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. 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.
- cluster
Resource Restore Scope 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.
- excluded
Namespaces This property is required. Property Map - 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. 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.
- no
Namespaces This property is required. Boolean - Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
- selected
Applications 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.
- selected
Namespaces 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.
- substitution
Rules 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.
- transformation
Rules 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.
- volume
Data Restore Policy 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
- New
Value 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 ("").
- Original
Value Pattern 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.
- Target
Group Kinds This property is required. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Group Kind Response> - 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. 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).
- Target
Namespaces 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.
- New
Value 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 ("").
- Original
Value Pattern 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.
- Target
Group Kinds This property is required. []GroupKind Response - 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. 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).
- Target
Namespaces 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. 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 ("").
- original
Value Pattern 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.
- target
Group Kinds This property is required. List<GroupKind Response> - 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. 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).
- target
Namespaces 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.
- new
Value 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 ("").
- original
Value Pattern 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.
- target
Group Kinds This property is required. GroupKind Response[] - 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. 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).
- target
Namespaces 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[GroupKind Response] - 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.
- new
Value 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 ("").
- original
Value Pattern 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.
- target
Group Kinds 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).
- target
Json Path 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).
- target
Namespaces 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
- From
Path 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. 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. 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. 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.
- from
Path 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.
- Field
Actions This property is required. List<Pulumi.Google Native. Gkebackup. V1. Inputs. Transformation Rule Action Response> - 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. Pulumi.Google Native. Gkebackup. V1. Inputs. Resource Filter Response - 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.
- Field
Actions This property is required. []TransformationRule Action Response - 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. ResourceFilter Response - 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.
- field
Actions This property is required. List<TransformationRule Action Response> - 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. ResourceFilter Response - 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.
- field
Actions This property is required. TransformationRule Action Response[] - 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. ResourceFilter Response - 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[TransformationRule Action Response] - 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. ResourceFilter Response - 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.
- field
Actions 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.
- resource
Filter 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