published on Thursday, Apr 30, 2026 by Pulumi
published on Thursday, Apr 30, 2026 by Pulumi
This resource provides the Snapshot resource in Oracle Cloud Infrastructure File Storage service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/filestorage/latest/Snapshot
Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/
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",
},
lockDurationDetails: {
lockDuration: snapshotLockDurationDetailsLockDuration,
lockMode: snapshotLockDurationDetailsLockMode,
coolOffDuration: snapshotLockDurationDetailsCoolOffDuration,
},
locks: [{
type: snapshotLocksType,
message: snapshotLocksMessage,
relatedResourceId: testResource.id,
timeCreated: snapshotLocksTimeCreated,
}],
});
import pulumi
import pulumi_oci as oci
test_snapshot = oci.filestorage.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",
},
lock_duration_details={
"lock_duration": snapshot_lock_duration_details_lock_duration,
"lock_mode": snapshot_lock_duration_details_lock_mode,
"cool_off_duration": snapshot_lock_duration_details_cool_off_duration,
},
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/v4/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"),
},
LockDurationDetails: &filestorage.SnapshotLockDurationDetailsArgs{
LockDuration: pulumi.Any(snapshotLockDurationDetailsLockDuration),
LockMode: pulumi.Any(snapshotLockDurationDetailsLockMode),
CoolOffDuration: pulumi.Any(snapshotLockDurationDetailsCoolOffDuration),
},
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" },
},
LockDurationDetails = new Oci.FileStorage.Inputs.SnapshotLockDurationDetailsArgs
{
LockDuration = snapshotLockDurationDetailsLockDuration,
LockMode = snapshotLockDurationDetailsLockMode,
CoolOffDuration = snapshotLockDurationDetailsCoolOffDuration,
},
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.SnapshotLockDurationDetailsArgs;
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"))
.lockDurationDetails(SnapshotLockDurationDetailsArgs.builder()
.lockDuration(snapshotLockDurationDetailsLockDuration)
.lockMode(snapshotLockDurationDetailsLockMode)
.coolOffDuration(snapshotLockDurationDetailsCoolOffDuration)
.build())
.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
lockDurationDetails:
lockDuration: ${snapshotLockDurationDetailsLockDuration}
lockMode: ${snapshotLockDurationDetailsLockMode}
coolOffDuration: ${snapshotLockDurationDetailsCoolOffDuration}
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,
lock_duration_details: Optional[SnapshotLockDurationDetailsArgs] = None,
locks: Optional[Sequence[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.
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:
- File
System stringId - The OCID of the file system to take a snapshot of.
- 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"} - Expiration
Time string - (Updatable) The time when this snapshot will be deleted.
- 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"} - Is
Lock boolOverride - Lock
Duration SnapshotDetails Lock Duration Details - (Updatable) Details for setting a retention date or legal hold.
- Locks
List<Snapshot
Lock> - 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 stringId - The OCID of the file system to take a snapshot of.
- 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"} - Expiration
Time string - (Updatable) The time when this snapshot will be deleted.
- 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"} - Is
Lock boolOverride - Lock
Duration SnapshotDetails Lock Duration Details Args - (Updatable) Details for setting a retention date or legal hold.
- Locks
[]Snapshot
Lock Args - 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 StringId - The OCID of the file system to take a snapshot of.
- 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"} - expiration
Time String - (Updatable) The time when this snapshot will be deleted.
- 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"} - is
Lock BooleanOverride - lock
Duration SnapshotDetails Lock Duration Details - (Updatable) Details for setting a retention date or legal hold.
- locks
List<Snapshot
Lock> - 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 stringId - The OCID of the file system to take a snapshot of.
- {[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"} - expiration
Time string - (Updatable) The time when this snapshot will be deleted.
- {[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"} - is
Lock booleanOverride - lock
Duration SnapshotDetails Lock Duration Details - (Updatable) Details for setting a retention date or legal hold.
- locks
Snapshot
Lock[] - 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_ strid - The OCID of the file system to take a snapshot of.
- 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.
- 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_ booloverride - lock_
duration_ Snapshotdetails Lock Duration Details Args - (Updatable) Details for setting a retention date or legal hold.
- locks
Sequence[Snapshot
Lock Args] - 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
- file
System StringId - The OCID of the file system to take a snapshot of.
- 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"} - expiration
Time String - (Updatable) The time when this snapshot will be deleted.
- 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"} - is
Lock BooleanOverride - lock
Duration Property MapDetails - (Updatable) Details for setting a retention date or legal hold.
- 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:
- Filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Clone boolSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- Lifecycle
Details string - Additional information about the current
lifecycleState. - Provenance
Id string - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - Snapshot
Time string - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 string - Specifies the generation type of the snapshot.
- State string
- The current state of the snapshot.
- Dictionary<string, string>
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- Time
Created string - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - Time
Locked string - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- Filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Clone boolSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- Lifecycle
Details string - Additional information about the current
lifecycleState. - Provenance
Id string - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - Snapshot
Time string - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 string - Specifies the generation type of the snapshot.
- State string
- The current state of the snapshot.
- map[string]string
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- Time
Created string - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - Time
Locked string - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- filesystem
Snapshot StringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Clone BooleanSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- lifecycle
Details String - Additional information about the current
lifecycleState. - provenance
Id String - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - snapshot
Time String - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 String - Specifies the generation type of the snapshot.
- state String
- The current state of the snapshot.
- Map<String,String>
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time
Created String - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time
Locked String - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Clone booleanSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- lifecycle
Details string - Additional information about the current
lifecycleState. - provenance
Id string - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - snapshot
Time string - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 string - Specifies the generation type of the snapshot.
- state string
- The current state of the snapshot.
- {[key: string]: string}
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time
Created string - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time
Locked string - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- filesystem_
snapshot_ strpolicy_ id - 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_ boolsource - 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
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. 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
timeCreateddepending 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.
- Mapping[str, str]
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time_
created str - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time_
locked str - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- filesystem
Snapshot StringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Clone BooleanSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- lifecycle
Details String - Additional information about the current
lifecycleState. - provenance
Id String - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - snapshot
Time String - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 String - Specifies the generation type of the snapshot.
- state String
- The current state of the snapshot.
- Map<String>
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time
Created String - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time
Locked String - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
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,
lock_duration_details: Optional[SnapshotLockDurationDetailsArgs] = None,
locks: Optional[Sequence[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,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_locked: Optional[str] = None) -> Snapshotfunc 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)resources: _: type: oci:FileStorage:Snapshot get: id: ${id}- 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.
- 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"} - Expiration
Time string - (Updatable) The time when this snapshot will be deleted.
- File
System stringId - The OCID of the file system to take a snapshot of.
- Filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- 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"} - Is
Clone boolSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- Is
Lock boolOverride - Lifecycle
Details string - Additional information about the current
lifecycleState. - Lock
Duration SnapshotDetails Lock Duration Details - (Updatable) Details for setting a retention date or legal hold.
- Locks
List<Snapshot
Lock> - 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
- Provenance
Id string - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - Snapshot
Time string - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 string - Specifies the generation type of the snapshot.
- State string
- The current state of the snapshot.
- Dictionary<string, string>
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- Time
Created string - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - Time
Locked string - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- 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"} - Expiration
Time string - (Updatable) The time when this snapshot will be deleted.
- File
System stringId - The OCID of the file system to take a snapshot of.
- Filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- 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"} - Is
Clone boolSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- Is
Lock boolOverride - Lifecycle
Details string - Additional information about the current
lifecycleState. - Lock
Duration SnapshotDetails Lock Duration Details Args - (Updatable) Details for setting a retention date or legal hold.
- Locks
[]Snapshot
Lock Args - 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
- Provenance
Id string - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - Snapshot
Time string - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 string - Specifies the generation type of the snapshot.
- State string
- The current state of the snapshot.
- map[string]string
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- Time
Created string - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - Time
Locked string - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- 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"} - expiration
Time String - (Updatable) The time when this snapshot will be deleted.
- file
System StringId - The OCID of the file system to take a snapshot of.
- filesystem
Snapshot StringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- 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"} - is
Clone BooleanSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- is
Lock BooleanOverride - lifecycle
Details String - Additional information about the current
lifecycleState. - lock
Duration SnapshotDetails Lock Duration Details - (Updatable) Details for setting a retention date or legal hold.
- locks
List<Snapshot
Lock> - 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
- provenance
Id String - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - snapshot
Time String - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 String - Specifies the generation type of the snapshot.
- state String
- The current state of the snapshot.
- Map<String,String>
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time
Created String - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time
Locked String - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- {[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"} - expiration
Time string - (Updatable) The time when this snapshot will be deleted.
- file
System stringId - The OCID of the file system to take a snapshot of.
- filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- {[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"} - is
Clone booleanSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- is
Lock booleanOverride - lifecycle
Details string - Additional information about the current
lifecycleState. - lock
Duration SnapshotDetails Lock Duration Details - (Updatable) Details for setting a retention date or legal hold.
- locks
Snapshot
Lock[] - 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
- provenance
Id string - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - snapshot
Time string - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 string - Specifies the generation type of the snapshot.
- state string
- The current state of the snapshot.
- {[key: string]: string}
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time
Created string - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time
Locked string - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- 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_ strid - The OCID of the file system to take a snapshot of.
- filesystem_
snapshot_ strpolicy_ id - The OCID of the file system snapshot policy that created this snapshot.
- 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_ boolsource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- is_
lock_ booloverride - lifecycle_
details str - Additional information about the current
lifecycleState. - lock_
duration_ Snapshotdetails Lock Duration Details Args - (Updatable) Details for setting a retention date or legal hold.
- locks
Sequence[Snapshot
Lock Args] - 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
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. 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
timeCreateddepending 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.
- Mapping[str, str]
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time_
created str - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time_
locked str - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
- 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"} - expiration
Time String - (Updatable) The time when this snapshot will be deleted.
- file
System StringId - The OCID of the file system to take a snapshot of.
- filesystem
Snapshot StringPolicy Id - The OCID of the file system snapshot policy that created this snapshot.
- 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"} - is
Clone BooleanSource - Specifies whether the snapshot has been cloned. See Cloning a File System.
- is
Lock BooleanOverride - lifecycle
Details String - Additional information about the current
lifecycleState. - lock
Duration Property MapDetails - (Updatable) Details for setting a retention date or legal hold.
- 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
- provenance
Id String - An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the
provenanceIdis the same as the snapshotidvalue. If this snapshot was cloned, then theprovenanceIdvalue is the parent'sprovenanceId. See Cloning a File System. - snapshot
Time String - The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from
timeCreateddepending 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 String - Specifies the generation type of the snapshot.
- state String
- The current state of the snapshot.
- Map<String>
- System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
- time
Created String - The date and time the snapshot was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z - time
Locked String - The date and time as per RFC 3339 when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service.
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.
- string
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created 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.
- string
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created 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.
- String
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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.
- string
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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.
- 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.
- String
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - When the lock was created.
SnapshotLockDurationDetails, SnapshotLockDurationDetailsArgs
- Lock
Duration int - (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
- Lock
Mode string - (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.
- Cool
Off intDuration - (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.
- Lock
Duration int - (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
- Lock
Mode string - (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.
- Cool
Off intDuration - (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.
- lock
Duration Integer - (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
- lock
Mode String - (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.
- cool
Off IntegerDuration - (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.
- lock
Duration number - (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
- lock
Mode string - (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.
- cool
Off numberDuration - (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.
- lock_
duration int - (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
- lock_
mode str - (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.
- cool_
off_ intduration - (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.
- lock
Duration Number - (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
- lock
Mode String - (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.
- cool
Off NumberDuration - (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.
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
ociTerraform Provider.
published on Thursday, Apr 30, 2026 by Pulumi
