Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. file
  5. file/v1
  6. getBackup

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
pulumi/pulumi-google-native

google-native.file/v1.getBackup

Explore with Pulumi AI

google-native logo

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
pulumi/pulumi-google-native

    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/v1:getBackup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BackupId string
    Location string
    Project string
    BackupId string
    Location string
    Project string
    backupId String
    location String
    project String
    backupId string
    location string
    project string
    backupId String
    location String
    project String

    getBackup Result

    The following output properties are available:

    CapacityGb string
    Capacity of the source file share when the backup was created.
    CreateTime 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.
    DownloadBytes string
    Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.
    KmsKey string
    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_number}/locations/{location_id}/backups/{backup_id}.
    SatisfiesPzs bool
    Reserved for future use.
    SourceFileShare string
    Name of the file share in the source Filestore instance that the backup is created from.
    SourceInstance string
    The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
    SourceInstanceTier string
    The service tier of the source Filestore instance that this backup is created from.
    State string
    The backup state.
    StorageBytes string
    The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
    CapacityGb string
    Capacity of the source file share when the backup was created.
    CreateTime 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.
    DownloadBytes string
    Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.
    KmsKey string
    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_number}/locations/{location_id}/backups/{backup_id}.
    SatisfiesPzs bool
    Reserved for future use.
    SourceFileShare string
    Name of the file share in the source Filestore instance that the backup is created from.
    SourceInstance string
    The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
    SourceInstanceTier string
    The service tier of the source Filestore instance that this backup is created from.
    State string
    The backup state.
    StorageBytes string
    The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
    capacityGb String
    Capacity of the source file share when the backup was created.
    createTime 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.
    downloadBytes String
    Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.
    kmsKey String
    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_number}/locations/{location_id}/backups/{backup_id}.
    satisfiesPzs Boolean
    Reserved for future use.
    sourceFileShare String
    Name of the file share in the source Filestore instance that the backup is created from.
    sourceInstance String
    The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
    sourceInstanceTier String
    The service tier of the source Filestore instance that this backup is created from.
    state String
    The backup state.
    storageBytes String
    The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
    capacityGb string
    Capacity of the source file share when the backup was created.
    createTime 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.
    downloadBytes string
    Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.
    kmsKey string
    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_number}/locations/{location_id}/backups/{backup_id}.
    satisfiesPzs boolean
    Reserved for future use.
    sourceFileShare string
    Name of the file share in the source Filestore instance that the backup is created from.
    sourceInstance string
    The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
    sourceInstanceTier string
    The service tier of the source Filestore instance that this backup is created from.
    state string
    The backup state.
    storageBytes 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. This may be different than storage bytes, since sequential backups of the same disk will share storage.
    kms_key str
    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_number}/locations/{location_id}/backups/{backup_id}.
    satisfies_pzs bool
    Reserved for future use.
    source_file_share 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_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
    source_instance_tier str
    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.
    capacityGb String
    Capacity of the source file share when the backup was created.
    createTime 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.
    downloadBytes String
    Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.
    kmsKey String
    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_number}/locations/{location_id}/backups/{backup_id}.
    satisfiesPzs Boolean
    Reserved for future use.
    sourceFileShare String
    Name of the file share in the source Filestore instance that the backup is created from.
    sourceInstance String
    The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
    sourceInstanceTier String
    The service tier of the source Filestore instance that this backup is created from.
    state String
    The backup state.
    storageBytes 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-native logo

    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
    pulumi/pulumi-google-native