Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. FileSystem
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.FileSystem

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 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("testFileSystem", {
    availabilityDomain: _var.file_system_availability_domain,
    compartmentId: _var.compartment_id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.file_system_display_name,
    filesystemSnapshotPolicyId: oci_file_storage_filesystem_snapshot_policy.test_filesystem_snapshot_policy.id,
    freeformTags: {
        Department: "Finance",
    },
    kmsKeyId: oci_kms_key.test_key.id,
    sourceSnapshotId: oci_file_storage_snapshot.test_snapshot.id,
});

    import pulumi
import pulumi_oci as oci

test_file_system = oci.file_storage.FileSystem("testFileSystem",
    availability_domain=var["file_system_availability_domain"],
    compartment_id=var["compartment_id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["file_system_display_name"],
    filesystem_snapshot_policy_id=oci_file_storage_filesystem_snapshot_policy["test_filesystem_snapshot_policy"]["id"],
    freeform_tags={
        "Department": "Finance",
    },
    kms_key_id=oci_kms_key["test_key"]["id"],
    source_snapshot_id=oci_file_storage_snapshot["test_snapshot"]["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := FileStorage.NewFileSystem(ctx, "testFileSystem", &FileStorage.FileSystemArgs{
			AvailabilityDomain: pulumi.Any(_var.File_system_availability_domain),
			CompartmentId:      pulumi.Any(_var.Compartment_id),
			DefinedTags: pulumi.Map{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName:                pulumi.Any(_var.File_system_display_name),
			FilesystemSnapshotPolicyId: pulumi.Any(oci_file_storage_filesystem_snapshot_policy.Test_filesystem_snapshot_policy.Id),
			FreeformTags: pulumi.Map{
				"Department": pulumi.Any("Finance"),
			},
			KmsKeyId:         pulumi.Any(oci_kms_key.Test_key.Id),
			SourceSnapshotId: pulumi.Any(oci_file_storage_snapshot.Test_snapshot.Id),
		})
		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 testFileSystem = new Oci.FileStorage.FileSystem("testFileSystem", new()
    {
        AvailabilityDomain = @var.File_system_availability_domain,
        CompartmentId = @var.Compartment_id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.File_system_display_name,
        FilesystemSnapshotPolicyId = oci_file_storage_filesystem_snapshot_policy.Test_filesystem_snapshot_policy.Id,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        KmsKeyId = oci_kms_key.Test_key.Id,
        SourceSnapshotId = oci_file_storage_snapshot.Test_snapshot.Id,
    });

});

    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 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(var_.file_system_availability_domain())
            .compartmentId(var_.compartment_id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.file_system_display_name())
            .filesystemSnapshotPolicyId(oci_file_storage_filesystem_snapshot_policy.test_filesystem_snapshot_policy().id())
            .freeformTags(Map.of("Department", "Finance"))
            .kmsKeyId(oci_kms_key.test_key().id())
            .sourceSnapshotId(oci_file_storage_snapshot.test_snapshot().id())
            .build());

    }
}

    resources:
  testFileSystem:
    type: oci:FileStorage:FileSystem
    properties:
      #Required
      availabilityDomain: ${var.file_system_availability_domain}
      compartmentId: ${var.compartment_id}
      #Optional
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${var.file_system_display_name}
      filesystemSnapshotPolicyId: ${oci_file_storage_filesystem_snapshot_policy.test_filesystem_snapshot_policy.id}
      freeformTags:
        Department: Finance
      kmsKeyId: ${oci_kms_key.test_key.id}
      sourceSnapshotId: ${oci_file_storage_snapshot.test_snapshot.id}

    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,
               availability_domain: Optional[str] = None,
               compartment_id: Optional[str] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               display_name: Optional[str] = None,
               filesystem_snapshot_policy_id: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None,
               kms_key_id: Optional[str] = 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 string
    The unique name of the resource.
    args FileSystemArgs
    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 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 string
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var fileSystemResource = new Oci.FileStorage.FileSystem("fileSystemResource", new()
{
    AvailabilityDomain = "string",
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "any" },
    },
    DisplayName = "string",
    FilesystemSnapshotPolicyId = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
    KmsKeyId = "string",
    SourceSnapshotId = "string",
});

    example, err := FileStorage.NewFileSystem(ctx, "fileSystemResource", &FileStorage.FileSystemArgs{
	AvailabilityDomain: pulumi.String("string"),
	CompartmentId:      pulumi.String("string"),
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	DisplayName:                pulumi.String("string"),
	FilesystemSnapshotPolicyId: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	KmsKeyId:         pulumi.String("string"),
	SourceSnapshotId: pulumi.String("string"),
})

    var fileSystemResource = new FileSystem("fileSystemResource", FileSystemArgs.builder()        
    .availabilityDomain("string")
    .compartmentId("string")
    .definedTags(Map.of("string", "any"))
    .displayName("string")
    .filesystemSnapshotPolicyId("string")
    .freeformTags(Map.of("string", "any"))
    .kmsKeyId("string")
    .sourceSnapshotId("string")
    .build());

    file_system_resource = oci.file_storage.FileSystem("fileSystemResource",
    availability_domain="string",
    compartment_id="string",
    defined_tags={
        "string": "any",
    },
    display_name="string",
    filesystem_snapshot_policy_id="string",
    freeform_tags={
        "string": "any",
    },
    kms_key_id="string",
    source_snapshot_id="string")

    const fileSystemResource = new oci.filestorage.FileSystem("fileSystemResource", {
    availabilityDomain: "string",
    compartmentId: "string",
    definedTags: {
        string: "any",
    },
    displayName: "string",
    filesystemSnapshotPolicyId: "string",
    freeformTags: {
        string: "any",
    },
    kmsKeyId: "string",
    sourceSnapshotId: "string",
});

    type: oci:FileStorage:FileSystem
properties:
    availabilityDomain: string
    compartmentId: string
    definedTags:
        string: any
    displayName: string
    filesystemSnapshotPolicyId: string
    freeformTags:
        string: any
    kmsKeyId: string
    sourceSnapshotId: string

    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

    The FileSystem resource accepts the following input properties:

    AvailabilityDomain string
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment to create the file system in.
    DefinedTags Dictionary<string, object>
    (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"}
    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, object>
    (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"}
    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.
    SourceSnapshotId string

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    AvailabilityDomain string
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment to create the file system in.
    DefinedTags map[string]interface{}
    (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"}
    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]interface{}
    (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"}
    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.
    SourceSnapshotId string

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    availabilityDomain String
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment to create the file system in.
    definedTags Map<String,Object>
    (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"}
    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,Object>
    (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"}
    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.
    sourceSnapshotId String

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    availabilityDomain string
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartmentId string
    (Updatable) The OCID of the compartment to create the file system in.
    definedTags {[key: string]: any}
    (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"}
    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]: any}
    (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"}
    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.
    sourceSnapshotId string

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    availability_domain str
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartment_id str
    (Updatable) The OCID of the compartment to create the file system in.
    defined_tags Mapping[str, Any]
    (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"}
    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, Any]
    (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"}
    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.
    source_snapshot_id str

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    availabilityDomain String
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment to create the file system in.
    definedTags Map<Any>
    (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"}
    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<Any>
    (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"}
    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.
    sourceSnapshotId String

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

    ** 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 FileSystem resource produces the following output properties:

    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.
    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.
    TimeCreated string
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    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.
    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.
    TimeCreated string
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    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.
    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.
    timeCreated String
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    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.
    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.
    timeCreated string
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    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.
    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.
    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
    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.
    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.
    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,
        availability_domain: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        filesystem_snapshot_policy_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_clone_parent: Optional[bool] = None,
        is_hydrated: Optional[bool] = None,
        is_targetable: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        metered_bytes: Optional[str] = None,
        replication_target_id: Optional[str] = None,
        source_details: Optional[Sequence[_filestorage.FileSystemSourceDetailArgs]] = None,
        source_snapshot_id: Optional[str] = None,
        state: Optional[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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailabilityDomain string
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment to create the file system in.
    DefinedTags Dictionary<string, object>
    (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"}
    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, object>
    (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.
    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'.
    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.
    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 string

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    State string
    The current state of the file system.
    TimeCreated string
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    AvailabilityDomain string
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment to create the file system in.
    DefinedTags map[string]interface{}
    (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"}
    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]interface{}
    (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.
    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'.
    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.
    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 string

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    State string
    The current state of the file system.
    TimeCreated string
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment to create the file system in.
    definedTags Map<String,Object>
    (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"}
    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,Object>
    (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.
    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'.
    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.
    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 String

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    state String
    The current state of the file system.
    timeCreated String
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain string
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartmentId string
    (Updatable) The OCID of the compartment to create the file system in.
    definedTags {[key: string]: any}
    (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"}
    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]: any}
    (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.
    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'.
    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.
    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 string

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    state string
    The current state of the file system.
    timeCreated string
    The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availability_domain str
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartment_id str
    (Updatable) The OCID of the compartment to create the file system in.
    defined_tags Mapping[str, Any]
    (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"}
    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, Any]
    (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_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'.
    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.
    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 str

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    state str
    The current state of the file system.
    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
    availabilityDomain String
    The availability domain to create the file system in. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment to create the file system in.
    definedTags Map<Any>
    (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"}
    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<Any>
    (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.
    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'.
    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.
    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 String

    The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

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

    state String
    The current state of the file system.
    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

    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.

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

    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.

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

    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.

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

    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.

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

    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.

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

    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.

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

    Import

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

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

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi
    pulumi/pulumi-oci