Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.file/v1beta1.getBackup
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets the details of a specific backup.
Using getBackup
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 getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOptions): Output<GetBackupResult>
def get_backup(backup_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(backup_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackupResult]
func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput
> Note: This function is named LookupBackup
in the Go SDK.
public static class GetBackup
{
public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:file/v1beta1:getBackup
arguments:
# arguments dictionary
The following arguments are supported:
getBackup Result
The following output properties are available:
- Capacity
Gb string Capacity of the source file share when the backup was created.
- Create
Time string The time when the backup was created.
- Description string
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- Download
Bytes string Amount of bytes that will be downloaded if the backup is restored
- Kms
Key stringName Immutable. KMS key name used for data encryption.
- Labels Dictionary<string, string>
Resource labels to represent user provided metadata.
- Name string
The resource name of the backup, in the format
projects/{project_id}/locations/{location_id}/backups/{backup_id}
.- Satisfies
Pzs bool Reserved for future use.
- string
Name of the file share in the source Filestore instance that the backup is created from.
- Source
Instance string The resource name of the source Filestore instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}
, used to create this backup.- Source
Instance stringTier The service tier of the source Filestore instance that this backup is created from.
- State string
The backup state.
- Storage
Bytes string The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- Capacity
Gb string Capacity of the source file share when the backup was created.
- Create
Time string The time when the backup was created.
- Description string
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- Download
Bytes string Amount of bytes that will be downloaded if the backup is restored
- Kms
Key stringName Immutable. KMS key name used for data encryption.
- Labels map[string]string
Resource labels to represent user provided metadata.
- Name string
The resource name of the backup, in the format
projects/{project_id}/locations/{location_id}/backups/{backup_id}
.- Satisfies
Pzs bool Reserved for future use.
- string
Name of the file share in the source Filestore instance that the backup is created from.
- Source
Instance string The resource name of the source Filestore instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}
, used to create this backup.- Source
Instance stringTier The service tier of the source Filestore instance that this backup is created from.
- State string
The backup state.
- Storage
Bytes string The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- capacity
Gb String Capacity of the source file share when the backup was created.
- create
Time String The time when the backup was created.
- description String
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- download
Bytes String Amount of bytes that will be downloaded if the backup is restored
- kms
Key StringName Immutable. KMS key name used for data encryption.
- labels Map<String,String>
Resource labels to represent user provided metadata.
- name String
The resource name of the backup, in the format
projects/{project_id}/locations/{location_id}/backups/{backup_id}
.- satisfies
Pzs Boolean Reserved for future use.
- String
Name of the file share in the source Filestore instance that the backup is created from.
- source
Instance String The resource name of the source Filestore instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}
, used to create this backup.- source
Instance StringTier The service tier of the source Filestore instance that this backup is created from.
- state String
The backup state.
- storage
Bytes String The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- capacity
Gb string Capacity of the source file share when the backup was created.
- create
Time string The time when the backup was created.
- description string
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- download
Bytes string Amount of bytes that will be downloaded if the backup is restored
- kms
Key stringName Immutable. KMS key name used for data encryption.
- labels {[key: string]: string}
Resource labels to represent user provided metadata.
- name string
The resource name of the backup, in the format
projects/{project_id}/locations/{location_id}/backups/{backup_id}
.- satisfies
Pzs boolean Reserved for future use.
- string
Name of the file share in the source Filestore instance that the backup is created from.
- source
Instance string The resource name of the source Filestore instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}
, used to create this backup.- source
Instance stringTier The service tier of the source Filestore instance that this backup is created from.
- state string
The backup state.
- storage
Bytes string The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- capacity_
gb str Capacity of the source file share when the backup was created.
- create_
time str The time when the backup was created.
- description str
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- download_
bytes str Amount of bytes that will be downloaded if the backup is restored
- kms_
key_ strname Immutable. KMS key name used for data encryption.
- labels Mapping[str, str]
Resource labels to represent user provided metadata.
- name str
The resource name of the backup, in the format
projects/{project_id}/locations/{location_id}/backups/{backup_id}
.- satisfies_
pzs bool Reserved for future use.
- str
Name of the file share in the source Filestore instance that the backup is created from.
- source_
instance str The resource name of the source Filestore instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}
, used to create this backup.- source_
instance_ strtier The service tier of the source Filestore instance that this backup is created from.
- state str
The backup state.
- storage_
bytes str The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- capacity
Gb String Capacity of the source file share when the backup was created.
- create
Time String The time when the backup was created.
- description String
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- download
Bytes String Amount of bytes that will be downloaded if the backup is restored
- kms
Key StringName Immutable. KMS key name used for data encryption.
- labels Map<String>
Resource labels to represent user provided metadata.
- name String
The resource name of the backup, in the format
projects/{project_id}/locations/{location_id}/backups/{backup_id}
.- satisfies
Pzs Boolean Reserved for future use.
- String
Name of the file share in the source Filestore instance that the backup is created from.
- source
Instance String The resource name of the source Filestore instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}
, used to create this backup.- source
Instance StringTier The service tier of the source Filestore instance that this backup is created from.
- state String
The backup state.
- storage
Bytes String The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
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.