Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. FileSystem
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.FileSystem

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

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

Creates a new file system in the specified compartment and availability domain. Instances can mount file systems in another availability domain, but doing so might increase latency when compared to mounting instances in the same availability domain.

After you create a file system, you can associate it with a mount target. Instances can then mount the file system by connecting to the mount target’s IP address. You can associate a file system with more than one mount target at a time.

For information about access control and compartments, see Overview of the IAM Service.

For information about Network Security Groups access control, see Network Security Groups.

For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

All Oracle Cloud Infrastructure resources, including file systems, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type or by viewing the resource in the Console.

Example Usage

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

const testFileSystem = new oci.filestorage.FileSystem("test_file_system", {
    availabilityDomain: fileSystemAvailabilityDomain,
    compartmentId: compartmentId,
    areQuotaRulesEnabled: fileSystemAreQuotaRulesEnabled,
    cloneAttachStatus: fileSystemCloneAttachStatus,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: fileSystemDisplayName,
    filesystemSnapshotPolicyId: testFilesystemSnapshotPolicy.id,
    freeformTags: {
        Department: "Finance",
    },
    kmsKeyId: testKey.id,
    locks: [{
        type: fileSystemLocksType,
        message: fileSystemLocksMessage,
        relatedResourceId: testResource.id,
        timeCreated: fileSystemLocksTimeCreated,
    }],
    sourceSnapshotId: testSnapshot.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_file_system = oci.file_storage.FileSystem("test_file_system",
    availability_domain=file_system_availability_domain,
    compartment_id=compartment_id,
    are_quota_rules_enabled=file_system_are_quota_rules_enabled,
    clone_attach_status=file_system_clone_attach_status,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=file_system_display_name,
    filesystem_snapshot_policy_id=test_filesystem_snapshot_policy["id"],
    freeform_tags={
        "Department": "Finance",
    },
    kms_key_id=test_key["id"],
    locks=[{
        "type": file_system_locks_type,
        "message": file_system_locks_message,
        "related_resource_id": test_resource["id"],
        "time_created": file_system_locks_time_created,
    }],
    source_snapshot_id=test_snapshot["id"])
Copy
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.NewFileSystem(ctx, "test_file_system", &filestorage.FileSystemArgs{
			AvailabilityDomain:   pulumi.Any(fileSystemAvailabilityDomain),
			CompartmentId:        pulumi.Any(compartmentId),
			AreQuotaRulesEnabled: pulumi.Any(fileSystemAreQuotaRulesEnabled),
			CloneAttachStatus:    pulumi.Any(fileSystemCloneAttachStatus),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName:                pulumi.Any(fileSystemDisplayName),
			FilesystemSnapshotPolicyId: pulumi.Any(testFilesystemSnapshotPolicy.Id),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			KmsKeyId: pulumi.Any(testKey.Id),
			Locks: filestorage.FileSystemLockArray{
				&filestorage.FileSystemLockArgs{
					Type:              pulumi.Any(fileSystemLocksType),
					Message:           pulumi.Any(fileSystemLocksMessage),
					RelatedResourceId: pulumi.Any(testResource.Id),
					TimeCreated:       pulumi.Any(fileSystemLocksTimeCreated),
				},
			},
			SourceSnapshotId: pulumi.Any(testSnapshot.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testFileSystem = new Oci.FileStorage.FileSystem("test_file_system", new()
    {
        AvailabilityDomain = fileSystemAvailabilityDomain,
        CompartmentId = compartmentId,
        AreQuotaRulesEnabled = fileSystemAreQuotaRulesEnabled,
        CloneAttachStatus = fileSystemCloneAttachStatus,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = fileSystemDisplayName,
        FilesystemSnapshotPolicyId = testFilesystemSnapshotPolicy.Id,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        KmsKeyId = testKey.Id,
        Locks = new[]
        {
            new Oci.FileStorage.Inputs.FileSystemLockArgs
            {
                Type = fileSystemLocksType,
                Message = fileSystemLocksMessage,
                RelatedResourceId = testResource.Id,
                TimeCreated = fileSystemLocksTimeCreated,
            },
        },
        SourceSnapshotId = testSnapshot.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileSystem;
import com.pulumi.oci.FileStorage.FileSystemArgs;
import com.pulumi.oci.FileStorage.inputs.FileSystemLockArgs;
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 testFileSystem = new FileSystem("testFileSystem", FileSystemArgs.builder()
            .availabilityDomain(fileSystemAvailabilityDomain)
            .compartmentId(compartmentId)
            .areQuotaRulesEnabled(fileSystemAreQuotaRulesEnabled)
            .cloneAttachStatus(fileSystemCloneAttachStatus)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(fileSystemDisplayName)
            .filesystemSnapshotPolicyId(testFilesystemSnapshotPolicy.id())
            .freeformTags(Map.of("Department", "Finance"))
            .kmsKeyId(testKey.id())
            .locks(FileSystemLockArgs.builder()
                .type(fileSystemLocksType)
                .message(fileSystemLocksMessage)
                .relatedResourceId(testResource.id())
                .timeCreated(fileSystemLocksTimeCreated)
                .build())
            .sourceSnapshotId(testSnapshot.id())
            .build());

    }
}
Copy
resources:
  testFileSystem:
    type: oci:FileStorage:FileSystem
    name: test_file_system
    properties:
      availabilityDomain: ${fileSystemAvailabilityDomain}
      compartmentId: ${compartmentId}
      areQuotaRulesEnabled: ${fileSystemAreQuotaRulesEnabled}
      cloneAttachStatus: ${fileSystemCloneAttachStatus}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${fileSystemDisplayName}
      filesystemSnapshotPolicyId: ${testFilesystemSnapshotPolicy.id}
      freeformTags:
        Department: Finance
      kmsKeyId: ${testKey.id}
      locks:
        - type: ${fileSystemLocksType}
          message: ${fileSystemLocksMessage}
          relatedResourceId: ${testResource.id}
          timeCreated: ${fileSystemLocksTimeCreated}
      sourceSnapshotId: ${testSnapshot.id}
Copy

Create FileSystem Resource

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

Constructor syntax

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

@overload
def FileSystem(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               compartment_id: Optional[str] = None,
               availability_domain: Optional[str] = None,
               display_name: Optional[str] = None,
               clone_attach_status: Optional[str] = None,
               defined_tags: Optional[Mapping[str, str]] = None,
               detach_clone_trigger: Optional[int] = None,
               are_quota_rules_enabled: Optional[bool] = None,
               filesystem_snapshot_policy_id: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, str]] = None,
               is_lock_override: Optional[bool] = None,
               kms_key_id: Optional[str] = None,
               locks: Optional[Sequence[_filestorage.FileSystemLockArgs]] = None,
               source_snapshot_id: Optional[str] = None)
func NewFileSystem(ctx *Context, name string, args FileSystemArgs, opts ...ResourceOption) (*FileSystem, error)
public FileSystem(string name, FileSystemArgs args, CustomResourceOptions? opts = null)
public FileSystem(String name, FileSystemArgs args)
public FileSystem(String name, FileSystemArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FileSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FileSystemArgs
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 fileSystemResource = new Oci.FileStorage.FileSystem("fileSystemResource", new()
{
    CompartmentId = "string",
    AvailabilityDomain = "string",
    DisplayName = "string",
    CloneAttachStatus = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DetachCloneTrigger = 0,
    AreQuotaRulesEnabled = false,
    FilesystemSnapshotPolicyId = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    KmsKeyId = "string",
    Locks = new[]
    {
        new Oci.FileStorage.Inputs.FileSystemLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
    SourceSnapshotId = "string",
});
Copy
example, err := FileStorage.NewFileSystem(ctx, "fileSystemResource", &FileStorage.FileSystemArgs{
	CompartmentId:      pulumi.String("string"),
	AvailabilityDomain: pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	CloneAttachStatus:  pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DetachCloneTrigger:         pulumi.Int(0),
	AreQuotaRulesEnabled:       pulumi.Bool(false),
	FilesystemSnapshotPolicyId: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride: pulumi.Bool(false),
	KmsKeyId:       pulumi.String("string"),
	Locks: filestorage.FileSystemLockArray{
		&filestorage.FileSystemLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
	SourceSnapshotId: pulumi.String("string"),
})
Copy
var fileSystemResource = new FileSystem("fileSystemResource", FileSystemArgs.builder()
    .compartmentId("string")
    .availabilityDomain("string")
    .displayName("string")
    .cloneAttachStatus("string")
    .definedTags(Map.of("string", "string"))
    .detachCloneTrigger(0)
    .areQuotaRulesEnabled(false)
    .filesystemSnapshotPolicyId("string")
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .kmsKeyId("string")
    .locks(FileSystemLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .sourceSnapshotId("string")
    .build());
Copy
file_system_resource = oci.file_storage.FileSystem("fileSystemResource",
    compartment_id="string",
    availability_domain="string",
    display_name="string",
    clone_attach_status="string",
    defined_tags={
        "string": "string",
    },
    detach_clone_trigger=0,
    are_quota_rules_enabled=False,
    filesystem_snapshot_policy_id="string",
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    kms_key_id="string",
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }],
    source_snapshot_id="string")
Copy
const fileSystemResource = new oci.filestorage.FileSystem("fileSystemResource", {
    compartmentId: "string",
    availabilityDomain: "string",
    displayName: "string",
    cloneAttachStatus: "string",
    definedTags: {
        string: "string",
    },
    detachCloneTrigger: 0,
    areQuotaRulesEnabled: false,
    filesystemSnapshotPolicyId: "string",
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    kmsKeyId: "string",
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
    sourceSnapshotId: "string",
});
Copy
type: oci:FileStorage:FileSystem
properties:
    areQuotaRulesEnabled: false
    availabilityDomain: string
    cloneAttachStatus: string
    compartmentId: string
    definedTags:
        string: string
    detachCloneTrigger: 0
    displayName: string
    filesystemSnapshotPolicyId: string
    freeformTags:
        string: string
    isLockOverride: false
    kmsKeyId: string
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    sourceSnapshotId: string
Copy

FileSystem 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 FileSystem resource accepts the following input properties:

AvailabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
CompartmentId This property is required. string
(Updatable) The OCID of the compartment to create the file system in.
AreQuotaRulesEnabled bool
(Updatable) Specifies the enforcement of quota rules on the file system.
CloneAttachStatus string
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
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"}
DetachCloneTrigger int

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
FilesystemSnapshotPolicyId string

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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
KmsKeyId string
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
Locks Changes to this property will trigger replacement. List<FileSystemLock>
Locks associated with this resource.
SourceSnapshotId Changes to this property will trigger replacement. string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
AvailabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
CompartmentId This property is required. string
(Updatable) The OCID of the compartment to create the file system in.
AreQuotaRulesEnabled bool
(Updatable) Specifies the enforcement of quota rules on the file system.
CloneAttachStatus string
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
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"}
DetachCloneTrigger int

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
FilesystemSnapshotPolicyId string

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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
KmsKeyId string
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
Locks Changes to this property will trigger replacement. []FileSystemLockArgs
Locks associated with this resource.
SourceSnapshotId Changes to this property will trigger replacement. string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
availabilityDomain
This property is required.
Changes to this property will trigger replacement.
String
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
compartmentId This property is required. String
(Updatable) The OCID of the compartment to create the file system in.
areQuotaRulesEnabled Boolean
(Updatable) Specifies the enforcement of quota rules on the file system.
cloneAttachStatus String
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
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"}
detachCloneTrigger Integer

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId String

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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
kmsKeyId String
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
locks Changes to this property will trigger replacement. List<FileSystemLock>
Locks associated with this resource.
sourceSnapshotId Changes to this property will trigger replacement. String
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
availabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
compartmentId This property is required. string
(Updatable) The OCID of the compartment to create the file system in.
areQuotaRulesEnabled boolean
(Updatable) Specifies the enforcement of quota rules on the file system.
cloneAttachStatus string
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
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"}
detachCloneTrigger number

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

displayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId string

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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
kmsKeyId string
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
locks Changes to this property will trigger replacement. FileSystemLock[]
Locks associated with this resource.
sourceSnapshotId Changes to this property will trigger replacement. string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
availability_domain
This property is required.
Changes to this property will trigger replacement.
str
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
compartment_id This property is required. str
(Updatable) The OCID of the compartment to create the file system in.
are_quota_rules_enabled bool
(Updatable) Specifies the enforcement of quota rules on the file system.
clone_attach_status str
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
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"}
detach_clone_trigger int

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

display_name str
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystem_snapshot_policy_id str

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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
kms_key_id str
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
locks Changes to this property will trigger replacement. Sequence[filestorage.FileSystemLockArgs]
Locks associated with this resource.
source_snapshot_id Changes to this property will trigger replacement. str
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
availabilityDomain
This property is required.
Changes to this property will trigger replacement.
String
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
compartmentId This property is required. String
(Updatable) The OCID of the compartment to create the file system in.
areQuotaRulesEnabled Boolean
(Updatable) Specifies the enforcement of quota rules on the file system.
cloneAttachStatus String
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
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"}
detachCloneTrigger Number

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId String

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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
kmsKeyId String
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
sourceSnapshotId Changes to this property will trigger replacement. String
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

Outputs

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

CloneCount int
Specifies the total number of children of a file system.
Id string
The provider-assigned unique ID for this managed resource.
IsCloneParent bool
Specifies whether the file system has been cloned. See Cloning a File System.
IsHydrated bool
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
IsTargetable bool
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
LifecycleDetails string
Additional information about the current 'lifecycleState'.
MeteredBytes string
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
QuotaEnforcementState string
Displays the state of enforcement of quota rules on the file system.
ReplicationSourceCount int
Specifies the total number of replications for which this file system is a source.
ReplicationTargetId string
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
SourceDetails List<FileSystemSourceDetail>
Source information for the file system.
State string
The current state of the file system.
SystemTags Dictionary<string, string>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
CloneCount int
Specifies the total number of children of a file system.
Id string
The provider-assigned unique ID for this managed resource.
IsCloneParent bool
Specifies whether the file system has been cloned. See Cloning a File System.
IsHydrated bool
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
IsTargetable bool
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
LifecycleDetails string
Additional information about the current 'lifecycleState'.
MeteredBytes string
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
QuotaEnforcementState string
Displays the state of enforcement of quota rules on the file system.
ReplicationSourceCount int
Specifies the total number of replications for which this file system is a source.
ReplicationTargetId string
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
SourceDetails []FileSystemSourceDetail
Source information for the file system.
State string
The current state of the file system.
SystemTags map[string]string
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
cloneCount Integer
Specifies the total number of children of a file system.
id String
The provider-assigned unique ID for this managed resource.
isCloneParent Boolean
Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated Boolean
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isTargetable Boolean
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
lifecycleDetails String
Additional information about the current 'lifecycleState'.
meteredBytes String
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState String
Displays the state of enforcement of quota rules on the file system.
replicationSourceCount Integer
Specifies the total number of replications for which this file system is a source.
replicationTargetId String
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails List<FileSystemSourceDetail>
Source information for the file system.
state String
The current state of the file system.
systemTags Map<String,String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
cloneCount number
Specifies the total number of children of a file system.
id string
The provider-assigned unique ID for this managed resource.
isCloneParent boolean
Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated boolean
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isTargetable boolean
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
lifecycleDetails string
Additional information about the current 'lifecycleState'.
meteredBytes string
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState string
Displays the state of enforcement of quota rules on the file system.
replicationSourceCount number
Specifies the total number of replications for which this file system is a source.
replicationTargetId string
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails FileSystemSourceDetail[]
Source information for the file system.
state string
The current state of the file system.
systemTags {[key: string]: string}
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
clone_count int
Specifies the total number of children of a file system.
id str
The provider-assigned unique ID for this managed resource.
is_clone_parent bool
Specifies whether the file system has been cloned. See Cloning a File System.
is_hydrated bool
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
is_targetable bool
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
lifecycle_details str
Additional information about the current 'lifecycleState'.
metered_bytes str
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quota_enforcement_state str
Displays the state of enforcement of quota rules on the file system.
replication_source_count int
Specifies the total number of replications for which this file system is a source.
replication_target_id str
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
source_details Sequence[filestorage.FileSystemSourceDetail]
Source information for the file system.
state str
The current state of the file system.
system_tags 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 file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
cloneCount Number
Specifies the total number of children of a file system.
id String
The provider-assigned unique ID for this managed resource.
isCloneParent Boolean
Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated Boolean
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isTargetable Boolean
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
lifecycleDetails String
Additional information about the current 'lifecycleState'.
meteredBytes String
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState String
Displays the state of enforcement of quota rules on the file system.
replicationSourceCount Number
Specifies the total number of replications for which this file system is a source.
replicationTargetId String
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails List<Property Map>
Source information for the file system.
state String
The current state of the file system.
systemTags Map<String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Look up Existing FileSystem Resource

Get an existing FileSystem 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?: FileSystemState, opts?: CustomResourceOptions): FileSystem
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        are_quota_rules_enabled: Optional[bool] = None,
        availability_domain: Optional[str] = None,
        clone_attach_status: Optional[str] = None,
        clone_count: Optional[int] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        detach_clone_trigger: Optional[int] = None,
        display_name: Optional[str] = None,
        filesystem_snapshot_policy_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_clone_parent: Optional[bool] = None,
        is_hydrated: Optional[bool] = None,
        is_lock_override: Optional[bool] = None,
        is_targetable: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[_filestorage.FileSystemLockArgs]] = None,
        metered_bytes: Optional[str] = None,
        quota_enforcement_state: Optional[str] = None,
        replication_source_count: Optional[int] = None,
        replication_target_id: Optional[str] = None,
        source_details: Optional[Sequence[_filestorage.FileSystemSourceDetailArgs]] = None,
        source_snapshot_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None) -> FileSystem
func GetFileSystem(ctx *Context, name string, id IDInput, state *FileSystemState, opts ...ResourceOption) (*FileSystem, error)
public static FileSystem Get(string name, Input<string> id, FileSystemState? state, CustomResourceOptions? opts = null)
public static FileSystem get(String name, Output<String> id, FileSystemState state, CustomResourceOptions options)
resources:  _:    type: oci:FileStorage:FileSystem    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AreQuotaRulesEnabled bool
(Updatable) Specifies the enforcement of quota rules on the file system.
AvailabilityDomain Changes to this property will trigger replacement. string
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
CloneAttachStatus string
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
CloneCount int
Specifies the total number of children of a file system.
CompartmentId string
(Updatable) The OCID of the compartment to create the file system in.
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"}
DetachCloneTrigger int

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
FilesystemSnapshotPolicyId string

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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"}
IsCloneParent bool
Specifies whether the file system has been cloned. See Cloning a File System.
IsHydrated bool
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
IsLockOverride bool
IsTargetable bool
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
KmsKeyId string
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
LifecycleDetails string
Additional information about the current 'lifecycleState'.
Locks Changes to this property will trigger replacement. List<FileSystemLock>
Locks associated with this resource.
MeteredBytes string
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
QuotaEnforcementState string
Displays the state of enforcement of quota rules on the file system.
ReplicationSourceCount int
Specifies the total number of replications for which this file system is a source.
ReplicationTargetId string
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
SourceDetails List<FileSystemSourceDetail>
Source information for the file system.
SourceSnapshotId Changes to this property will trigger replacement. string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
State string
The current state of the file system.
SystemTags Dictionary<string, string>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
AreQuotaRulesEnabled bool
(Updatable) Specifies the enforcement of quota rules on the file system.
AvailabilityDomain Changes to this property will trigger replacement. string
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
CloneAttachStatus string
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
CloneCount int
Specifies the total number of children of a file system.
CompartmentId string
(Updatable) The OCID of the compartment to create the file system in.
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"}
DetachCloneTrigger int

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
FilesystemSnapshotPolicyId string

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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"}
IsCloneParent bool
Specifies whether the file system has been cloned. See Cloning a File System.
IsHydrated bool
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
IsLockOverride bool
IsTargetable bool
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
KmsKeyId string
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
LifecycleDetails string
Additional information about the current 'lifecycleState'.
Locks Changes to this property will trigger replacement. []FileSystemLockArgs
Locks associated with this resource.
MeteredBytes string
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
QuotaEnforcementState string
Displays the state of enforcement of quota rules on the file system.
ReplicationSourceCount int
Specifies the total number of replications for which this file system is a source.
ReplicationTargetId string
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
SourceDetails []FileSystemSourceDetailArgs
Source information for the file system.
SourceSnapshotId Changes to this property will trigger replacement. string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
State string
The current state of the file system.
SystemTags map[string]string
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
areQuotaRulesEnabled Boolean
(Updatable) Specifies the enforcement of quota rules on the file system.
availabilityDomain Changes to this property will trigger replacement. String
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
cloneAttachStatus String
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
cloneCount Integer
Specifies the total number of children of a file system.
compartmentId String
(Updatable) The OCID of the compartment to create the file system in.
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"}
detachCloneTrigger Integer

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId String

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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"}
isCloneParent Boolean
Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated Boolean
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isLockOverride Boolean
isTargetable Boolean
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kmsKeyId String
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
lifecycleDetails String
Additional information about the current 'lifecycleState'.
locks Changes to this property will trigger replacement. List<FileSystemLock>
Locks associated with this resource.
meteredBytes String
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState String
Displays the state of enforcement of quota rules on the file system.
replicationSourceCount Integer
Specifies the total number of replications for which this file system is a source.
replicationTargetId String
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails List<FileSystemSourceDetail>
Source information for the file system.
sourceSnapshotId Changes to this property will trigger replacement. String
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state String
The current state of the file system.
systemTags Map<String,String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
areQuotaRulesEnabled boolean
(Updatable) Specifies the enforcement of quota rules on the file system.
availabilityDomain Changes to this property will trigger replacement. string
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
cloneAttachStatus string
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
cloneCount number
Specifies the total number of children of a file system.
compartmentId string
(Updatable) The OCID of the compartment to create the file system in.
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"}
detachCloneTrigger number

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

displayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId string

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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"}
isCloneParent boolean
Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated boolean
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isLockOverride boolean
isTargetable boolean
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kmsKeyId string
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
lifecycleDetails string
Additional information about the current 'lifecycleState'.
locks Changes to this property will trigger replacement. FileSystemLock[]
Locks associated with this resource.
meteredBytes string
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState string
Displays the state of enforcement of quota rules on the file system.
replicationSourceCount number
Specifies the total number of replications for which this file system is a source.
replicationTargetId string
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails FileSystemSourceDetail[]
Source information for the file system.
sourceSnapshotId Changes to this property will trigger replacement. string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state string
The current state of the file system.
systemTags {[key: string]: string}
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
are_quota_rules_enabled bool
(Updatable) Specifies the enforcement of quota rules on the file system.
availability_domain Changes to this property will trigger replacement. str
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
clone_attach_status str
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
clone_count int
Specifies the total number of children of a file system.
compartment_id str
(Updatable) The OCID of the compartment to create the file system in.
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"}
detach_clone_trigger int

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

display_name str
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystem_snapshot_policy_id str

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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_parent bool
Specifies whether the file system has been cloned. See Cloning a File System.
is_hydrated bool
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
is_lock_override bool
is_targetable bool
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kms_key_id str
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
lifecycle_details str
Additional information about the current 'lifecycleState'.
locks Changes to this property will trigger replacement. Sequence[filestorage.FileSystemLockArgs]
Locks associated with this resource.
metered_bytes str
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quota_enforcement_state str
Displays the state of enforcement of quota rules on the file system.
replication_source_count int
Specifies the total number of replications for which this file system is a source.
replication_target_id str
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
source_details Sequence[filestorage.FileSystemSourceDetailArgs]
Source information for the file system.
source_snapshot_id Changes to this property will trigger replacement. str
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state str
The current state of the file system.
system_tags 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 file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
areQuotaRulesEnabled Boolean
(Updatable) Specifies the enforcement of quota rules on the file system.
availabilityDomain Changes to this property will trigger replacement. String
The availability domain to create the file system in. Example: Uocm:PHX-AD-1
cloneAttachStatus String
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
cloneCount Number
Specifies the total number of children of a file system.
compartmentId String
(Updatable) The OCID of the compartment to create the file system in.
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"}
detachCloneTrigger Number

(Updatable) An optional property when incremented triggers Detach Clone. Could be set to any integer value.

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

displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId String

(Updatable) The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

May be unset as a blank value.

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"}
isCloneParent Boolean
Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated Boolean
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isLockOverride Boolean
isTargetable Boolean
Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kmsKeyId String
(Updatable) The OCID of KMS key used to encrypt the encryption keys associated with this file system. May be unset as a blank or deleted from the configuration to remove the KMS key.
lifecycleDetails String
Additional information about the current 'lifecycleState'.
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
meteredBytes String
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState String
Displays the state of enforcement of quota rules on the file system.
replicationSourceCount Number
Specifies the total number of replications for which this file system is a source.
replicationTargetId String
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails List<Property Map>
Source information for the file system.
sourceSnapshotId Changes to this property will trigger replacement. String
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state String
The current state of the file system.
systemTags Map<String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Supporting Types

FileSystemLock
, FileSystemLockArgs

Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated Changes to this property will trigger replacement. string
When the lock was created.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated Changes to this property will trigger replacement. string
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. String
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
message Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. string
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
str
Type of the lock.
message Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created Changes to this property will trigger replacement. str
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. String
When the lock was created.

FileSystemSourceDetail
, FileSystemSourceDetailArgs

ParentFileSystemId string
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
ParentFileSystemId string
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
parentFileSystemId String
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
parentFileSystemId string
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
parent_file_system_id str
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
source_snapshot_id str
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
parentFileSystemId String
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

Import

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

$ pulumi import oci:FileStorage/fileSystem:FileSystem test_file_system "id"
Copy

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.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci