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

oci.FileStorage.Snapshot

Explore with Pulumi AI

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

    This resource provides the Snapshot resource in Oracle Cloud Infrastructure File Storage service.

    Creates a new snapshot of the specified file system. You can access the snapshot at .snapshot/<name>.

    Example Usage

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

const testSnapshot = new oci.filestorage.Snapshot("test_snapshot", {
    fileSystemId: testFileSystem.id,
    name: snapshotName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    expirationTime: snapshotExpirationTime,
    freeformTags: {
        Department: "Finance",
    },
    locks: [{
        type: snapshotLocksType,
        message: snapshotLocksMessage,
        relatedResourceId: testResource.id,
        timeCreated: snapshotLocksTimeCreated,
    }],
});

    import pulumi
import pulumi_oci as oci

test_snapshot = oci.file_storage.Snapshot("test_snapshot",
    file_system_id=test_file_system["id"],
    name=snapshot_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    expiration_time=snapshot_expiration_time,
    freeform_tags={
        "Department": "Finance",
    },
    locks=[{
        "type": snapshot_locks_type,
        "message": snapshot_locks_message,
        "related_resource_id": test_resource["id"],
        "time_created": snapshot_locks_time_created,
    }])

    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.NewSnapshot(ctx, "test_snapshot", &FileStorage.SnapshotArgs{
			FileSystemId: pulumi.Any(testFileSystem.Id),
			Name:         pulumi.Any(snapshotName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			ExpirationTime: pulumi.Any(snapshotExpirationTime),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			Locks: filestorage.SnapshotLockArray{
				&filestorage.SnapshotLockArgs{
					Type:              pulumi.Any(snapshotLocksType),
					Message:           pulumi.Any(snapshotLocksMessage),
					RelatedResourceId: pulumi.Any(testResource.Id),
					TimeCreated:       pulumi.Any(snapshotLocksTimeCreated),
				},
			},
		})
		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 = new Oci.FileStorage.Snapshot("test_snapshot", new()
    {
        FileSystemId = testFileSystem.Id,
        Name = snapshotName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        ExpirationTime = snapshotExpirationTime,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        Locks = new[]
        {
            new Oci.FileStorage.Inputs.SnapshotLockArgs
            {
                Type = snapshotLocksType,
                Message = snapshotLocksMessage,
                RelatedResourceId = testResource.Id,
                TimeCreated = snapshotLocksTimeCreated,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.Snapshot;
import com.pulumi.oci.FileStorage.SnapshotArgs;
import com.pulumi.oci.FileStorage.inputs.SnapshotLockArgs;
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) {
        var testSnapshot = new Snapshot("testSnapshot", SnapshotArgs.builder()
            .fileSystemId(testFileSystem.id())
            .name(snapshotName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .expirationTime(snapshotExpirationTime)
            .freeformTags(Map.of("Department", "Finance"))
            .locks(SnapshotLockArgs.builder()
                .type(snapshotLocksType)
                .message(snapshotLocksMessage)
                .relatedResourceId(testResource.id())
                .timeCreated(snapshotLocksTimeCreated)
                .build())
            .build());

    }
}

    resources:
  testSnapshot:
    type: oci:FileStorage:Snapshot
    name: test_snapshot
    properties:
      fileSystemId: ${testFileSystem.id}
      name: ${snapshotName}
      definedTags:
        Operations.CostCenter: '42'
      expirationTime: ${snapshotExpirationTime}
      freeformTags:
        Department: Finance
      locks:
        - type: ${snapshotLocksType}
          message: ${snapshotLocksMessage}
          relatedResourceId: ${testResource.id}
          timeCreated: ${snapshotLocksTimeCreated}

    Create Snapshot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);
    @overload
def Snapshot(resource_name: str,
             args: SnapshotArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Snapshot(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             file_system_id: Optional[str] = None,
             defined_tags: Optional[Mapping[str, str]] = None,
             expiration_time: Optional[str] = None,
             freeform_tags: Optional[Mapping[str, str]] = None,
             is_lock_override: Optional[bool] = None,
             locks: Optional[Sequence[_filestorage.SnapshotLockArgs]] = None,
             name: Optional[str] = None)
    func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)
    public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
    public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)

    type: oci:FileStorage:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var snapshotResource = new Oci.FileStorage.Snapshot("snapshotResource", new()
{
    FileSystemId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    ExpirationTime = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    Locks = new[]
    {
        new Oci.FileStorage.Inputs.SnapshotLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
    Name = "string",
});

    example, err := FileStorage.NewSnapshot(ctx, "snapshotResource", &FileStorage.SnapshotArgs{
	FileSystemId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ExpirationTime: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride: pulumi.Bool(false),
	Locks: filestorage.SnapshotLockArray{
		&filestorage.SnapshotLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
})

    var snapshotResource = new Snapshot("snapshotResource", SnapshotArgs.builder()
    .fileSystemId("string")
    .definedTags(Map.of("string", "string"))
    .expirationTime("string")
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .locks(SnapshotLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .name("string")
    .build());

    snapshot_resource = oci.file_storage.Snapshot("snapshotResource",
    file_system_id="string",
    defined_tags={
        "string": "string",
    },
    expiration_time="string",
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }],
    name="string")

    const snapshotResource = new oci.filestorage.Snapshot("snapshotResource", {
    fileSystemId: "string",
    definedTags: {
        string: "string",
    },
    expirationTime: "string",
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
    name: "string",
});

    type: oci:FileStorage:Snapshot
properties:
    definedTags:
        string: string
    expirationTime: string
    fileSystemId: string
    freeformTags:
        string: string
    isLockOverride: false
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    name: string

    Snapshot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Snapshot resource accepts the following input properties:

    FileSystemId string
    The OCID of the file system to take a snapshot of.
    DefinedTags Dictionary<string, string>
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    IsLockOverride bool
    Locks List<SnapshotLock>
    Locks associated with this resource.
    Name string

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    FileSystemId string
    The OCID of the file system to take a snapshot of.
    DefinedTags map[string]string
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    FreeformTags map[string]string
    (Updatable) 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"}
    IsLockOverride bool
    Locks []SnapshotLockArgs
    Locks associated with this resource.
    Name string

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    fileSystemId String
    The OCID of the file system to take a snapshot of.
    definedTags Map<String,String>
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    freeformTags Map<String,String>
    (Updatable) 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"}
    isLockOverride Boolean
    locks List<SnapshotLock>
    Locks associated with this resource.
    name String

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    fileSystemId string
    The OCID of the file system to take a snapshot of.
    definedTags {[key: string]: string}
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    isLockOverride boolean
    locks SnapshotLock[]
    Locks associated with this resource.
    name string

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    file_system_id str
    The OCID of the file system to take a snapshot of.
    defined_tags Mapping[str, str]
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    is_lock_override bool
    locks Sequence[filestorage.SnapshotLockArgs]
    Locks associated with this resource.
    name str

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    fileSystemId String
    The OCID of the file system to take a snapshot of.
    definedTags Map<String>
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    freeformTags Map<String>
    (Updatable) 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"}
    isLockOverride Boolean
    locks List<Property Map>
    Locks associated with this resource.
    name String

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:

    FilesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCloneSource bool
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    LifecycleDetails string
    Additional information about the current lifecycleState.
    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.
    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
    FilesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCloneSource bool
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    LifecycleDetails string
    Additional information about the current lifecycleState.
    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.
    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
    filesystemSnapshotPolicyId String
    The OCID of the file system snapshot policy that created this snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    isCloneSource Boolean
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    lifecycleDetails String
    Additional information about the current lifecycleState.
    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.
    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
    filesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    id string
    The provider-assigned unique ID for this managed resource.
    isCloneSource boolean
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    lifecycleDetails string
    Additional information about the current lifecycleState.
    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.
    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
    filesystem_snapshot_policy_id str
    The OCID of the file system snapshot policy that created this snapshot.
    id str
    The provider-assigned unique ID for this managed resource.
    is_clone_source bool
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    lifecycle_details str
    Additional information about the current lifecycleState.
    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_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
    filesystemSnapshotPolicyId String
    The OCID of the file system snapshot policy that created this snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    isCloneSource Boolean
    Specifies whether the snapshot has been cloned. See Cloning a File System.
    lifecycleDetails String
    Additional information about the current lifecycleState.
    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.
    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

    Look up Existing Snapshot Resource

    Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SnapshotState, opts?: CustomResourceOptions): Snapshot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        expiration_time: Optional[str] = None,
        file_system_id: Optional[str] = None,
        filesystem_snapshot_policy_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_clone_source: Optional[bool] = None,
        is_lock_override: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[_filestorage.SnapshotLockArgs]] = None,
        name: Optional[str] = None,
        provenance_id: Optional[str] = None,
        snapshot_time: Optional[str] = None,
        snapshot_type: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None) -> Snapshot
    func GetSnapshot(ctx *Context, name string, id IDInput, state *SnapshotState, opts ...ResourceOption) (*Snapshot, error)
    public static Snapshot Get(string name, Input<string> id, SnapshotState? state, CustomResourceOptions? opts = null)
    public static Snapshot get(String name, Output<String> id, SnapshotState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefinedTags Dictionary<string, string>
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    FileSystemId string
    The OCID of the file system to take a snapshot of.
    FilesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    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<SnapshotLock>
    Locks associated with this resource.
    Name string

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    FileSystemId string
    The OCID of the file system to take a snapshot of.
    FilesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    FreeformTags map[string]string
    (Updatable) 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"}
    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 []SnapshotLockArgs
    Locks associated with this resource.
    Name string

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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>
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    fileSystemId String
    The OCID of the file system to take a snapshot of.
    filesystemSnapshotPolicyId String
    The OCID of the file system snapshot policy that created this snapshot.
    freeformTags Map<String,String>
    (Updatable) 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"}
    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<SnapshotLock>
    Locks associated with this resource.
    name String

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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}
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    fileSystemId string
    The OCID of the file system to take a snapshot of.
    filesystemSnapshotPolicyId string
    The OCID of the file system snapshot policy that created this snapshot.
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    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 SnapshotLock[]
    Locks associated with this resource.
    name string

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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]
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    file_system_id str
    The OCID of the file system to take a snapshot of.
    filesystem_snapshot_policy_id str
    The OCID of the file system snapshot policy that created this snapshot.
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    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.SnapshotLockArgs]
    Locks associated with this resource.
    name str

    Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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_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>
    (Updatable) 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
    (Updatable) The time when this snapshot will be deleted.
    fileSystemId String
    The OCID of the file system to take a snapshot of.
    filesystemSnapshotPolicyId String
    The OCID of the file system snapshot policy that created this snapshot.
    freeformTags Map<String>
    (Updatable) 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"}
    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. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

    Avoid entering confidential information.

    Example: Sunday

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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

    SnapshotLock, SnapshotLockArgs

    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
    When the lock was created.
    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
    When the lock was created.
    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
    When the lock was created.
    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
    When the lock was created.
    type str
    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
    When the lock was created.
    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
    When the lock was created.

    Import

    Snapshots can be imported using the id, e.g.

    $ pulumi import oci:FileStorage/snapshot:Snapshot test_snapshot "id"

    To learn more about importing existing cloud resources, see Importing resources.

    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