1. Docs
  2. Reference
  3. API
  4. Open Stack
  5. sharedfilesystem
  6. GetSnapshot

GetSnapshot

Use this data source to get the ID of an available Shared File System snapshot.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var snapshot1 = Output.Create(OpenStack.SharedFileSystem.GetSnapshot.InvokeAsync(new OpenStack.SharedFileSystem.GetSnapshotArgs
        {
            Name = "snapshot_1",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

snapshot1 = openstack.sharedfilesystem.get_snapshot(name="snapshot_1")
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const snapshot1 = pulumi.output(openstack.sharedfilesystem.getSnapshot({
    name: "snapshot_1",
}, { async: true }));

Using GetSnapshot

function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function  get_snapshot(description=None, name=None, region=None, share_id=None, status=None, opts=None)
func GetSnapshot(ctx *Context, args *GetSnapshotArgs, opts ...InvokeOption) (*GetSnapshotResult, error)
public static class GetSnapshot {
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Description string

The human-readable description of the snapshot.

Name string

The name of the snapshot.

Region string

The region in which to obtain the V2 Shared File System client.

ShareId string

The UUID of the source share that was used to create the snapshot.

Status string

A snapshot status filter. A valid value is available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error or error_deleting.

Description string

The human-readable description of the snapshot.

Name string

The name of the snapshot.

Region string

The region in which to obtain the V2 Shared File System client.

ShareId string

The UUID of the source share that was used to create the snapshot.

Status string

A snapshot status filter. A valid value is available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error or error_deleting.

description string

The human-readable description of the snapshot.

name string

The name of the snapshot.

region string

The region in which to obtain the V2 Shared File System client.

shareId string

The UUID of the source share that was used to create the snapshot.

status string

A snapshot status filter. A valid value is available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error or error_deleting.

description str

The human-readable description of the snapshot.

name str

The name of the snapshot.

region str

The region in which to obtain the V2 Shared File System client.

share_id str

The UUID of the source share that was used to create the snapshot.

status str

A snapshot status filter. A valid value is available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error or error_deleting.

GetSnapshot Result

The following output properties are available:

Description string

See Argument Reference above.

Id string

The provider-assigned unique ID for this managed resource.

Name string

See Argument Reference above.

ProjectId string

See Argument Reference above.

Region string
ShareId string

The UUID of the source share that was used to create the snapshot.

ShareProto string

The file system protocol of a share snapshot.

ShareSize int

The share snapshot size, in GBs.

Size int

The snapshot size, in GBs.

Status string

See Argument Reference above.

Description string

See Argument Reference above.

Id string

The provider-assigned unique ID for this managed resource.

Name string

See Argument Reference above.

ProjectId string

See Argument Reference above.

Region string
ShareId string

The UUID of the source share that was used to create the snapshot.

ShareProto string

The file system protocol of a share snapshot.

ShareSize int

The share snapshot size, in GBs.

Size int

The snapshot size, in GBs.

Status string

See Argument Reference above.

description string

See Argument Reference above.

id string

The provider-assigned unique ID for this managed resource.

name string

See Argument Reference above.

projectId string

See Argument Reference above.

region string
shareId string

The UUID of the source share that was used to create the snapshot.

shareProto string

The file system protocol of a share snapshot.

shareSize number

The share snapshot size, in GBs.

size number

The snapshot size, in GBs.

status string

See Argument Reference above.

description str

See Argument Reference above.

id str

The provider-assigned unique ID for this managed resource.

name str

See Argument Reference above.

project_id str

See Argument Reference above.

region str
share_id str

The UUID of the source share that was used to create the snapshot.

share_proto str

The file system protocol of a share snapshot.

share_size float

The share snapshot size, in GBs.

size float

The snapshot size, in GBs.

status str

See Argument Reference above.

Package Details

Repository
https://github.com/pulumi/pulumi-openstack
License
Apache-2.0
Notes
This Pulumi package is based on the openstack Terraform Provider.