Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. getSnapshot
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.getSnapshot

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Snapshot resource in Oracle Cloud Infrastructure File Storage service.

    Gets the specified snapshot’s information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSnapshot = oci.FileStorage.getSnapshot({
    snapshotId: testSnapshotOciFileStorageSnapshot.id,
});

    import pulumi
import pulumi_oci as oci

test_snapshot = oci.FileStorage.get_snapshot(snapshot_id=test_snapshot_oci_file_storage_snapshot["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/FileStorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := FileStorage.GetSnapshot(ctx, &filestorage.GetSnapshotArgs{
			SnapshotId: testSnapshotOciFileStorageSnapshot.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSnapshot = Oci.FileStorage.GetSnapshot.Invoke(new()
    {
        SnapshotId = testSnapshotOciFileStorageSnapshot.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileStorageFunctions;
import com.pulumi.oci.FileStorage.inputs.GetSnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testSnapshot = FileStorageFunctions.getSnapshot(GetSnapshotArgs.builder()
            .snapshotId(testSnapshotOciFileStorageSnapshot.id())
            .build());

    }
}

    variables:
  testSnapshot:
    fn::invoke:
      Function: oci:FileStorage:getSnapshot
      Arguments:
        snapshotId: ${testSnapshotOciFileStorageSnapshot.id}

    Using getSnapshot

    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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>
    def get_snapshot(snapshot_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(snapshot_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]
    func GetSnapshot(ctx *Context, args *GetSnapshotArgs, opts ...InvokeOption) (*GetSnapshotResult, error)
func GetSnapshotOutput(ctx *Context, args *GetSnapshotOutputArgs, opts ...InvokeOption) GetSnapshotResultOutput

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

    public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:FileStorage/getSnapshot:getSnapshot
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SnapshotId string
    The OCID of the snapshot.
    SnapshotId string
    The OCID of the snapshot.
    snapshotId String
    The OCID of the snapshot.
    snapshotId string
    The OCID of the snapshot.
    snapshot_id str
    The OCID of the snapshot.
    snapshotId String
    The OCID of the snapshot.

    getSnapshot Result

    The following output properties are available:

    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    ExpirationTime string
    The time when this snapshot will be deleted.
    FileSystemId string
    The OCID of the file system from which the snapshot was created.
    FilesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the snapshot.
    IsCloneSource bool
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    IsLockOverride bool
    LifecycleDetails string
    Additional information about the current lifecycleState.
    Locks List<GetSnapshotLock>
    Locks associated with this resource.
    Name string
    Name of the snapshot. This value is immutable.
    ProvenanceId string
    An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.
    SnapshotId string
    SnapshotTime string
    The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

    • If the snapshot is created in the original file system directory.
    • If the snapshot is cloned from a file system.
    • If the snapshot is replicated from a file system.
    SnapshotType string
    Specifies the generation type of the snapshot.
    State string
    The current state of the snapshot.
    TimeCreated string
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    ExpirationTime string
    The time when this snapshot will be deleted.
    FileSystemId string
    The OCID of the file system from which the snapshot was created.
    FilesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the snapshot.
    IsCloneSource bool
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    IsLockOverride bool
    LifecycleDetails string
    Additional information about the current lifecycleState.
    Locks []GetSnapshotLock
    Locks associated with this resource.
    Name string
    Name of the snapshot. This value is immutable.
    ProvenanceId string
    An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.
    SnapshotId string
    SnapshotTime string
    The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

    • If the snapshot is created in the original file system directory.
    • If the snapshot is cloned from a file system.
    • If the snapshot is replicated from a file system.
    SnapshotType string
    Specifies the generation type of the snapshot.
    State string
    The current state of the snapshot.
    TimeCreated string
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    expirationTime String
    The time when this snapshot will be deleted.
    fileSystemId String
    The OCID of the file system from which the snapshot was created.
    filesystemSnapshotPolicyId String
    The OCID of the file system snapshot policy that created this snapshot.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the snapshot.
    isCloneSource Boolean
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    isLockOverride Boolean
    lifecycleDetails String
    Additional information about the current lifecycleState.
    locks List<GetSnapshotLock>
    Locks associated with this resource.
    name String
    Name of the snapshot. This value is immutable.
    provenanceId String
    An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.
    snapshotId String
    snapshotTime String
    The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

    • If the snapshot is created in the original file system directory.
    • If the snapshot is cloned from a file system.
    • If the snapshot is replicated from a file system.
    snapshotType String
    Specifies the generation type of the snapshot.
    state String
    The current state of the snapshot.
    timeCreated String
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    expirationTime string
    The time when this snapshot will be deleted.
    fileSystemId string
    The OCID of the file system from which the snapshot was created.
    filesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the snapshot.
    isCloneSource boolean
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    isLockOverride boolean
    lifecycleDetails string
    Additional information about the current lifecycleState.
    locks GetSnapshotLock[]
    Locks associated with this resource.
    name string
    Name of the snapshot. This value is immutable.
    provenanceId string
    An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.
    snapshotId string
    snapshotTime string
    The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

    • If the snapshot is created in the original file system directory.
    • If the snapshot is cloned from a file system.
    • If the snapshot is replicated from a file system.
    snapshotType string
    Specifies the generation type of the snapshot.
    state string
    The current state of the snapshot.
    timeCreated string
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    expiration_time str
    The time when this snapshot will be deleted.
    file_system_id str
    The OCID of the file system from which the snapshot was created.
    filesystem_snapshot_policy_id str
    The OCID of the file system snapshot policy that created this snapshot.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the snapshot.
    is_clone_source bool
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    is_lock_override bool
    lifecycle_details str
    Additional information about the current lifecycleState.
    locks Sequence[filestorage.GetSnapshotLock]
    Locks associated with this resource.
    name str
    Name of the snapshot. This value is immutable.
    provenance_id str
    An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.
    snapshot_id str
    snapshot_time str
    The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

    • If the snapshot is created in the original file system directory.
    • If the snapshot is cloned from a file system.
    • If the snapshot is replicated from a file system.
    snapshot_type str
    Specifies the generation type of the snapshot.
    state str
    The current state of the snapshot.
    time_created str
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    expirationTime String
    The time when this snapshot will be deleted.
    fileSystemId String
    The OCID of the file system from which the snapshot was created.
    filesystemSnapshotPolicyId String
    The OCID of the file system snapshot policy that created this snapshot.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the snapshot.
    isCloneSource Boolean
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    isLockOverride Boolean
    lifecycleDetails String
    Additional information about the current lifecycleState.
    locks List<Property Map>
    Locks associated with this resource.
    name String
    Name of the snapshot. This value is immutable.
    provenanceId String
    An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System.
    snapshotId String
    snapshotTime String
    The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from timeCreated depending on the following factors:

    • If the snapshot is created in the original file system directory.
    • If the snapshot is cloned from a file system.
    • If the snapshot is replicated from a file system.
    snapshotType String
    Specifies the generation type of the snapshot.
    state String
    The current state of the snapshot.
    timeCreated String
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    GetSnapshotLock

    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    Type string
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    type String
    Type of the lock.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId string
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated string
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    type string
    Type of the lock.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    type str
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    type String
    Type of the lock.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci